Compare commits
536 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| f29319efc4 | |||
| b21d20d414 | |||
| fedb45a419 | |||
| 15ca246abd | |||
| 6b76f6b9a2 | |||
| 944ec1e856 | |||
| 14811e3f9c | |||
| 38323e6be1 | |||
| 24f10b89b0 | |||
| 0607cf5386 | |||
| 28297f3a0e | |||
| 7bd5decc62 | |||
| f1f1957c43 | |||
| 82bac17b38 | |||
| 1ea1ef6fd0 | |||
| 5ca5312c52 | |||
| 4a2d8e63ea | |||
| 78212f06d7 | |||
| f838ef3779 | |||
| 5aaa1ad732 | |||
| c135ad0fba | |||
| a3a2bce652 | |||
| 6db0f8c905 | |||
| b62a1a19b0 | |||
| d6361dac4d | |||
| bae29fd9c7 | |||
| aca968ccbd | |||
| db044551cc | |||
| cfdf0af878 | |||
| d6e6287b56 | |||
| 98c1644d76 | |||
| 002017e5e6 | |||
| 2d2ce49537 | |||
| 42ed2819b8 | |||
| 80147ed61b | |||
| b28344d272 | |||
| 7678f61480 | |||
| eac8be3d31 | |||
| 3cb9bc9931 | |||
| b388eae439 | |||
| c1b81004be | |||
| 02e423c0f2 | |||
| ce34e40a52 | |||
| 4f701c4b1c | |||
| 6c0ee8abc5 | |||
| 9bacac8f3d | |||
| a0dc5a6ae9 | |||
| 6b548a34e6 | |||
| 8c5629c9ce | |||
| e7589f6ceb | |||
| 711582ae71 | |||
| db22c1801d | |||
| 422bc33da7 | |||
| 96603f025a | |||
| a8fecd133e | |||
| 7f10811c05 | |||
| f09c98906a | |||
| 04dfb5f327 | |||
| dc801e9cc9 | |||
| a8e2ab941f | |||
| c83bc8c769 | |||
| 0eb7f66c2b | |||
| d70615a32d | |||
| 26694f30e3 | |||
| 3563639ce0 | |||
| a42f49e1fa | |||
| 42b0b0c350 | |||
| 6e6abfe833 | |||
| baa696b880 | |||
| 27eebeb9cb | |||
| d349e5e4fb | |||
| 53a47511d8 | |||
| 518b4d4e62 | |||
| a771136761 | |||
| 36ee6f64bc | |||
| 2257b72255 | |||
| a65c9b5a18 | |||
| d38e461246 | |||
| edc9901e7e | |||
| 48b55df18e | |||
| dc024c9d99 | |||
| 9f09dd06c9 | |||
| 133e70ea89 | |||
| 3a4146e0c3 | |||
| fd5603629f | |||
| 4c77c595c6 | |||
| 3f825e4375 | |||
| 2d6f6e5cb0 | |||
| 5580824ac9 | |||
| ed0266029a | |||
| 1feed40962 | |||
| b2a7ef5f41 | |||
| 65e5ce0c63 | |||
| 2de2d9ccb6 | |||
| 7231f620c8 | |||
| 6df32b6b34 | |||
| 02e429d99d | |||
| 554964f57c | |||
| 866fa254f6 | |||
| cf9c605c34 | |||
| 9d39ec8802 | |||
| e3a4634d3c | |||
| ad35a0b7f9 | |||
| b2352e338b | |||
| 53741632a4 | |||
| e9652daba9 | |||
| ed5b7f669f | |||
| d6e7fd314f | |||
| ceeabd1ebc | |||
| 15149ffa0b | |||
| 2f180747b7 | |||
| 25fe90253c | |||
| 86d122aacf | |||
| 9737d5c930 | |||
| c6088d91fa | |||
| 15fdf77ce4 | |||
| f7f001ac2e | |||
| a193c283f3 | |||
| 3524d02047 | |||
| 7948201e18 | |||
| 8d84137a27 | |||
| 2273cffbc2 | |||
| 63ef35a005 | |||
| 417be73b23 | |||
| 18367219c8 | |||
| 2a77cf1a02 | |||
| 41b0f7d742 | |||
| 24c81c234f | |||
| 4833d9f00d | |||
| 37e3497522 | |||
| 8229aa73fe | |||
| e67590d0a1 | |||
| 33f0608d84 | |||
| 3d1a586c73 | |||
| 7d36253668 | |||
| e076e9f4ca | |||
| 44aa4d3a32 | |||
| a1d08b6fa4 | |||
| fc4a71f7e1 | |||
| 9a59b9fea4 | |||
| 19081a2e1f | |||
| 3cb4003bcd | |||
| beb48e500e | |||
| 93c4679c46 | |||
| d6688def9d | |||
| 489d53f55c | |||
| 3deb8fb8d2 | |||
| 1af3a0f092 | |||
| de80ac551b | |||
| 89601efde0 | |||
| 235065322c | |||
| 11b3e120e2 | |||
| 667edf3724 | |||
| 4a10e27ddf | |||
| b4305a1edb | |||
| 7598ee96da | |||
| 6de7c861ed | |||
| 658c57e22c | |||
| 60cf1dab18 | |||
| 4ce9183bd3 | |||
| 7dd002396f | |||
| 1130a830c7 | |||
| 66a9026b8f | |||
| 458f1e517c | |||
| a13f9b481a | |||
| de70a22c42 | |||
| f3d3506e02 | |||
| 1daa14584a | |||
| 477d51fbbb | |||
| 08c9214976 | |||
| c110dcd40e | |||
| eaa3e1e6af | |||
| 6562d16ce5 | |||
| 15a5b16b39 | |||
| d9c0c9c68e | |||
| d1ca123104 | |||
| f37647599a | |||
| cb14e84a26 | |||
| 8d7e4d1066 | |||
| c30ed923b6 | |||
| 50713188bf | |||
| e2ccd11f07 | |||
| f3316a017b | |||
| bdf1b63833 | |||
| 3ef26f2918 | |||
| 372360d739 | |||
| dc5877f398 | |||
| 3e3492bbab | |||
| 49b2113fe1 | |||
| 556cfa1ee3 | |||
| 1ab4093d54 | |||
| 97e1ec2be4 | |||
| bf27da5c66 | |||
| 1010b9fce7 | |||
| 3e34bd6bff | |||
| 3f892493c0 | |||
| 7d4567efbe | |||
| 9aed707a77 | |||
| 0c373e6b2c | |||
| a501b32a03 | |||
| 8ab6603999 | |||
| 85383f989a | |||
| 0423ac31d9 | |||
| 6e95ff92b1 | |||
| d4274d54d2 | |||
| 35f37f3a36 | |||
| 78d7bb9262 | |||
| 3c545be5c5 | |||
| c1983f75e6 | |||
| 7c3de6d77f | |||
| 17dc80f11b | |||
| 846d449aac | |||
| db9b7335f2 | |||
| 6f98473009 | |||
| 357261ec73 | |||
| 5bef901295 | |||
| 59e247c012 | |||
| a87c4796b5 | |||
| 4d289ee14a | |||
| 08feb7c9dd | |||
| 9cb06cb71e | |||
| 5ec607d94a | |||
| ac7ef119e0 | |||
| 03c8127bd3 | |||
| aee33a6a4b | |||
| eb001e59b3 | |||
| 3e46d4b280 | |||
| eae07fcad0 | |||
| 25a0928195 | |||
| 41b65a76c1 | |||
| 67c992806f | |||
| 33672315d2 | |||
| 26fc0c67a5 | |||
| 4032ed4e3f | |||
| 2147746ff9 | |||
| 819b3b4de7 | |||
| 3a909c76e0 | |||
| 30c7f6f705 | |||
| b4f1985c99 | |||
| c57e7ebdfe | |||
| fc79251f66 | |||
| 93f6eeac87 | |||
| 138fd1184c | |||
| 0f0e8e9f98 | |||
| 576c0a82f8 | |||
| 57cb349371 | |||
| 791040364b | |||
| defd744ef0 | |||
| 298809686b | |||
| 1b80d008ef | |||
| 0e53e43c77 | |||
| bb76d2edcf | |||
| c9499d839c | |||
| ba1dd3df6b | |||
| 721f93d82d | |||
| 9df663dc9b | |||
| c535126605 | |||
| 6df7b16cdf | |||
| 7cc7919da4 | |||
| e639cee4ee | |||
| da299d8a03 | |||
| b04a8460b0 | |||
| 62b4816498 | |||
| 56c811ad89 | |||
| 71b3989083 | |||
| e753344137 | |||
| bc32a8a10e | |||
| 906f73f303 | |||
| d84c307593 | |||
| de8524b37c | |||
| c67d8761e2 | |||
| 7600ae86d1 | |||
| 97e0998e1d | |||
| 5b85acbd73 | |||
| ca84f4dfea | |||
| 315f0f3858 | |||
| 21d5f74dd8 | |||
| 08c9d5a0e3 | |||
| 4a719b6c9a | |||
| 7043af47c3 | |||
| ebbb3e8ed0 | |||
| 863f0bba2c | |||
| 7df81177de | |||
| 9f6ea0fb58 | |||
| f64514cbe6 | |||
| b651bc6385 | |||
| 6b7351d1b3 | |||
| 878b93889f | |||
| 9edbcc6f01 | |||
| 3f6661e2dc | |||
| f9a8e3149f | |||
| 4ef7c2fb0b | |||
| d6689888b2 | |||
| 1523091637 | |||
| 0b0046986e | |||
| 1b0c0da677 | |||
| 660a619944 | |||
| dcb7957d15 | |||
| dfe07b16ae | |||
| 9bbb40ce8c | |||
| 98c5946efd | |||
| 40fd739b2c | |||
| d2909ab21d | |||
| 4f5445a833 | |||
| 54dad486a4 | |||
| 84fca7ba25 | |||
| 795b4e5095 | |||
| 2e497ccec8 | |||
| d0c5ddc9c7 | |||
| 9871d1c23b | |||
| 50eec23c85 | |||
| 1675c48fc3 | |||
| 86ec6de894 | |||
| ca0a51ec15 | |||
| 244aba88d3 | |||
| 4b7e815c68 | |||
| c946e56a41 | |||
| cbc9ec4634 | |||
| 094e084316 | |||
| 52085cf521 | |||
| a4e9b70b27 | |||
| 2cfd947429 | |||
| 24ed20305f | |||
| 12607cca44 | |||
| 00ee79d33c | |||
| d7d0cb3a06 | |||
| ec8ce1f2f6 | |||
| f7f78da1a1 | |||
| 49b0772076 | |||
| 9b8a6c36db | |||
| f44e06c57e | |||
| b46b904504 | |||
| 004b42436e | |||
| 5e5db62d2a | |||
| fd39b0008e | |||
| af5d5206f8 | |||
| de0e014e50 | |||
| 6bf38d369b | |||
| dbb98ba4fe | |||
| 87c9bc769e | |||
| f014d7ffcd | |||
| 07306ff209 | |||
| ab0b92ad5c | |||
| df96d14643 | |||
| 61ec7509ad | |||
| 0bcedadc5c | |||
| c1c5aa9239 | |||
| ab7c8aa250 | |||
| 0fb9878cff | |||
| acd0092f26 | |||
| 71a4923c56 | |||
| dea59c5285 | |||
| f1d0ab20cb | |||
| fb9dc3fbc5 | |||
| 49acd71ff9 | |||
| 026fdc0d33 | |||
| 08a4c1b732 | |||
| 3eaa8b6efd | |||
| 6c4e157b5c | |||
| b7847ebaad | |||
| 1fe4e19239 | |||
| 4b4f5eba8c | |||
| 8c9d40eefa | |||
| 925d2172ff | |||
| 6b0fb0385d | |||
| 2e9a7265e9 | |||
| d1835c5c06 | |||
| 7babad8262 | |||
| 9282b4231e | |||
| e4201aebff | |||
| 1fb42bffdc | |||
| 9d7d0a0ec9 | |||
| c5730230f6 | |||
| 19867cbcd9 | |||
| 131bd63a5b | |||
| 562529a26b | |||
| 6eae7226be | |||
| 0091a4da92 | |||
| 95ac89c5ec | |||
| 11084f6689 | |||
| 1b5fa5129c | |||
| 00a27fc4a8 | |||
| e1b1dfafac | |||
| 4ffdba8e41 | |||
| 092ae26257 | |||
| 11c3eeb9b8 | |||
| ae656932ba | |||
| 7d4e8ba27c | |||
| fd3d45a21a | |||
| c8042c6a75 | |||
| 421fb76320 | |||
| 6f336970db | |||
| 985285963c | |||
| 43223ad1cc | |||
| f6c8172676 | |||
| 05466f96c0 | |||
| 08b1df79f2 | |||
| 3ec53548a9 | |||
| 93108817de | |||
| 4b19b7199b | |||
| e8d1be6aa6 | |||
| bde3cdd09f | |||
| d05f9aa267 | |||
| d253a88daa | |||
| 6db5a93598 | |||
| d4a4c6878d | |||
| 550e45a5c0 | |||
| 266fcbf58b | |||
| f162de89be | |||
| 2efb9fb2a1 | |||
| 1156373f0c | |||
| 5f9bf37617 | |||
| c0fdd102e3 | |||
| 9f3ee8d963 | |||
| 802865c1a6 | |||
| 02835579c1 | |||
| 81b3be894e | |||
| 3875181d89 | |||
| 0669c64da1 | |||
| 931e9d13f7 | |||
| cd0598c5d1 | |||
| bc4980c6b8 | |||
| f20945be9f | |||
| 099bbb1607 | |||
| ebcfa4f9dc | |||
| f121505c50 | |||
| 793830ab21 | |||
| 735c1ce688 | |||
| 837d4ef7ee | |||
| adfa88aef8 | |||
| fbd0101b45 | |||
| f1cfeb0acc | |||
| 45b8563db1 | |||
| ec3c89ac1b | |||
| b422a565d5 | |||
| eb3212ee2d | |||
| e209251d0b | |||
| e73fa2d7f9 | |||
| 8c0ed525b3 | |||
| 31e66c7213 | |||
| b3e76f5580 | |||
| f217a819fe | |||
| 6a784a14fa | |||
| d809fc021f | |||
| 582df6e3a8 | |||
| d5a4f96482 | |||
| d2fc9cf558 | |||
| b530ac5a5c | |||
| 2659336ee9 | |||
| c32a09bfc1 | |||
| f7ff415374 | |||
| 9cac674d7b | |||
| 2cf7da9c91 | |||
| 0d1d3a1ed5 | |||
| 7e2ebe8013 | |||
| 0606a1278c | |||
| 7c9f24f695 | |||
| 227fb4fa94 | |||
| 77ef154941 | |||
| a00aa3ee02 | |||
| 7b6b5efd8d | |||
| db62e05275 | |||
| 3db66eb55b | |||
| 4709177bc3 | |||
| e25a890946 | |||
| bc4a181182 | |||
| ce7af09f25 | |||
| e3da438225 | |||
| edbb7ccabe | |||
| f4360b34d9 | |||
| 0ed0cf4aa2 | |||
| 61fc2198c9 | |||
| f45f5a899b | |||
| 37f6dce344 | |||
| 10624787fe | |||
| d7a697d68d | |||
| 97954f59c3 | |||
| 3b23e9f420 | |||
| 94712ecbfc | |||
| a2c2b69026 | |||
| 6abc6f9d1a | |||
| db0fbfaaf4 | |||
| a59210c559 | |||
| add11b0037 | |||
| c26034a89c | |||
| 9287464eb8 | |||
| 1c103b2db7 | |||
| ed6a5fc7f1 | |||
| 768efc8cf7 | |||
| 39a9bc9022 | |||
| f90b7b3c9b | |||
| 802a225c3e | |||
| 74370db5de | |||
| db788c3c30 | |||
| eae619e7e8 | |||
| 0f3380e91e | |||
| 7c80486d88 | |||
| 1f65198803 | |||
| 0f18b7bd80 | |||
| b89f4a3b6b | |||
| 658d2d7af4 | |||
| f09c404f65 | |||
| fbe8eca263 | |||
| 923e8b070d | |||
| e6e53e566f | |||
| f144f1d71c | |||
| 3694e1a6e4 | |||
| d45b6dc8dc | |||
| 5194133a78 | |||
| 6e5d634af6 | |||
| 32d5ff3b47 | |||
| 5545554d7e | |||
| 6a0faa958e | |||
| 15c0478710 | |||
| bab9804022 | |||
| c93c417dba | |||
| 2fe91de000 | |||
| 412e3a078c | |||
| b6dda55a82 | |||
| b8bda93e8d | |||
| ac485f9c87 | |||
| 4b33627d19 | |||
| af28624e2d | |||
| 3457aedf5d | |||
| 5acac4ba5b | |||
| 0b151f9054 | |||
| cafc45dbba | |||
| e3cbcab6b2 | |||
| ec7e9a546c | |||
| 7a2aab3204 | |||
| 5dcdd2c36f | |||
| fb0a630bfd | |||
| 1da28024cc | |||
| 480e6a62b6 | |||
| 807456de86 | |||
| c8ef42ab21 |
@@ -1,5 +1,653 @@
|
|||||||
# Change Log
|
# Change Log
|
||||||
|
|
||||||
|
# 2604.1
|
||||||
|
|
||||||
|
## What's Changed
|
||||||
|
|
||||||
|
### Fluent style
|
||||||
|
|
||||||
|
With the release of PowerShell 7.6 finally going to GA, I was able to release the Fluent UI styling refresh. This will bring significant improvement to the look and feel of FFU Builder. Note that you will want to make sure you're running **PowerShell 7.6**, otherwise the listviews for Drivers and Applications will be missing the column headers.
|
||||||
|
|
||||||
|
### Build tab reorganization
|
||||||
|
|
||||||
|
The build tab sections now have expanders for the settings within. This should help with organization of each setting.
|
||||||
|
|
||||||
|
### Home page build and release status
|
||||||
|
|
||||||
|
The Home page of FFU Builder will now tell you what build you're on and if there's a new build along with the release notes for the new build. You can also see disk space and hyper-v status, as well as the latest Github repo discussions and a list of resources.
|
||||||
|
|
||||||
|
### Fixed an issue with Surface and Lenovo driver downloads
|
||||||
|
|
||||||
|
Microsoft changed the Surface driver download support page. FFU Builder now uses the [Microsoft Learn page for Surface driver downloads ](https://learn.microsoft.com/en-us/surface/manage-surface-driver-and-firmware-updates) that's designed for IT Admins. It's an easier table to parse rather than trying to parse the updated support page that FFU Builder used to use.
|
||||||
|
|
||||||
|
Fixed an issue where retrieving Lenovo models was failing.
|
||||||
|
|
||||||
|
### Removed Capture ISO
|
||||||
|
|
||||||
|
FFU Builder no longer relies on booting to WinPE to capture builds done via the VM. Instead, FFU Builder will now just capture the VHDX directly. This improves FFU build times tremendously and reduces the need for the VM Switch. The switch is still necessary for those that want to add internet connectivity during the FFU build process.
|
||||||
|
|
||||||
|
### Refresh Windows SKU after fallback SKU selection
|
||||||
|
|
||||||
|
Fixed an issue grabbing the correct Windows SKU when the user incorrectly chose a SKU that wasn't in the media and had to later be prompted for an available SKU. In this situation the SKU that was provided earlier was chosen, which caused a variety of issues.
|
||||||
|
|
||||||
|
### Removed registry-based FFU file naming
|
||||||
|
|
||||||
|
Removed registry-based FFU file naming and now rely on parameters provided at build time and the custom FFU naming template. This will remove the hard coded wait times that had to do with loading/unloading of the registry.
|
||||||
|
|
||||||
|
### Added a checkbox to enable network connectivity during VM build
|
||||||
|
|
||||||
|
Add a checkbox to enable network connectivity during the VM build. I'm fairly confident that the build process should be able to withstand any sysprep-related issues being connected to the internet. The checkbox is flagged as experimental. Give it a try and let me know if you notice any issues.
|
||||||
|
|
||||||
|
### Added UI controls for Device Naming
|
||||||
|
|
||||||
|
Device naming now has an expander in the Build tab that will expose a number of new options available. Rather than writing up a whole thing here in the release notes, the UI should be intuitive enough to explain how it works. The docs have also been updated. I spent a lot of time testing the changes with both legacy naming scenarios and if you make changes in the UI. If you see something that doesn't work, open a discussion or issue.
|
||||||
|
|
||||||
|
### Fixed Office installation issues on ARM64 VMs
|
||||||
|
|
||||||
|
I actually didn't fix anything, but rather removed a restriction that was put in place due to Office requiring internet access to install on ARM64. It seems the PG has fixed the issue requiring internet access and office will now install. However there's a caveat that it will prompt with a compatibility assistant popup. I think we can disable the compatibility assistant service to prevent the pop up from happening in the orchestrator. Will look into this in a future release.
|
||||||
|
|
||||||
|
### Auto-generate ComputerName in Unattend.xml
|
||||||
|
|
||||||
|
Now you can provide your own Unattend.xml without a ComputerName element and FFU Builder will add it if you've chosen to include a computer name. If there's a ComputerName element already in the file, ApplyFFU.ps1 will find it and modify it as per your naming choices.
|
||||||
|
|
||||||
|
### Add custom unattend.xml paths
|
||||||
|
|
||||||
|
There's a new expander for Unattend.xml options in the Build tab which includes paths for the x64 and arm64 unattend.xml files. This means that you can have your unattend files in any location instead of in the FFUDevelopment\unattend folder. This should make upgrades easier for those that have custom unattend.xml files and copying new releases would overwrite your customized unattend files.
|
||||||
|
|
||||||
|
### Fixed an issue where CUs wouldn't service after the March 31, 2026 OOB update (KB5086672) was installed on your host machine
|
||||||
|
|
||||||
|
The KB5086672 CU which is rolled into the April 14, 2026 update (KB5083769) caused an issue with Add-WindowsPackage. Add-WindowsPackage uses the DISM API to service a Windows image. The native dism.exe doesn't have this issue. To keep things consistent, FFU Builder will now use the dism.exe from the installed Windows ADK. While this version of dism might be older than what's on your machine, it should be consistent and not be impacted by future CUs.
|
||||||
|
|
||||||
|
# 2603.2
|
||||||
|
|
||||||
|
## What's Changed
|
||||||
|
|
||||||
|
Highly recommended to upgrade to this release due to potential SecureBoot issues
|
||||||
|
|
||||||
|
### Fixes SecureBoot-related boot issues on newly deployed FFUs
|
||||||
|
|
||||||
|
Fixes an issue where some devices may not boot after an FFU was applied if the FFU was built from a machine that had been updated to the Windows UEFI CA 2023 SecureBoot certificates.
|
||||||
|
|
||||||
|
Sometime at the start of this calendar year (Either January or February), a change was made in Windows to how BCDBoot functioned. If you took a CU from either of these months, BCDBoot will now check to see if the device has the 2011 or 2023 CA certificates. If 2023, the local BCDBoot will use the 2023 signed boot files when creating the System partition and these boot files will be deployed to the target system when the FFU is deployed. If the target machine hasn't updated to the 2023 certificates, boot will fail.
|
||||||
|
|
||||||
|
To fix this, FFU Builder now uses the version of BCDBoot from the ADK instead of the locally installed version. The version of BCDBoot from the 10.1.26100.2454 ADK December 2024 version (which is what FFU Builder considers the latest), will provide the boot files signed with the 2011 certs.
|
||||||
|
|
||||||
|
The version of [BCDBoot from the 10.1.28000.1 ADK](https://learn.microsoft.com/en-us/windows-hardware/get-started/what-s-new-in-kits-and-tools#bcd-boot) from November 2025 will default to using the 2023 certs as long as the machine supports the 2023 CA. This has been documented since this ADK was released. The behavior of this version of BCDBoot is what we're seeing now in devices that have been recently updated.
|
||||||
|
|
||||||
|
I suspect that when 26H2 is released, there will be a new ADK around that time and at that point we'll move to using that version of the ADK, which that version of BCDBoot will default to using the 2023 signed boot files and I suspect WinPE will probably default to doing the same. By then, hopefully, most in-market devices should have the 2023 certificates in UEFI and those that don't will need to get the certs or downgrade their ADK version to use the 2011 signed boot files.
|
||||||
|
|
||||||
|
### Fixes working directory handling
|
||||||
|
|
||||||
|
Creation and deletion of the dirty.txt marker file now use an explicit path based on $FFUDevelopmentPath, avoiding ambiguity and potential issues with relative paths.
|
||||||
|
|
||||||
|
**Full Changelog**: https://github.com/rbalsleyMSFT/FFU/compare/v2603.1...v2603.2
|
||||||
|
|
||||||
|
# 2603.1
|
||||||
|
|
||||||
|
## What's Changed
|
||||||
|
|
||||||
|
### UI Out of Preview
|
||||||
|
|
||||||
|
The UI is finally out of preview and the code from the UI branch has been pushed to main.
|
||||||
|
|
||||||
|
### Remove old MSU files before servicing
|
||||||
|
|
||||||
|
Fixes an issue where older cumulative update MSU files were mixed with newer files. In Windows 11 24H2, dism treats all MSU files in the same folder as possible update sources, causing servicing issues.
|
||||||
|
|
||||||
|
This will primarily be an issue for those of you who use ISO files that don't have the latest updates, or those of you who create your FFUs with the ESD media shortly after patch Tuesday.
|
||||||
|
|
||||||
|
### Adds OS-scoped update KB folders
|
||||||
|
|
||||||
|
The KB folder where the CU and .NET updates downloads to will now have sub-folders for each Windows version. You may notice that if selecting 25H2, that the KB sub-folder for Windows 11 will show 24H2, this is to keep consistent with Windows 11 LTSC 2024 and Windows Server 2025, which all use the same 24H2 source OS (25H2 is just an eKB, not a full OS Swap Windows release like 24H2 was).
|
||||||
|
|
||||||
|
### .NET Updates stored under their own dedicated KB folder
|
||||||
|
|
||||||
|
This is more so to keep things clean, rather than fixing any sort of technical issue
|
||||||
|
|
||||||
|
### Reworked Windows 10 LTSB\LTSC Cumulative Update Installation
|
||||||
|
|
||||||
|
Since Windows 10 is out of support, offline servicing Windows 10 LTSC builds that are still supported fails due to extended security update requirements. The workaround to this is to install the updates in audit mode. FFU Builder now creates an Apps\LTSCUpdate folder and copies the LCU for Windows 10 LTSC builds still in support to the folder and installs the update in audit mode.
|
||||||
|
|
||||||
|
### Fixes an issue with Update ADK failing for non-English languages
|
||||||
|
|
||||||
|
Fixed a bug where updating the ADK would fail on non-English installations of Windows due to an assumption that the add/remove programs display information would be in English. Update ADK should correctly identify if the latest release of the ADK is installed and work as expected.
|
||||||
|
|
||||||
|
### Added dependency validation when selecting Build USB drive and Copy Drivers
|
||||||
|
|
||||||
|
Fixed an issue where a build would begin even though Copy Drivers to USB was set to true but no USB was inserted. FFU Builder will now check before the build gets started and inform the user if no USB drive is inserted.
|
||||||
|
|
||||||
|
### Normalizes Windows LTSC release versions to handle driver downloads
|
||||||
|
|
||||||
|
Driver downloads would fail if you were building certain LTSC releases due to FFU Builder incorrectly using the LTSC release year instead of the base Windows client version information. When build LTSC FFUs, the drivers should now download as expected.
|
||||||
|
|
||||||
|
### Scopes select-all to visible filtered list items in drivers listview
|
||||||
|
|
||||||
|
When filtering the drivers listview and selecting all driver models using the select all header checkbox, the select all behavior was selecting everything, even the hidden models in the list. If then selecting Download Selected, FFU Builder would download all models, even hidden ones. This now fixes that issue to only select all visible models and download those selected models.
|
||||||
|
|
||||||
|
### Retain downloaded ESD files
|
||||||
|
|
||||||
|
FFU Builder will now allow you to retain a downloaded ESD file. There's a new option on the Build tab to Remove Downloaded ESD File(s) which is checked by default to keep with the previous behavior. The intent here is to prevent from having to re-download the ESD file every time you're doing a build. This gives you another option along with Allow VHDX Caching to reduce the need of redownloading media.
|
||||||
|
|
||||||
|
### Reduce the size of cached VHDX files
|
||||||
|
|
||||||
|
Added some code to reduce the size of the cached VHDX files.
|
||||||
|
|
||||||
|
### Include disk size in VHDX cache validation
|
||||||
|
|
||||||
|
Prevents reusing cached images when the requested disk size changes. Ensures the disk size property is properly saved and verified against existing cache items to maintain configuration accuracy. This makes it so that if you create a new build with a larger disk size and have Allow VHDX caching selected, it won't use a cached VHDX with a smaller size.
|
||||||
|
|
||||||
|
### Enhances file backup and cleanup for cancelled builds
|
||||||
|
|
||||||
|
Improves the current-run cleanup mechanism by tracking file downloads explicitly. This ensures that files downloaded via BITS or preserving older timestamps are correctly identified and removed during cleanup. Extends the run manifest schema to support file backups, allowing for safe restoration of pre-existing scripts and configuration files modified during a run. Additional cleanup logic now correctly prunes residual empty directories after tracked files are removed.
|
||||||
|
|
||||||
|
### Fixed an issue with arm64 ESD downloads
|
||||||
|
|
||||||
|
With the change to how ESD downloads work with 25H2 and the Media Creation Tool, arm64 was broken. This was fixed.
|
||||||
|
|
||||||
|
# 2602.1 UI Preview
|
||||||
|
|
||||||
|
## What's Changed
|
||||||
|
|
||||||
|
### Improved Automatic Matching for Surface devices
|
||||||
|
|
||||||
|
To keep inline with HP, Dell, and Lenovo, added support for Surface devices to leverage the SystemSKU values from WMI when doing automatic driver matching during deployment. Check https://github.com/rbalsleyMSFT/FFU/pull/394 for more information. Long story short, there's a new `SurfaceDriverIndex.json` file that is created when getting the models which gathers the WMI information per model as well as the download links for each model. This info is used to generate the DriverMapping.json file for Surface to allow for better matching.
|
||||||
|
|
||||||
|
There'll be deeper documentation on the new [docs site](https://rbalsleymsft.github.io/FFU/)
|
||||||
|
|
||||||
|
### Improved driver injection error handling when deploying drivers via USB
|
||||||
|
|
||||||
|
When drivers failed to be added from the USB drive during deployment, ApplyFFU.ps1 would fail with an error message and the deployment wouldn't complete. ApplyFFU.ps1 will now continue on failure and log the error and capture the setupapi.offline.log to the USB drive for troubleshooting if needed.
|
||||||
|
|
||||||
|
### Fixed an issue with Windows image index for non-English media
|
||||||
|
|
||||||
|
In some cases non-English media would cause the end-user to have to select which Windows SKU to select due to parsing the image name output and assuming the output was in English. BuildFFUVM.ps1 will now parse the edition metadata for each index. This should improve the experience for those that are creating FFUs from non-English media.
|
||||||
|
|
||||||
|
### Run builds in separate pwsh process instead of background jobs
|
||||||
|
|
||||||
|
In https://github.com/rbalsleyMSFT/FFU/pull/393, by changing the deprecated Get-WmiObject calls to Get-CimInstance, this actually broke console output. Still don't fully understand why GWMI was allowing background jobs to output console output to the calling pwsh Window but get-ciminstance wouldn't (WinRM, PowerShell Remoting, etc), but this required changing to running the build in a separate pwsh process. Between this and https://github.com/rbalsleyMSFT/FFU/pull/393, this should fix those that might build their FFUs on Servers and still expect to see console output.
|
||||||
|
|
||||||
|
### Fixed an issue with USB drive selection for same-model USB drives
|
||||||
|
|
||||||
|
When using the UI and selecting specific USB drives to create, the UI would allow you to select multiple of the same name, but would only create one of the drives. You should now be able to multi-select multiple USB drives with the same name and they should build as expected.
|
||||||
|
|
||||||
|
### Created new docs site
|
||||||
|
|
||||||
|
[FFU Builder docs](https://rbalsleymsft.github.io/FFU/) are now available! I'm still working on adding more documentation, but the layout of the site, the prereqs, quick start, and UI overview are done. I still have some stuff to migrate from the old docx file and some deep dive stuff to write up (Drivers, Apps, FAQs, Troubleshooting, etc). It should work well on both mobile and desktop. It also has built-in search capabilities to make it easy to find what you're interested in.
|
||||||
|
|
||||||
|
## New Contributors
|
||||||
|
|
||||||
|
* @JGehl99 made their first contribution in https://github.com/rbalsleyMSFT/FFU/pull/393
|
||||||
|
|
||||||
|
**Full Changelog**: https://github.com/rbalsleyMSFT/FFU/compare/v2601.1Preview...v2602.1Preview
|
||||||
|
|
||||||
|
# 2601.1 UI Preview
|
||||||
|
|
||||||
|
## What's Changed
|
||||||
|
|
||||||
|
### Improved WinPE driver copy reliability and logging
|
||||||
|
|
||||||
|
Fixed a bug where some drivers weren't being copied into WinPE media when using **Use Drivers Folder as PE Drivers Source** option (`UseDriversAsPEDrivers` parameter)
|
||||||
|
|
||||||
|
### Improved driver injection for long driver folder paths
|
||||||
|
|
||||||
|
In some cases some drivers weren't being copied to the FFU or WinPE deployment media due to long paths. This required some significant refactoring. [See this post](https://github.com/rbalsleyMSFT/FFU/discussions/375) for more details on the changes that were made and the reasoning behind them.
|
||||||
|
|
||||||
|
### Fixed an issue with WingetWin32Apps.Json file corruption during parallel app updates
|
||||||
|
|
||||||
|
A code refactor that was done to consolidate some of the winget application download work that both the UI and BuildFFUVM.ps1 script caused an issue where parallel writes to the WingetWin32Apps.json file was causing the file to corrupt, resulting in apps not installing as expected.
|
||||||
|
|
||||||
|
### Winget App installs now follow Applist.json order
|
||||||
|
|
||||||
|
Winget application installs were installing in an indeterministic way when the WingetWin32Apps.json file was created. The order will now follow the order listed in the AppList.json file.
|
||||||
|
|
||||||
|
### Support added for Winget Win32 app dependency handling
|
||||||
|
|
||||||
|
Some apps (Camtasia) require dependency apps to be installed first. Winget will download said dependency apps. Dependent applications will now install before the calling application. There is also deduplication support added in the event multiple applications have the same dependencies.
|
||||||
|
|
||||||
|
**Full Changelog**: [https://github.com/rbalsleyMSFT/FFU/compare/v2512.1Preview...v2601.1Preview](https://github.com/rbalsleyMSFT/FFU/compare/v2512.1Preview...v2601.1Preview)
|
||||||
|
|
||||||
|
# 2512.1 UI Preview
|
||||||
|
|
||||||
|
## What's Changed
|
||||||
|
|
||||||
|
### Refactored Cleanup logic into a shared module
|
||||||
|
|
||||||
|
Consolidates duplicated cleanup code by moving logic into a shared function, eliminating redundant implementations across multiple locations.
|
||||||
|
|
||||||
|
Removes standalone cleanup functions (Remove-FFU, Remove-Apps, Remove-Updates) and replaces scattered cleanup calls with a single invocation of Invoke-FFUPostBuildCleanup.
|
||||||
|
|
||||||
|
### Add 30 second delay to allow for Windows Security Platform to install
|
||||||
|
|
||||||
|
There was an issue where the Windows Security Platform would attempt to install in the VM during the build via `Update-Defender.ps1` however the install didn't always happen and on deployment of the FFU, Windows Update would show that the Windows Security Platform needed an update. I suspect this is related to the AppxSVC not being ready during Audit Mode. Adding a 30 second delay appears to work more reliably.
|
||||||
|
|
||||||
|
### Windows and .NET CU's now persist across builds
|
||||||
|
|
||||||
|
Content in the FFUDevelopment\KB folder was always deleted once it was used. Since the Windows CU is so large now, it doesn't make sense to delete it if a user wants it again and may not be using cached VHDX files.
|
||||||
|
|
||||||
|
Deletion of the KB folder is now correctly handled via the **Remove Downloaded Update Files** option on the Build tab.
|
||||||
|
|
||||||
|
### Skip CU downloads if the Windows ESD version is current or newer
|
||||||
|
|
||||||
|
Now that the Windows ESD media is kept up to date, there rarely will be a need to download the latest CU. There will always be a slight gap when the latest CU comes out and the updated media is available, but that's generally just a few days to a week.
|
||||||
|
|
||||||
|
The script will now do some parsing of the windows version of the ESD file and the latest CU and if the ESD is newer, the CU will not be downloaded.
|
||||||
|
|
||||||
|
### Fixes an issue with WingetWin32Apps.json file not being created if applications were pre-downloaded via the UI
|
||||||
|
|
||||||
|
Fixed a bug due to some code consolidation that broke scenarios where applications that were downloaded via the UI, but were not installing in the VM.
|
||||||
|
|
||||||
|
**Full Changelog**: https://github.com/rbalsleyMSFT/FFU/compare/v2511.1preview...v2511.2
|
||||||
|
|
||||||
|
# 2511.1 UI Preview
|
||||||
|
|
||||||
|
## What's Changed
|
||||||
|
|
||||||
|
### Major changes to drivers
|
||||||
|
|
||||||
|
A few weeks ago I wrote a [lengthy post](https://github.com/rbalsleyMSFT/FFU/discussions/350) asking for some help testing some changes that were added.
|
||||||
|
|
||||||
|
The summary of that post is that there have been significant changes for both Dell and HP driver downloads to leverage the SystemID for each model. This increases the total number of driver models that are exposed in the UI. This also requires the `DriverMapping.json` to be modified to require the SystemID and query the SystemID from WMI when doing automatic matching.
|
||||||
|
|
||||||
|
#### Driver folder structure changes on the USB drive - breaking change
|
||||||
|
|
||||||
|
Driver folder structure on the USB drive has also changed. The new structure is `Drivers\Make\Model` (e.g. `D:\Drivers\Lenovo\Lenovo 300w`). This structure is consistent with how the UI and `BuildFFUVM.ps1` script download and store drivers and automatically copy them. So if you've been following that, then no changes are required.
|
||||||
|
|
||||||
|
Please read [the post](https://github.com/rbalsleyMSFT/FFU/discussions/350) for more details on these changes to drivers.
|
||||||
|
|
||||||
|
### Windows 11 25H2 is now the default option for MCT/ESD downloads
|
||||||
|
|
||||||
|
For MCT/ESD downloads: Adds dynamic products.cab download functionality for Windows 11 using Windows Update service API instead of static MCT links. This is due to a change in how the MCT pulls the products.cab file. In other words, the Windows 11 25H2 ESD media is now updated each month (usually shortly after patch Tuesday)
|
||||||
|
|
||||||
|
### Added 8 new hardware manufactures for automatic driver matching during deployment
|
||||||
|
|
||||||
|
Extends hardware detection and driver mapping capabilities to support Panasonic, Viglen, AZW, Fujitsu, Getac, ByteSpeed, and Intel devices when applying the FFU to a device. This does not mean FFU Builder supports downloading drivers from these manufacturers. You'll still need to download the drivers for them manually. You can now create your own `DriverMapping.json` file to include these manufacturers.
|
||||||
|
|
||||||
|
Thanks to @arwidmark and the [Modern Driver Management](https://msendpointmgr.com/modern-driver-management/) team for the WMI queries.
|
||||||
|
|
||||||
|
### Fixed an issue with long paths when applying drivers from USB
|
||||||
|
|
||||||
|
Implemented SUBST drive mappings to shorten driver file paths within WinPE as some paths were causing dism to error when servicing drivers. You should see a Z:\ drive when applying drivers from the USB drive.
|
||||||
|
|
||||||
|
### Added an option to skip driver selection when multiple driver models are detected during deployment
|
||||||
|
|
||||||
|
Allows users to bypass driver installation by entering 0 at the selection prompt, providing flexibility for deployments that don't require driver updates.
|
||||||
|
|
||||||
|
### Add HTTP fallback for BITS transfer network authentication errors
|
||||||
|
|
||||||
|
Fixes an issue with standard users elevating PowerShell as Admin and getting BITS errors when trying to download content.
|
||||||
|
|
||||||
|
### Add -BitsPriority script parameter
|
||||||
|
|
||||||
|
Introduces a new parameter `-BitsPriority` with options `(Foreground, High, Normal, Low)` to control BITS download priority across the build system and UI, allowing users to optimize transfer speeds when needed.
|
||||||
|
|
||||||
|
The feature adds a priority selector to the UI with four options (Foreground, High, Normal, Low) and propagates the selection through the build script and common modules. Priority can be set via UI or command-line parameter with Normal as the default.
|
||||||
|
|
||||||
|
### BYO Apps: Add MSI path quoting to handle spaces in msiexec arguments
|
||||||
|
|
||||||
|
When specifying Build Your Own Apps msiexec arguments, if there were spaces in the argument list that weren't quoted properly, you'd get an error. This should now automatically add missing spaces in case you forget to add them or there are spaces in your application name.
|
||||||
|
|
||||||
|
### Misc Fixes
|
||||||
|
|
||||||
|
* Fixed some reliability issues when trying to download Lenovo drivers
|
||||||
|
* Fixed an issue with PPKG files with spaces
|
||||||
|
* Replaced SerialNumber with UniqueID for USB drive identification when building USB drives. USB drive manufacturers may use the same serial number for different drives, potentially causing data loss if the wrong drive is chosen.
|
||||||
|
* `-Threads` parameter has been added to `BuildFFUVM.ps1` which defaults to 5, matching the UI behavior. This value can be 1-64.
|
||||||
|
* ESD media downloads now use BITS by default
|
||||||
|
* Fixed an issue with multi-disk devices. Prior, if multiple disks were detected, ApplyFFU.ps1 would fail. Now a menu pops up asking the end user to select the disk they want to deploy the FFU to
|
||||||
|
|
||||||
|
## New Contributors
|
||||||
|
|
||||||
|
* @arwidmark made their first contribution in https://github.com/rbalsleyMSFT/FFU/pull/325
|
||||||
|
|
||||||
|
**Full Changelog**: https://github.com/rbalsleyMSFT/FFU/compare/v2509.1preview...v2511.1preview
|
||||||
|
|
||||||
|
# 2509.1 UI Preview
|
||||||
|
|
||||||
|
## What's Changed
|
||||||
|
|
||||||
|
### [Refactor: Enhance artifact cleanup for disabled features](https://github.com/rbalsleyMSFT/FFU/commit/1ab4093d54b7d9bda9f47d7819694e66ae8de357)
|
||||||
|
|
||||||
|
Renames `Remove-DisabledUpdates` to `Remove-DisabledArtifacts` to better reflect its expanded scope.
|
||||||
|
|
||||||
|
This function now also removes Office installation scripts and downloaded content if the Office installation is disabled via the `$InstallOffice` flag.
|
||||||
|
|
||||||
|
The function call is moved to run before app installations to ensure artifacts are removed prior to the installation phase.
|
||||||
|
|
||||||
|
### [Removes the VM workaround for MCT ESD builds](https://github.com/rbalsleyMSFT/FFU/commit/dc5877f398316969299ee03800f3d07c7d98a9ab)
|
||||||
|
|
||||||
|
Comments out the logic that forces app installation when building from a downloaded ESD file. This workaround was implemented to prevent an OOBE reboot loop but is no longer required. This should speed up scenarios where you want to download the ESD media, install the latest CU and .NET CU, and capture the FFU.
|
||||||
|
|
||||||
|
### [Update default disk size to 50GB in FFU scripts and UI](https://github.com/rbalsleyMSFT/FFU/commit/372360d7392ad945be0db889a68e1fff0ed3b5d6)
|
||||||
|
|
||||||
|
Changed the default disk size parameter from 30GB to 50GB in BuildFFUVM.ps1 and FFUUI.Core.psm1 to accommodate larger virtual machines.
|
||||||
|
Updated tooltip and default value in the UI XAML file to reflect the new disk size.
|
||||||
|
|
||||||
|
### [Adds auto-loading of previous configuration on startup](https://github.com/rbalsleyMSFT/FFU/commit/3ef26f2918977906ebe14e328f015ce4f1941dc3)
|
||||||
|
|
||||||
|
Implements a new feature to automatically load the previously saved environment when the UI is launched.
|
||||||
|
|
||||||
|
This improves user experience by restoring the last saved configuration, including selected applications and drivers, eliminating the need to manually reload them on each run.
|
||||||
|
|
||||||
|
The process loads the main `FFUConfig.json` and then proceeds to load associated Winget, BYO App, and Driver lists if they are defined. UI elements and checkboxes are updated accordingly to reflect the loaded state.
|
||||||
|
|
||||||
|
### [Improves UI state after environment autoload](https://github.com/rbalsleyMSFT/FFU/commit/bdf1b63833c83171aed63e8fc16702078ccd577b)
|
||||||
|
|
||||||
|
Updates the visibility of UI panels for Winget and drivers when a previous environment is automatically loaded.
|
||||||
|
|
||||||
|
This ensures that if Winget apps or driver models are present, their corresponding UI sections are made visible. Additionally, it updates the "select all" checkbox state for Winget results and attempts to pre-select the hardware make for loaded drivers.
|
||||||
|
|
||||||
|
### [Add restore defaults and centralize cleanup logic](https://github.com/rbalsleyMSFT/FFU/commit/f3316a017b73bf12cf1a66e3d03a63e29c437cb1)
|
||||||
|
|
||||||
|
Introduces a "Restore Defaults" feature in the UI to reset the environment. This action removes generated configuration files, ISOs, downloaded apps, updates, drivers, and FFUs.
|
||||||
|
|
||||||
|
The post-build cleanup logic is refactored from the main build script into a new common function. This new function is used by both the standard build process and the new restore defaults feature, promoting code reuse and simplifying maintenance.
|
||||||
|
|
||||||
|
### [Add option to dynamically build PE drivers](https://github.com/rbalsleyMSFT/FFU/commit/e2ccd11f07217b389f1622a69794224412e046e1)
|
||||||
|
|
||||||
|
Thanks to @JonasKloseBW for the original code for this in https://github.com/rbalsleyMSFT/FFU/pull/115
|
||||||
|
|
||||||
|
Introduces a new parameter, `UseDriversAsPEDrivers`, that allows WinPE drivers to be sourced directly from the main driver repository.
|
||||||
|
|
||||||
|
When enabled, the script scans all available drivers, parses their INF files, and copies only the essential driver types (e.g., storage, mouse, keyboard, touchpad, system devices) needed for WinPE. This eliminates the need to maintain a separate, manually curated `PEDrivers` folder.
|
||||||
|
|
||||||
|
The UI is updated with a new checkbox that becomes visible when "Copy PE Drivers" is selected, making this a sub-option. Parameter validation is also adjusted to support this new workflow.
|
||||||
|
|
||||||
|
### [Improve model name normalization for driver mapping](https://github.com/rbalsleyMSFT/FFU/commit/50713188bffcb64f1b0c1f9eb89e02a300e3de98)
|
||||||
|
|
||||||
|
Enhances the model name normalization function to better handle variations in hardware model strings. This change introduces specific rules to canonicalize "All-in-One" and screen size variants (e.g., "-in" or "inch") for more reliable matching against driver mapping rules.
|
||||||
|
|
||||||
|
Additionally, optimizes performance by normalizing the system model once before the comparison loop. Logging is also added to show the original and normalized model strings for easier debugging.
|
||||||
|
|
||||||
|
### [Defer cleanup of compressed driver source folders](https://github.com/rbalsleyMSFT/FFU/commit/c30ed923b68b933f719b9a2941043b813bf4fd3f)
|
||||||
|
|
||||||
|
Implements a deferred cleanup mechanism for driver source folders when they are compressed to a WIM and also used for WinPE.
|
||||||
|
|
||||||
|
When drivers are compressed, the original source folders are now preserved if they are also needed for WinPE driver injection. A marker file is created in these preserved folders.
|
||||||
|
|
||||||
|
A new cleanup step is added after the WinPE media creation to remove these preserved folders, ensuring they are available when needed but not left behind permanently.
|
||||||
|
|
||||||
|
### [Refactor config loading and improve error handling](https://github.com/rbalsleyMSFT/FFU/commit/8d7e4d106620761d0ae1a5133f6d6ba301131471)
|
||||||
|
|
||||||
|
Extracts the logic for importing supplemental assets (Winget, BYO, Drivers) into a new reusable function. This function is now called by both the manual and automatic configuration loaders, reducing code duplication.
|
||||||
|
|
||||||
|
Enhances the manual configuration loading process with more robust error handling. It now provides specific user-facing error messages for file read failures, empty files, and invalid JSON, improving the user experience when loading a malformed configuration.
|
||||||
|
|
||||||
|
When loading a configuration, if optional supplemental files like AppList.json are referenced but not found, an informational message is now displayed to the user instead of failing silently.
|
||||||
|
|
||||||
|
### [Add robust sanitization for names used in paths](https://github.com/rbalsleyMSFT/FFU/commit/cb14e84a26acaf5863aa3bb094dbf18424798875)
|
||||||
|
|
||||||
|
Introduces a new common function, `ConvertTo-SafeName`, to sanitize strings by removing characters that are invalid in Windows file paths.
|
||||||
|
|
||||||
|
This function is now used consistently when creating directory and file names for drivers (Dell, HP, Lenovo, Microsoft) and applications to prevent path-related errors. It replaces several ad-hoc sanitization methods with a single, more robust implementation.
|
||||||
|
|
||||||
|
### [Includes exit code fields when using Copy Apps button](https://github.com/rbalsleyMSFT/FFU/commit/f37647599a318da29b62154bebff8c8a857d3002)
|
||||||
|
|
||||||
|
Adds persistence of AdditionalExitCodes and IgnoreNonZeroExitCodes when exporting the UI list to prevent losing custom exit handling settings and maintain parity with the primary save routine.
|
||||||
|
|
||||||
|
### [Sanitizes app names for storage and paths](https://github.com/rbalsleyMSFT/FFU/commit/d1ca1231045e38316733495e1fdb8590a225be67)
|
||||||
|
|
||||||
|
Applies name sanitization when persisting the app list and when building/checking Win32 and Store download directories.
|
||||||
|
Prevents invalid characters in folder names, aligns persisted names with on-disk structure, and improves detection of existing content to avoid redundant downloads and errors.
|
||||||
|
|
||||||
|
### [Adds exit-code overrides and UI for winget apps](https://github.com/rbalsleyMSFT/FFU/commit/d9c0c9c68ee1769230c9789b5c7cb84bcff4d642)
|
||||||
|
|
||||||
|
Adds per-app control for additional accepted exit codes and ignoring non‑zero exit codes to improve handling of installers with nonstandard returns.
|
||||||
|
|
||||||
|
Exposes editable fields in the app list UI, persists them across search defaults, import/export, and pre-download save, and applies overrides during app resolution to honor configured behavior.
|
||||||
|
|
||||||
|
### [Adds UI/CLI to copy additional FFUs to USB build](https://github.com/rbalsleyMSFT/FFU/commit/15a5b16b39887b71ae545c638d57183c97bdf629)
|
||||||
|
|
||||||
|
- Enables selecting multiple existing FFU images to include on the deployment USB for easier distribution and testing.
|
||||||
|
- Adds a UI option with selectable, sortable list from the capture folder, refresh support, and persisted selections.
|
||||||
|
- Validates that selections exist when the option is enabled to prevent empty runs.
|
||||||
|
- Supports unattended/CLI flows by prompting early or accepting a preselected list for USB creation; deduplicates and logs chosen files.
|
||||||
|
- Always includes the just-built (or latest available) FFU as a base.
|
||||||
|
- Improves no-FFU handling and streamlines multi-FFU selection workflow.
|
||||||
|
|
||||||
|
### [Standardizes JSON output: depth, UTF-8, key order](https://github.com/rbalsleyMSFT/FFU/commit/6562d16ce500197b428b51915332c6649df302df)
|
||||||
|
|
||||||
|
- Sorts top-level config keys before serialization for deterministic files and cleaner diffs.
|
||||||
|
- Increases JSON depth to 10 to retain nested settings.
|
||||||
|
- Writes JSON as UTF-8 via Set-Content for consistent encoding.
|
||||||
|
- Applies across config export and UI save flows.
|
||||||
|
|
||||||
|
### [Adds Windows 11 25H2 mapping](https://github.com/rbalsleyMSFT/FFU/commit/eaa3e1e6af5c25e0f8b185f8107e017782b0f00f)
|
||||||
|
|
||||||
|
Extends supported Windows 11 releases to include 25H2. Default is still 24H2.
|
||||||
|
|
||||||
|
* Update USBImagingToolCreator.ps1 by @jrollmann in https://github.com/rbalsleyMSFT/FFU/pull/262
|
||||||
|
|
||||||
|
## New Contributors
|
||||||
|
|
||||||
|
* @jrollmann made their first contribution in https://github.com/rbalsleyMSFT/FFU/pull/262
|
||||||
|
|
||||||
|
# 2507.1 UI Preview
|
||||||
|
|
||||||
|
Waaay too many to list. Just watch the Youtube video in the Readme :)
|
||||||
|
|
||||||
|
# 2505.1
|
||||||
|
|
||||||
|
Highly recommended that you upgrade to this release. Fixes the issue with the May 2025 cumulative update and some SKU naming issues for SKUs other than Pro.
|
||||||
|
|
||||||
|
# Support for Windows LTSB/LTSC
|
||||||
|
|
||||||
|
Thanks to @zehadialam for the code to allow support for LTSB and LTSC. This has been a requested feature from a number of customers and some might be opting for LTSC when Windows 10 support ends in October. We support LTSB 2016, LTSC 2019, 2021, 2024 including the N and IoT variants. Extensive testing has gone into validating CU and .net support. File an issue if you see any weird behavior.
|
||||||
|
|
||||||
|
# Support for automating computer naming via CSV
|
||||||
|
|
||||||
|
Thanks to @JonasKloseBW for PR #150
|
||||||
|
|
||||||
|
- Allows setting the computer name with a predefined list (SerialComputerNames.csv) of serial numbers and matching computer names
|
||||||
|
- Defaults to FFU-{Random} if no matching serial number is found in list so FFU deployment can continue without user input
|
||||||
|
|
||||||
|
# Fixes
|
||||||
|
|
||||||
|
- Thanks to @JonasKloseBW for PR #129 for adding the -AppListPath parameter
|
||||||
|
- Fixed an issue where if AppsScriptVariables was configured in a config file, the hashtable wasn't being created by the script when setting the variable.
|
||||||
|
- Fixed a crash where shortening the Windows SKU was creating duplicate shortened names for certain SKUs (EDU mainly, but others too)
|
||||||
|
- Fix an issue with checkpoint CUs and May 2025-05B CU. Should future proof new checkpoint CUs in the future.
|
||||||
|
|
||||||
|
# Additional Fixes
|
||||||
|
|
||||||
|
BuildFFUVM.ps1
|
||||||
|
|
||||||
|
- Added parameter definitions that were missing:
|
||||||
|
- AppListPath - Path to a JSON file containing a list of applications to install using WinGet. Default is $FFUDevelopmentPath\Apps\AppList.json.
|
||||||
|
- PEDriversFolder - Path to the folder containing drivers to be injected into the WinPE deployment media. Default is $FFUDevelopmentPath\PEDrivers.
|
||||||
|
- Added two new parameters:
|
||||||
|
- UpdateLatestMicrocode - This is used for Windows 10/Server. When set to $true, will download and install the latest microcode updates for applicable Windows releases (e.g., Windows Server 2016/2019, Windows 10 LTSC 2016/2019) into the FFU. Default is $false.
|
||||||
|
- UpdateADK - Added for airgapped scenarios where you've manually updated the ADK and don't need it to continually check. When set to $true, the script will check for and install the latest Windows ADK and WinPE add-on if they are not already installed or up-to-date. Default is $true.
|
||||||
|
- Reorganized the WindowsSKU validateset to make it easier to read and added in 2016 LTSB releases
|
||||||
|
- Changed version to 2505.1
|
||||||
|
- Reorganized the releasetoMapping SKUs to make it easier to read
|
||||||
|
- Omitted Defender/Edge from reporting KB ID since neither includes it
|
||||||
|
- Updated Save-KB with some enhancements from the UI branch which will handle KBs that don't have an architecture defined in their file name that will leverage a new function Get-PEArchitecture that can interrogate the file name and determine the correct architecture
|
||||||
|
- Updated Get-ShortenedWindowsSKU with LTSB/LTSC SKUs
|
||||||
|
- Updated New-FFUFileName to use $winverinfo.Name for $WindowsRelease for client OSes to which will set $WindowsRelease to using Win10 or Win11. This fixes a bug where you might see 10 or 11 instead of Win10 or Win11 for FFU builds that use only the VHDX (e.g. `-InstallApps $false`. This keeps the naming consistent with FFUs built via VM.
|
||||||
|
- Updated Get-WindowsVersionInfo to fix an issue with naming LTSC 2019
|
||||||
|
- Added Get-PEArchitecture function
|
||||||
|
- Commented out the Windows Security Platform Update code since the URL is dead for the content. This is fixed in the UI branch and will be reintroduced in Dev and Main at a later date when the UI work is complete.
|
||||||
|
- Created a new variable `$isLTSC`
|
||||||
|
- Modified and reorganized the search strings for the various .net framework components. LTSC introduced some complexity with handling the various .net releases.
|
||||||
|
- VHDXCaching will now recurse the KBPath folder when finding downloaded KBs to include in its config file
|
||||||
|
|
||||||
|
Sample_default.json
|
||||||
|
|
||||||
|
- Added new/missing parameters
|
||||||
|
- ApplistPath
|
||||||
|
- UpdateADK
|
||||||
|
- UpdateLatestMicrocode
|
||||||
|
|
||||||
|
CaptureFFU.ps1
|
||||||
|
|
||||||
|
- `$WindowsVersion` 2016 and 2019 for LTSC releases
|
||||||
|
- Changed some SKU spacing to make things more consistent and included Enterprise N LTSC
|
||||||
|
|
||||||
|
ApplyFFU.ps1
|
||||||
|
|
||||||
|
- Updated version to 2505.1
|
||||||
|
|
||||||
|
# 2412.1
|
||||||
|
|
||||||
|
This is a major release with a number of quality-of-life improvements that will reduce the time it takes to create FFUs. I highly recommend you update to this release.
|
||||||
|
|
||||||
|
## Windows Server Support
|
||||||
|
|
||||||
|
Thanks to [JonasKloseBW](https://github.com/JonasKloseBW) we have added support for Windows Server! This includes support for Windows Server 2016 through 2025 and supports both core and desktop experience. It will require you to provide your own Server ISO
|
||||||
|
using the `-ISOPath` parameter since we can't automatically download it like we can with client. You also will want to set the `-WindowsSKU` parameter to either `'Standard', 'Datacenter', 'Standard (Desktop Experience)', or 'Datacenter (Desktop Experience)'` depending on your needs.
|
||||||
|
|
||||||
|
Cumulative Updates for Windows and .NET should work as expected. Defender updates should work too. If you notice anything that doesn't work, open an issue.
|
||||||
|
|
||||||
|
## VHDX Caching Support
|
||||||
|
|
||||||
|
Thanks again to Jonas for adding VHDX caching support #89. For those of you that might be making many FFUs for different configurations, instead of building the VHDX every time, you can cache the VHDX and re-use it for your next build. In testing, this seems to save about 10 minutes, depending on how you're installing Windows (via MCT download, or your own ISO and how old your media is).
|
||||||
|
|
||||||
|
The way this works is a VHDXCache folder is created in the FFUDevelopment folder. If `-AllowVHDXCaching $true`, we store the VHDX file and a config file that keeps track of the following info
|
||||||
|
|
||||||
|
```
|
||||||
|
{
|
||||||
|
"VhdxFileName": "_FFU-808829869.vhdx",
|
||||||
|
"LogicalSectorSizeBytes": 512,
|
||||||
|
"WindowsSKU": "Pro",
|
||||||
|
"WindowsRelease": "11",
|
||||||
|
"WindowsVersion": "24H2",
|
||||||
|
"OptionalFeatures": "",
|
||||||
|
"IncludedUpdates": [
|
||||||
|
{
|
||||||
|
"Name": "windows11.0-kb5043080-x64_953449672073f8fb99badb4cc6d5d7849b9c83e8.msu"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"Name": "windows11.0-kb5045934-x64-ndp481_fa9c3adfb0532eb8f4e521f4fb92a179380184c5.msu"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"Name": "windows11.0-kb5048667-x64_d4ad0ca69de9a02bc356757581e0e0d6960c9f93.msu"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
The VHDX files are cached before boot, so they've never been sysprepped. On subsequent runs, if `-AllowVHDXCaching $true` is set, we search the VHDXCache folder, loop through any config files, and look to see if we find one that matches the build information you've passed to the script. If a match is found, robocopy copies in the VHDX and uses the cached VHDX to build the FFU VM.
|
||||||
|
|
||||||
|
## Configuration File Support
|
||||||
|
|
||||||
|
A configuration file can now be used to configure the parameters in lieu of, or in conjunction with, parameters specified on the command line. Configuration files are especially helpful for those making FFUs for different models, Windows releases, application sets, and more.
|
||||||
|
|
||||||
|
To use, run:
|
||||||
|
`.\BuildFFUVM.ps1 -ConfigFile 'C:\FFUDevelopment\config\Sample_default.json' -verbose`
|
||||||
|
|
||||||
|
### Creating your own Configuration Json file
|
||||||
|
|
||||||
|
If you have a command line that you’ve been using for awhile and would like to convert it to a json file automatically, run your command line like normal, adding
|
||||||
|
`-exportConfigFile 'C:\FFUDevelopment\config\YourConfigFile.json'`
|
||||||
|
to the end of the command. Doing this will generate a well-formatted json file with your configuration settings.
|
||||||
|
|
||||||
|
You can also temporarily overwrite parameters while using a config file. Using the following sample command:
|
||||||
|
|
||||||
|
`.\BuildFFUVM.ps1 -ConfigFile 'C:\FFUDevelopment\config\Sample_default.json' -verbose`
|
||||||
|
|
||||||
|
If you’d like to not include Office (the Sample_default.json file installs Office), you’d add `-InstallOffice $False` to the command line
|
||||||
|
|
||||||
|
`.\BuildFFUVM.ps1 -ConfigFile 'C:\FFUDevelopment\config\Sample_default.json' -verbose -InstallOffice $False`
|
||||||
|
|
||||||
|
Doing this will temporarily overwrite whatever is in the json for the `InstallOffice` parameter. It will not modify the json file. If you would like to change the json file, you can add `-exportConfigFile 'C:\FFUDevelopment\config\Sample_default.json'` and that will overwrite the json file with the new parameter.
|
||||||
|
|
||||||
|
`.\BuildFFUVM.ps1 -ConfigFile 'C:\FFUDevelopment\config\Sample_default.json' -verbose -InstallOffice $False -exportConfigFile 'C:\FFUDevelopment\config\Sample_default.json'`
|
||||||
|
|
||||||
|
## Custom FFU Naming Support
|
||||||
|
|
||||||
|
Thanks to Jonas, we now have custom FFU naming support. A new parameter -CustomFFUNameTemplate has been added.
|
||||||
|
|
||||||
|
This parameter sets a custom FFU output name with placeholders. Allowed placeholders are:
|
||||||
|
|
||||||
|
`{WindowsRelease}, {WindowsVersion}, {SKU}, {BuildDate}, {yyyy}, {MM}, {dd}, {H}, {hh}, {mm}, {tt}`
|
||||||
|
|
||||||
|
And below is a description of what to expect when you use each placeholder.
|
||||||
|
|
||||||
|
```
|
||||||
|
{WindowsRelease} = 10, 11, 2016, 2019, 2022, 2025
|
||||||
|
{WindowsVersion} = 1607, 1809, 21h2, 22h2, 23h2, 24h2, etc
|
||||||
|
{SKU} = Home, Home N, Home Single Language, Education, Education N, Pro, Pro N, Pro Education, Pro Education N, Pro for Workstations, Pro N for Workstations, Enterprise, Enterprise N, Standard, Standard (Desktop Experience), Datacenter, Datacenter (Desktop Experience)
|
||||||
|
{BuildDate} = e.g. Dec2024
|
||||||
|
{yyyy} = e.g. 2024
|
||||||
|
{MM} = 2 digit month format (e.g. 12 for December)
|
||||||
|
{dd} = Day of the month in 2 digit format (19)
|
||||||
|
{HH} = Current hour in 24-hour format (e.g., 14 for 2 PM)
|
||||||
|
{hh} = Current hour in 12-hour format (e.g., 02 for 2 PM)
|
||||||
|
{mm} = Current minute in 2-digit format (e.g., 09)
|
||||||
|
{tt} = Current AM/PM designator (e.g., AM or PM)
|
||||||
|
```
|
||||||
|
|
||||||
|
An example for Windows 11 24h2 Pro built today would be:
|
||||||
|
|
||||||
|
`-CustomFFUNameTemplate '{WindowsRelease}_{WindowsVersion}_{SKU}_{yyyy}-{MM}-{dd}_{HH}{mm}'`
|
||||||
|
|
||||||
|
Would result in a FFU file name of:
|
||||||
|
|
||||||
|
`Win11_24h2_Pro_2024-12-20_1225.ffu`
|
||||||
|
|
||||||
|
You can also mix in static text in the name
|
||||||
|
|
||||||
|
`-CustomFFUNameTemplate '{WindowsRelease}_{WindowsVersion}_{SKU}_Office_{yyyy}-{MM}-{dd}_{HH}{mm}'`
|
||||||
|
|
||||||
|
Would result in:
|
||||||
|
|
||||||
|
`Win11_24h2_Pro_Office_2024-12-20_1225.ffu`
|
||||||
|
|
||||||
|
## Additional PRs added
|
||||||
|
|
||||||
|
#79 Includes the latest Microsoft Software Removal Tool from `@zehadialam` - use `-UpdateLatestMSRT $true`
|
||||||
|
|
||||||
|
#72 Includes some Unattend Sample files from @HedgeComp in the `$FFUDevelopment\Unattend` folder
|
||||||
|
|
||||||
|
#74 Includes some improvements to the USBImagingToolCreator.ps1 file from @w0
|
||||||
|
|
||||||
|
#103 Includes some additional improvements to the USBImagingToolCreator.ps1 file from @MKellyCBSD
|
||||||
|
|
||||||
|
## Misc Fixes
|
||||||
|
|
||||||
|
- Added server skus to validateset for $WindowsSKU
|
||||||
|
- Added new variable $installationType which uses $WindowsRelease to determine Server or Client. If $installationType is Server, $WindowsRelease version is used to set $WindowsVersion to the appropriate version (1607, 1809, 21H2)
|
||||||
|
- Fixed an issue where the recovery partition wouldn't be created on server OSes due to winre.wim being hidden. Never saw this on client OSes even though it also was hidden IIRC.
|
||||||
|
- Removed verbosity for Optimize-Volume as it was outputting when -verbose was not specified.
|
||||||
|
- Modified some search strings for .NET CUs when installing on Server OS
|
||||||
|
- Included SSU for Windows Server 2016 as it's mandatory
|
||||||
|
- Added some error checking for Server 2019 and 2022 CU installations when CU fails due to lack of SSU. If you run into this error, you're using old media and should use the latest. Always use the latest ISO if you can.
|
||||||
|
- $WindowsVersion set to 24h2, can override by using -WindowsVersion 23H2 if you want the old behavior
|
||||||
|
- Removed the "Downloading information GUID" messages when downloading content from the Microsoft Update Catalog while -verbose was specified in the command line
|
||||||
|
- In Get-KBLink, made a change to just grab the first result returned instead of the entire results page. This removes the need to use a break statement in Save-KB when downloading updates. This fixed an issue with the new 24H2 Checkpoint Cumulative Updates in Win11 and Server 2025.
|
||||||
|
- Changed Windows MSRT search string for x64 and x86. This was mainly to get x64 to the top of the search results. x86 won't actually download since the code isn't in place for content from the MU Catalog to download x86 content (no idea if anyone actually builds x86 FFUs for Win10 - I hope not)
|
||||||
|
- If not passing an ISO, hardcoded WindowsVersion of 22H2 for Windows 10 or 24H2 for Windows 11 since the ESD media only provides those two versions. Not doing this allowed for unnecessary VHDX creation since it checks the WindowsVersion via the json file. This also fixes an issue where CUs could be searched for that didn’t exist, but the media would still download
|
||||||
|
- Added some additional logging entries
|
||||||
|
- Removed verbose output of the Optimize-Volume command
|
||||||
|
- Fixed an issue where not passing an ISO caused the script to fail
|
||||||
|
- Cleaned up the KBPath folder at the end of the run
|
||||||
|
- Changed some minor formatting items
|
||||||
|
- Added Get-Childprocesses function to return child processes of parent process
|
||||||
|
- Added a new -Wait boolean parameter to Invoke-Process function. This is to control whether Invoke-Process should wait in order to track stdout and stderr output. This is needed for processes that may hang, waiting for user input and there isn't a way to bypass (some Intel drivers provided by Dell leave dialog windows even when running silently)
|
||||||
|
-Invoke-Process now returns process information (returns $cmd). This allows for process tracking when calling the function.
|
||||||
|
- Since Invoke-Process now returns the process information, also needed to add Out-Null to the majority of the Invoke-Process references to prevent Invoke-Process from writing to the terminal
|
||||||
|
- Refactored a lot of the Get-DellDrivers function due to inconsistencies with how driver extraction behaves between client and server devices. For client, /s /e seemed to work fine, but for server it would only extract the driver installer content and other dell related files, rather than the driver files themselves. We have since switched to using /s /drivers= which will extract the driver content. Not all drivers support /drivers= and may output some information to the terminal that looks like help documentation. If a driver doesn't support /drivers, the script falls back to using /s /e to do the extraction. If this doesn't work for you, you can always provide your own drivers that you manually download from Dell's website.
|
||||||
|
- Updated Malicious Software Removal Tool (MSRT) code to handle Windows Server
|
||||||
|
- Refactored the Get-ODTURL function to fix recent download issues. Also added some better error handling
|
||||||
|
- Moved the odtsetup.exe download to the FFUDevelopment folder and will clean it up after office has downloaded
|
||||||
|
Updated parameter definition block to be alphabetized (not to be confused by the param block, which is not alphabetized)
|
||||||
|
- Added $PEDriversFolder script variable to the param block (for some reason it was missing)
|
||||||
|
- Added ConfigFile and ExportConfigFile parameters to support json config files
|
||||||
|
- Changed Version to 2412.1
|
||||||
|
- Modified vhdxCacheItem class to include $LogicalSectorSizeBytes
|
||||||
|
- Added new function Get-Parameters to help with new config and export config file functionality
|
||||||
|
- Fixed Get-MicrosoftDrivers function to not require the HTMLFILE COM object, which isn't available in Windows 11. It seems to be installed with Office, which is what was allowing downloads to work and masked the issue.
|
||||||
|
- Added long path support to prevent issues with oscdimg creating the Apps.iso.
|
||||||
|
- Fixed an issue where the $PEDriversFolder variable wasn't being used (instead $FFUDevelopment\PEDrivers was used)
|
||||||
|
- Created a new function New-FFUFileName - this works in conjunction with the new $CustomFFUNameTemplate. The function was needed to support both scenarios where $InstallApps is either $true or $false.
|
||||||
|
- Added new function Export-ConfigFile. When passing -ExportConfigFile 'Path\To\ConfigFile.json' the script will generate a parameter dump of all of the configured parameters
|
||||||
|
- Added driver folder validation to throw an error if spaces are detected in the folder name of the drivers folder (e.g. C:\FFUDevelopment\Drivers\Dell 3190). This is due to an issue with Dell drivers and their inability to handle paths with spaces consistently.
|
||||||
|
- Added back the Windows Security Platform update which grabs it from the web instead of the Microsoft update catalog
|
||||||
|
- Fixed an issue where the Drivers folder was being completely deleted instead of its sub-folders
|
||||||
|
- Removed the Requires -PSEdition Desktop. The script works with both Desktop and Core, so pwsh 7 is fine.
|
||||||
|
- Created a new config folder to hold config files. A new sample_default.json file is provided to show what the format looks like.
|
||||||
|
- You can now set the computername in the unattend.xml file where ever you want. Prior it required that the computername was the first component element.
|
||||||
|
|
||||||
## **2409.1**
|
## **2409.1**
|
||||||
|
|
||||||
### Fixes
|
### Fixes
|
||||||
|
|||||||
@@ -1,178 +1,23 @@
|
|||||||
{
|
{
|
||||||
"apps": [
|
"apps": [
|
||||||
{
|
|
||||||
"name": "Windows Terminal",
|
|
||||||
"id": "9N0DX20HK701",
|
|
||||||
"source": "msstore"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"name": "Cross Device Experience Host",
|
|
||||||
"id": "9NTXGKQ8P7N0",
|
|
||||||
"source": "msstore"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"name": "Movies & TV",
|
|
||||||
"id": "9WZDNCRFJ3P2",
|
|
||||||
"source": "msstore"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"name": "Microsoft Photos",
|
|
||||||
"id": "9WZDNCRFJBH4",
|
|
||||||
"source": "msstore"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"name": "Mail and Calendar",
|
|
||||||
"id": "9WZDNCRFHVQM",
|
|
||||||
"source": "msstore"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"name": "Microsoft Sticky Notes",
|
|
||||||
"id": "9NBLGGH4QGHW",
|
|
||||||
"source": "msstore"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"name": "Power Automate",
|
|
||||||
"id": "9NFTCH6J7FHV",
|
|
||||||
"source": "msstore"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"name": "Snipping Tool",
|
|
||||||
"id": "9MZ95KL8MR0L",
|
|
||||||
"source": "msstore"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"name": "Phone Link",
|
|
||||||
"id": "9NMPJ99VJBWV",
|
|
||||||
"source": "msstore"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"name": "Microsoft 365 (Office Hub)",
|
|
||||||
"id": "9WZDNCRFJBH4",
|
|
||||||
"source": "msstore"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"name": "App Installer",
|
|
||||||
"id": "9NBLGGH4NNS1",
|
|
||||||
"source": "msstore"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"name": "Microsoft Clipchamp",
|
|
||||||
"id": "9P1J8S7CCWWT",
|
|
||||||
"source": "msstore"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"name": "Webp Image Extensions",
|
|
||||||
"id": "9PG2DK419DRG",
|
|
||||||
"source": "msstore"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"name": "Windows Web Experience Pack",
|
|
||||||
"id": "9MSSGKG348SP",
|
|
||||||
"source": "msstore"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"name": "Xbox",
|
|
||||||
"id": "9MV0B5HZVK9Z",
|
|
||||||
"source": "msstore"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"name": "Paint",
|
|
||||||
"id": "9PCFS5B6T72H",
|
|
||||||
"source": "msstore"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"name": "Windows Camera",
|
|
||||||
"id": "9WZDNCRFJBBG",
|
|
||||||
"source": "msstore"
|
|
||||||
},
|
|
||||||
{
|
{
|
||||||
"name": "Windows Notepad",
|
"name": "Windows Notepad",
|
||||||
"id": "9MSMLRH6LZF3",
|
"id": "9MSMLRH6LZF3",
|
||||||
"source": "msstore"
|
"source": "msstore"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"name": "Windows Sound Recorder",
|
"name": "Windows Client Web Experience",
|
||||||
"id": "9WZDNCRFHWKN",
|
"id": "9MSSGKG348SP",
|
||||||
"source": "msstore"
|
"source": "msstore"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"name": "Windows Calculator",
|
"name": "Screen Sketch",
|
||||||
"id": "9WZDNCRFHVN5",
|
"id": "9MZ95KL8MR0L",
|
||||||
"source": "msstore"
|
"source": "msstore"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"name": "Feedback Hub",
|
"name": "Windows Terminal",
|
||||||
"id": "9NBLGGH4R32N",
|
"id": "9N0DX20HK701",
|
||||||
"source": "msstore"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"name": "Xbox Identity Provider",
|
|
||||||
"id": "9WZDNCRD1HKW",
|
|
||||||
"source": "msstore"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"name": "Windows Media Player",
|
|
||||||
"id": "9WZDNCRFJ3PT",
|
|
||||||
"source": "msstore"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"name": "MSN Weather",
|
|
||||||
"id": "9WZDNCRFJ3Q2",
|
|
||||||
"source": "msstore"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"name": "Game Bar",
|
|
||||||
"id": "9NZKPSTSNW4P",
|
|
||||||
"source": "msstore"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"name": "Web Media Extensions",
|
|
||||||
"id": "9N5TDP8VCMHS",
|
|
||||||
"source": "msstore"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"name": "Get Help",
|
|
||||||
"id": "9PKDZBMV1H3T",
|
|
||||||
"source": "msstore"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"name": "Raw Image Extension",
|
|
||||||
"id": "9NCTDW2W1BH8",
|
|
||||||
"source": "msstore"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"name": "Store Experience Host",
|
|
||||||
"id": "9NBLGGH4LS1F",
|
|
||||||
"source": "msstore"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"name": "Windows Maps",
|
|
||||||
"id": "9WZDNCRDTBVB",
|
|
||||||
"source": "msstore"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"name": "Windows Clock",
|
|
||||||
"id": "9WZDNCRFJ3PR",
|
|
||||||
"source": "msstore"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"name": "Microsoft To Do",
|
|
||||||
"id": "9NBLGGH5R558",
|
|
||||||
"source": "msstore"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"name": "Cortana",
|
|
||||||
"id": "9NFFX4SZZ23L",
|
|
||||||
"source": "msstore"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"name": "Quick Assist",
|
|
||||||
"id": "9P7BP5VNWKX5",
|
|
||||||
"source": "msstore"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"name": "HEIF Image Extensions",
|
|
||||||
"id": "9PMMSR1CGPWG",
|
|
||||||
"source": "msstore"
|
"source": "msstore"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
@@ -181,28 +26,123 @@
|
|||||||
"source": "msstore"
|
"source": "msstore"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"name": "Xbox Live in-game experience",
|
"name": "MPEG2 Video Extension",
|
||||||
|
"id": "9N95Q1ZZPMH4",
|
||||||
|
"source": "msstore"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "Store Purchase App",
|
||||||
|
"id": "9NBLGGH4LS1F",
|
||||||
|
"source": "msstore"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "Windows Feedback Hub",
|
||||||
|
"id": "9NBLGGH4R32N",
|
||||||
|
"source": "msstore"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "Todos",
|
||||||
|
"id": "9NBLGGH5R558",
|
||||||
|
"source": "msstore"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "Raw Image Extension",
|
||||||
|
"id": "9NCTDW2W1BH8",
|
||||||
|
"source": "msstore"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "Power Automate Desktop",
|
||||||
|
"id": "9NFTCH6J7FHV",
|
||||||
|
"source": "msstore"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "Xbox TCUI",
|
||||||
"id": "9NKNC0LD5NN6",
|
"id": "9NKNC0LD5NN6",
|
||||||
"source": "msstore"
|
"source": "msstore"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"name": "Xbox Game Speech Window",
|
"name": "Your Phone",
|
||||||
"id": "9P086NHDNB9W",
|
"id": "9NMPJ99VJBWV",
|
||||||
"source": "msstore"
|
"source": "msstore"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"name": "Microsoft News",
|
"name": "Xbox Gaming Overlay",
|
||||||
|
"id": "9NZKPSTSNW4P",
|
||||||
|
"source": "msstore"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "Clipchamp",
|
||||||
|
"id": "9P1J8S7CCWWT",
|
||||||
|
"source": "msstore"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "Paint",
|
||||||
|
"id": "9PCFS5B6T72H",
|
||||||
|
"source": "msstore"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "Webp Image Extension",
|
||||||
|
"id": "9PG2DK419DRG",
|
||||||
|
"source": "msstore"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "Get Help",
|
||||||
|
"id": "9PKDZBMV1H3T",
|
||||||
|
"source": "msstore"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "HEIF Image Extension",
|
||||||
|
"id": "9PMMSR1CGPWG",
|
||||||
|
"source": "msstore"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "Xbox Identity Provider",
|
||||||
|
"id": "9WZDNCRD1HKW",
|
||||||
|
"source": "msstore"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "Microsoft Office Hub",
|
||||||
|
"id": "9WZDNCRD29V9",
|
||||||
|
"source": "msstore"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "Bing News",
|
||||||
"id": "9WZDNCRFHVFW",
|
"id": "9WZDNCRFHVFW",
|
||||||
"source": "msstore"
|
"source": "msstore"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"name": "Microsoft Store",
|
"name": "Windows Sound Recorder",
|
||||||
"id": "9WZDNCRFJBMP",
|
"id": "9WZDNCRFHWKN",
|
||||||
"source": "msstore"
|
"source": "msstore"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"name": "Microsoft Tips",
|
"name": "Windows Alarms",
|
||||||
"id": "9WZDNCRDTBJJ",
|
"id": "9WZDNCRFJ3PR",
|
||||||
|
"source": "msstore"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "Zune Music",
|
||||||
|
"id": "9WZDNCRFJ3PT",
|
||||||
|
"source": "msstore"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "Bing Weather",
|
||||||
|
"id": "9WZDNCRFJ3Q2",
|
||||||
|
"source": "msstore"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "Windows Camera",
|
||||||
|
"id": "9WZDNCRFJBBG",
|
||||||
|
"source": "msstore"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "Windows Photos",
|
||||||
|
"id": "9WZDNCRFJBH4",
|
||||||
|
"source": "msstore"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "Windows Store",
|
||||||
|
"id": "9WZDNCRFJBMP",
|
||||||
"source": "msstore"
|
"source": "msstore"
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
@@ -1,83 +0,0 @@
|
|||||||
setlocal enabledelayedexpansion
|
|
||||||
REM Put each app install on a separate line
|
|
||||||
REM M365 Apps/Office ProPlus
|
|
||||||
REM d:\Office\setup.exe /configure d:\office\DeployFFU.xml
|
|
||||||
REM Install Defender Platform Update
|
|
||||||
REM Install Defender Definitions
|
|
||||||
REM Install Windows Security Platform Update
|
|
||||||
REM Install OneDrive Per Machine
|
|
||||||
REM Install Edge Stable
|
|
||||||
REM Winget Win32 Apps
|
|
||||||
REM Add additional apps below here
|
|
||||||
REM Contoso App (Example)
|
|
||||||
REM msiexec /i d:\Contoso\setup.msi /qn /norestart
|
|
||||||
set "INSTALL_STOREAPPS=false"
|
|
||||||
if /i "%INSTALL_STOREAPPS%"=="false" (
|
|
||||||
echo Skipping MS Store installation due to INSTALL_STOREAPPS flag.
|
|
||||||
goto :remaining
|
|
||||||
)
|
|
||||||
set "basepath=D:\MSStore"
|
|
||||||
for /d %%D in ("%basepath%\*") do (
|
|
||||||
set "appfolder=%%D"
|
|
||||||
set "mainpackage="
|
|
||||||
set "dependenciesfolder=!appfolder!\Dependencies"
|
|
||||||
for %%F in ("!appfolder!\*") do (
|
|
||||||
if not "%%~dpF"=="!dependenciesfolder!\" (
|
|
||||||
if /i not "%%~xF"==".xml" (
|
|
||||||
if /i not "%%~xF"==".yaml" (
|
|
||||||
set "mainpackage=%%F"
|
|
||||||
)
|
|
||||||
)
|
|
||||||
)
|
|
||||||
)
|
|
||||||
if defined mainpackage (
|
|
||||||
set "dism_command=DISM /Online /Add-ProvisionedAppxPackage /PackagePath:"!mainpackage!" /Region:all /StubPackageOption:installfull"
|
|
||||||
if exist "!dependenciesfolder!" (
|
|
||||||
for %%G in ("!dependenciesfolder!\*") do (
|
|
||||||
set "dism_command=!dism_command! /DependencyPackagePath:"%%G""
|
|
||||||
)
|
|
||||||
)
|
|
||||||
for %%F in ("!appfolder!\*.xml") do (
|
|
||||||
set "licensefile=%%F"
|
|
||||||
)
|
|
||||||
if defined licensefile (
|
|
||||||
set "dism_command=!dism_command! /LicensePath:"!licensefile!""
|
|
||||||
) else (
|
|
||||||
set "dism_command=!dism_command! /SkipLicense"
|
|
||||||
)
|
|
||||||
echo !dism_command!
|
|
||||||
!dism_command!
|
|
||||||
)
|
|
||||||
)
|
|
||||||
:remaining
|
|
||||||
endlocal
|
|
||||||
for /r "D:\" %%G in (.) do (
|
|
||||||
if exist "%%G\Notepad++" (
|
|
||||||
powershell -Command "Remove-AppxPackage -Package NotepadPlusPlus_1.0.0.0_neutral__7njy0v32s6xk6"
|
|
||||||
)
|
|
||||||
)
|
|
||||||
REM The below lines will remove the unattend.xml that gets the machine into audit mode. If not removed, the OS will get stuck booting to audit mode each time.
|
|
||||||
REM Also kills the sysprep process in order to automate sysprep generalize
|
|
||||||
del c:\windows\panther\unattend\unattend.xml /F /Q
|
|
||||||
del c:\windows\panther\unattend.xml /F /Q
|
|
||||||
taskkill /IM sysprep.exe
|
|
||||||
timeout /t 10
|
|
||||||
REM Run disk cleanup (cleanmgr.exe) with all options enabled: https://learn.microsoft.com/en-us/troubleshoot/windows-server/backup-and-storage/automating-disk-cleanup-tool
|
|
||||||
set rootkey=HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Explorer\VolumeCaches
|
|
||||||
REM Per above doc, the Offline Pages Files subkey does not have stateflags value
|
|
||||||
for /f "tokens=*" %%K in ('reg query "%rootkey%"') do (
|
|
||||||
echo %%K | findstr /i /c:"Offline Pages Files"
|
|
||||||
if errorlevel 1 (
|
|
||||||
reg add "%%K" /v StateFlags0000 /t REG_DWORD /d 2 /f
|
|
||||||
)
|
|
||||||
)
|
|
||||||
cleanmgr.exe /sagerun:0
|
|
||||||
REM Remove the StateFlags0000 registry value
|
|
||||||
for /f "tokens=*" %%K in ('reg query "%rootkey%"') do (
|
|
||||||
echo %%K | findstr /i /c:"Offline Pages Files"
|
|
||||||
if errorlevel 1 (
|
|
||||||
reg delete "%%K" /v StateFlags0000 /f
|
|
||||||
)
|
|
||||||
)
|
|
||||||
REM Sysprep/Generalize
|
|
||||||
c:\windows\system32\sysprep\sysprep.exe /quiet /generalize /oobe
|
|
||||||
@@ -2,16 +2,6 @@
|
|||||||
<Add SourcePath="C:\FFUDevelopment\Apps\Office" OfficeClientEdition="64" Channel="Current">
|
<Add SourcePath="C:\FFUDevelopment\Apps\Office" OfficeClientEdition="64" Channel="Current">
|
||||||
<Product ID="O365ProPlusRetail">
|
<Product ID="O365ProPlusRetail">
|
||||||
<Language ID="MatchOS" />
|
<Language ID="MatchOS" />
|
||||||
<ExcludeApp ID="Access" />
|
|
||||||
<ExcludeApp ID="Lync" />
|
|
||||||
<ExcludeApp ID="Publisher" />
|
|
||||||
<ExcludeApp ID="Bing" />
|
|
||||||
</Product>
|
</Product>
|
||||||
</Add>
|
</Add>
|
||||||
<Property Name="SharedComputerLicensing" Value="0" />
|
|
||||||
<Property Name="FORCEAPPSHUTDOWN" Value="FALSE" />
|
|
||||||
<Property Name="DeviceBasedLicensing" Value="0" />
|
|
||||||
<Property Name="SCLCacheOverride" Value="0" />
|
|
||||||
<Updates Enabled="TRUE" />
|
|
||||||
<Display Level="None" AcceptEULA="TRUE" />
|
|
||||||
</Configuration>
|
</Configuration>
|
||||||
@@ -0,0 +1,4 @@
|
|||||||
|
{
|
||||||
|
"VMWareTools": true,
|
||||||
|
"foo": "bar"
|
||||||
|
}
|
||||||
@@ -0,0 +1,269 @@
|
|||||||
|
#Requires -RunAsAdministrator
|
||||||
|
|
||||||
|
# --- CONFIGURATION ---
|
||||||
|
# Base path where application folders are located. Each subfolder represents one application.
|
||||||
|
$basePath = "D:\MSStore"
|
||||||
|
# Path for temporary files (e.g., for extracting archives). This will be created and cleaned up automatically.
|
||||||
|
$tempBasePath = Join-Path -Path $env:TEMP -ChildPath "StoreAppInstall"
|
||||||
|
|
||||||
|
# --- SCRIPT ---
|
||||||
|
|
||||||
|
# Helper function to clean up temporary files on exit or error
|
||||||
|
function Remove-TemporaryFiles {
|
||||||
|
if (Test-Path -Path $tempBasePath) {
|
||||||
|
Write-Host "Cleaning up temporary directory: $tempBasePath"
|
||||||
|
Remove-Item -Path $tempBasePath -Recurse -Force
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# Ensure temp directory is clean before starting
|
||||||
|
Remove-TemporaryFiles
|
||||||
|
New-Item -Path $tempBasePath -ItemType Directory -Force | Out-Null
|
||||||
|
|
||||||
|
# 1. Determine applicable dependency architectures based on the OS architecture
|
||||||
|
$osArchitecture = $env:PROCESSOR_ARCHITECTURE
|
||||||
|
$applicableArchitectures = switch ($osArchitecture) {
|
||||||
|
"AMD64" { 'x64', 'x86' }
|
||||||
|
"x86" { 'x86' }
|
||||||
|
"ARM64" { 'arm64', 'arm' }
|
||||||
|
default { $osArchitecture.ToLower() }
|
||||||
|
}
|
||||||
|
Write-Host "Installing Store Apps: Detected OS Architecture: $osArchitecture."
|
||||||
|
Write-Host "Applicable dependency architectures: $($applicableArchitectures -join ', ')"
|
||||||
|
|
||||||
|
# Check if the base path exists
|
||||||
|
if (-not (Test-Path -Path $basePath)) {
|
||||||
|
Write-Host "Installing Store Apps: Base path '$basePath' does not exist. Exiting."
|
||||||
|
exit
|
||||||
|
}
|
||||||
|
Write-Host "Installing Store Apps: Base path '$basePath' exists."
|
||||||
|
|
||||||
|
# 2. Process and install each main application
|
||||||
|
Write-Host "Starting main application installation process..."
|
||||||
|
foreach ($appFolder in Get-ChildItem -Path $basePath -Directory) {
|
||||||
|
Write-Host "--- Processing application in folder: $($appFolder.Name) ---"
|
||||||
|
|
||||||
|
# Find the main application package (.appx/.msix/.appxbundle) in the app's root folder
|
||||||
|
$mainPackage = Get-ChildItem -Path $appFolder.FullName -File |
|
||||||
|
Where-Object { $_.Extension -in '.appx', '.msix', '.appxbundle', '.msixbundle' } |
|
||||||
|
Select-Object -First 1
|
||||||
|
|
||||||
|
if (-not $mainPackage) {
|
||||||
|
Write-Warning "No main application package found in '$($appFolder.Name)'. Skipping."
|
||||||
|
Write-Output ""
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
Write-Host "Found main package: $($mainPackage.Name)"
|
||||||
|
|
||||||
|
# Extract and parse AppxManifest.xml from the main package
|
||||||
|
$manifestTempPath = Join-Path -Path $tempBasePath -ChildPath "AppxManifest.xml"
|
||||||
|
if (Test-Path $manifestTempPath) { Remove-Item $manifestTempPath -Force }
|
||||||
|
|
||||||
|
$requiredDependencies = $null
|
||||||
|
try {
|
||||||
|
[System.Reflection.Assembly]::LoadWithPartialName("System.IO.Compression.FileSystem") | Out-Null
|
||||||
|
|
||||||
|
# Logic for handling bundles vs. single packages
|
||||||
|
if ($mainPackage.Extension -in '.appxbundle', '.msixbundle') {
|
||||||
|
Write-Host "Processing bundle. Searching for architecture-specific package..."
|
||||||
|
$bundleArchive = [System.IO.Compression.ZipFile]::OpenRead($mainPackage.FullName)
|
||||||
|
try {
|
||||||
|
# Find the best matching .appx/.msix package inside the bundle
|
||||||
|
$primaryArch = if ($osArchitecture -eq 'AMD64') { 'x64' } else { $osArchitecture.ToLower() }
|
||||||
|
$packageEntries = $bundleArchive.Entries | Where-Object { ($_.Name.EndsWith('.appx') -or $_.Name.EndsWith('.msix')) -and $_.Name -notlike "*_language-*" }
|
||||||
|
|
||||||
|
# Prioritize the primary architecture, then x86 (on x64), then neutral
|
||||||
|
$bestPackageEntry = $packageEntries | Where-Object { $_.Name -imatch "[._]${primaryArch}\.(appx|msix)$" } | Select-Object -First 1
|
||||||
|
if (-not $bestPackageEntry -and $primaryArch -eq 'x64') {
|
||||||
|
$bestPackageEntry = $packageEntries | Where-Object { $_.Name -imatch "[._]x86\.(appx|msix)$" } | Select-Object -First 1
|
||||||
|
}
|
||||||
|
if (-not $bestPackageEntry) {
|
||||||
|
$bestPackageEntry = $packageEntries | Where-Object { $_.Name -imatch "[._]neutral\.(appx|msix)$" } | Select-Object -First 1
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($bestPackageEntry) {
|
||||||
|
Write-Host "Found inner package: $($bestPackageEntry.Name). Extracting to read its manifest."
|
||||||
|
$innerPackageTempPath = Join-Path -Path $tempBasePath -ChildPath $bestPackageEntry.Name
|
||||||
|
[System.IO.Compression.ZipFileExtensions]::ExtractToFile($bestPackageEntry, $innerPackageTempPath, $true)
|
||||||
|
|
||||||
|
$innerPackageArchive = [System.IO.Compression.ZipFile]::OpenRead($innerPackageTempPath)
|
||||||
|
try {
|
||||||
|
$manifestEntry = $innerPackageArchive.Entries | Where-Object { $_.Name -eq 'AppxManifest.xml' } | Select-Object -First 1
|
||||||
|
if ($manifestEntry) {
|
||||||
|
[System.IO.Compression.ZipFileExtensions]::ExtractToFile($manifestEntry, $manifestTempPath, $true)
|
||||||
|
}
|
||||||
|
} finally {
|
||||||
|
$innerPackageArchive.Dispose()
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
Write-Error "Could not find a suitable architecture-specific package inside '$($mainPackage.Name)'."
|
||||||
|
}
|
||||||
|
} finally {
|
||||||
|
$bundleArchive.Dispose()
|
||||||
|
}
|
||||||
|
} else { # It's a regular .appx or .msix
|
||||||
|
$zipArchive = [System.IO.Compression.ZipFile]::OpenRead($mainPackage.FullName)
|
||||||
|
try {
|
||||||
|
$manifestEntry = $zipArchive.Entries | Where-Object { $_.Name -eq 'AppxManifest.xml' } | Select-Object -First 1
|
||||||
|
if ($manifestEntry) {
|
||||||
|
[System.IO.Compression.ZipFileExtensions]::ExtractToFile($manifestEntry, $manifestTempPath, $true)
|
||||||
|
}
|
||||||
|
} finally {
|
||||||
|
$zipArchive.Dispose()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# Common manifest parsing logic
|
||||||
|
if (Test-Path $manifestTempPath) {
|
||||||
|
[xml]$manifest = Get-Content -Path $manifestTempPath
|
||||||
|
$nsm = [System.Xml.XmlNamespaceManager]::new($manifest.NameTable)
|
||||||
|
$nsm.AddNamespace("def", "http://schemas.microsoft.com/appx/manifest/foundation/windows10")
|
||||||
|
|
||||||
|
$dependenciesNode = $manifest.SelectSingleNode("//def:Dependencies", $nsm)
|
||||||
|
if ($dependenciesNode) {
|
||||||
|
$requiredDependencies = $dependenciesNode.SelectNodes("def:PackageDependency", $nsm)
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
Write-Error "Could not find or extract AppxManifest.xml from '$($mainPackage.FullName)'."
|
||||||
|
}
|
||||||
|
} catch {
|
||||||
|
Write-Error "Failed to read or parse manifest from '$($mainPackage.FullName)'. Error: $($_.Exception.Message)"
|
||||||
|
}
|
||||||
|
|
||||||
|
# Scan for and resolve dependencies only if the manifest lists actual package dependencies.
|
||||||
|
$resolvedDependencyPaths = [System.Collections.Generic.List[string]]::new()
|
||||||
|
|
||||||
|
if ($null -ne $requiredDependencies -and $requiredDependencies.Count -gt 0) {
|
||||||
|
$appDependenciesPath = Join-Path -Path $appFolder.FullName -ChildPath "Dependencies"
|
||||||
|
|
||||||
|
if (Test-Path -Path $appDependenciesPath) {
|
||||||
|
Write-Host "Scanning for dependencies in '$appDependenciesPath'..."
|
||||||
|
$appSpecificDependencies = @{}
|
||||||
|
$dependencyFoldersToScan = [System.Collections.Generic.List[string]]::new()
|
||||||
|
$dependencyFoldersToScan.Add($appDependenciesPath)
|
||||||
|
|
||||||
|
# Handle zipped dependencies by extracting them to a temp location
|
||||||
|
Get-ChildItem -Path $appDependenciesPath -Filter "*.zip" -File | ForEach-Object {
|
||||||
|
$zipFile = $_
|
||||||
|
# Ensure unique extract path per app to avoid conflicts
|
||||||
|
$extractPath = Join-Path -Path $tempBasePath -ChildPath "$($appFolder.Name)_$($zipFile.BaseName)"
|
||||||
|
Write-Host "Extracting zipped dependencies from '$($zipFile.FullName)' to '$extractPath'..."
|
||||||
|
try {
|
||||||
|
Expand-Archive -Path $zipFile.FullName -DestinationPath $extractPath -Force
|
||||||
|
$dependencyFoldersToScan.Add($extractPath)
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
Write-Error "Failed to extract '$($zipFile.FullName)'. Error: $($_.Exception.Message)"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# Regex to parse package filenames
|
||||||
|
$packageFileRegex = '^(?<Name>.+?)_(?<Version>(?:\d+\.){2,3}\d+)_(?:[^_]+_)*(?<Arch>x64|x86|arm|arm64|neutral)(?:__.*)?$'
|
||||||
|
|
||||||
|
# Catalog all package files found in the dependency folders for this app
|
||||||
|
foreach ($folder in $dependencyFoldersToScan.ToArray() | Select-Object -Unique) {
|
||||||
|
Get-ChildItem -Path $folder -Recurse -File | Where-Object { $_.Extension -in '.appx', '.msix', '.appxbundle' } | ForEach-Object {
|
||||||
|
$file = $_
|
||||||
|
$match = $file.BaseName -imatch $packageFileRegex
|
||||||
|
if ($match) {
|
||||||
|
$dependencyName = $matches.Name
|
||||||
|
try {
|
||||||
|
$dependencyVersion = [System.Version]$matches.Version
|
||||||
|
$dependencyArch = $matches.Arch
|
||||||
|
|
||||||
|
if (-not $appSpecificDependencies.ContainsKey($dependencyName)) {
|
||||||
|
$appSpecificDependencies[$dependencyName] = [System.Collections.Generic.List[object]]::new()
|
||||||
|
}
|
||||||
|
$appSpecificDependencies[$dependencyName].Add([pscustomobject]@{
|
||||||
|
Name = $dependencyName
|
||||||
|
Version = $dependencyVersion
|
||||||
|
Arch = $dependencyArch
|
||||||
|
Path = $file.FullName
|
||||||
|
})
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
Write-Warning "Could not parse version for file '$($file.Name)'. Skipping."
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
Write-Host "Dependency scan for '$($appFolder.Name)' complete."
|
||||||
|
|
||||||
|
# Resolve all required dependencies using the app-specific catalog
|
||||||
|
foreach ($req in $requiredDependencies) {
|
||||||
|
$reqName = $req.Name
|
||||||
|
$reqMinVersion = [System.Version]$req.MinVersion
|
||||||
|
Write-Host "Resolving dependency: $reqName (MinVersion: $reqMinVersion)"
|
||||||
|
|
||||||
|
if ($appSpecificDependencies.ContainsKey($reqName)) {
|
||||||
|
# Find all available packages that meet the minimum version and architecture requirements
|
||||||
|
$candidates = $appSpecificDependencies[$reqName] | Where-Object {
|
||||||
|
$_.Version -ge $reqMinVersion -and
|
||||||
|
$_.Arch -in ($applicableArchitectures + 'neutral')
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($candidates) {
|
||||||
|
# Group by architecture and find the single latest version for each applicable arch
|
||||||
|
$bestCandidates = $candidates | Group-Object -Property Arch | ForEach-Object {
|
||||||
|
$_.Group | Sort-Object -Property Version -Descending | Select-Object -First 1
|
||||||
|
}
|
||||||
|
|
||||||
|
foreach($best in $bestCandidates) {
|
||||||
|
Write-Host " - Found best match: $($best.Path.Replace($basePath, '...'))"
|
||||||
|
$resolvedDependencyPaths.Add($best.Path)
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
Write-Warning " - No suitable package found for dependency '$reqName' with MinVersion '$reqMinVersion' for applicable architectures."
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
Write-Warning " - Dependency '$reqName' not found in this app's dependency folder."
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
Write-Warning "Dependencies are required by manifest, but no 'Dependencies' folder found for '$($appFolder.Name)'."
|
||||||
|
}
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
Write-Host "No actual package dependencies listed in manifest for '$($appFolder.Name)'. Proceeding without dependency resolution."
|
||||||
|
}
|
||||||
|
|
||||||
|
# Build the DISM command
|
||||||
|
$dismParams = @(
|
||||||
|
"/Online"
|
||||||
|
"/Add-ProvisionedAppxPackage"
|
||||||
|
"/PackagePath:`"$($mainPackage.FullName)`""
|
||||||
|
"/Region:all"
|
||||||
|
# "/StubPackageOption:installfull"
|
||||||
|
)
|
||||||
|
|
||||||
|
# Add resolved dependencies, ensuring no duplicates
|
||||||
|
$resolvedDependencyPaths.ToArray() | Select-Object -Unique | ForEach-Object {
|
||||||
|
$dismParams += "/DependencyPackagePath:`"$_`""
|
||||||
|
}
|
||||||
|
|
||||||
|
# Find and add the license file, or skip if not found
|
||||||
|
$licenseFile = Get-ChildItem -Path $appFolder.FullName -Filter "*.xml" -File | Select-Object -First 1
|
||||||
|
if ($licenseFile) {
|
||||||
|
$dismParams += "/LicensePath:`"$($licenseFile.FullName)`""
|
||||||
|
} else {
|
||||||
|
$dismParams += "/SkipLicense"
|
||||||
|
}
|
||||||
|
|
||||||
|
# Execute the DISM command
|
||||||
|
$dismCommand = "DISM.exe " + ($dismParams -join " ")
|
||||||
|
Write-Host "Constructed DISM command:"
|
||||||
|
Write-Output $dismCommand
|
||||||
|
|
||||||
|
try {
|
||||||
|
Invoke-Expression -Command $dismCommand -ErrorAction Stop
|
||||||
|
Write-Host "Successfully installed $($mainPackage.Name)."
|
||||||
|
} catch {
|
||||||
|
Write-Error "DISM command failed for $($mainPackage.Name). Error: $($_.Exception.Message)"
|
||||||
|
}
|
||||||
|
Write-Output ""
|
||||||
|
}
|
||||||
|
|
||||||
|
# Final cleanup
|
||||||
|
Write-Host "Installation process finished."
|
||||||
|
Remove-TemporaryFiles
|
||||||
@@ -0,0 +1,328 @@
|
|||||||
|
# Allow Orchestrator.ps1 to override the app list file paths while preserving legacy defaults.
|
||||||
|
param(
|
||||||
|
[Parameter()]
|
||||||
|
[string]$wingetAppsJsonFile = (Join-Path -Path $PSScriptRoot -ChildPath "WinGetWin32Apps.json"),
|
||||||
|
[Parameter()]
|
||||||
|
[string]$userAppsJsonFile = (Join-Path -Path (Split-Path -Parent $PSScriptRoot) -ChildPath "UserAppList.json")
|
||||||
|
)
|
||||||
|
|
||||||
|
function Invoke-Process {
|
||||||
|
[CmdletBinding(SupportsShouldProcess)]
|
||||||
|
param
|
||||||
|
(
|
||||||
|
[Parameter(Mandatory)]
|
||||||
|
[ValidateNotNullOrEmpty()]
|
||||||
|
[string]$FilePath,
|
||||||
|
|
||||||
|
[Parameter()]
|
||||||
|
[string[]]$ArgumentList,
|
||||||
|
|
||||||
|
[Parameter()]
|
||||||
|
[ValidateNotNullOrEmpty()]
|
||||||
|
[bool]$Wait = $true,
|
||||||
|
|
||||||
|
[Parameter()]
|
||||||
|
[string[]]$AdditionalSuccessCodes,
|
||||||
|
|
||||||
|
[Parameter()]
|
||||||
|
[bool]$IgnoreNonZeroExitCodes = $false
|
||||||
|
)
|
||||||
|
|
||||||
|
$ErrorActionPreference = 'Stop'
|
||||||
|
|
||||||
|
try {
|
||||||
|
if ($PSCmdlet.ShouldProcess("Process [$($FilePath)]", "Run with args: [$($ArgumentList)]")) {
|
||||||
|
# Use .NET Process class for proper stream handling
|
||||||
|
$pinfo = New-Object System.Diagnostics.ProcessStartInfo
|
||||||
|
$pinfo.FileName = $FilePath
|
||||||
|
if ($ArgumentList) {
|
||||||
|
$pinfo.Arguments = $ArgumentList -join ' '
|
||||||
|
}
|
||||||
|
$pinfo.RedirectStandardOutput = $true
|
||||||
|
$pinfo.RedirectStandardError = $true
|
||||||
|
$pinfo.UseShellExecute = $false
|
||||||
|
$pinfo.CreateNoWindow = $true
|
||||||
|
|
||||||
|
$p = New-Object System.Diagnostics.Process
|
||||||
|
$p.StartInfo = $pinfo
|
||||||
|
|
||||||
|
# Start the process
|
||||||
|
$p.Start() | Out-Null
|
||||||
|
|
||||||
|
# Read output and error streams
|
||||||
|
$cmdOutput = $p.StandardOutput.ReadToEnd()
|
||||||
|
$cmdError = $p.StandardError.ReadToEnd()
|
||||||
|
|
||||||
|
if ($Wait) {
|
||||||
|
$p.WaitForExit()
|
||||||
|
}
|
||||||
|
|
||||||
|
$exitCode = $p.ExitCode
|
||||||
|
# An exit code of 0 is always a success
|
||||||
|
if ($exitCode -ne 0) {
|
||||||
|
# If IgnoreNonZeroExitCodes is true, treat any non-zero exit code as a success
|
||||||
|
if ($IgnoreNonZeroExitCodes) {
|
||||||
|
Write-Host "Ignoring non-zero exit code $exitCode because IgnoreNonZeroExitCodes is set to true."
|
||||||
|
}
|
||||||
|
# Check if the non-zero exit code is in the list of additional success codes
|
||||||
|
elseif ($null -eq $AdditionalSuccessCodes -or $exitCode -notin $AdditionalSuccessCodes) {
|
||||||
|
if ($cmdError) {
|
||||||
|
throw $cmdError.Trim()
|
||||||
|
}
|
||||||
|
if ($cmdOutput) {
|
||||||
|
throw $cmdOutput.Trim()
|
||||||
|
}
|
||||||
|
# If there's no output, throw a generic error with the exit code
|
||||||
|
if (-not $cmdError -and -not $cmdOutput) {
|
||||||
|
throw "Process exited with non-zero code: $exitCode"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
if ([string]::IsNullOrEmpty($cmdOutput) -eq $false) {
|
||||||
|
# WriteLog $cmdOutput
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# Create a simple object with exit code for compatibility
|
||||||
|
$result = [PSCustomObject]@{
|
||||||
|
ExitCode = $exitCode
|
||||||
|
}
|
||||||
|
|
||||||
|
return $result
|
||||||
|
}
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
#$PSCmdlet.ThrowTerminatingError($_)
|
||||||
|
# WriteLog $_
|
||||||
|
# Write-Host "Script failed - $Logfile for more info"
|
||||||
|
throw $_
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function Format-MsiArguments {
|
||||||
|
<#
|
||||||
|
.SYNOPSIS
|
||||||
|
Ensures MSI file paths in msiexec arguments are properly quoted.
|
||||||
|
.DESCRIPTION
|
||||||
|
Detects /i arguments followed by an unquoted path ending in .msi
|
||||||
|
and wraps the path in double quotes to handle paths with spaces.
|
||||||
|
#>
|
||||||
|
param(
|
||||||
|
[Parameter(Mandatory)]
|
||||||
|
[string]$CommandLine,
|
||||||
|
|
||||||
|
[Parameter(Mandatory)]
|
||||||
|
[string]$Arguments
|
||||||
|
)
|
||||||
|
|
||||||
|
# Only process if the command is msiexec
|
||||||
|
if ($CommandLine -notmatch '^msiexec(\.exe)?$') {
|
||||||
|
return $Arguments
|
||||||
|
}
|
||||||
|
|
||||||
|
# Regex pattern explanation:
|
||||||
|
# (?i) - Case-insensitive matching
|
||||||
|
# (/i)\s+ - Match /i followed by whitespace
|
||||||
|
# (?!") - Negative lookahead: not already quoted
|
||||||
|
# (.+?\.msi) - Capture path ending in .msi (lazy match to stop at first .msi)
|
||||||
|
# (?=\s+/|\s*$) - Followed by another switch or end of string
|
||||||
|
|
||||||
|
# Pattern to match /i followed by an unquoted MSI path
|
||||||
|
$pattern = '(?i)(/i)\s+(?!")(.+?\.msi)(?=\s+/|\s*$)'
|
||||||
|
|
||||||
|
if ($Arguments -match $pattern) {
|
||||||
|
$originalArgs = $Arguments
|
||||||
|
# Replace with quoted path
|
||||||
|
$Arguments = $Arguments -replace $pattern, '$1 "$2"'
|
||||||
|
Write-Host "Detected unquoted MSI path in msiexec arguments. Adjusted arguments:"
|
||||||
|
Write-Host "Original: $originalArgs"
|
||||||
|
Write-Host "Modified: $Arguments"
|
||||||
|
}
|
||||||
|
|
||||||
|
return $Arguments
|
||||||
|
}
|
||||||
|
|
||||||
|
function Install-Applications {
|
||||||
|
param(
|
||||||
|
[Parameter(Mandatory)]
|
||||||
|
[array]$apps
|
||||||
|
)
|
||||||
|
|
||||||
|
if ($apps.Count -eq 0) {
|
||||||
|
Write-Host "No applications to install from this source."
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
Write-Host "Total apps to install from this source: $($apps.Count)"
|
||||||
|
|
||||||
|
# Sort all apps by priority
|
||||||
|
$sortedApps = $apps | Sort-Object -Property Priority
|
||||||
|
|
||||||
|
# Install each app
|
||||||
|
foreach ($app in $sortedApps) {
|
||||||
|
# Check if required properties exist
|
||||||
|
if (-not $app.PSObject.Properties['Name'] -or -not $app.PSObject.Properties['CommandLine'] -or -not $app.PSObject.Properties['Arguments']) {
|
||||||
|
Write-Warning "Skipping app due to missing required properties (Name, CommandLine, Arguments): $($app | ConvertTo-Json -Depth 1 -Compress)"
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
Write-Host "Installing $($app.Name)..."
|
||||||
|
|
||||||
|
# Wait until no MSIExec installation is running
|
||||||
|
while ($true) {
|
||||||
|
try {
|
||||||
|
# Try to open the MSIExec global mutex
|
||||||
|
$Mutex = [System.Threading.Mutex]::OpenExisting("Global\_MSIExecute")
|
||||||
|
# Dispose releases the handle from our script only.
|
||||||
|
$Mutex.Dispose()
|
||||||
|
Write-Host "Another MSIExec installer is running. Waiting for 5 seconds before rechecking..."
|
||||||
|
Start-Sleep -Seconds 5
|
||||||
|
}
|
||||||
|
catch [System.Threading.WaitHandleCannotBeOpenedException] {
|
||||||
|
# If we can't open the mutex, it means no MSIExec installation is running
|
||||||
|
break
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
# Handle other potential errors when checking the mutex
|
||||||
|
Write-Warning "Error checking MSIExec mutex: $_. Proceeding with caution."
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# Check for 'PAUSE' command
|
||||||
|
if ($app.CommandLine -eq 'PAUSE') {
|
||||||
|
Write-Host "Pausing script as requested by '$($app.Name)'. Press Enter to continue..."
|
||||||
|
$null = Read-Host
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
# Normalize arguments: treat null/empty/whitespace as no arguments
|
||||||
|
$argumentsToPass = $null
|
||||||
|
if ($null -ne $app.Arguments) {
|
||||||
|
if ($app.Arguments -is [array]) {
|
||||||
|
$trimmed = $app.Arguments | ForEach-Object { ($_ | ForEach-Object { if ($_ -ne $null) { $_.ToString().Trim() } else { $_ } }) } | Where-Object { $_ -and (-not [string]::IsNullOrWhiteSpace($_)) }
|
||||||
|
if ($trimmed.Count -gt 0) {
|
||||||
|
$argumentsToPass = $trimmed
|
||||||
|
}
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
$single = $app.Arguments.ToString().Trim()
|
||||||
|
if (-not [string]::IsNullOrWhiteSpace($single)) {
|
||||||
|
$argumentsToPass = @($single)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# Check for and parse AdditionalExitCodes
|
||||||
|
$additionalSuccessCodes = @()
|
||||||
|
if ($app.PSObject.Properties['AdditionalExitCodes'] -and -not [string]::IsNullOrWhiteSpace($app.AdditionalExitCodes)) {
|
||||||
|
$additionalSuccessCodes = $app.AdditionalExitCodes -split ',' | ForEach-Object { $_.Trim() }
|
||||||
|
Write-Host "Additional success exit codes for $($app.Name): $($additionalSuccessCodes -join ', ')"
|
||||||
|
}
|
||||||
|
|
||||||
|
# Check for IgnoreNonZeroExitCodes
|
||||||
|
$ignoreNonZeroExitCodes = $false
|
||||||
|
if ($app.PSObject.Properties['IgnoreNonZeroExitCodes'] -and $app.IgnoreNonZeroExitCodes -is [bool]) {
|
||||||
|
$ignoreNonZeroExitCodes = $app.IgnoreNonZeroExitCodes
|
||||||
|
}
|
||||||
|
|
||||||
|
# Auto-quote MSI paths if using msiexec and path contains spaces but no quotes
|
||||||
|
if ($null -ne $argumentsToPass -and $argumentsToPass.Count -gt 0) {
|
||||||
|
$joinedArgs = $argumentsToPass -join ' '
|
||||||
|
$formattedArgs = Format-MsiArguments -CommandLine $app.CommandLine -Arguments $joinedArgs
|
||||||
|
if ($formattedArgs -ne $joinedArgs) {
|
||||||
|
$argumentsToPass = @($formattedArgs)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($null -eq $argumentsToPass -or $argumentsToPass.Count -eq 0) {
|
||||||
|
Write-Host "Running command: $($app.CommandLine) (no arguments)"
|
||||||
|
$result = Invoke-Process -FilePath $app.CommandLine -AdditionalSuccessCodes $additionalSuccessCodes -IgnoreNonZeroExitCodes $ignoreNonZeroExitCodes
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
Write-Host "Running command: $($app.CommandLine) $($argumentsToPass -join ' ')"
|
||||||
|
$result = Invoke-Process -FilePath $app.CommandLine -ArgumentList $argumentsToPass -AdditionalSuccessCodes $additionalSuccessCodes -IgnoreNonZeroExitCodes $ignoreNonZeroExitCodes
|
||||||
|
}
|
||||||
|
Write-Host "$($app.Name) exited with exit code: $($result.ExitCode)`r`n"
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
Write-Error "Error occurred while installing $($app.Name): $_"
|
||||||
|
Read-Host "An error occurred, and the script cannot continue. Press Enter to exit."
|
||||||
|
throw $_
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# Initialize empty arrays for apps from each source
|
||||||
|
$wingetApps = @()
|
||||||
|
$userApps = @()
|
||||||
|
|
||||||
|
# Read the WinGetWin32Apps.json file if it exists
|
||||||
|
if (Test-Path -Path $wingetAppsJsonFile) {
|
||||||
|
Write-Host "Processing WinGetWin32Apps.json..."
|
||||||
|
try {
|
||||||
|
$wingetContent = Get-Content -Path $wingetAppsJsonFile -Raw -ErrorAction Stop | ConvertFrom-Json
|
||||||
|
if ($wingetContent -is [array]) {
|
||||||
|
$wingetApps = $wingetContent
|
||||||
|
Write-Host "Found $(($wingetApps | Measure-Object).Count) WinGet Win32 apps."
|
||||||
|
}
|
||||||
|
elseif ($wingetContent) {
|
||||||
|
$wingetApps = @($wingetContent) # Ensure it's an array
|
||||||
|
Write-Host "Found 1 WinGet Win32 app."
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
Write-Host "WinGetWin32Apps.json is empty or invalid."
|
||||||
|
}
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
Write-Error "Failed to read or parse WinGetWin32Apps.json file: $_"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
Write-Host "WinGetWin32Apps.json file not found. Skipping."
|
||||||
|
}
|
||||||
|
|
||||||
|
# Install WinGet apps if any were found
|
||||||
|
if ($wingetApps.Count -gt 0) {
|
||||||
|
Install-Applications -apps $wingetApps
|
||||||
|
}
|
||||||
|
|
||||||
|
# Read the configured BYO app list file if it exists
|
||||||
|
if (Test-Path -Path $userAppsJsonFile) {
|
||||||
|
Write-Host "Processing $(Split-Path -Path $userAppsJsonFile -Leaf)..."
|
||||||
|
try {
|
||||||
|
$userContent = Get-Content -Path $userAppsJsonFile -Raw -ErrorAction Stop | ConvertFrom-Json
|
||||||
|
if ($userContent -is [array]) {
|
||||||
|
$userApps = $userContent
|
||||||
|
Write-Host "Found $(($userApps | Measure-Object).Count) user-defined apps."
|
||||||
|
}
|
||||||
|
elseif ($userContent) {
|
||||||
|
$userApps = @($userContent)
|
||||||
|
Write-Host "Found 1 user-defined app."
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
Write-Host "$(Split-Path -Path $userAppsJsonFile -Leaf) is empty or invalid."
|
||||||
|
}
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
Write-Error "Failed to read or parse BYO app list file '$userAppsJsonFile': $_"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
Write-Host "BYO app list file not found at $userAppsJsonFile. Skipping."
|
||||||
|
}
|
||||||
|
|
||||||
|
# Install User apps if any were found
|
||||||
|
if ($userApps.Count -gt 0) {
|
||||||
|
Install-Applications -apps $userApps
|
||||||
|
}
|
||||||
|
|
||||||
|
# Check if any apps were installed at all
|
||||||
|
if ($wingetApps.Count -eq 0 -and $userApps.Count -eq 0) {
|
||||||
|
Write-Host "No Win32 apps found in either WinGetWin32Apps.json or UserAppList.json. Exiting."
|
||||||
|
exit 0
|
||||||
|
}
|
||||||
|
|
||||||
|
Write-Host "All Win32 app installations attempted."
|
||||||
@@ -0,0 +1,60 @@
|
|||||||
|
<#
|
||||||
|
.SYNOPSIS
|
||||||
|
This script uses the variables from the AppsScriptVariables hashtable passed to BuildFFUVM.ps1 to run application deployment tasks.
|
||||||
|
|
||||||
|
.DESCRIPTION
|
||||||
|
By defining the variables in the AppsScriptVariables hashtable, you can customize the application deployment tasks that are run by this script.
|
||||||
|
The BuildFFUVM.ps1 script will export the AppsScriptVariables hashtable to a JSON file in the Orchestration folder.
|
||||||
|
Include your own custom script here if you want to run it as part of the application deployment tasks.
|
||||||
|
Alternatively, you can pass the AppsScriptVariables hashtable directly to this script.
|
||||||
|
#>
|
||||||
|
|
||||||
|
param (
|
||||||
|
[hashtable]$AppsScriptVariables
|
||||||
|
)
|
||||||
|
|
||||||
|
# Try to read from the JSON file if it exists and AppsScriptVariables is not provided
|
||||||
|
$appsScriptVarsJsonPath = Join-Path -Path $PSScriptRoot -ChildPath "AppsScriptVariables.json"
|
||||||
|
if ((-not $AppsScriptVariables -or $AppsScriptVariables.Count -eq 0) -and (Test-Path -Path $appsScriptVarsJsonPath)) {
|
||||||
|
try {
|
||||||
|
$jsonContent = Get-Content -Path $appsScriptVarsJsonPath -Raw -ErrorAction Stop
|
||||||
|
$jsonObject = $jsonContent | ConvertFrom-Json -ErrorAction Stop
|
||||||
|
|
||||||
|
# Convert PSCustomObject to hashtable
|
||||||
|
$AppsScriptVariables = @{}
|
||||||
|
foreach ($prop in $jsonObject.PSObject.Properties) {
|
||||||
|
$AppsScriptVariables[$prop.Name] = $prop.Value
|
||||||
|
}
|
||||||
|
|
||||||
|
Write-Host "Successfully loaded AppsScriptVariables from $appsScriptVarsJsonPath"
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
Write-Error "Failed to load AppsScriptVariables from JSON file: $_"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
Write-Host "AppsScriptVariables provided directly, skipping JSON file load."
|
||||||
|
}
|
||||||
|
|
||||||
|
# Example of how to use the AppsScriptVariables hashtable to control script execution
|
||||||
|
|
||||||
|
# Note: The UI saves the values as strings, so if you type true for a value, it'll save to the config file as a string, not boolean
|
||||||
|
|
||||||
|
# Example: Check if a variable named 'foo' is set to string 'bar' and run a script accordingly
|
||||||
|
# if ($AppsScriptVariables['foo'] -eq 'bar') {
|
||||||
|
# Write-Host "Foo would have installed"
|
||||||
|
# }
|
||||||
|
# else {
|
||||||
|
# Write-Host "Foo would not have installed"
|
||||||
|
# }
|
||||||
|
|
||||||
|
# Example: Check if a variable named 'Teams' is set to string 'true' and run a script accordingly
|
||||||
|
# if ($AppsScriptVariables['Teams'] -eq 'true') {
|
||||||
|
# Write-Host "Teams would have been installed"
|
||||||
|
# }
|
||||||
|
# else {
|
||||||
|
# Write-Host "Teams would not have been installed"
|
||||||
|
# }
|
||||||
|
|
||||||
|
# Your code below here
|
||||||
|
Write-Host 'Invoke-AppsScript.ps1 finished'
|
||||||
@@ -0,0 +1,138 @@
|
|||||||
|
<#
|
||||||
|
.SYNOPSIS
|
||||||
|
Orchestration script for FFU VM deployment tasks
|
||||||
|
|
||||||
|
.DESCRIPTION
|
||||||
|
This script orchestrates the following deployment tasks:
|
||||||
|
- Install-Office.ps1
|
||||||
|
- Update-Defender.ps1
|
||||||
|
- Update-MSRT.ps1
|
||||||
|
- Update-OneDrive.ps1
|
||||||
|
- Update-Edge.ps1
|
||||||
|
- Install-Win32Apps.ps1
|
||||||
|
- Invoke-AppsScript.ps1
|
||||||
|
- Install-UserApps.ps1
|
||||||
|
- Install-StoreApps.ps1
|
||||||
|
- Run-DiskCleanup.ps1
|
||||||
|
- Run-Sysprep.ps1
|
||||||
|
|
||||||
|
The script will check for the presence of each of these files and if they exist, will run the script
|
||||||
|
#>
|
||||||
|
|
||||||
|
# Header
|
||||||
|
|
||||||
|
Write-Host "---------------------------------------------------" -ForegroundColor Yellow
|
||||||
|
Write-Host " FFU Builder Orchestrator " -ForegroundColor Yellow
|
||||||
|
Write-Host "---------------------------------------------------" -ForegroundColor Yellow
|
||||||
|
|
||||||
|
# Define the path to the scripts
|
||||||
|
$scriptPath = Split-Path -Parent $MyInvocation.MyCommand.Definition
|
||||||
|
|
||||||
|
# Resolve the configured BYO app list path for runtime orchestration.
|
||||||
|
$appInstallConfigPath = Join-Path -Path $scriptPath -ChildPath "AppInstallConfig.json"
|
||||||
|
$userAppsJsonFile = Join-Path -Path (Split-Path -Parent $scriptPath) -ChildPath "UserAppList.json"
|
||||||
|
|
||||||
|
if (Test-Path -Path $appInstallConfigPath) {
|
||||||
|
try {
|
||||||
|
$appInstallConfig = Get-Content -Path $appInstallConfigPath -Raw | ConvertFrom-Json
|
||||||
|
if ($null -ne $appInstallConfig -and $appInstallConfig.PSObject.Properties.Match('UserAppListPath').Count -gt 0 -and -not [string]::IsNullOrWhiteSpace($appInstallConfig.UserAppListPath)) {
|
||||||
|
$userAppsJsonFile = $appInstallConfig.UserAppListPath
|
||||||
|
Write-Host "Using BYO app list path from AppInstallConfig.json: $userAppsJsonFile"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
Write-Host "Failed to parse AppInstallConfig.json. Falling back to default BYO app list path."
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# Define the list of scripts to run
|
||||||
|
$scriptList = @(
|
||||||
|
"Install-LTSCUpdate.ps1",
|
||||||
|
"Update-Defender.ps1",
|
||||||
|
"Install-Office.ps1",
|
||||||
|
"Update-MSRT.ps1",
|
||||||
|
"Update-OneDrive.ps1",
|
||||||
|
"Update-Edge.ps1",
|
||||||
|
"Install-Win32Apps.ps1",
|
||||||
|
"Install-StoreApps.ps1",
|
||||||
|
"Install-UserApps.ps1"
|
||||||
|
)
|
||||||
|
# Check if each script exists and has content to process, then run it
|
||||||
|
foreach ($script in $scriptList) {
|
||||||
|
$scriptFile = Join-Path -Path $scriptPath -ChildPath $script
|
||||||
|
if (-not (Test-Path -Path $scriptFile)) {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
$shouldRun = $true # Default to run if script exists
|
||||||
|
switch ($script) {
|
||||||
|
"Install-Win32Apps.ps1" {
|
||||||
|
$wingetAppsJsonFile = Join-Path -Path $scriptPath -ChildPath "WinGetWin32Apps.json"
|
||||||
|
if (-not (Test-Path -Path $wingetAppsJsonFile) -and -not (Test-Path -Path $userAppsJsonFile)) {
|
||||||
|
$shouldRun = $false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
"Install-StoreApps.ps1" {
|
||||||
|
$msStorePath = "D:\MSStore"
|
||||||
|
if (-not (Test-Path -Path $msStorePath) -or -not (Get-ChildItem -Path $msStorePath)) {
|
||||||
|
$shouldRun = $false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($shouldRun) {
|
||||||
|
Write-Host "`n" # Add a newline for spacing
|
||||||
|
Write-Host "---------------------------------------------------" -ForegroundColor Yellow
|
||||||
|
Write-Host " Running script: $script " -ForegroundColor Yellow
|
||||||
|
Write-Host "---------------------------------------------------" -ForegroundColor Yellow
|
||||||
|
# Run script and wait for it to finish.
|
||||||
|
if ($script -eq "Install-Win32Apps.ps1") {
|
||||||
|
& $scriptFile -UserAppsJsonFile $userAppsJsonFile
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
& $scriptFile
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# Invoke-AppsScript.ps1 if it exists and AppsScriptVariables.json is present
|
||||||
|
$appsScriptFile = Join-Path -Path $scriptPath -ChildPath "Invoke-AppsScript.ps1"
|
||||||
|
$appsScriptVarsJsonPath = Join-Path -Path $PSScriptRoot -ChildPath "AppsScriptVariables.json"
|
||||||
|
if ((Test-Path -Path $appsScriptFile) -and (Test-Path -Path $appsScriptVarsJsonPath)) {
|
||||||
|
Write-Host "`n" # Add a newline for spacing
|
||||||
|
Write-Host "---------------------------------------------------" -ForegroundColor Yellow
|
||||||
|
Write-Host " Running script: Invoke-AppsScript.ps1 " -ForegroundColor Yellow
|
||||||
|
Write-Host "---------------------------------------------------" -ForegroundColor Yellow
|
||||||
|
|
||||||
|
Write-Host "Using AppsScriptVariables from JSON file: $appsScriptVarsJsonPath"
|
||||||
|
& $appsScriptFile
|
||||||
|
}
|
||||||
|
|
||||||
|
# Run-DiskCleanup.ps1 must run before Run-Sysprep.ps1
|
||||||
|
$diskCleanupScript = Join-Path -Path $scriptPath -ChildPath "Run-DiskCleanup.ps1"
|
||||||
|
if (Test-Path -Path $diskCleanupScript) {
|
||||||
|
Write-Host "`n" # Add a newline for spacing
|
||||||
|
Write-Host "---------------------------------------------------" -ForegroundColor Yellow
|
||||||
|
Write-Host " Running script: Run-DiskCleanup.ps1 " -ForegroundColor Yellow
|
||||||
|
Write-Host "---------------------------------------------------" -ForegroundColor Yellow
|
||||||
|
# Run script and wait for it to finish
|
||||||
|
& $diskCleanupScript
|
||||||
|
|
||||||
|
} else {
|
||||||
|
Write-Host "Run-DiskCleanup.ps1 not found!"
|
||||||
|
}
|
||||||
|
|
||||||
|
# Run-Sysprep.ps1 must run last
|
||||||
|
$sysprepScript = Join-Path -Path $scriptPath -ChildPath "Run-Sysprep.ps1"
|
||||||
|
if (Test-Path -Path $sysprepScript) {
|
||||||
|
Write-Host "`n" # Add a newline for spacing
|
||||||
|
Write-Host "---------------------------------------------------" -ForegroundColor Yellow
|
||||||
|
Write-Host " Running script: Run-Sysprep.ps1 " -ForegroundColor Yellow
|
||||||
|
Write-Host "---------------------------------------------------" -ForegroundColor Yellow
|
||||||
|
# Run script and wait for it to finish
|
||||||
|
& $sysprepScript
|
||||||
|
} else {
|
||||||
|
Write-Host "Run-Sysprep.ps1 not found!"
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
@@ -0,0 +1,21 @@
|
|||||||
|
# Run disk cleanup (cleanmgr.exe) with all options enabled
|
||||||
|
# Reference: https://learn.microsoft.com/en-us/troubleshoot/windows-server/backup-and-storage/automating-disk-cleanup-tool
|
||||||
|
|
||||||
|
$rootKey = "HKLM:\SOFTWARE\Microsoft\Windows\CurrentVersion\Explorer\VolumeCaches"
|
||||||
|
|
||||||
|
# Set StateFlags0000 to 2 for all subkeys except "Offline Pages Files"
|
||||||
|
Get-ChildItem -Path $rootKey | ForEach-Object {
|
||||||
|
if ($_.PSChildName -ne "Offline Pages Files") {
|
||||||
|
Set-ItemProperty -Path $_.PSPath -Name "StateFlags0000" -Type DWord -Value 2 -Force
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# Run the disk cleanup tool with the specified flags
|
||||||
|
Start-Process -FilePath "cleanmgr.exe" -ArgumentList "/sagerun:0" -Wait
|
||||||
|
|
||||||
|
# Remove the StateFlags0000 registry values that were added
|
||||||
|
Get-ChildItem -Path $rootKey | ForEach-Object {
|
||||||
|
if ($_.PSChildName -ne "Offline Pages Files") {
|
||||||
|
Remove-ItemProperty -Path $_.PSPath -Name "StateFlags0000" -Force
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,90 @@
|
|||||||
|
#The below lines will remove the unattend.xml that gets the machine into audit mode. If not removed, the OS will get stuck booting to audit mode each time.
|
||||||
|
#Also kills the sysprep process in order to automate sysprep generalize
|
||||||
|
Write-Host "Removing existing unattend.xml files and stopping sysprep process if running..."
|
||||||
|
Remove-Item -Path "C:\windows\panther\unattend\unattend.xml" -Force -ErrorAction SilentlyContinue
|
||||||
|
Remove-Item -Path "C:\windows\panther\unattend.xml" -Force -ErrorAction SilentlyContinue
|
||||||
|
Stop-Process -Name "sysprep" -Force -ErrorAction SilentlyContinue
|
||||||
|
Start-Sleep -Seconds 10
|
||||||
|
|
||||||
|
# Detect and remediate per-user, non-provisioned Appx packages that would block Sysprep.
|
||||||
|
Write-Host "Checking for per-user Appx packages not provisioned for all users (potential Sysprep blockers)..."
|
||||||
|
|
||||||
|
# Build hash set of provisioned package families (DisplayName_PublisherId).
|
||||||
|
$provFamilies = New-Object 'System.Collections.Generic.HashSet[string]' ([StringComparer]::OrdinalIgnoreCase)
|
||||||
|
Get-AppxProvisionedPackage -Online | ForEach-Object {
|
||||||
|
$family = '{0}_{1}' -f $_.DisplayName, $_.PublisherId
|
||||||
|
[void]$provFamilies.Add($family)
|
||||||
|
}
|
||||||
|
|
||||||
|
# Collect current user Appx packages excluding frameworks, resource packs, and non-removable packages.
|
||||||
|
$userApps = Get-AppxPackage -User $env:USERNAME | Where-Object {
|
||||||
|
$_.Status -eq 'Ok' -and
|
||||||
|
-not $_.IsFramework -and
|
||||||
|
-not $_.IsResourcePackage -and
|
||||||
|
-not $_.NonRemovable
|
||||||
|
}
|
||||||
|
|
||||||
|
# Identify packages not provisioned (per-user only).
|
||||||
|
$notProvisioned = foreach ($pkg in $userApps) {
|
||||||
|
if (-not $provFamilies.Contains($pkg.PackageFamilyName)) {
|
||||||
|
[PSCustomObject]@{
|
||||||
|
Name = $pkg.Name
|
||||||
|
PackageFamilyName = $pkg.PackageFamilyName
|
||||||
|
Version = $pkg.Version
|
||||||
|
SignatureKind = $pkg.SignatureKind
|
||||||
|
PackageFullName = $pkg.PackageFullName
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($notProvisioned) {
|
||||||
|
Write-Host "Found $($notProvisioned.Count) per-user Appx package(s) not provisioned for all users:"
|
||||||
|
$notProvisioned | Sort-Object PackageFamilyName | Format-Table -AutoSize -Property Name,PackageFamilyName,Version
|
||||||
|
Write-Host "Attempting removal of per-user, non-provisioned Appx packages..."
|
||||||
|
foreach ($pkg in $notProvisioned) {
|
||||||
|
try {
|
||||||
|
Write-Host "Removing $($pkg.PackageFullName)..."
|
||||||
|
Remove-AppxPackage -Package $pkg.PackageFullName -ErrorAction Stop
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
Write-Warning "Failed to remove $($pkg.PackageFullName): $($_.Exception.Message)"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# Re-check after attempted removals.
|
||||||
|
$remaining = @()
|
||||||
|
$currentUserApps = Get-AppxPackage -User $env:USERNAME | Where-Object {
|
||||||
|
$_.Status -eq 'Ok' -and
|
||||||
|
-not $_.IsFramework -and
|
||||||
|
-not $_.IsResourcePackage -and
|
||||||
|
-not $_.NonRemovable
|
||||||
|
}
|
||||||
|
foreach ($pkg in $currentUserApps) {
|
||||||
|
if (-not $provFamilies.Contains($pkg.PackageFamilyName)) {
|
||||||
|
$remaining += $pkg
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($remaining.Count -gt 0) {
|
||||||
|
Write-Error "Unable to remove all per-user, non-provisioned Appx packages. Sysprep cannot continue."
|
||||||
|
$remaining | Sort-Object PackageFamilyName | Format-Table -AutoSize -Property Name,PackageFamilyName,Version
|
||||||
|
throw "Sysprep aborted due to unresolved per-user Appx packages. Resolve manually and re-run."
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
Write-Host "All per-user, non-provisioned Appx packages were successfully removed."
|
||||||
|
}
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
Write-Host "No per-user, non-provisioned Appx packages detected."
|
||||||
|
}
|
||||||
|
|
||||||
|
# If an Unattend.xml has been provided on the mounted Apps ISO (D:\Unattend\Unattend.xml),
|
||||||
|
# pass it to sysprep; otherwise, run without /unattend.
|
||||||
|
$unattendOnAppsIso = "D:\Unattend\Unattend.xml"
|
||||||
|
if (Test-Path -Path $unattendOnAppsIso) {
|
||||||
|
Write-Host "Using $unattendOnAppsIso from Apps ISO..."
|
||||||
|
& "C:\windows\system32\sysprep\sysprep.exe" /quiet /generalize /oobe /unattend:$unattendOnAppsIso
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
& "C:\windows\system32\sysprep\sysprep.exe" /quiet /generalize /oobe
|
||||||
|
}
|
||||||
@@ -5,7 +5,7 @@
|
|||||||
<RunAsynchronous>
|
<RunAsynchronous>
|
||||||
<RunAsynchronousCommand wcm:action="add">
|
<RunAsynchronousCommand wcm:action="add">
|
||||||
<Order>1</Order>
|
<Order>1</Order>
|
||||||
<Path>d:\InstallAppsandSysprep.cmd</Path>
|
<Path>C:\Windows\System32\WindowsPowerShell\v1.0\powershell.exe -ExecutionPolicy Bypass -File "d:\orchestration\orchestrator.ps1"</Path>
|
||||||
</RunAsynchronousCommand>
|
</RunAsynchronousCommand>
|
||||||
</RunAsynchronous>
|
</RunAsynchronous>
|
||||||
</component>
|
</component>
|
||||||
|
|||||||
@@ -5,7 +5,7 @@
|
|||||||
<RunAsynchronous>
|
<RunAsynchronous>
|
||||||
<RunAsynchronousCommand wcm:action="add">
|
<RunAsynchronousCommand wcm:action="add">
|
||||||
<Order>1</Order>
|
<Order>1</Order>
|
||||||
<Path>d:\InstallAppsandSysprep.cmd</Path>
|
<Path>C:\Windows\System32\WindowsPowerShell\v1.0\powershell.exe -ExecutionPolicy Bypass -File "d:\orchestration\orchestrator.ps1"</Path>
|
||||||
</RunAsynchronousCommand>
|
</RunAsynchronousCommand>
|
||||||
</RunAsynchronous>
|
</RunAsynchronous>
|
||||||
</component>
|
</component>
|
||||||
|
|||||||
@@ -0,0 +1,839 @@
|
|||||||
|
<#
|
||||||
|
.SYNOPSIS
|
||||||
|
Launches the FFU Development UI, a WPF application for configuring and running the FFU build process.
|
||||||
|
.DESCRIPTION
|
||||||
|
The BuildFFUVM_UI.ps1 script is the main entry point for the FFU Development user interface. It initializes and displays a WPF-based graphical interface defined in BuildFFUVM_UI.xaml.
|
||||||
|
|
||||||
|
The script is responsible for:
|
||||||
|
- Initializing a global state object to manage UI controls, data, and application flags.
|
||||||
|
- Importing the required FFU.Common and FFUUI.Core modules which contain the business logic.
|
||||||
|
- Ensuring system prerequisites, such as PowerShell 7 and Long Path Support, are met.
|
||||||
|
- Loading the XAML window, initializing UI controls with default values, and registering all event handlers.
|
||||||
|
- Launching the core build script (BuildFFUVM.ps1) in a background job when the user initiates a build.
|
||||||
|
- Providing real-time feedback by monitoring the build log file and updating the UI's progress bar and log viewer.
|
||||||
|
- Handling cleanup operations, such as reverting system settings, when the application is closed.
|
||||||
|
|
||||||
|
This script acts as the primary host for the UI, connecting the user interface with the underlying build and logic modules.
|
||||||
|
#>
|
||||||
|
#Requires -RunAsAdministrator
|
||||||
|
|
||||||
|
[CmdletBinding()]
|
||||||
|
[System.STAThread()]
|
||||||
|
param()
|
||||||
|
|
||||||
|
# Check PowerShell Version
|
||||||
|
if ($PSVersionTable.PSVersion.Major -lt 7) {
|
||||||
|
Write-Error "PowerShell 7 or later is required to run this script."
|
||||||
|
exit 1
|
||||||
|
}
|
||||||
|
|
||||||
|
# Creating custom state object to hold UI state and data
|
||||||
|
$FFUDevelopmentPath = $PSScriptRoot
|
||||||
|
|
||||||
|
$script:uiState = [PSCustomObject]@{
|
||||||
|
FFUDevelopmentPath = $FFUDevelopmentPath;
|
||||||
|
Window = $null;
|
||||||
|
Controls = @{
|
||||||
|
featureCheckBoxes = @{};
|
||||||
|
UpdateInstallAppsBasedOnUpdates = $null
|
||||||
|
};
|
||||||
|
Data = @{
|
||||||
|
allDriverModels = [System.Collections.Generic.List[PSCustomObject]]::new();
|
||||||
|
appsScriptVariablesDataList = [System.Collections.Generic.List[PSCustomObject]]::new();
|
||||||
|
versionData = $null;
|
||||||
|
vmSwitchMap = @{};
|
||||||
|
logData = $null;
|
||||||
|
logStreamReader = $null;
|
||||||
|
pollTimer = $null;
|
||||||
|
currentBuildProcess = $null;
|
||||||
|
lastConfigFilePath = $null;
|
||||||
|
loadedDeviceNamingMode = $null
|
||||||
|
};
|
||||||
|
Flags = @{
|
||||||
|
installAppsForcedByUpdates = $false;
|
||||||
|
prevInstallAppsStateBeforeUpdates = $null;
|
||||||
|
installAppsCheckedByOffice = $false;
|
||||||
|
lastSortProperty = $null;
|
||||||
|
lastSortAscending = $true;
|
||||||
|
isBuilding = $false;
|
||||||
|
isCleanupRunning = $false;
|
||||||
|
isFluentSupported = $false;
|
||||||
|
deviceNamingModeWasExplicitlyChanged = $false;
|
||||||
|
suppressDeviceNamingChangeTracking = $false
|
||||||
|
};
|
||||||
|
Defaults = @{};
|
||||||
|
LogFilePath = "$FFUDevelopmentPath\FFUDevelopment_UI.log"
|
||||||
|
}
|
||||||
|
|
||||||
|
# Remove any existing modules to avoid conflicts
|
||||||
|
if (Get-Module -Name 'FFU.Common' -ErrorAction SilentlyContinue) {
|
||||||
|
Remove-Module -Name 'FFU.Common' -Force
|
||||||
|
}
|
||||||
|
if (Get-Module -Name 'FFUUI.Core' -ErrorAction SilentlyContinue) {
|
||||||
|
Remove-Module -Name 'FFUUI.Core' -Force
|
||||||
|
}
|
||||||
|
# Import Modules
|
||||||
|
Import-Module "$PSScriptRoot\FFU.Common" -Force
|
||||||
|
Import-Module "$PSScriptRoot\FFUUI.Core" -Force
|
||||||
|
|
||||||
|
# Set the log path
|
||||||
|
Set-CommonCoreLogPath -Path $script:uiState.LogFilePath
|
||||||
|
|
||||||
|
# Setting long path support - this prevents issues where some applications have deep directory structures
|
||||||
|
# and driver extraction fails due to long paths.
|
||||||
|
$script:uiState.Flags.originalLongPathsValue = $null # Store original value
|
||||||
|
try {
|
||||||
|
$script:uiState.Flags.originalLongPathsValue = Get-ItemPropertyValue -Path 'HKLM:\SYSTEM\CurrentControlSet\Control\FileSystem' -Name 'LongPathsEnabled' -ErrorAction SilentlyContinue
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
# Key or value might not exist, which is fine.
|
||||||
|
WriteLog "Could not read initial LongPathsEnabled value (may not exist)."
|
||||||
|
}
|
||||||
|
|
||||||
|
# Enable long paths if not already enabled
|
||||||
|
if ($script:uiState.Flags.originalLongPathsValue -ne 1) {
|
||||||
|
try {
|
||||||
|
WriteLog 'LongPathsEnabled is not set to 1. Setting it to 1 for the duration of this script.'
|
||||||
|
Set-ItemProperty -Path 'HKLM:\SYSTEM\CurrentControlSet\Control\FileSystem' -Name 'LongPathsEnabled' -Value 1 -Force
|
||||||
|
WriteLog 'LongPathsEnabled set to 1.'
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
WriteLog "Error setting LongPathsEnabled registry key: $($_.Exception.Message). Long path issues might persist."
|
||||||
|
}
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
WriteLog "LongPathsEnabled is already set to 1."
|
||||||
|
}
|
||||||
|
|
||||||
|
if (Test-Path -Path $script:uiState.LogFilePath) {
|
||||||
|
Remove-item -Path $script:uiState.LogFilePath -Force
|
||||||
|
}
|
||||||
|
|
||||||
|
Add-Type -AssemblyName WindowsBase
|
||||||
|
Add-Type -AssemblyName PresentationCore, PresentationFramework
|
||||||
|
Add-Type -AssemblyName System.Windows.Forms
|
||||||
|
|
||||||
|
# Load XAML
|
||||||
|
$xamlPath = Join-Path $PSScriptRoot "BuildFFUVM_UI.xaml"
|
||||||
|
if (-not (Test-Path $xamlPath)) {
|
||||||
|
Write-Error "XAML file not found: $xamlPath"
|
||||||
|
return
|
||||||
|
}
|
||||||
|
$xamlString = Get-Content $xamlPath -Raw
|
||||||
|
$reader = New-Object System.IO.StringReader($xamlString)
|
||||||
|
$xmlReader = [System.Xml.XmlReader]::Create($reader)
|
||||||
|
$window = [Windows.Markup.XamlReader]::Load($xmlReader)
|
||||||
|
|
||||||
|
# Apply Fluent theme before the window renders (requires PowerShell 7.5+ / .NET 9+)
|
||||||
|
Initialize-FluentTheme -Window $window -ThemeMode "System" -State $script:uiState
|
||||||
|
|
||||||
|
$window.Add_Loaded({
|
||||||
|
# Pass the state object to all initialization functions
|
||||||
|
$script:uiState.Window = $window
|
||||||
|
$window.Tag = $script:uiState
|
||||||
|
Initialize-UIControls -State $script:uiState
|
||||||
|
Initialize-UIDefaults -State $script:uiState
|
||||||
|
Initialize-DynamicUIElements -State $script:uiState
|
||||||
|
Register-EventHandlers -State $script:uiState
|
||||||
|
|
||||||
|
# Populate the Home page build and release status after the window initializes
|
||||||
|
Start-HomeStatusRefresh -State $script:uiState
|
||||||
|
|
||||||
|
# Attempt automatic load of previous environment (silent)
|
||||||
|
try {
|
||||||
|
Invoke-AutoLoadPreviousEnvironment -State $script:uiState
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
WriteLog "Auto-load previous environment failed: $($_.Exception.Message)"
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
|
||||||
|
# Button: Build FFU
|
||||||
|
$script:uiState.Controls.btnRun = $window.FindName('btnRun')
|
||||||
|
$script:uiState.Controls.btnRun.Add_Click({
|
||||||
|
# Get a local reference to the button for convenience in this handler
|
||||||
|
$btnRun = $script:uiState.Controls.btnRun
|
||||||
|
try {
|
||||||
|
# If a build is running and cleanup is not already running, treat this click as Cancel
|
||||||
|
if ($script:uiState.Flags.isBuilding -and -not $script:uiState.Flags.isCleanupRunning) {
|
||||||
|
$btnRun.IsEnabled = $false
|
||||||
|
$script:uiState.Controls.txtStatus.Text = "Cancel requested. Stopping build..."
|
||||||
|
WriteLog "Cancel requested by user. Stopping background build process."
|
||||||
|
|
||||||
|
# Stop the timer
|
||||||
|
if ($null -ne $script:uiState.Data.pollTimer) {
|
||||||
|
$script:uiState.Data.pollTimer.Stop()
|
||||||
|
$script:uiState.Data.pollTimer = $null
|
||||||
|
}
|
||||||
|
|
||||||
|
# Close the log stream
|
||||||
|
if ($null -ne $script:uiState.Data.logStreamReader) {
|
||||||
|
$script:uiState.Data.logStreamReader.Close()
|
||||||
|
$script:uiState.Data.logStreamReader.Dispose()
|
||||||
|
$script:uiState.Data.logStreamReader = $null
|
||||||
|
}
|
||||||
|
|
||||||
|
# Stop the running build process
|
||||||
|
$processToStop = $script:uiState.Data.currentBuildProcess
|
||||||
|
$script:uiState.Data.currentBuildProcess = $null
|
||||||
|
|
||||||
|
if ($null -ne $processToStop) {
|
||||||
|
# Recursively terminate the build process and any children (DISM, setup tools, etc.)
|
||||||
|
function Stop-ProcessTree {
|
||||||
|
param([int]$parentPid)
|
||||||
|
$children = Get-CimInstance Win32_Process -Filter "ParentProcessId=$parentPid" -ErrorAction SilentlyContinue
|
||||||
|
foreach ($child in $children) {
|
||||||
|
Stop-ProcessTree -parentPid $child.ProcessId
|
||||||
|
}
|
||||||
|
try { Stop-Process -Id $parentPid -Force -ErrorAction SilentlyContinue } catch {}
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
Stop-ProcessTree -parentPid $processToStop.Id
|
||||||
|
WriteLog "Background build process stopped (PID: $($processToStop.Id))."
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
WriteLog "Error terminating build process tree: $($_.Exception.Message)"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# Safety net: kill any active DISM capture still running
|
||||||
|
try {
|
||||||
|
$dismCaptures = Get-CimInstance Win32_Process -Filter "Name='DISM.EXE'" -ErrorAction SilentlyContinue | Where-Object { $_.CommandLine -match '/Capture-FFU' }
|
||||||
|
foreach ($p in $dismCaptures) {
|
||||||
|
try { Stop-Process -Id $p.ProcessId -Force -ErrorAction SilentlyContinue } catch {}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
WriteLog "Error stopping DISM capture processes: $($_.Exception.Message)"
|
||||||
|
}
|
||||||
|
|
||||||
|
# Also stop Office ODT setup.exe if running (to avoid recreating files after cleanup)
|
||||||
|
try {
|
||||||
|
$officePathForKill = $null
|
||||||
|
|
||||||
|
# Prefer explicit UI path
|
||||||
|
$uiOfficePath = $script:uiState.Controls.txtOfficePath.Text
|
||||||
|
if (-not [string]::IsNullOrWhiteSpace($uiOfficePath)) {
|
||||||
|
$officePathForKill = $uiOfficePath
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
# Fall back to the last config path only if known
|
||||||
|
$lastConfigPathLocal = $script:uiState.Data.lastConfigFilePath
|
||||||
|
if (-not [string]::IsNullOrWhiteSpace($lastConfigPathLocal)) {
|
||||||
|
$ffuDevRoot = Split-Path (Split-Path $lastConfigPathLocal -Parent) -Parent
|
||||||
|
if (-not [string]::IsNullOrWhiteSpace($ffuDevRoot)) {
|
||||||
|
$officePathForKill = Join-Path $ffuDevRoot 'Apps\Office'
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# Only proceed when a valid Office folder exists
|
||||||
|
if ($officePathForKill -and (Test-Path -LiteralPath $officePathForKill -PathType Container)) {
|
||||||
|
$setupProcs = Get-CimInstance Win32_Process -Filter "Name='setup.exe'" -ErrorAction SilentlyContinue | Where-Object { $_.ExecutablePath -like "$officePathForKill*" }
|
||||||
|
foreach ($p in $setupProcs) {
|
||||||
|
try { Stop-Process -Id $p.ProcessId -Force -ErrorAction SilentlyContinue } catch {}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
WriteLog "Error stopping Office setup.exe processes: $($_.Exception.Message)"
|
||||||
|
}
|
||||||
|
|
||||||
|
# Start cleanup using the same BuildFFUVM.ps1 via -Cleanup short-circuit
|
||||||
|
$lastConfigPath = $script:uiState.Data.lastConfigFilePath
|
||||||
|
if ([string]::IsNullOrWhiteSpace($lastConfigPath)) {
|
||||||
|
WriteLog "No stored config file path found. Cleanup cannot proceed."
|
||||||
|
$script:uiState.Controls.txtStatus.Text = "Build canceled. No config found for cleanup."
|
||||||
|
$script:uiState.Flags.isBuilding = $false
|
||||||
|
$script:uiState.Flags.isCleanupRunning = $false
|
||||||
|
$btnRun.Content = "Build FFU"
|
||||||
|
$btnRun.IsEnabled = $true
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
$ffuDevPath = Split-Path (Split-Path $lastConfigPath -Parent) -Parent
|
||||||
|
$mainLogPath = Join-Path $ffuDevPath "FFUDevelopment.log"
|
||||||
|
|
||||||
|
WriteLog "Starting cleanup without deleting FFUDevelopment.log (will append new entries)."
|
||||||
|
|
||||||
|
$script:uiState.Controls.txtStatus.Text = "Cancel in progress... Cleaning environment..."
|
||||||
|
WriteLog "Starting cleanup job (BuildFFUVM.ps1 -Cleanup)."
|
||||||
|
|
||||||
|
# Prepare parameters for cleanup
|
||||||
|
# Inform user: in-progress items will be removed; ask whether to also remove other items downloaded during this run
|
||||||
|
$removeCurrentRunToo = $false
|
||||||
|
$promptText = "Cancel requested.`n`nWe'll remove the download currently in progress to avoid partial/corrupt content.`n`nDo you also want to remove other items downloaded during this run? Previously downloaded items will be kept."
|
||||||
|
$result = [System.Windows.MessageBox]::Show($promptText, "Cancel cleanup options", [System.Windows.MessageBoxButton]::YesNo, [System.Windows.MessageBoxImage]::Question)
|
||||||
|
if ($result -eq [System.Windows.MessageBoxResult]::Yes) { $removeCurrentRunToo = $true }
|
||||||
|
|
||||||
|
$cleanupParams = @{
|
||||||
|
ConfigFile = $lastConfigPath
|
||||||
|
Cleanup = $true
|
||||||
|
# Avoid wiping all user content on cancel
|
||||||
|
RemoveApps = $false
|
||||||
|
RemoveUpdates = $false
|
||||||
|
CleanupDrivers = $false
|
||||||
|
# Scoped removal to current run only (optional per user choice)
|
||||||
|
CleanupCurrentRunDownloads = $removeCurrentRunToo
|
||||||
|
}
|
||||||
|
|
||||||
|
# Start cleanup in a separate pwsh process so the UI stays responsive
|
||||||
|
$pwshPath = Join-Path -Path $PSHOME -ChildPath 'pwsh.exe'
|
||||||
|
if (-not (Test-Path -Path $pwshPath)) {
|
||||||
|
$pwshPath = 'pwsh'
|
||||||
|
}
|
||||||
|
|
||||||
|
$cleanupScriptPath = Join-Path -Path $PSScriptRoot -ChildPath 'BuildFFUVM.ps1'
|
||||||
|
|
||||||
|
# Build argument list for cleanup.
|
||||||
|
# -Cleanup is a [switch] in BuildFFUVM.ps1, so do not pass a value after it.
|
||||||
|
# Use -Param:$true/$false syntax for boolean parameters to avoid argument transformation errors.
|
||||||
|
$cleanupArgs = @(
|
||||||
|
'-NoProfile',
|
||||||
|
'-ExecutionPolicy', 'Bypass',
|
||||||
|
'-File', $cleanupScriptPath,
|
||||||
|
'-ConfigFile', $cleanupParams.ConfigFile,
|
||||||
|
'-Cleanup',
|
||||||
|
"-RemoveApps:$($cleanupParams.RemoveApps)",
|
||||||
|
"-RemoveUpdates:$($cleanupParams.RemoveUpdates)",
|
||||||
|
"-CleanupDrivers:$($cleanupParams.CleanupDrivers)",
|
||||||
|
"-CleanupCurrentRunDownloads:$($cleanupParams.CleanupCurrentRunDownloads)"
|
||||||
|
)
|
||||||
|
|
||||||
|
$startCleanupParams = @{
|
||||||
|
FilePath = $pwshPath
|
||||||
|
ArgumentList = $cleanupArgs
|
||||||
|
WorkingDirectory = $ffuDevPath
|
||||||
|
PassThru = $true
|
||||||
|
}
|
||||||
|
if ($Host.Name -eq 'ConsoleHost') {
|
||||||
|
$startCleanupParams['NoNewWindow'] = $true
|
||||||
|
}
|
||||||
|
|
||||||
|
$script:uiState.Data.currentBuildProcess = Start-Process @startCleanupParams
|
||||||
|
|
||||||
|
# Wait for log file to appear (or open immediately if it exists)
|
||||||
|
$logWaitTimeout = 60
|
||||||
|
$watch = [System.Diagnostics.Stopwatch]::StartNew()
|
||||||
|
while (-not (Test-Path $mainLogPath) -and $watch.Elapsed.TotalSeconds -lt $logWaitTimeout) {
|
||||||
|
Start-Sleep -Milliseconds 250
|
||||||
|
}
|
||||||
|
$watch.Stop()
|
||||||
|
|
||||||
|
# Open log stream for cleanup (tail to end to avoid re-reading the whole file)
|
||||||
|
if (Test-Path $mainLogPath) {
|
||||||
|
$fileStream = [System.IO.File]::Open($mainLogPath, 'Open', 'Read', 'ReadWrite')
|
||||||
|
[void]$fileStream.Seek(0, [System.IO.SeekOrigin]::End)
|
||||||
|
$script:uiState.Data.logStreamReader = [System.IO.StreamReader]::new($fileStream)
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
WriteLog "Warning: Main log file not found at $mainLogPath after waiting. Monitor tab will not update during cleanup."
|
||||||
|
}
|
||||||
|
|
||||||
|
# Create a timer to poll the cleanup process
|
||||||
|
$script:uiState.Data.pollTimer = New-Object System.Windows.Threading.DispatcherTimer
|
||||||
|
$script:uiState.Data.pollTimer.Interval = [TimeSpan]::FromSeconds(1)
|
||||||
|
$script:uiState.Flags.isCleanupRunning = $true
|
||||||
|
|
||||||
|
$script:uiState.Data.pollTimer.Add_Tick({
|
||||||
|
param($sender, $e)
|
||||||
|
$currentProcess = $script:uiState.Data.currentBuildProcess
|
||||||
|
|
||||||
|
# Read new lines from log
|
||||||
|
if ($null -ne $script:uiState.Data.logStreamReader) {
|
||||||
|
while ($null -ne ($line = $script:uiState.Data.logStreamReader.ReadLine())) {
|
||||||
|
$script:uiState.Data.logData.Add($line)
|
||||||
|
if ($script:uiState.Flags.autoScrollLog) {
|
||||||
|
$script:uiState.Controls.lstLogOutput.ScrollIntoView($line)
|
||||||
|
$script:uiState.Controls.lstLogOutput.SelectedIndex = $script:uiState.Controls.lstLogOutput.Items.Count - 1
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($null -eq $currentProcess -or $null -eq $script:uiState.Data.pollTimer) {
|
||||||
|
if ($null -ne $sender) { $sender.Stop() }
|
||||||
|
$script:uiState.Data.pollTimer = $null
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($currentProcess.HasExited) {
|
||||||
|
if ($null -ne $sender) { $sender.Stop() }
|
||||||
|
$script:uiState.Data.pollTimer = $null
|
||||||
|
|
||||||
|
if ($null -ne $script:uiState.Data.logStreamReader) {
|
||||||
|
$lastLine = $null
|
||||||
|
while ($null -ne ($line = $script:uiState.Data.logStreamReader.ReadLine())) {
|
||||||
|
$script:uiState.Data.logData.Add($line)
|
||||||
|
$lastLine = $line
|
||||||
|
}
|
||||||
|
if ($script:uiState.Flags.autoScrollLog -and $null -ne $lastLine) {
|
||||||
|
$script:uiState.Controls.lstLogOutput.ScrollIntoView($lastLine)
|
||||||
|
$script:uiState.Controls.lstLogOutput.SelectedIndex = $script:uiState.Controls.lstLogOutput.Items.Count - 1
|
||||||
|
}
|
||||||
|
$script:uiState.Data.logStreamReader.Close()
|
||||||
|
$script:uiState.Data.logStreamReader.Dispose()
|
||||||
|
$script:uiState.Data.logStreamReader = $null
|
||||||
|
}
|
||||||
|
|
||||||
|
$script:uiState.Controls.txtStatus.Text = "Build canceled. Environment cleaned."
|
||||||
|
$script:uiState.Controls.pbOverallProgress.Visibility = 'Collapsed'
|
||||||
|
$script:uiState.Controls.pbOverallProgress.Value = 0
|
||||||
|
|
||||||
|
# Clear cleanup process state
|
||||||
|
$script:uiState.Data.currentBuildProcess = $null
|
||||||
|
|
||||||
|
# Reset flags and button
|
||||||
|
$script:uiState.Flags.isCleanupRunning = $false
|
||||||
|
$script:uiState.Flags.isBuilding = $false
|
||||||
|
$btn = $script:uiState.Controls.btnRun
|
||||||
|
$btn.Content = "Build FFU"
|
||||||
|
$btn.IsEnabled = $true
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
$script:uiState.Data.pollTimer.Start()
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
# Not currently building: start a new build
|
||||||
|
$btnRun.IsEnabled = $false
|
||||||
|
|
||||||
|
# Switch to Monitor page via navigation
|
||||||
|
$monitorIndex = 8 # Monitor is the 9th item (index 8) in the navigation list
|
||||||
|
if ($null -ne $script:uiState.Controls.lstNavigation) {
|
||||||
|
$script:uiState.Controls.lstNavigation.SelectedIndex = $monitorIndex
|
||||||
|
}
|
||||||
|
|
||||||
|
# Clear previous log data and reset autoscroll
|
||||||
|
if ($null -ne $script:uiState.Data.logData) {
|
||||||
|
$script:uiState.Data.logData.Clear()
|
||||||
|
$script:uiState.Flags.autoScrollLog = $true
|
||||||
|
}
|
||||||
|
|
||||||
|
$progressBar = $script:uiState.Controls.pbOverallProgress
|
||||||
|
$txtStatus = $script:uiState.Controls.txtStatus
|
||||||
|
$progressBar.Visibility = 'Visible'
|
||||||
|
$txtStatus.Text = "Starting FFU build..."
|
||||||
|
|
||||||
|
# Gather config on the UI thread before starting the job
|
||||||
|
$config = Get-UIConfig -State $script:uiState
|
||||||
|
|
||||||
|
# Validate Additional FFU selection if enabled
|
||||||
|
if ($config.BuildUSBDrive -and $config.CopyAdditionalFFUFiles -and (($null -eq $config.AdditionalFFUFiles) -or ($config.AdditionalFFUFiles.Count -eq 0))) {
|
||||||
|
[System.Windows.MessageBox]::Show("Please select at least one additional FFU file to copy, or uncheck 'Copy Additional FFU Files'.", "Selection Required", "OK", "Warning") | Out-Null
|
||||||
|
$btnRun.IsEnabled = $true
|
||||||
|
$script:uiState.Controls.txtStatus.Text = "Build canceled: Additional FFU selection required."
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($config.EnableVMNetworking -and $config.InstallApps -and [string]::IsNullOrWhiteSpace([string]$config.VMSwitchName)) {
|
||||||
|
[System.Windows.MessageBox]::Show("Select or enter a VM Switch Name before enabling VM networking.", "VM Switch Required", "OK", "Warning") | Out-Null
|
||||||
|
$btnRun.IsEnabled = $true
|
||||||
|
$script:uiState.Controls.txtStatus.Text = "Build canceled: VM switch required for experimental networking."
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($config.CopyUnattend -and $config.InjectUnattend) {
|
||||||
|
[System.Windows.MessageBox]::Show("Copy Unattend.xml and Inject Unattend.xml cannot both be selected. Choose only one unattend delivery method.", "Unattend Selection Required", "OK", "Warning") | Out-Null
|
||||||
|
$btnRun.IsEnabled = $true
|
||||||
|
$script:uiState.Controls.txtStatus.Text = "Build canceled: choose only one unattend delivery method."
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($config.CopyUnattend -or $config.InjectUnattend) {
|
||||||
|
$selectedUnattendArch = if ($config.WindowsArch -ieq 'arm64') { 'arm64' } else { 'x64' }
|
||||||
|
$selectedUnattendSourcePath = if ($selectedUnattendArch -eq 'arm64') {
|
||||||
|
[string]$config.UnattendArm64FilePath
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
[string]$config.UnattendX64FilePath
|
||||||
|
}
|
||||||
|
|
||||||
|
if ([string]::IsNullOrWhiteSpace($selectedUnattendSourcePath)) {
|
||||||
|
[System.Windows.MessageBox]::Show("Select a valid $selectedUnattendArch unattend XML file before using Copy Unattend.xml or Inject Unattend.xml.", "Unattend File Required", "OK", "Warning") | Out-Null
|
||||||
|
$btnRun.IsEnabled = $true
|
||||||
|
$script:uiState.Controls.txtStatus.Text = "Build canceled: unattend file path required."
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
if (-not (Test-Path -Path $selectedUnattendSourcePath -PathType Leaf)) {
|
||||||
|
[System.Windows.MessageBox]::Show("The selected $selectedUnattendArch unattend XML file was not found:`n$selectedUnattendSourcePath", "Unattend File Missing", "OK", "Warning") | Out-Null
|
||||||
|
$btnRun.IsEnabled = $true
|
||||||
|
$script:uiState.Controls.txtStatus.Text = "Build canceled: unattend file missing."
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
$selectedUnattendFileInfo = Get-Item -Path $selectedUnattendSourcePath -ErrorAction SilentlyContinue
|
||||||
|
if (($null -eq $selectedUnattendFileInfo) -or ($selectedUnattendFileInfo.Length -le 0)) {
|
||||||
|
[System.Windows.MessageBox]::Show("The selected $selectedUnattendArch unattend XML file is empty:`n$selectedUnattendSourcePath", "Unattend File Empty", "OK", "Warning") | Out-Null
|
||||||
|
$btnRun.IsEnabled = $true
|
||||||
|
$script:uiState.Controls.txtStatus.Text = "Build canceled: unattend file empty."
|
||||||
|
return
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($config.DeviceNamingMode -eq 'Prompt') {
|
||||||
|
if (-not $config.CopyUnattend) {
|
||||||
|
[System.Windows.MessageBox]::Show("Select Copy Unattend.xml before using 'Prompt for Device Name'.", "Copy Unattend Required", "OK", "Warning") | Out-Null
|
||||||
|
$btnRun.IsEnabled = $true
|
||||||
|
$script:uiState.Controls.txtStatus.Text = "Build canceled: prompt naming requires Copy Unattend.xml."
|
||||||
|
return
|
||||||
|
}
|
||||||
|
}
|
||||||
|
elseif ($config.DeviceNamingMode -eq 'Template') {
|
||||||
|
if ([string]::IsNullOrWhiteSpace([string]$config.DeviceNameTemplate)) {
|
||||||
|
[System.Windows.MessageBox]::Show("Specify a device name before using 'Specify Device Name'.", "Device Name Required", "OK", "Warning") | Out-Null
|
||||||
|
$btnRun.IsEnabled = $true
|
||||||
|
$script:uiState.Controls.txtStatus.Text = "Build canceled: device name required."
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
if (-not ($config.CopyUnattend -or $config.InjectUnattend)) {
|
||||||
|
[System.Windows.MessageBox]::Show("Select Copy Unattend.xml or Inject Unattend.xml before using 'Specify Device Name'.", "Unattend Selection Required", "OK", "Warning") | Out-Null
|
||||||
|
$btnRun.IsEnabled = $true
|
||||||
|
$script:uiState.Controls.txtStatus.Text = "Build canceled: unattend delivery method required for device naming."
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
$templateWithoutSupportedVariables = ([string]$config.DeviceNameTemplate) -replace '(?i)%serial%', ''
|
||||||
|
if ($templateWithoutSupportedVariables -match '%') {
|
||||||
|
[System.Windows.MessageBox]::Show("Only the %serial% device name variable is supported.", "Unsupported Device Name Variable", "OK", "Warning") | Out-Null
|
||||||
|
$btnRun.IsEnabled = $true
|
||||||
|
$script:uiState.Controls.txtStatus.Text = "Build canceled: unsupported device name variable."
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($config.InjectUnattend -and (-not $config.CopyUnattend) -and ([string]$config.DeviceNameTemplate -match '(?i)%serial%')) {
|
||||||
|
[System.Windows.MessageBox]::Show("The %serial% device name variable is only supported when Copy Unattend.xml is selected.", "Unsupported Inject Unattend Setting", "OK", "Warning") | Out-Null
|
||||||
|
$btnRun.IsEnabled = $true
|
||||||
|
$script:uiState.Controls.txtStatus.Text = "Build canceled: %serial% requires Copy Unattend.xml."
|
||||||
|
return
|
||||||
|
}
|
||||||
|
}
|
||||||
|
elseif ($config.DeviceNamingMode -eq 'Prefixes') {
|
||||||
|
if (-not $config.CopyUnattend) {
|
||||||
|
[System.Windows.MessageBox]::Show("Select Copy Unattend.xml before using 'Specify a list of Prefixes'.", "Copy Unattend Required", "OK", "Warning") | Out-Null
|
||||||
|
$btnRun.IsEnabled = $true
|
||||||
|
$script:uiState.Controls.txtStatus.Text = "Build canceled: prefixes require Copy Unattend.xml."
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
$hasSavedPrefixesPath = -not [string]::IsNullOrWhiteSpace([string]$config.DeviceNamePrefixesPath) -and (Test-Path -Path $config.DeviceNamePrefixesPath -PathType Leaf)
|
||||||
|
if ((($null -eq $config.DeviceNamePrefixes) -or ($config.DeviceNamePrefixes.Count -eq 0)) -and -not $hasSavedPrefixesPath) {
|
||||||
|
[System.Windows.MessageBox]::Show("Enter at least one prefix or choose a valid prefixes file before using 'Specify a list of Prefixes'.", "Prefixes Required", "OK", "Warning") | Out-Null
|
||||||
|
$btnRun.IsEnabled = $true
|
||||||
|
$script:uiState.Controls.txtStatus.Text = "Build canceled: prefixes required."
|
||||||
|
return
|
||||||
|
}
|
||||||
|
}
|
||||||
|
elseif ($config.DeviceNamingMode -eq 'SerialComputerNames') {
|
||||||
|
if (-not $config.CopyUnattend) {
|
||||||
|
[System.Windows.MessageBox]::Show("Select Copy Unattend.xml before using 'Specify Serial to Device Name Mapping'.", "Copy Unattend Required", "OK", "Warning") | Out-Null
|
||||||
|
$btnRun.IsEnabled = $true
|
||||||
|
$script:uiState.Controls.txtStatus.Text = "Build canceled: serial computer-name mapping requires Copy Unattend.xml."
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
$hasSavedSerialComputerNamesPath = -not [string]::IsNullOrWhiteSpace([string]$config.DeviceNameSerialComputerNamesPath) -and (Test-Path -Path $config.DeviceNameSerialComputerNamesPath -PathType Leaf)
|
||||||
|
if ((($null -eq $config.DeviceNameSerialComputerNames) -or ($config.DeviceNameSerialComputerNames.Count -eq 0)) -and -not $hasSavedSerialComputerNamesPath) {
|
||||||
|
[System.Windows.MessageBox]::Show("Enter CSV content or choose a valid Serial Computer Names CSV Mapping File Path before using 'Specify Serial to Device Name Mapping'.", "Serial Mapping Required", "OK", "Warning") | Out-Null
|
||||||
|
$btnRun.IsEnabled = $true
|
||||||
|
$script:uiState.Controls.txtStatus.Text = "Build canceled: serial computer-name mapping required."
|
||||||
|
return
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
$configFilePath = Join-Path $config.FFUDevelopmentPath "\config\FFUConfig.json"
|
||||||
|
# Sort top-level keys alphabetically for consistent output
|
||||||
|
$sortedConfig = [ordered]@{}
|
||||||
|
foreach ($k in ($config.Keys | Sort-Object)) { $sortedConfig[$k] = $config[$k] }
|
||||||
|
$sortedConfig | ConvertTo-Json -Depth 10 | Set-Content -Path $configFilePath -Encoding UTF8
|
||||||
|
$script:uiState.Data.lastConfigFilePath = $configFilePath
|
||||||
|
|
||||||
|
if ($config.InstallOffice -and $config.OfficeConfigXMLFile) {
|
||||||
|
Copy-Item -Path $config.OfficeConfigXMLFile -Destination $config.OfficePath -Force
|
||||||
|
WriteLog "Office Configuration XML file copied successfully."
|
||||||
|
}
|
||||||
|
|
||||||
|
$txtStatus.Text = "Executing BuildFFUVM.ps1 in the background..."
|
||||||
|
WriteLog "Executing BuildFFUVM.ps1 in the background..."
|
||||||
|
|
||||||
|
# Start BuildFFUVM.ps1 in a separate pwsh process.
|
||||||
|
# This keeps the UI responsive and restores console interaction (Write-Host / Read-Host) when available.
|
||||||
|
$pwshPath = Join-Path -Path $PSHOME -ChildPath 'pwsh.exe'
|
||||||
|
if (-not (Test-Path -Path $pwshPath)) {
|
||||||
|
$pwshPath = 'pwsh'
|
||||||
|
}
|
||||||
|
|
||||||
|
$buildScriptPath = Join-Path -Path $PSScriptRoot -ChildPath 'BuildFFUVM.ps1'
|
||||||
|
$pwshArgs = @(
|
||||||
|
'-NoProfile',
|
||||||
|
'-ExecutionPolicy', 'Bypass',
|
||||||
|
'-File', $buildScriptPath,
|
||||||
|
'-ConfigFile', $configFilePath
|
||||||
|
)
|
||||||
|
if ($config.Verbose) {
|
||||||
|
$pwshArgs += '-Verbose'
|
||||||
|
}
|
||||||
|
|
||||||
|
# Delete the old log file before starting the build process to ensure we don't read stale content.
|
||||||
|
$mainLogPath = Join-Path $config.FFUDevelopmentPath "FFUDevelopment.log"
|
||||||
|
if (Test-Path $mainLogPath) {
|
||||||
|
WriteLog "Removing old FFUDevelopment.log file."
|
||||||
|
Remove-Item -Path $mainLogPath -Force
|
||||||
|
}
|
||||||
|
|
||||||
|
$startBuildParams = @{
|
||||||
|
FilePath = $pwshPath
|
||||||
|
ArgumentList = $pwshArgs
|
||||||
|
WorkingDirectory = $config.FFUDevelopmentPath
|
||||||
|
PassThru = $true
|
||||||
|
}
|
||||||
|
if ($Host.Name -eq 'ConsoleHost') {
|
||||||
|
$startBuildParams['NoNewWindow'] = $true
|
||||||
|
}
|
||||||
|
|
||||||
|
# Start the build process and store it in the shared state object
|
||||||
|
$script:uiState.Data.currentBuildProcess = Start-Process @startBuildParams
|
||||||
|
|
||||||
|
# Wait for the new log file to be created by the background process.
|
||||||
|
$logWaitTimeout = 15 # seconds
|
||||||
|
$watch = [System.Diagnostics.Stopwatch]::StartNew()
|
||||||
|
while (-not (Test-Path $mainLogPath) -and $watch.Elapsed.TotalSeconds -lt $logWaitTimeout) {
|
||||||
|
Start-Sleep -Milliseconds 250
|
||||||
|
}
|
||||||
|
$watch.Stop()
|
||||||
|
|
||||||
|
# Open a stream reader to the main log file
|
||||||
|
if (Test-Path $mainLogPath) {
|
||||||
|
$fileStream = [System.IO.File]::Open($mainLogPath, 'Open', 'Read', 'ReadWrite')
|
||||||
|
$script:uiState.Data.logStreamReader = [System.IO.StreamReader]::new($fileStream)
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
WriteLog "Warning: Main log file not found at $mainLogPath after waiting. Monitor tab will not update."
|
||||||
|
}
|
||||||
|
|
||||||
|
# Create a timer to poll the job status from the UI thread
|
||||||
|
$script:uiState.Data.pollTimer = New-Object System.Windows.Threading.DispatcherTimer
|
||||||
|
$script:uiState.Data.pollTimer.Interval = [TimeSpan]::FromSeconds(1)
|
||||||
|
|
||||||
|
# Add the Tick event handler
|
||||||
|
$script:uiState.Data.pollTimer.Add_Tick({
|
||||||
|
param($sender, $e)
|
||||||
|
# This scriptblock runs on the UI thread, so it can safely access script-scoped variables
|
||||||
|
$currentProcess = $script:uiState.Data.currentBuildProcess
|
||||||
|
|
||||||
|
# Read from log stream
|
||||||
|
if ($null -ne $script:uiState.Data.logStreamReader) {
|
||||||
|
while ($null -ne ($line = $script:uiState.Data.logStreamReader.ReadLine())) {
|
||||||
|
# Add the full line to the log view first to maintain consistency
|
||||||
|
$script:uiState.Data.logData.Add($line)
|
||||||
|
if ($script:uiState.Flags.autoScrollLog) {
|
||||||
|
$script:uiState.Controls.lstLogOutput.ScrollIntoView($line)
|
||||||
|
$script:uiState.Controls.lstLogOutput.SelectedIndex = $script:uiState.Controls.lstLogOutput.Items.Count - 1
|
||||||
|
}
|
||||||
|
|
||||||
|
# Now, check if it's a progress line and update the UI accordingly
|
||||||
|
if ($line -match '\[PROGRESS\] (\d{1,3}) \| (.*)') {
|
||||||
|
$percentage = [double]$matches[1]
|
||||||
|
$message = $matches[2]
|
||||||
|
|
||||||
|
# Update progress bar and status text
|
||||||
|
$script:uiState.Controls.pbOverallProgress.Value = $percentage
|
||||||
|
$script:uiState.Controls.txtStatus.Text = $message
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# If process is somehow null or the timer has been nulled out, stop the timer
|
||||||
|
if ($null -eq $currentProcess -or $null -eq $script:uiState.Data.pollTimer) {
|
||||||
|
if ($null -ne $sender) {
|
||||||
|
$sender.Stop()
|
||||||
|
}
|
||||||
|
$script:uiState.Data.pollTimer = $null
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
# Check if the build process has exited
|
||||||
|
if ($currentProcess.HasExited) {
|
||||||
|
# Stop the timer, we're done polling
|
||||||
|
if ($null -ne $sender) {
|
||||||
|
$sender.Stop()
|
||||||
|
}
|
||||||
|
$script:uiState.Data.pollTimer = $null
|
||||||
|
|
||||||
|
# Final read of the log stream
|
||||||
|
if ($null -ne $script:uiState.Data.logStreamReader) {
|
||||||
|
$lastLine = $null
|
||||||
|
while ($null -ne ($line = $script:uiState.Data.logStreamReader.ReadLine())) {
|
||||||
|
# Add the full line to the log view first
|
||||||
|
$script:uiState.Data.logData.Add($line)
|
||||||
|
$lastLine = $line
|
||||||
|
|
||||||
|
# Now, check if it's a progress line and update the UI accordingly
|
||||||
|
if ($line -match '\[PROGRESS\] (\d{1,3}) \| (.*)') {
|
||||||
|
$percentage = [double]$matches[1]
|
||||||
|
$message = $matches[2]
|
||||||
|
|
||||||
|
$script:uiState.Controls.pbOverallProgress.Value = $percentage
|
||||||
|
$script:uiState.Controls.txtStatus.Text = $message
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# After the final read, scroll to the last line if autoscroll is enabled
|
||||||
|
if ($script:uiState.Flags.autoScrollLog -and $null -ne $lastLine) {
|
||||||
|
$script:uiState.Controls.lstLogOutput.ScrollIntoView($lastLine)
|
||||||
|
$script:uiState.Controls.lstLogOutput.SelectedIndex = $script:uiState.Controls.lstLogOutput.Items.Count - 1
|
||||||
|
}
|
||||||
|
|
||||||
|
$script:uiState.Data.logStreamReader.Close()
|
||||||
|
$script:uiState.Data.logStreamReader.Dispose()
|
||||||
|
$script:uiState.Data.logStreamReader = $null
|
||||||
|
}
|
||||||
|
|
||||||
|
$exitCode = $currentProcess.ExitCode
|
||||||
|
|
||||||
|
# Determine final status based on process exit code
|
||||||
|
$finalStatusText = "FFU build completed successfully."
|
||||||
|
if ($exitCode -ne 0) {
|
||||||
|
$finalStatusText = "FFU build failed. Check FFUDevelopment.log for details."
|
||||||
|
WriteLog "BuildFFUVM.ps1 process failed with exit code: $exitCode"
|
||||||
|
[System.Windows.MessageBox]::Show("The build process failed. Please check the $FFUDevelopmentPath\FFUDevelopment.log file for details.`n`nExit code: $exitCode", "Build Error", "OK", "Error") | Out-Null
|
||||||
|
$script:uiState.Controls.pbOverallProgress.Visibility = 'Collapsed'
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
WriteLog "BuildFFUVM.ps1 process completed successfully."
|
||||||
|
$script:uiState.Controls.pbOverallProgress.Value = 100
|
||||||
|
}
|
||||||
|
|
||||||
|
# Update UI elements
|
||||||
|
$script:uiState.Controls.txtStatus.Text = $finalStatusText
|
||||||
|
|
||||||
|
# Clear process state
|
||||||
|
$script:uiState.Data.currentBuildProcess = $null
|
||||||
|
|
||||||
|
# Reset button and flags for next run
|
||||||
|
$script:uiState.Flags.isBuilding = $false
|
||||||
|
$script:uiState.Flags.isCleanupRunning = $false
|
||||||
|
$script:uiState.Controls.btnRun.Content = "Build FFU"
|
||||||
|
$script:uiState.Controls.btnRun.IsEnabled = $true
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
# Start the timer
|
||||||
|
$script:uiState.Data.pollTimer.Start()
|
||||||
|
|
||||||
|
# Mark building and toggle button to Cancel
|
||||||
|
$script:uiState.Flags.isBuilding = $true
|
||||||
|
$btnRun.Content = "Cancel"
|
||||||
|
$btnRun.IsEnabled = $true
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
# This catch block handles errors during the setup of the job (e.g., Get-UIConfig fails)
|
||||||
|
$errorMessage = "An error occurred before starting the build job: $_"
|
||||||
|
WriteLog $errorMessage
|
||||||
|
[System.Windows.MessageBox]::Show($errorMessage, "Error", "OK", "Error")
|
||||||
|
|
||||||
|
# Clean up stream reader if it was opened
|
||||||
|
if ($null -ne $script:uiState.Data.logStreamReader) {
|
||||||
|
$script:uiState.Data.logStreamReader.Close()
|
||||||
|
$script:uiState.Data.logStreamReader.Dispose()
|
||||||
|
$script:uiState.Data.logStreamReader = $null
|
||||||
|
}
|
||||||
|
|
||||||
|
# Re-enable UI elements
|
||||||
|
$script:uiState.Controls.txtStatus.Text = "FFU build failed to start."
|
||||||
|
$script:uiState.Controls.pbOverallProgress.Visibility = 'Collapsed'
|
||||||
|
if ($null -ne $script:uiState.Controls.btnRun) {
|
||||||
|
$script:uiState.Controls.btnRun.IsEnabled = $true
|
||||||
|
$script:uiState.Controls.btnRun.Content = "Build FFU"
|
||||||
|
$script:uiState.Flags.isBuilding = $false
|
||||||
|
$script:uiState.Flags.isCleanupRunning = $false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
# Add handler for Remove button clicks
|
||||||
|
$window.Add_SourceInitialized({
|
||||||
|
$listView = $window.FindName('lstApplications')
|
||||||
|
$listView.AddHandler(
|
||||||
|
[System.Windows.Controls.Button]::ClickEvent,
|
||||||
|
[System.Windows.RoutedEventHandler] {
|
||||||
|
param($buttonSender, $clickEventArgs)
|
||||||
|
if ($clickEventArgs.OriginalSource -is [System.Windows.Controls.Button] -and $clickEventArgs.OriginalSource.Content -eq "Remove") {
|
||||||
|
Remove-Application -priority $clickEventArgs.OriginalSource.Tag -State $script:uiState
|
||||||
|
}
|
||||||
|
}
|
||||||
|
)
|
||||||
|
})
|
||||||
|
|
||||||
|
# Register cleanup to reclaim memory and revert LongPathsEnabled setting when the UI window closes
|
||||||
|
$window.Add_Closed({
|
||||||
|
# Stop any running build process if the window is closed
|
||||||
|
if ($null -ne $script:uiState.Data.currentBuildProcess) {
|
||||||
|
WriteLog "UI closing, stopping background build process."
|
||||||
|
|
||||||
|
# Stop the timer
|
||||||
|
if ($null -ne $script:uiState.Data.pollTimer) {
|
||||||
|
$script:uiState.Data.pollTimer.Stop()
|
||||||
|
$script:uiState.Data.pollTimer = $null
|
||||||
|
}
|
||||||
|
|
||||||
|
# Close the log stream
|
||||||
|
if ($null -ne $script:uiState.Data.logStreamReader) {
|
||||||
|
$script:uiState.Data.logStreamReader.Close()
|
||||||
|
$script:uiState.Data.logStreamReader.Dispose()
|
||||||
|
$script:uiState.Data.logStreamReader = $null
|
||||||
|
}
|
||||||
|
|
||||||
|
$processToStop = $script:uiState.Data.currentBuildProcess
|
||||||
|
$script:uiState.Data.currentBuildProcess = $null
|
||||||
|
|
||||||
|
try {
|
||||||
|
# Terminate the build process and any children
|
||||||
|
function Stop-ProcessTree {
|
||||||
|
param([int]$parentPid)
|
||||||
|
$children = Get-CimInstance Win32_Process -Filter "ParentProcessId=$parentPid" -ErrorAction SilentlyContinue
|
||||||
|
foreach ($child in $children) {
|
||||||
|
Stop-ProcessTree -parentPid $child.ProcessId
|
||||||
|
}
|
||||||
|
try { Stop-Process -Id $parentPid -Force -ErrorAction SilentlyContinue } catch {}
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($null -ne $processToStop -and -not $processToStop.HasExited) {
|
||||||
|
Stop-ProcessTree -parentPid $processToStop.Id
|
||||||
|
}
|
||||||
|
|
||||||
|
WriteLog "Background process stopped."
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
WriteLog "Error stopping background build process: $($_.Exception.Message)"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# Revert LongPathsEnabled registry setting if it was changed by this script
|
||||||
|
if ($script:uiState.Flags.originalLongPathsValue -ne 1) {
|
||||||
|
# Only revert if we changed it from something other than 1
|
||||||
|
try {
|
||||||
|
$currentValue = Get-ItemPropertyValue -Path 'HKLM:\SYSTEM\CurrentControlSet\Control\FileSystem' -Name 'LongPathsEnabled' -ErrorAction SilentlyContinue
|
||||||
|
if ($currentValue -eq 1) {
|
||||||
|
# Double-check it's still 1 before reverting
|
||||||
|
$revertValue = if ($null -eq $script:uiState.Flags.originalLongPathsValue) { 0 } else { $script:uiState.Flags.originalLongPathsValue } # Revert to original or 0 if it didn't exist
|
||||||
|
WriteLog "Reverting LongPathsEnabled registry key back to original value ($revertValue)."
|
||||||
|
Set-ItemProperty -Path 'HKLM:\SYSTEM\CurrentControlSet\Control\FileSystem' -Name 'LongPathsEnabled' -Value $revertValue -Force
|
||||||
|
WriteLog "LongPathsEnabled reverted."
|
||||||
|
}
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
WriteLog "Error reverting LongPathsEnabled registry key: $($_.Exception.Message)."
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# # Garbage collection
|
||||||
|
# [System.GC]::Collect()
|
||||||
|
# [System.GC]::WaitForPendingFinalizers()
|
||||||
|
})
|
||||||
|
|
||||||
|
[void]$window.ShowDialog()
|
||||||
@@ -3,11 +3,8 @@ param (
|
|||||||
[string]$adkPath = 'C:\Program Files (x86)\Windows Kits\10\',
|
[string]$adkPath = 'C:\Program Files (x86)\Windows Kits\10\',
|
||||||
[string]$WindowsArch = 'x64',
|
[string]$WindowsArch = 'x64',
|
||||||
[bool]$CopyPEDrivers = $false,
|
[bool]$CopyPEDrivers = $false,
|
||||||
[string]$CaptureISO = "$PSScriptRoot\WinPE_FFU_Capture_x64.iso",
|
|
||||||
[string]$DeployISO = "$PSScriptRoot\WinPE_FFU_Deploy_x64.iso",
|
[string]$DeployISO = "$PSScriptRoot\WinPE_FFU_Deploy_x64.iso",
|
||||||
[string]$LogFile = "$PSScriptRoot\Create-PEMedia.log",
|
[string]$LogFile = "$PSScriptRoot\Create-PEMedia.log"
|
||||||
[bool]$Capture,
|
|
||||||
[bool]$Deploy = $true
|
|
||||||
)
|
)
|
||||||
|
|
||||||
function WriteLog($LogText) {
|
function WriteLog($LogText) {
|
||||||
@@ -77,12 +74,7 @@ function Invoke-Process {
|
|||||||
}
|
}
|
||||||
|
|
||||||
function New-PEMedia {
|
function New-PEMedia {
|
||||||
param (
|
param ()
|
||||||
[Parameter()]
|
|
||||||
[bool]$Capture,
|
|
||||||
[Parameter()]
|
|
||||||
[bool]$Deploy
|
|
||||||
)
|
|
||||||
#Need to use the Demployment and Imaging tools environment to create winPE media
|
#Need to use the Demployment and Imaging tools environment to create winPE media
|
||||||
$DandIEnv = "$adkPath`Assessment and Deployment Kit\Deployment Tools\DandISetEnv.bat"
|
$DandIEnv = "$adkPath`Assessment and Deployment Kit\Deployment Tools\DandISetEnv.bat"
|
||||||
$WinPEFFUPath = "$FFUDevelopmentPath\WinPE"
|
$WinPEFFUPath = "$FFUDevelopmentPath\WinPE"
|
||||||
@@ -135,36 +127,21 @@ function New-PEMedia {
|
|||||||
Add-WindowsPackage -Path "$WinPEFFUPath\mount" -PackagePath $PackagePath | Out-Null
|
Add-WindowsPackage -Path "$WinPEFFUPath\mount" -PackagePath $PackagePath | Out-Null
|
||||||
WriteLog "Adding package complete"
|
WriteLog "Adding package complete"
|
||||||
}
|
}
|
||||||
If ($Capture) {
|
WriteLog "Copying $FFUDevelopmentPath\WinPEDeployFFUFiles\* to WinPE deploy media"
|
||||||
WriteLog "Copying $FFUDevelopmentPath\WinPECaptureFFUFiles\* to WinPE capture media"
|
Copy-Item -Path "$FFUDevelopmentPath\WinPEDeployFFUFiles\*" -Destination "$WinPEFFUPath\mount" -Recurse -Force | Out-Null
|
||||||
Copy-Item -Path "$FFUDevelopmentPath\WinPECaptureFFUFiles\*" -Destination "$WinPEFFUPath\mount" -Recurse -Force | out-null
|
WriteLog 'Copy complete'
|
||||||
WriteLog "Copy complete"
|
#If $CopyPEDrivers = $true, add drivers to WinPE media using dism
|
||||||
#Remove Bootfix.bin - for BIOS systems, shouldn't be needed, but doesn't hurt to remove for our purposes
|
if ($CopyPEDrivers) {
|
||||||
#Remove-Item -Path "$WinPEFFUPath\media\boot\bootfix.bin" -Force | Out-null
|
WriteLog "Adding drivers to WinPE media"
|
||||||
# $WinPEISOName = 'WinPE_FFU_Capture.iso'
|
try {
|
||||||
$WinPEISOFile = $CaptureISO
|
Add-WindowsDriver -Path "$WinPEFFUPath\Mount" -Driver "$FFUDevelopmentPath\PEDrivers" -Recurse -ErrorAction SilentlyContinue | Out-null
|
||||||
# $Capture = $false
|
|
||||||
}
|
|
||||||
If ($Deploy) {
|
|
||||||
WriteLog "Copying $FFUDevelopmentPath\WinPEDeployFFUFiles\* to WinPE deploy media"
|
|
||||||
Copy-Item -Path "$FFUDevelopmentPath\WinPEDeployFFUFiles\*" -Destination "$WinPEFFUPath\mount" -Recurse -Force | Out-Null
|
|
||||||
WriteLog 'Copy complete'
|
|
||||||
#If $CopyPEDrivers = $true, add drivers to WinPE media using dism
|
|
||||||
if ($CopyPEDrivers) {
|
|
||||||
WriteLog "Adding drivers to WinPE media"
|
|
||||||
try {
|
|
||||||
Add-WindowsDriver -Path "$WinPEFFUPath\Mount" -Driver "$FFUDevelopmentPath\PEDrivers" -Recurse -ErrorAction SilentlyContinue | Out-null
|
|
||||||
}
|
|
||||||
catch {
|
|
||||||
WriteLog 'Some drivers failed to be added to the FFU. This can be expected. Continuing.'
|
|
||||||
}
|
|
||||||
WriteLog "Adding drivers complete"
|
|
||||||
}
|
}
|
||||||
# $WinPEISOName = 'WinPE_FFU_Deploy.iso'
|
catch {
|
||||||
$WinPEISOFile = $DeployISO
|
WriteLog 'Some drivers failed to be added to the FFU. This can be expected. Continuing.'
|
||||||
|
}
|
||||||
# $Deploy = $false
|
WriteLog "Adding drivers complete"
|
||||||
}
|
}
|
||||||
|
$WinPEISOFile = $DeployISO
|
||||||
WriteLog 'Dismounting WinPE media'
|
WriteLog 'Dismounting WinPE media'
|
||||||
Dismount-WindowsImage -Path "$WinPEFFUPath\mount" -Save | Out-Null
|
Dismount-WindowsImage -Path "$WinPEFFUPath\mount" -Save | Out-Null
|
||||||
WriteLog 'Dismount complete'
|
WriteLog 'Dismount complete'
|
||||||
@@ -179,21 +156,10 @@ function New-PEMedia {
|
|||||||
WriteLog "Creating WinPE ISO at $WinPEISOFile"
|
WriteLog "Creating WinPE ISO at $WinPEISOFile"
|
||||||
# & "$OSCDIMG" -m -o -u2 -udfver102 -bootdata:2`#p0,e,b$OSCDIMGPath\etfsboot.com`#pEF,e,b$OSCDIMGPath\Efisys_noprompt.bin $WinPEFFUPath\media $FFUDevelopmentPath\$WinPEISOName | Out-null
|
# & "$OSCDIMG" -m -o -u2 -udfver102 -bootdata:2`#p0,e,b$OSCDIMGPath\etfsboot.com`#pEF,e,b$OSCDIMGPath\Efisys_noprompt.bin $WinPEFFUPath\media $FFUDevelopmentPath\$WinPEISOName | Out-null
|
||||||
if($WindowsArch -eq 'x64'){
|
if($WindowsArch -eq 'x64'){
|
||||||
if($Capture){
|
$OSCDIMGArgs = "-m -o -u2 -udfver102 -bootdata:2`#p0,e,b`"$OSCDIMGPath\etfsboot.com`"`#pEF,e,b`"$OSCDIMGPath\Efisys.bin`" `"$WinPEFFUPath\media`" `"$WinPEISOFile`""
|
||||||
$OSCDIMGArgs = "-m -o -u2 -udfver102 -bootdata:2`#p0,e,b`"$OSCDIMGPath\etfsboot.com`"`#pEF,e,b`"$OSCDIMGPath\Efisys_noprompt.bin`" `"$WinPEFFUPath\media`" `"$WinPEISOFile`""
|
|
||||||
}
|
|
||||||
if($Deploy){
|
|
||||||
$OSCDIMGArgs = "-m -o -u2 -udfver102 -bootdata:2`#p0,e,b`"$OSCDIMGPath\etfsboot.com`"`#pEF,e,b`"$OSCDIMGPath\Efisys.bin`" `"$WinPEFFUPath\media`" `"$WinPEISOFile`""
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
elseif($WindowsArch -eq 'arm64'){
|
elseif($WindowsArch -eq 'arm64'){
|
||||||
if($Capture){
|
$OSCDIMGArgs = "-m -o -u2 -udfver102 -bootdata:1`#pEF,e,b`"$OSCDIMGPath\Efisys.bin`" `"$WinPEFFUPath\media`" `"$WinPEISOFile`""
|
||||||
$OSCDIMGArgs = "-m -o -u2 -udfver102 -bootdata:1`#pEF,e,b`"$OSCDIMGPath\Efisys_noprompt.bin`" `"$WinPEFFUPath\media`" `"$WinPEISOFile`""
|
|
||||||
}
|
|
||||||
if($Deploy){
|
|
||||||
$OSCDIMGArgs = "-m -o -u2 -udfver102 -bootdata:1`#pEF,e,b`"$OSCDIMGPath\Efisys.bin`" `"$WinPEFFUPath\media`" `"$WinPEISOFile`""
|
|
||||||
}
|
|
||||||
|
|
||||||
}
|
}
|
||||||
Invoke-Process $OSCDIMG $OSCDIMGArgs
|
Invoke-Process $OSCDIMG $OSCDIMGArgs
|
||||||
WriteLog "ISO created successfully"
|
WriteLog "ISO created successfully"
|
||||||
@@ -201,9 +167,4 @@ function New-PEMedia {
|
|||||||
Remove-Item -Path "$WinPEFFUPath" -Recurse -Force
|
Remove-Item -Path "$WinPEFFUPath" -Recurse -Force
|
||||||
WriteLog 'Cleanup complete'
|
WriteLog 'Cleanup complete'
|
||||||
}
|
}
|
||||||
if($Capture){
|
New-PEMedia
|
||||||
New-PEMedia -Capture $Capture
|
|
||||||
}
|
|
||||||
if($Deploy){
|
|
||||||
New-PEMedia -Deploy $Deploy
|
|
||||||
}
|
|
||||||
@@ -0,0 +1,126 @@
|
|||||||
|
```mermaid
|
||||||
|
graph TD
|
||||||
|
subgraph "Start & Initialization"
|
||||||
|
A[Start] --> B{Load ConfigFile?};
|
||||||
|
B --> C[Process Parameters];
|
||||||
|
C --> D{Validate Parameters};
|
||||||
|
D --> E{"dirty.txt exists?"};
|
||||||
|
E -- Yes --> F[Run Cleanup Routine];
|
||||||
|
F --> G["Create new dirty.txt"];
|
||||||
|
E -- No --> G;
|
||||||
|
end
|
||||||
|
|
||||||
|
G --> H{"-InstallDrivers or -CopyDrivers?"};
|
||||||
|
|
||||||
|
subgraph "Pre-Build Preparations"
|
||||||
|
H -- Yes --> I{Driver Source?};
|
||||||
|
I -- "-DriversJsonPath" --> J[Download Drivers via JSON in Parallel];
|
||||||
|
I -- "-Make and -Model" --> K[Download Drivers for specific Make/Model];
|
||||||
|
I -- "Local Folder" --> L[Use Existing Drivers in Drivers Folder];
|
||||||
|
|
||||||
|
subgraph "ADK & WinPE"
|
||||||
|
M[Check for ADK & WinPE Add-on];
|
||||||
|
M --> N{Latest Version Installed?};
|
||||||
|
N -- No --> O[Uninstall Old & Install Latest ADK/WinPE];
|
||||||
|
N -- Yes --> P[Get ADK Path];
|
||||||
|
O --> P;
|
||||||
|
end
|
||||||
|
|
||||||
|
Q{"-InstallApps?"};
|
||||||
|
subgraph "Application & In-VM Content Preparation"
|
||||||
|
direction LR
|
||||||
|
R[Check for existing downloaded apps];
|
||||||
|
R --> S{Download missing WinGet apps};
|
||||||
|
S --> T{"-InstallOffice?"};
|
||||||
|
T -- Yes --> U[Download ODT & Office content];
|
||||||
|
T -- No --> V[Continue];
|
||||||
|
U --> V;
|
||||||
|
V --> W["Download in-VM updates: Defender, MSRT, etc."];
|
||||||
|
W --> X["Create Apps.iso"];
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
J --> M;
|
||||||
|
K --> M;
|
||||||
|
L --> M;
|
||||||
|
H -- No --> M;
|
||||||
|
P --> Q;
|
||||||
|
Q -- Yes --> R;
|
||||||
|
X --> Y;
|
||||||
|
Q -- No --> Y{"-AllowVHDXCaching?"};
|
||||||
|
|
||||||
|
subgraph "VHDX Management"
|
||||||
|
Y -- Yes --> Z[Check for matching cached VHDX];
|
||||||
|
Z --> AA{Cache Hit?};
|
||||||
|
AA -- Yes --> AB[Use Cached VHDX];
|
||||||
|
AA -- No --> AC[Create New VHDX];
|
||||||
|
Y -- No --> AC;
|
||||||
|
|
||||||
|
subgraph "VHDX Creation Workflow"
|
||||||
|
AC --> AD{ISOPath provided?};
|
||||||
|
AD -- No --> AE[Download Windows ESD media];
|
||||||
|
AD -- Yes --> AF[Use provided ISO];
|
||||||
|
AE --> AG[Create & Partition VHDX];
|
||||||
|
AF --> AG;
|
||||||
|
AG --> AH[Apply Base Windows Image to VHDX];
|
||||||
|
AH --> AI{"Updates specified? (CU, dotNET, etc.)"};
|
||||||
|
AI -- Yes --> AJ[Apply Updates to Offline VHDX];
|
||||||
|
AJ --> AK[Run Component Cleanup];
|
||||||
|
AI -- No --> AK;
|
||||||
|
AK --> AL{"Optional Features specified?"};
|
||||||
|
AL -- Yes --> AM[Enable Optional Features];
|
||||||
|
AL -- No --> AN[Finalize VHDX Setup];
|
||||||
|
AM --> AN;
|
||||||
|
AN --> AO{"-AllowVHDXCaching?"};
|
||||||
|
AO -- Yes --> AP[Optimize and Copy VHDX to Cache];
|
||||||
|
AO -- No --> AQ[Continue];
|
||||||
|
AP --> AQ;
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
AB --> BA;
|
||||||
|
AQ --> BA{"-InstallApps?"};
|
||||||
|
|
||||||
|
subgraph "FFU Creation"
|
||||||
|
subgraph "VM-Based Capture (-InstallApps)"
|
||||||
|
direction LR
|
||||||
|
BB[Create Hyper-V VM from VHDX];
|
||||||
|
BB --> BE["Start VM: Boots to Audit Mode"];
|
||||||
|
BE --> BF[Orchestrator runs: Installs apps, syspreps, shuts down];
|
||||||
|
BF --> BG[Host optimizes and remounts VHDX];
|
||||||
|
BG --> BH["DISM captures FFU directly from host-mounted VHDX"];
|
||||||
|
end
|
||||||
|
|
||||||
|
subgraph "Direct VHDX Capture"
|
||||||
|
BI[Capture FFU directly from VHDX using DISM];
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
BA -- Yes --> BB;
|
||||||
|
BA -- No --> BI;
|
||||||
|
|
||||||
|
subgraph "Post-Processing & Media Creation"
|
||||||
|
BK{"-InstallDrivers?"};
|
||||||
|
BK -- Yes --> BL[Mount FFU & Inject Drivers];
|
||||||
|
BK -- No --> BM[Continue];
|
||||||
|
BL --> BM;
|
||||||
|
BM --> BN{"-Optimize?"};
|
||||||
|
BN -- Yes --> BO[Optimize FFU using DISM];
|
||||||
|
BN -- No --> BP[Continue];
|
||||||
|
BO --> BP;
|
||||||
|
BP --> BQ{"-BuildUSBDrive?"};
|
||||||
|
BQ -- Yes --> BR[Create WinPE Deployment Media];
|
||||||
|
BR --> BS["Partition USB Drive(s)"];
|
||||||
|
BS --> BT[Copy FFU, Deploy scripts & other assets to USB];
|
||||||
|
BQ -- No --> BU[Continue];
|
||||||
|
BT --> BU;
|
||||||
|
end
|
||||||
|
|
||||||
|
BH --> BK;
|
||||||
|
BI --> BK;
|
||||||
|
|
||||||
|
subgraph "Final Cleanup"
|
||||||
|
BU --> BV[Cleanup VM, VHDX, temp files];
|
||||||
|
BV --> BW["Remove dirty.txt"];
|
||||||
|
BW --> BX[End];
|
||||||
|
end
|
||||||
@@ -0,0 +1,140 @@
|
|||||||
|
# Provides shared cleanup functionality for both UI and build script.
|
||||||
|
|
||||||
|
function Invoke-FFUPostBuildCleanup {
|
||||||
|
param(
|
||||||
|
[string]$RootPath,
|
||||||
|
[string]$AppsPath,
|
||||||
|
[string]$DriversPath,
|
||||||
|
[string]$FFUCapturePath,
|
||||||
|
[string]$DeployISOPath,
|
||||||
|
[string]$AppsISOPath,
|
||||||
|
[string]$KBPath,
|
||||||
|
[bool]$RemoveDeployISO = $false,
|
||||||
|
[bool]$RemoveAppsISO = $false,
|
||||||
|
[bool]$RemoveDrivers = $false,
|
||||||
|
[bool]$RemoveFFU = $false,
|
||||||
|
[bool]$RemoveApps = $false,
|
||||||
|
[bool]$RemoveUpdates = $false,
|
||||||
|
[bool]$RemoveDownloadedESD = $false
|
||||||
|
)
|
||||||
|
$originalProgressPreference = $ProgressPreference
|
||||||
|
$ProgressPreference = 'SilentlyContinue'
|
||||||
|
try {
|
||||||
|
WriteLog "CommonCleanup: Starting cleanup (DeployISO=$RemoveDeployISO AppsISO=$RemoveAppsISO Drivers=$RemoveDrivers FFU=$RemoveFFU Apps=$RemoveApps Updates=$RemoveUpdates RemoveDownloadedESD=$RemoveDownloadedESD KBPath=$KBPath)."
|
||||||
|
|
||||||
|
# Primary ISO paths (new naming/location)
|
||||||
|
if ($RemoveDeployISO -and -not [string]::IsNullOrWhiteSpace($DeployISOPath) -and (Test-Path -LiteralPath $DeployISOPath)) {
|
||||||
|
WriteLog "CommonCleanup: Removing $DeployISOPath"
|
||||||
|
try { Remove-Item -LiteralPath $DeployISOPath -Force -ErrorAction Stop } catch { WriteLog "CommonCleanup: Failed removing $DeployISOPath : $($_.Exception.Message)" }
|
||||||
|
}
|
||||||
|
if ($RemoveAppsISO -and -not [string]::IsNullOrWhiteSpace($AppsISOPath) -and (Test-Path -LiteralPath $AppsISOPath)) {
|
||||||
|
WriteLog "CommonCleanup: Removing $AppsISOPath"
|
||||||
|
try { Remove-Item -LiteralPath $AppsISOPath -Force -ErrorAction Stop } catch { WriteLog "CommonCleanup: Failed removing $AppsISOPath : $($_.Exception.Message)" }
|
||||||
|
}
|
||||||
|
|
||||||
|
# Legacy / root-level WinPE ISOs (pattern-based)
|
||||||
|
if ($RemoveDeployISO) {
|
||||||
|
Get-ChildItem -LiteralPath $RootPath -Filter 'WinPE_FFU_Deploy*.iso' -ErrorAction SilentlyContinue | ForEach-Object {
|
||||||
|
try { WriteLog "CommonCleanup: Removing legacy deploy ISO $($_.FullName)"; Remove-Item -LiteralPath $_.FullName -Force -ErrorAction Stop } catch { WriteLog "CommonCleanup: Failed removing legacy deploy ISO $($_.FullName) : $($_.Exception.Message)" }
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($RemoveDrivers -and -not [string]::IsNullOrWhiteSpace($DriversPath) -and (Test-Path -LiteralPath $DriversPath -PathType Container)) {
|
||||||
|
WriteLog "CommonCleanup: Removing contents of $DriversPath (preserving Drivers.json and DriverMapping.json)"
|
||||||
|
try {
|
||||||
|
# Preserve drivers json files
|
||||||
|
$driverItems = Get-ChildItem -LiteralPath $DriversPath -Force -ErrorAction SilentlyContinue | Where-Object { @('Drivers.json', 'DriverMapping.json') -notcontains $_.Name }
|
||||||
|
if ($driverItems) {
|
||||||
|
$driverItems | Remove-Item -Force -Recurse -ErrorAction SilentlyContinue
|
||||||
|
}
|
||||||
|
}
|
||||||
|
catch { WriteLog "CommonCleanup: Driver content cleanup issue: $($_.Exception.Message)" }
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($RemoveFFU -and -not [string]::IsNullOrWhiteSpace($FFUCapturePath) -and (Test-Path -LiteralPath $FFUCapturePath -PathType Container)) {
|
||||||
|
WriteLog "CommonCleanup: Removing FFU files in $FFUCapturePath"
|
||||||
|
Get-ChildItem -LiteralPath $FFUCapturePath -Filter *.ffu -ErrorAction SilentlyContinue | ForEach-Object {
|
||||||
|
try { Remove-Item -LiteralPath $_.FullName -Force -ErrorAction Stop } catch { WriteLog "CommonCleanup: Failed removing FFU $($_.FullName) : $($_.Exception.Message)" }
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($RemoveApps -and -not [string]::IsNullOrWhiteSpace($AppsPath) -and (Test-Path -LiteralPath $AppsPath -PathType Container)) {
|
||||||
|
$win32 = Join-Path $AppsPath 'Win32'
|
||||||
|
$store = Join-Path $AppsPath 'MSStore'
|
||||||
|
if (Test-Path -LiteralPath $win32) {
|
||||||
|
WriteLog "CommonCleanup: Removing $win32"
|
||||||
|
try { Remove-Item -LiteralPath $win32 -Recurse -Force -ErrorAction Stop } catch { WriteLog "CommonCleanup: Failed removing $win32 : $($_.Exception.Message)" }
|
||||||
|
}
|
||||||
|
if (Test-Path -LiteralPath $store) {
|
||||||
|
WriteLog "CommonCleanup: Removing $store"
|
||||||
|
try { Remove-Item -LiteralPath $store -Recurse -Force -ErrorAction Stop } catch { WriteLog "CommonCleanup: Failed removing $store : $($_.Exception.Message)" }
|
||||||
|
}
|
||||||
|
$office = Join-Path $AppsPath 'Office'
|
||||||
|
if ((Test-Path -LiteralPath $office) -and $InstallOffice) {
|
||||||
|
WriteLog "CommonCleanup: Checking for Office artifacts in $office"
|
||||||
|
$officeSub = Join-Path $office 'Office'
|
||||||
|
if (Test-Path -LiteralPath $officeSub) {
|
||||||
|
WriteLog "CommonCleanup: Removing $officeSub"
|
||||||
|
try { Remove-Item -LiteralPath $officeSub -Recurse -Force -ErrorAction Stop } catch { WriteLog "CommonCleanup: Failed removing $officeSub : $($_.Exception.Message)" }
|
||||||
|
}
|
||||||
|
$setupExe = Join-Path $office 'setup.exe'
|
||||||
|
if (Test-Path -LiteralPath $setupExe) {
|
||||||
|
WriteLog "CommonCleanup: Removing $setupExe"
|
||||||
|
try { Remove-Item -LiteralPath $setupExe -Force -ErrorAction Stop } catch { WriteLog "CommonCleanup: Failed removing $setupExe : $($_.Exception.Message)" }
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# Always remove LTSC update staging folder (out-of-band cleanup exception)
|
||||||
|
if (-not [string]::IsNullOrWhiteSpace($AppsPath) -and (Test-Path -LiteralPath $AppsPath -PathType Container)) {
|
||||||
|
$ltscUpdateFolder = Join-Path $AppsPath 'LTSCUpdate'
|
||||||
|
if (Test-Path -LiteralPath $ltscUpdateFolder) {
|
||||||
|
WriteLog "CommonCleanup: Removing LTSC update staging folder $ltscUpdateFolder"
|
||||||
|
try { Remove-Item -LiteralPath $ltscUpdateFolder -Recurse -Force -ErrorAction Stop } catch { WriteLog "CommonCleanup: Failed removing $ltscUpdateFolder : $($_.Exception.Message)" }
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($RemoveUpdates) {
|
||||||
|
if (-not [string]::IsNullOrWhiteSpace($AppsPath) -and (Test-Path -LiteralPath $AppsPath)) {
|
||||||
|
# Remove per-run app update payloads stored under Apps
|
||||||
|
$appUpdateDirs = @('Defender', 'Edge', 'MSRT', 'OneDrive')
|
||||||
|
foreach ($d in $appUpdateDirs) {
|
||||||
|
$target = Join-Path $AppsPath $d
|
||||||
|
if (Test-Path -LiteralPath $target) {
|
||||||
|
WriteLog "CommonCleanup: Removing update folder $target"
|
||||||
|
try { Remove-Item -LiteralPath $target -Recurse -Force -ErrorAction Stop } catch { WriteLog "CommonCleanup: Failed removing $target : $($_.Exception.Message)" }
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if (-not [string]::IsNullOrWhiteSpace($KBPath) -and (Test-Path -LiteralPath $KBPath)) {
|
||||||
|
# Remove Windows/.NET CU downloads stored under KB
|
||||||
|
WriteLog "CommonCleanup: Removing downloaded updates in $KBPath"
|
||||||
|
try { Remove-Item -LiteralPath $KBPath -Recurse -Force -ErrorAction Stop } catch { WriteLog "CommonCleanup: Failed removing $KBPath : $($_.Exception.Message)" }
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# Remove downloaded ESD files from the root path when requested
|
||||||
|
if ($RemoveDownloadedESD -and -not [string]::IsNullOrWhiteSpace($RootPath) -and (Test-Path -LiteralPath $RootPath -PathType Container)) {
|
||||||
|
WriteLog "CommonCleanup: Removing downloaded ESD files in $RootPath"
|
||||||
|
Get-ChildItem -LiteralPath $RootPath -Filter *.esd -File -ErrorAction SilentlyContinue | ForEach-Object {
|
||||||
|
try {
|
||||||
|
WriteLog "CommonCleanup: Removing ESD $($_.FullName)"
|
||||||
|
Remove-Item -LiteralPath $_.FullName -Force -ErrorAction Stop
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
WriteLog "CommonCleanup: Failed removing ESD $($_.FullName) : $($_.Exception.Message)"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
WriteLog "CommonCleanup: Completed."
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
WriteLog "CommonCleanup: Fatal cleanup error $($_.Exception.Message)"
|
||||||
|
}
|
||||||
|
finally {
|
||||||
|
$ProgressPreference = $originalProgressPreference
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
Export-ModuleMember -Function Invoke-FFUPostBuildCleanup
|
||||||
@@ -0,0 +1,381 @@
|
|||||||
|
<#
|
||||||
|
.SYNOPSIS
|
||||||
|
Provides core, shared functions for logging, process execution, and resilient file transfers used across the FFU project.
|
||||||
|
.DESCRIPTION
|
||||||
|
This module is a central component of the FFU project, offering a set of robust, reusable functions.
|
||||||
|
It includes a centralized logging mechanism (WriteLog), a wrapper for running external processes with error handling (Invoke-Process),
|
||||||
|
a retry-aware BITS transfer function for reliable downloads (Start-BitsTransferWithRetry), and a progress reporting helper.
|
||||||
|
This module is designed to be imported by other scripts and modules within the project to ensure consistent behavior for common tasks.
|
||||||
|
#>
|
||||||
|
# Script-scoped variable for the log file path
|
||||||
|
$script:CommonCoreLogFilePath = $null
|
||||||
|
# Mutex for log file access
|
||||||
|
$script:commonCoreLogMutexName = "Global\FFUCommonCoreLogMutex" # Unique name
|
||||||
|
$script:commonCoreLogMutex = New-Object System.Threading.Mutex($false, $script:commonCoreLogMutexName)
|
||||||
|
$script:BitsTransferPriority = 'Normal'
|
||||||
|
if (-not [string]::IsNullOrWhiteSpace($env:FFU_BITS_PRIORITY)) {
|
||||||
|
$script:BitsTransferPriority = $env:FFU_BITS_PRIORITY
|
||||||
|
}
|
||||||
|
|
||||||
|
# Function to set the log file path for this module
|
||||||
|
function Set-CommonCoreLogPath {
|
||||||
|
[CmdletBinding()]
|
||||||
|
param(
|
||||||
|
[Parameter(Mandatory = $true)]
|
||||||
|
[string]$Path
|
||||||
|
)
|
||||||
|
$script:CommonCoreLogFilePath = $Path
|
||||||
|
if (-not [string]::IsNullOrWhiteSpace($script:CommonCoreLogFilePath)) {
|
||||||
|
# This initial WriteLog confirms the path is set and the logger is working.
|
||||||
|
WriteLog "CommonCoreLogPath set to: $script:CommonCoreLogFilePath"
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
# This Write-Warning will appear on console if path is bad, but won't go to log file yet.
|
||||||
|
Write-Warning "Set-CommonCoreLogPath called with an empty or null path."
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function Set-BitsTransferPriority {
|
||||||
|
[CmdletBinding()]
|
||||||
|
param(
|
||||||
|
[Parameter(Mandatory = $true)]
|
||||||
|
[ValidateSet('Foreground', 'High', 'Normal', 'Low')]
|
||||||
|
[string]$Priority
|
||||||
|
)
|
||||||
|
$script:BitsTransferPriority = $Priority
|
||||||
|
try {
|
||||||
|
Set-Item -Path Env:FFU_BITS_PRIORITY -Value $Priority -ErrorAction Stop
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
WriteLog "Failed to set FFU_BITS_PRIORITY environment variable: $($_.Exception.Message)"
|
||||||
|
}
|
||||||
|
WriteLog "BITS transfer priority set to $Priority."
|
||||||
|
}
|
||||||
|
|
||||||
|
# Centralized WriteLog function
|
||||||
|
function WriteLog {
|
||||||
|
[CmdletBinding()]
|
||||||
|
param(
|
||||||
|
[Parameter(Mandatory = $true)]
|
||||||
|
[string]$LogText
|
||||||
|
)
|
||||||
|
|
||||||
|
# Check if the log file path has been set
|
||||||
|
if ([string]::IsNullOrWhiteSpace($script:CommonCoreLogFilePath)) {
|
||||||
|
Write-Warning "CommonCoreLogFilePath not set. Message: $LogText"
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
$logEntry = "$((Get-Date).ToString()) $LogText"
|
||||||
|
$streamWriter = $null
|
||||||
|
|
||||||
|
try {
|
||||||
|
$script:commonCoreLogMutex.WaitOne() | Out-Null
|
||||||
|
# Ensure directory exists before writing
|
||||||
|
$logDir = Split-Path -Path $script:CommonCoreLogFilePath -Parent
|
||||||
|
if (-not (Test-Path -Path $logDir -PathType Container)) {
|
||||||
|
New-Item -Path $logDir -ItemType Directory -Force -ErrorAction SilentlyContinue | Out-Null
|
||||||
|
}
|
||||||
|
$streamWriter = New-Object System.IO.StreamWriter($script:CommonCoreLogFilePath, $true, [System.Text.Encoding]::UTF8)
|
||||||
|
$streamWriter.WriteLine($logEntry)
|
||||||
|
|
||||||
|
Write-Verbose $LogText
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
# Use Write-Host for console visibility as Write-Warning might also try to log
|
||||||
|
Write-Host "WARNING: Error writing to log file '$($script:CommonCoreLogFilePath)': $($_.Exception.Message)" -ForegroundColor Yellow
|
||||||
|
}
|
||||||
|
finally {
|
||||||
|
if ($null -ne $streamWriter) {
|
||||||
|
$streamWriter.Dispose()
|
||||||
|
}
|
||||||
|
$script:commonCoreLogMutex.ReleaseMutex()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function Invoke-Process {
|
||||||
|
[CmdletBinding(SupportsShouldProcess)]
|
||||||
|
param
|
||||||
|
(
|
||||||
|
[Parameter(Mandatory)]
|
||||||
|
[ValidateNotNullOrEmpty()]
|
||||||
|
[string]$FilePath,
|
||||||
|
|
||||||
|
[Parameter()]
|
||||||
|
[ValidateNotNullOrEmpty()]
|
||||||
|
[string[]]$ArgumentList,
|
||||||
|
|
||||||
|
[Parameter()]
|
||||||
|
[ValidateNotNullOrEmpty()]
|
||||||
|
[bool]$Wait = $true
|
||||||
|
)
|
||||||
|
|
||||||
|
$ErrorActionPreference = 'Stop'
|
||||||
|
|
||||||
|
try {
|
||||||
|
$stdOutTempFile = "$env:TEMP\$((New-Guid).Guid)"
|
||||||
|
$stdErrTempFile = "$env:TEMP\$((New-Guid).Guid)"
|
||||||
|
|
||||||
|
$startProcessParams = @{
|
||||||
|
FilePath = $FilePath
|
||||||
|
ArgumentList = $ArgumentList
|
||||||
|
RedirectStandardError = $stdErrTempFile
|
||||||
|
RedirectStandardOutput = $stdOutTempFile
|
||||||
|
Wait = $($Wait);
|
||||||
|
PassThru = $true;
|
||||||
|
NoNewWindow = $true;
|
||||||
|
}
|
||||||
|
if ($PSCmdlet.ShouldProcess("Process [$($FilePath)]", "Run with args: [$($ArgumentList)]")) {
|
||||||
|
$cmd = Start-Process @startProcessParams
|
||||||
|
$cmdOutput = Get-Content -Path $stdOutTempFile -Raw
|
||||||
|
$cmdError = Get-Content -Path $stdErrTempFile -Raw
|
||||||
|
if ($cmd.ExitCode -ne 0 -and $wait -eq $true) {
|
||||||
|
if ($cmdError) {
|
||||||
|
throw $cmdError.Trim()
|
||||||
|
}
|
||||||
|
if ($cmdOutput) {
|
||||||
|
throw $cmdOutput.Trim()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
if ([string]::IsNullOrEmpty($cmdOutput) -eq $false) {
|
||||||
|
WriteLog $cmdOutput
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
#$PSCmdlet.ThrowTerminatingError($_)
|
||||||
|
WriteLog $_
|
||||||
|
# Write-Host "Script failed - $Logfile for more info"
|
||||||
|
throw $_
|
||||||
|
|
||||||
|
}
|
||||||
|
finally {
|
||||||
|
Remove-Item -Path $stdOutTempFile, $stdErrTempFile -Force -ErrorAction Ignore
|
||||||
|
}
|
||||||
|
return $cmd
|
||||||
|
}
|
||||||
|
|
||||||
|
function Get-RunManifestPathForDownloadTarget {
|
||||||
|
[CmdletBinding()]
|
||||||
|
param(
|
||||||
|
[Parameter(Mandatory = $true)]
|
||||||
|
[string]$Destination
|
||||||
|
)
|
||||||
|
|
||||||
|
try {
|
||||||
|
$currentPath = Split-Path -Path $Destination -Parent
|
||||||
|
if ([string]::IsNullOrWhiteSpace($currentPath)) { return $null }
|
||||||
|
|
||||||
|
while ($currentPath) {
|
||||||
|
$manifestPath = Join-Path -Path $currentPath -ChildPath '.session\currentRun.json'
|
||||||
|
if (Test-Path -LiteralPath $manifestPath -PathType Leaf) {
|
||||||
|
return $manifestPath
|
||||||
|
}
|
||||||
|
|
||||||
|
$parentPath = Split-Path -Path $currentPath -Parent
|
||||||
|
if ([string]::IsNullOrWhiteSpace($parentPath) -or $parentPath -eq $currentPath) {
|
||||||
|
break
|
||||||
|
}
|
||||||
|
$currentPath = $parentPath
|
||||||
|
}
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
WriteLog "Get-RunManifestPathForDownloadTarget failed for '$Destination': $($_.Exception.Message)"
|
||||||
|
}
|
||||||
|
|
||||||
|
return $null
|
||||||
|
}
|
||||||
|
|
||||||
|
function Register-CurrentRunDownloadTarget {
|
||||||
|
[CmdletBinding()]
|
||||||
|
param(
|
||||||
|
[Parameter(Mandatory = $true)]
|
||||||
|
[string]$Destination
|
||||||
|
)
|
||||||
|
|
||||||
|
if ([string]::IsNullOrWhiteSpace($Destination)) { return }
|
||||||
|
|
||||||
|
$manifestPath = Get-RunManifestPathForDownloadTarget -Destination $Destination
|
||||||
|
if ([string]::IsNullOrWhiteSpace($manifestPath)) { return }
|
||||||
|
|
||||||
|
$mutexName = 'Global\FFUCurrentRunDownloadTargetsMutex'
|
||||||
|
$mutex = New-Object System.Threading.Mutex($false, $mutexName)
|
||||||
|
|
||||||
|
try {
|
||||||
|
$null = $mutex.WaitOne()
|
||||||
|
|
||||||
|
$manifest = Get-Content -LiteralPath $manifestPath -Raw -ErrorAction Stop | ConvertFrom-Json -ErrorAction Stop
|
||||||
|
if ($null -eq $manifest) { return }
|
||||||
|
|
||||||
|
if ($null -eq $manifest.PSObject.Properties['DownloadTargets']) {
|
||||||
|
Add-Member -InputObject $manifest -MemberType NoteProperty -Name DownloadTargets -Value @()
|
||||||
|
}
|
||||||
|
|
||||||
|
$downloadTargets = @($manifest.DownloadTargets)
|
||||||
|
if ($Destination -notin $downloadTargets) {
|
||||||
|
$downloadTargets += $Destination
|
||||||
|
$manifest.DownloadTargets = $downloadTargets
|
||||||
|
$manifest | ConvertTo-Json -Depth 8 | Set-Content -LiteralPath $manifestPath -Encoding UTF8
|
||||||
|
WriteLog "Registered current-run download target: $Destination"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
WriteLog "Register-CurrentRunDownloadTarget failed for '$Destination': $($_.Exception.Message)"
|
||||||
|
}
|
||||||
|
finally {
|
||||||
|
try { $mutex.ReleaseMutex() | Out-Null } catch {}
|
||||||
|
$mutex.Dispose()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# Function to download a file using BITS with retry and error handling
|
||||||
|
function Start-BitsTransferWithRetry {
|
||||||
|
param (
|
||||||
|
[Parameter(Mandatory = $true)]
|
||||||
|
[string]$Source,
|
||||||
|
[Parameter(Mandatory = $true)]
|
||||||
|
[string]$Destination,
|
||||||
|
[int]$Retries = 3,
|
||||||
|
[ValidateSet('Foreground','High','Normal','Low')]
|
||||||
|
[string]$Priority
|
||||||
|
)
|
||||||
|
|
||||||
|
if ([string]::IsNullOrWhiteSpace($Priority)) {
|
||||||
|
if (-not [string]::IsNullOrWhiteSpace($env:FFU_BITS_PRIORITY)) {
|
||||||
|
$Priority = $env:FFU_BITS_PRIORITY
|
||||||
|
}
|
||||||
|
elseif (-not [string]::IsNullOrWhiteSpace($script:BitsTransferPriority)) {
|
||||||
|
$Priority = $script:BitsTransferPriority
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
$Priority = 'Normal'
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# Register destination so cancel cleanup can remove this run's downloaded files
|
||||||
|
# even when file timestamps are inherited from the source.
|
||||||
|
Register-CurrentRunDownloadTarget -Destination $Destination
|
||||||
|
|
||||||
|
$attempt = 0
|
||||||
|
$lastError = $null
|
||||||
|
$notLoggedOnHResult = [int]0x800704dd
|
||||||
|
$fallbackTriggered = $false
|
||||||
|
|
||||||
|
while ($attempt -lt $Retries -and -not $fallbackTriggered) {
|
||||||
|
$OriginalVerbosePreference = $VerbosePreference
|
||||||
|
$OriginalProgressPreference = $ProgressPreference
|
||||||
|
try {
|
||||||
|
$VerbosePreference = 'SilentlyContinue'
|
||||||
|
$ProgressPreference = 'SilentlyContinue'
|
||||||
|
|
||||||
|
Start-BitsTransfer -Source $Source -Destination $Destination -Priority $Priority -ErrorAction Stop
|
||||||
|
|
||||||
|
$ProgressPreference = $OriginalProgressPreference
|
||||||
|
$VerbosePreference = $OriginalVerbosePreference
|
||||||
|
WriteLog "Successfully transferred $Source to $Destination."
|
||||||
|
return
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
$lastError = $_
|
||||||
|
$attempt++
|
||||||
|
$errorMessage = $lastError.Exception.Message
|
||||||
|
WriteLog "Attempt $attempt of $Retries failed to download $Source. Error: $errorMessage."
|
||||||
|
$hResult = $null
|
||||||
|
if ($null -ne $lastError.Exception) {
|
||||||
|
$hResult = $lastError.Exception.HResult
|
||||||
|
}
|
||||||
|
$needsHttpFallback = $false
|
||||||
|
if ($hResult -eq $notLoggedOnHResult) {
|
||||||
|
$needsHttpFallback = $true
|
||||||
|
}
|
||||||
|
elseif ($errorMessage -match '0x800704DD' -or $errorMessage -match 'not.*logged on to the network') {
|
||||||
|
$needsHttpFallback = $true
|
||||||
|
}
|
||||||
|
if ($needsHttpFallback) {
|
||||||
|
WriteLog "BITS cannot download $Source because the current session is not logged on to the network. Falling back to Invoke-WebRequest."
|
||||||
|
$fallbackTriggered = $true
|
||||||
|
break
|
||||||
|
}
|
||||||
|
Start-Sleep -Seconds (1 * $attempt)
|
||||||
|
}
|
||||||
|
finally {
|
||||||
|
if (Get-Variable -Name 'OriginalProgressPreference' -ErrorAction SilentlyContinue) {
|
||||||
|
$ProgressPreference = $OriginalProgressPreference
|
||||||
|
}
|
||||||
|
if (Get-Variable -Name 'OriginalVerbosePreference' -ErrorAction SilentlyContinue) {
|
||||||
|
$VerbosePreference = $OriginalVerbosePreference
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($fallbackTriggered) {
|
||||||
|
$remainingAttempts = $Retries - $attempt
|
||||||
|
if ($remainingAttempts -lt 1) {
|
||||||
|
$remainingAttempts = 1
|
||||||
|
}
|
||||||
|
$httpAttempt = 0
|
||||||
|
while ($httpAttempt -lt $remainingAttempts) {
|
||||||
|
$httpAttempt++
|
||||||
|
$OriginalVerbosePreference = $VerbosePreference
|
||||||
|
$OriginalProgressPreference = $ProgressPreference
|
||||||
|
try {
|
||||||
|
$VerbosePreference = 'SilentlyContinue'
|
||||||
|
$ProgressPreference = 'SilentlyContinue'
|
||||||
|
Invoke-WebRequest -Uri $Source -OutFile $Destination -ErrorAction Stop
|
||||||
|
$ProgressPreference = $OriginalProgressPreference
|
||||||
|
$VerbosePreference = $OriginalVerbosePreference
|
||||||
|
WriteLog "Successfully transferred $Source to $Destination via HTTP fallback."
|
||||||
|
return
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
$lastError = $_
|
||||||
|
WriteLog "HTTP fallback attempt $httpAttempt of $remainingAttempts failed to download $Source. Error: $($lastError.Exception.Message)."
|
||||||
|
Start-Sleep -Seconds (1 * $httpAttempt)
|
||||||
|
}
|
||||||
|
finally {
|
||||||
|
if (Get-Variable -Name 'OriginalProgressPreference' -ErrorAction SilentlyContinue) {
|
||||||
|
$ProgressPreference = $OriginalProgressPreference
|
||||||
|
}
|
||||||
|
if (Get-Variable -Name 'OriginalVerbosePreference' -ErrorAction SilentlyContinue) {
|
||||||
|
$VerbosePreference = $OriginalVerbosePreference
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
WriteLog "Failed to download $Source after $Retries attempts. Last Error: $($lastError.Exception.Message)"
|
||||||
|
throw $lastError
|
||||||
|
}
|
||||||
|
|
||||||
|
function Set-Progress {
|
||||||
|
[CmdletBinding()]
|
||||||
|
param(
|
||||||
|
[Parameter(Mandatory)]
|
||||||
|
[int]$Percentage,
|
||||||
|
[Parameter(Mandatory)]
|
||||||
|
[string]$Message
|
||||||
|
)
|
||||||
|
WriteLog "[PROGRESS] $Percentage | $Message"
|
||||||
|
}
|
||||||
|
|
||||||
|
function ConvertTo-SafeName {
|
||||||
|
[CmdletBinding()]
|
||||||
|
param(
|
||||||
|
[Parameter(Mandatory = $true)]
|
||||||
|
[string]$Name
|
||||||
|
)
|
||||||
|
# Replace invalid Windows filename characters (<>:"/\|?* and control chars) with a dash
|
||||||
|
$sanitized = $Name -replace '[<>:\"/\\|?*\x00-\x1F]', '-'
|
||||||
|
# Collapse multiple consecutive dashes
|
||||||
|
$sanitized = $sanitized -replace '-{2,}', '-'
|
||||||
|
# Trim leading/trailing spaces, periods, and dashes
|
||||||
|
$sanitized = $sanitized.Trim(' ', '.', '-')
|
||||||
|
if ([string]::IsNullOrWhiteSpace($sanitized)) {
|
||||||
|
$sanitized = 'Unnamed'
|
||||||
|
}
|
||||||
|
return $sanitized
|
||||||
|
}
|
||||||
|
|
||||||
|
Export-ModuleMember -Function *
|
||||||
@@ -0,0 +1,300 @@
|
|||||||
|
<#
|
||||||
|
.SYNOPSIS
|
||||||
|
Common Dell driver helpers (catalog index, model listing, latest package selection).
|
||||||
|
#>
|
||||||
|
|
||||||
|
function Convert-DellVendorVersion {
|
||||||
|
param([Parameter(Mandatory=$true)][string]$VendorVersion)
|
||||||
|
$segments = $VendorVersion.Split('.') | ForEach-Object {
|
||||||
|
if ($_ -match '^\d+$') { [int]$_ } else { 0 }
|
||||||
|
}
|
||||||
|
return ,$segments
|
||||||
|
}
|
||||||
|
|
||||||
|
function Compare-DellVendorVersion {
|
||||||
|
param(
|
||||||
|
[int[]]$Left,
|
||||||
|
[int[]]$Right
|
||||||
|
)
|
||||||
|
$len = [Math]::Max($Left.Length,$Right.Length)
|
||||||
|
for ($i=0; $i -lt $len; $i++) {
|
||||||
|
$l = if ($i -lt $Left.Length) { $Left[$i] } else { 0 }
|
||||||
|
$r = if ($i -lt $Right.Length) { $Right[$i] } else { 0 }
|
||||||
|
if ($l -gt $r) { return 1 }
|
||||||
|
if ($l -lt $r) { return -1 }
|
||||||
|
}
|
||||||
|
return 0
|
||||||
|
}
|
||||||
|
|
||||||
|
function Get-DellCatalogIndex {
|
||||||
|
[CmdletBinding()]
|
||||||
|
param(
|
||||||
|
[Parameter(Mandatory=$true)][string]$DriversFolder
|
||||||
|
)
|
||||||
|
|
||||||
|
$dellFolder = Join-Path $DriversFolder 'Dell'
|
||||||
|
if (-not (Test-Path $dellFolder)) { New-Item -Path $dellFolder -ItemType Directory -Force | Out-Null }
|
||||||
|
$cabPath = Join-Path $dellFolder 'CatalogIndexPC.cab'
|
||||||
|
$xmlPath = Join-Path $dellFolder 'CatalogIndexPC.xml'
|
||||||
|
$url = 'https://downloads.dell.com/catalog/CatalogIndexPC.cab'
|
||||||
|
|
||||||
|
$need = $true
|
||||||
|
if (Test-Path $xmlPath) {
|
||||||
|
$ageDays = ((Get-Date) - (Get-Item $xmlPath).CreationTime).TotalDays
|
||||||
|
if ($ageDays -lt 7) { $need = $false }
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($need) {
|
||||||
|
if (Test-Path $cabPath) { Remove-Item $cabPath -Force -ErrorAction SilentlyContinue }
|
||||||
|
if (Test-Path $xmlPath) { Remove-Item $xmlPath -Force -ErrorAction SilentlyContinue }
|
||||||
|
Start-BitsTransferWithRetry -Source $url -Destination $cabPath
|
||||||
|
Invoke-Process -FilePath Expand.exe -ArgumentList """$cabPath"" ""$xmlPath""" | Out-Null
|
||||||
|
Remove-Item $cabPath -Force -ErrorAction SilentlyContinue
|
||||||
|
}
|
||||||
|
|
||||||
|
if (-not (Test-Path $xmlPath)) { throw "Dell CatalogIndexPC XML missing: $xmlPath" }
|
||||||
|
return $xmlPath
|
||||||
|
}
|
||||||
|
|
||||||
|
function Get-DellClientModels {
|
||||||
|
[CmdletBinding()]
|
||||||
|
param(
|
||||||
|
[Parameter(Mandatory=$true)][string]$CatalogIndexXmlPath
|
||||||
|
)
|
||||||
|
|
||||||
|
$settings = New-Object System.Xml.XmlReaderSettings
|
||||||
|
$settings.IgnoreWhitespace = $true
|
||||||
|
$settings.IgnoreComments = $true
|
||||||
|
$reader = [System.Xml.XmlReader]::Create($CatalogIndexXmlPath,$settings)
|
||||||
|
|
||||||
|
$models = [System.Collections.Generic.List[pscustomobject]]::new()
|
||||||
|
try {
|
||||||
|
while ($reader.Read()) {
|
||||||
|
if ($reader.NodeType -eq [System.Xml.XmlNodeType]::Element -and $reader.Name -eq 'GroupManifest') {
|
||||||
|
# Read subtree to pick out brand/model/systemID + path
|
||||||
|
$sub = $reader.ReadSubtree()
|
||||||
|
$doc = New-Object System.Xml.XmlDocument
|
||||||
|
$doc.Load($sub)
|
||||||
|
$sub.Dispose()
|
||||||
|
|
||||||
|
# Use local-name() to ignore namespaces
|
||||||
|
$brandNode = $doc.SelectSingleNode("//*[local-name()='SupportedSystems']/*[local-name()='Brand']")
|
||||||
|
if (-not $brandNode) { continue }
|
||||||
|
$brandDisplay = ($brandNode.SelectSingleNode("*[local-name()='Display']")?.InnerText).Trim()
|
||||||
|
$modelNode = $brandNode.SelectSingleNode("*[local-name()='Model']")
|
||||||
|
if (-not $modelNode) { continue }
|
||||||
|
$modelNumber = ($modelNode.SelectSingleNode("*[local-name()='Display']")?.InnerText).Trim()
|
||||||
|
$systemId = $modelNode.GetAttribute('systemID')
|
||||||
|
$manifestInfo = $doc.SelectSingleNode("//*[local-name()='ManifestInformation']")
|
||||||
|
if (-not $manifestInfo) { continue }
|
||||||
|
$pathAttr = $manifestInfo.GetAttribute('path')
|
||||||
|
if (-not $pathAttr) { continue }
|
||||||
|
$cabUrl = 'https://downloads.dell.com/' + $pathAttr
|
||||||
|
# Normalize model display using GroupManifest Display CDATA if available (strip 'PDK Catalog for')
|
||||||
|
$gmDisplayNode = $doc.SelectSingleNode("/*[local-name()='GroupManifest']/*[local-name()='Display']")
|
||||||
|
$modelFull = $null
|
||||||
|
if ($gmDisplayNode -and $gmDisplayNode.InnerText) {
|
||||||
|
$rawDisplay = $gmDisplayNode.InnerText.Trim()
|
||||||
|
$modelFull = ($rawDisplay -replace '^\s*PDK Catalog for\s+','').Trim()
|
||||||
|
}
|
||||||
|
if ([string]::IsNullOrWhiteSpace($modelFull)) {
|
||||||
|
# Fallback: assemble from brand/model nodes (legacy heuristic)
|
||||||
|
$prefixedModelNumber = $modelNumber
|
||||||
|
if ($modelNumber -and $brandDisplay) {
|
||||||
|
if ($modelNumber.StartsWith($brandDisplay,[System.StringComparison]::OrdinalIgnoreCase)) {
|
||||||
|
$prefixedModelNumber = $modelNumber
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
$prefixedModelNumber = "$brandDisplay $modelNumber"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
elseif ($brandDisplay -and -not $modelNumber) {
|
||||||
|
$prefixedModelNumber = $brandDisplay
|
||||||
|
}
|
||||||
|
$modelFull = $prefixedModelNumber
|
||||||
|
}
|
||||||
|
$modelDisplay = "$modelFull ($systemId)"
|
||||||
|
$models.Add([pscustomobject]@{
|
||||||
|
Brand = $brandDisplay
|
||||||
|
ModelNumber = $modelNumber
|
||||||
|
SystemId = $systemId
|
||||||
|
CabRelativePath = $pathAttr
|
||||||
|
CabUrl = $cabUrl
|
||||||
|
ModelDisplay = $modelDisplay
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
finally {
|
||||||
|
$reader.Dispose()
|
||||||
|
}
|
||||||
|
return $models
|
||||||
|
}
|
||||||
|
|
||||||
|
function Get-DellLatestDriverPackages {
|
||||||
|
[CmdletBinding()]
|
||||||
|
param(
|
||||||
|
[Parameter(Mandatory=$true)][string]$ModelXmlPath,
|
||||||
|
[Parameter(Mandatory=$true)][string]$WindowsArch,
|
||||||
|
[Parameter(Mandatory=$true)][int]$WindowsRelease
|
||||||
|
)
|
||||||
|
|
||||||
|
if (-not (Test-Path $ModelXmlPath)) { throw "Model XML not found: $ModelXmlPath" }
|
||||||
|
|
||||||
|
$xml = [xml](Get-Content -Path $ModelXmlPath -Raw)
|
||||||
|
|
||||||
|
# Collect all SoftwareComponent nodes
|
||||||
|
$components = $xml.SelectNodes("//*[local-name()='SoftwareComponent']")
|
||||||
|
if (-not $components) { return @() }
|
||||||
|
|
||||||
|
$rawPackages = [System.Collections.Generic.List[pscustomobject]]::new()
|
||||||
|
|
||||||
|
foreach ($comp in $components) {
|
||||||
|
$ctype = $comp.SelectSingleNode("*[local-name()='ComponentType']")
|
||||||
|
if (-not $ctype) { continue }
|
||||||
|
if ($ctype.GetAttribute('value') -ne 'DRVR') { continue }
|
||||||
|
|
||||||
|
# OS filtering (arch only – release filtering intentionally minimal for now)
|
||||||
|
$osNodes = @($comp.SelectNodes("*[local-name()='SupportedOperatingSystems']/*[local-name()='OperatingSystem']"))
|
||||||
|
if (-not $osNodes) { continue }
|
||||||
|
$validOS = $osNodes | Where-Object { $_.GetAttribute('osArch') -eq $WindowsArch } | Select-Object -First 1
|
||||||
|
if (-not $validOS) { continue }
|
||||||
|
|
||||||
|
$path = $comp.GetAttribute('path')
|
||||||
|
if (-not $path) { continue }
|
||||||
|
|
||||||
|
$downloadUrl = "https://downloads.dell.com/$path"
|
||||||
|
$fileName = [IO.Path]::GetFileName($path)
|
||||||
|
$vendorVersion = $comp.GetAttribute('vendorVersion')
|
||||||
|
$versionArr = if ($vendorVersion) { Convert-DellVendorVersion $vendorVersion } else { @(0) }
|
||||||
|
$dateTimeAttr = $comp.GetAttribute('dateTime')
|
||||||
|
$dt = Get-Date
|
||||||
|
if ($dateTimeAttr) {
|
||||||
|
try { $dt = [DateTime]::Parse($dateTimeAttr) } catch { }
|
||||||
|
}
|
||||||
|
|
||||||
|
$categoryNode = $comp.SelectSingleNode("*[local-name()='Category']/*[local-name()='Display']")
|
||||||
|
$category = if ($categoryNode) { $categoryNode.InnerText.Trim() } else { 'Uncategorized' }
|
||||||
|
|
||||||
|
# Collect componentIDs (SupportedDevices + SupportedDCHDevices)
|
||||||
|
$compIds = [System.Collections.Generic.List[string]]::new()
|
||||||
|
$devNodes = @($comp.SelectNodes(".//*[local-name()='Device']"))
|
||||||
|
foreach ($dn in $devNodes) {
|
||||||
|
$id = $dn.GetAttribute('componentID')
|
||||||
|
if ($id) { [void]$compIds.Add($id) }
|
||||||
|
}
|
||||||
|
if ($compIds.Count -eq 0) { continue }
|
||||||
|
|
||||||
|
# Build a deterministic sortable key: zero-pad each numeric segment to 6 digits
|
||||||
|
$versionSortable = ($versionArr | ForEach-Object { $_.ToString('D6') }) -join '-'
|
||||||
|
|
||||||
|
# Capture a human‑readable driver name (preserve spaces like HP/Lenovo; remove only illegal path chars and extra whitespace)
|
||||||
|
$displayNode = $comp.SelectSingleNode("*[local-name()='Name']/*[local-name()='Display']")
|
||||||
|
$nameRaw = if ($displayNode) { $displayNode.InnerText.Trim() } else { $fileName }
|
||||||
|
# Remove characters not suitable for display (and disallowed in file names) but keep spaces
|
||||||
|
$nameDisplay = $nameRaw -replace '[\\\/:\*\?\"\<\>\|]', ' ' -replace '[,]', '-'
|
||||||
|
# Collapse multiple spaces to single
|
||||||
|
$nameDisplay = ($nameDisplay -replace '\s+', ' ').Trim()
|
||||||
|
|
||||||
|
$rawPackages.Add([pscustomobject]@{
|
||||||
|
Path = $path
|
||||||
|
DownloadUrl = $downloadUrl
|
||||||
|
FileName = $fileName
|
||||||
|
Name = $nameDisplay
|
||||||
|
Category = $category
|
||||||
|
VendorVersion = $vendorVersion
|
||||||
|
VersionArray = $versionArr
|
||||||
|
VersionSortable = $versionSortable
|
||||||
|
DateTime = $dt
|
||||||
|
ComponentIds = $compIds
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($rawPackages.Count -eq 0) { return @() }
|
||||||
|
|
||||||
|
# Sort newest first by VersionSortable (lexicographic works due to zero padding) then DateTime
|
||||||
|
$sorted = $rawPackages | Sort-Object -Property @{ Expression = { $_.VersionSortable }; Descending = $true }, @{ Expression = { $_.DateTime }; Descending = $true }
|
||||||
|
|
||||||
|
$chosen = [System.Collections.Generic.List[pscustomobject]]::new()
|
||||||
|
$assignedIds = [System.Collections.Generic.HashSet[string]]::new()
|
||||||
|
|
||||||
|
foreach ($pkg in $sorted) {
|
||||||
|
$hasOverlap = $false
|
||||||
|
foreach ($cid in $pkg.ComponentIds) {
|
||||||
|
if ($assignedIds.Contains($cid)) { $hasOverlap = $true; break }
|
||||||
|
}
|
||||||
|
if ($hasOverlap) {
|
||||||
|
WriteLog "Get-DellLatestDriverPackages: Skipping superseded package $($pkg.FileName) (shared componentID with newer package)."
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
foreach ($cid in $pkg.ComponentIds) { [void]$assignedIds.Add($cid) }
|
||||||
|
|
||||||
|
$chosen.Add([pscustomobject]@{
|
||||||
|
Path = $pkg.Path
|
||||||
|
DownloadUrl = $pkg.DownloadUrl
|
||||||
|
DriverFileName = $pkg.FileName
|
||||||
|
Name = $pkg.Name
|
||||||
|
Category = $pkg.Category
|
||||||
|
VendorVersion = $pkg.VendorVersion
|
||||||
|
DateTime = $pkg.DateTime
|
||||||
|
ComponentIds = $pkg.ComponentIds
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($chosen.Count -eq 0) {
|
||||||
|
WriteLog "Get-DellLatestDriverPackages: No qualifying driver packages after supersedence."
|
||||||
|
return @()
|
||||||
|
}
|
||||||
|
|
||||||
|
WriteLog ("Get-DellLatestDriverPackages: Selected {0} package(s) after supersedence." -f $chosen.Count)
|
||||||
|
return $chosen
|
||||||
|
}
|
||||||
|
|
||||||
|
# Resolve a Dell per‑model CabUrl when missing by inspecting CatalogIndexPC
|
||||||
|
function Resolve-DellCabUrlFromModel {
|
||||||
|
[CmdletBinding()]
|
||||||
|
param(
|
||||||
|
[Parameter(Mandatory = $true)][string]$DriversFolder,
|
||||||
|
[Parameter()][string]$ModelDisplay,
|
||||||
|
[Parameter()][string]$SystemId
|
||||||
|
)
|
||||||
|
|
||||||
|
if ([string]::IsNullOrWhiteSpace($SystemId) -and -not [string]::IsNullOrWhiteSpace($ModelDisplay)) {
|
||||||
|
# Try to parse the trailing (XXXX) token (SystemId)
|
||||||
|
if ($ModelDisplay -match '\(([0-9A-Fa-f]{4})\)\s*$') {
|
||||||
|
$SystemId = $matches[1].ToUpperInvariant()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if ([string]::IsNullOrWhiteSpace($SystemId)) {
|
||||||
|
WriteLog "Resolve-DellCabUrlFromModel: No SystemId could be determined from '$ModelDisplay'."
|
||||||
|
return $null
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
$indexXml = Get-DellCatalogIndex -DriversFolder $DriversFolder
|
||||||
|
# Reuse existing model parsing to avoid duplicating streaming logic
|
||||||
|
$allModels = Get-DellClientModels -CatalogIndexXmlPath $indexXml
|
||||||
|
$match = $allModels | Where-Object { $_.SystemId -eq $SystemId } | Select-Object -First 1
|
||||||
|
if ($null -eq $match) {
|
||||||
|
WriteLog "Resolve-DellCabUrlFromModel: SystemId '$SystemId' not found in CatalogIndexPC.xml."
|
||||||
|
return $null
|
||||||
|
}
|
||||||
|
WriteLog "Resolve-DellCabUrlFromModel: Resolved CabUrl for '$($match.ModelDisplay)' -> $($match.CabUrl)"
|
||||||
|
return [pscustomobject]@{
|
||||||
|
Brand = $match.Brand
|
||||||
|
ModelNumber = $match.ModelNumber
|
||||||
|
SystemId = $match.SystemId
|
||||||
|
CabRelativePath = $match.CabRelativePath
|
||||||
|
CabUrl = $match.CabUrl
|
||||||
|
ModelDisplay = $match.ModelDisplay
|
||||||
|
}
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
WriteLog "Resolve-DellCabUrlFromModel: Failure resolving CabUrl for '$ModelDisplay' / SystemId '$SystemId' : $($_.Exception.Message)"
|
||||||
|
return $null
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
Export-ModuleMember -Function Convert-DellVendorVersion,Compare-DellVendorVersion,Get-DellCatalogIndex,Get-DellClientModels,Get-DellLatestDriverPackages,Resolve-DellCabUrlFromModel
|
||||||
@@ -0,0 +1,763 @@
|
|||||||
|
<#
|
||||||
|
.SYNOPSIS
|
||||||
|
Common Microsoft/Surface driver helpers (cache index, SKU mapping).
|
||||||
|
.DESCRIPTION
|
||||||
|
This module contains Microsoft/Surface-specific functions used by the UI and scripts
|
||||||
|
to map Surface driver packs to System SKU values using:
|
||||||
|
- Source A: Surface System SKU reference (Learn)
|
||||||
|
- Source B: Support page model list
|
||||||
|
- Source C: Download Center details (window.__DLCDetails__)
|
||||||
|
#>
|
||||||
|
|
||||||
|
# --------------------------------------------------------------------------
|
||||||
|
# SECTION: Microsoft Surface Driver Index Cache (Sources A/B/C)
|
||||||
|
# --------------------------------------------------------------------------
|
||||||
|
|
||||||
|
function Get-SurfaceDriverIndexCachePath {
|
||||||
|
[CmdletBinding()]
|
||||||
|
param(
|
||||||
|
[Parameter(Mandatory = $true)]
|
||||||
|
[string]$DriversFolder
|
||||||
|
)
|
||||||
|
|
||||||
|
# Store the cache under Drivers\Microsoft so it travels with the driver content
|
||||||
|
$microsoftDriversFolder = Join-Path -Path $DriversFolder -ChildPath 'Microsoft'
|
||||||
|
if (-not (Test-Path -Path $microsoftDriversFolder -PathType Container)) {
|
||||||
|
New-Item -Path $microsoftDriversFolder -ItemType Directory -Force | Out-Null
|
||||||
|
}
|
||||||
|
|
||||||
|
return (Join-Path -Path $microsoftDriversFolder -ChildPath 'SurfaceDriverIndex.json')
|
||||||
|
}
|
||||||
|
|
||||||
|
function Import-SurfaceDriverIndexCache {
|
||||||
|
[CmdletBinding()]
|
||||||
|
param(
|
||||||
|
[Parameter(Mandatory = $true)]
|
||||||
|
[string]$DriversFolder
|
||||||
|
)
|
||||||
|
|
||||||
|
$cachePath = Get-SurfaceDriverIndexCachePath -DriversFolder $DriversFolder
|
||||||
|
|
||||||
|
# Surface cache TTL (7 days): treat stale caches as missing so we re-download Sources A/B/C as needed.
|
||||||
|
$cacheTtlDays = 7
|
||||||
|
if (-not (Test-Path -Path $cachePath -PathType Leaf)) {
|
||||||
|
return [pscustomobject]@{
|
||||||
|
ModelIndex = @()
|
||||||
|
SkuIndex = @()
|
||||||
|
DownloadCenterDetails = @()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
$cacheAgeDays = ((Get-Date) - (Get-Item -Path $cachePath -ErrorAction Stop).LastWriteTime).TotalDays
|
||||||
|
if ($cacheAgeDays -ge $cacheTtlDays) {
|
||||||
|
WriteLog "Surface cache: Cache file '$cachePath' is older than $cacheTtlDays days ($([math]::Round($cacheAgeDays, 1)) days). Refreshing."
|
||||||
|
return [pscustomobject]@{
|
||||||
|
ModelIndex = @()
|
||||||
|
SkuIndex = @()
|
||||||
|
DownloadCenterDetails = @()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
WriteLog "Surface cache: Loading cached SurfaceDriverIndex.json from '$cachePath' (age: $([math]::Round($cacheAgeDays, 1)) days)."
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
WriteLog "Surface cache: Failed to read cache timestamp for '$cachePath'. Refreshing. Error: $($_.Exception.Message)"
|
||||||
|
return [pscustomobject]@{
|
||||||
|
ModelIndex = @()
|
||||||
|
SkuIndex = @()
|
||||||
|
DownloadCenterDetails = @()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
$cache = Get-Content -Path $cachePath -Raw | ConvertFrom-Json -ErrorAction Stop
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
WriteLog "Warning: Could not read Surface driver cache '$cachePath'. Creating a new cache. Error: $($_.Exception.Message)"
|
||||||
|
return [pscustomobject]@{
|
||||||
|
ModelIndex = @()
|
||||||
|
SkuIndex = @()
|
||||||
|
DownloadCenterDetails = @()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($null -eq $cache) {
|
||||||
|
return [pscustomobject]@{
|
||||||
|
ModelIndex = @()
|
||||||
|
SkuIndex = @()
|
||||||
|
DownloadCenterDetails = @()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# Ensure expected properties exist (backward compatible with earlier cache shapes)
|
||||||
|
if (-not $cache.PSObject.Properties['ModelIndex']) {
|
||||||
|
$cache | Add-Member -NotePropertyName ModelIndex -NotePropertyValue @()
|
||||||
|
}
|
||||||
|
if (-not $cache.PSObject.Properties['SkuIndex']) {
|
||||||
|
$cache | Add-Member -NotePropertyName SkuIndex -NotePropertyValue @()
|
||||||
|
}
|
||||||
|
if (-not $cache.PSObject.Properties['DownloadCenterDetails']) {
|
||||||
|
$cache | Add-Member -NotePropertyName DownloadCenterDetails -NotePropertyValue @()
|
||||||
|
}
|
||||||
|
|
||||||
|
return $cache
|
||||||
|
}
|
||||||
|
|
||||||
|
function Save-SurfaceDriverIndexCache {
|
||||||
|
[CmdletBinding()]
|
||||||
|
param(
|
||||||
|
[Parameter(Mandatory = $true)]
|
||||||
|
[psobject]$Cache,
|
||||||
|
[Parameter(Mandatory = $true)]
|
||||||
|
[string]$DriversFolder
|
||||||
|
)
|
||||||
|
|
||||||
|
$cachePath = Get-SurfaceDriverIndexCachePath -DriversFolder $DriversFolder
|
||||||
|
$Cache | ConvertTo-Json -Depth 10 | Set-Content -Path $cachePath -Encoding UTF8
|
||||||
|
}
|
||||||
|
|
||||||
|
function ConvertTo-SurfaceComparableName {
|
||||||
|
[CmdletBinding()]
|
||||||
|
param(
|
||||||
|
[Parameter(Mandatory = $true)]
|
||||||
|
[string]$Text
|
||||||
|
)
|
||||||
|
|
||||||
|
# Normalize Surface marketing strings into a comparable family key.
|
||||||
|
# This intentionally strips consumer/commercial/processor qualifiers so we can join Sources A/B/C.
|
||||||
|
$value = [System.Net.WebUtility]::HtmlDecode($Text)
|
||||||
|
if ([string]::IsNullOrWhiteSpace($value)) {
|
||||||
|
return $null
|
||||||
|
}
|
||||||
|
|
||||||
|
$value = $value.Trim()
|
||||||
|
$value = $value -replace '\(', ' '
|
||||||
|
$value = $value -replace '\)', ' '
|
||||||
|
$value = $value -replace ',', ' '
|
||||||
|
|
||||||
|
# Normalize punctuation that frequently differs between Support/Learn pages
|
||||||
|
# (e.g. Wi‑Fi unicode hyphen, AT&T, Y!mobile)
|
||||||
|
$value = $value -replace '[-\u2010\u2011\u2012\u2013\u2014\u2212]', ' '
|
||||||
|
$value = $value -replace '&', ' '
|
||||||
|
$value = $value -replace '!', ' '
|
||||||
|
$value = $value -replace '™', ' '
|
||||||
|
|
||||||
|
$value = $value -replace '(?i)\bMicrosoft\b', ''
|
||||||
|
$value = $value -replace '(?i)\bfor\s+Business\b', ''
|
||||||
|
$value = $value -replace '(?i)\bConsumer\b', ''
|
||||||
|
$value = $value -replace '(?i)\bCommercial\b', ''
|
||||||
|
|
||||||
|
# Strip processor/connection qualifiers that cause mismatches between WMI, Learn, and Support naming.
|
||||||
|
$value = $value -replace '(?i)\bwith\s+Intel\b', ''
|
||||||
|
$value = $value -replace '(?i)\bIntel\s+processor\b', ''
|
||||||
|
$value = $value -replace '(?i)\bIntel\b', ''
|
||||||
|
$value = $value -replace '(?i)\bSnapdragon\s+processor\b', ''
|
||||||
|
$value = $value -replace '(?i)\bSnapdragon\b', ''
|
||||||
|
$value = $value -replace '(?i)\bwith\s+5G\b', ''
|
||||||
|
$value = $value -replace '(?i)\bLTE\b', ''
|
||||||
|
$value = $value -replace '(?i)\b4G\b', ''
|
||||||
|
$value = $value -replace '(?i)\bprocessor\b', ''
|
||||||
|
|
||||||
|
# Cleanup: remove orphaned "with" left behind by earlier removals (e.g., "Surface Pro 9 with Intel Processor")
|
||||||
|
$value = $value -replace '(?i)\bwith\b', ''
|
||||||
|
$value = $value -replace '\s+', ' '
|
||||||
|
|
||||||
|
return $value.Trim().ToUpperInvariant()
|
||||||
|
}
|
||||||
|
|
||||||
|
function ConvertTo-SurfaceHtmlText {
|
||||||
|
[CmdletBinding()]
|
||||||
|
param(
|
||||||
|
[Parameter(Mandatory = $true)]
|
||||||
|
[AllowEmptyString()]
|
||||||
|
[string]$HtmlFragment
|
||||||
|
)
|
||||||
|
|
||||||
|
# Normalize HTML fragments from the Learn table into plain text values.
|
||||||
|
$textValue = $HtmlFragment -replace '<br\s*/?>', ' '
|
||||||
|
$textValue = $textValue -replace '<[^>]+>', ' '
|
||||||
|
$textValue = [System.Net.WebUtility]::HtmlDecode($textValue)
|
||||||
|
$textValue = $textValue -replace '\s+', ' '
|
||||||
|
|
||||||
|
return $textValue.Trim()
|
||||||
|
}
|
||||||
|
|
||||||
|
function ConvertTo-SurfaceDownloadCenterLink {
|
||||||
|
[CmdletBinding()]
|
||||||
|
param(
|
||||||
|
[Parameter(Mandatory = $true)]
|
||||||
|
[string]$LinkValue
|
||||||
|
)
|
||||||
|
|
||||||
|
# Normalize Learn links down to the canonical Download Center details URL.
|
||||||
|
$decodedLink = [System.Net.WebUtility]::HtmlDecode($LinkValue).Trim()
|
||||||
|
if ([string]::IsNullOrWhiteSpace($decodedLink)) {
|
||||||
|
return $null
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($decodedLink.StartsWith('/')) {
|
||||||
|
$decodedLink = "https://www.microsoft.com$decodedLink"
|
||||||
|
}
|
||||||
|
|
||||||
|
$downloadCenterMatch = [regex]::Match(
|
||||||
|
$decodedLink,
|
||||||
|
'https://www\.microsoft\.com(?:/en-us)?/download/details\.aspx\?id=\d+',
|
||||||
|
[System.Text.RegularExpressions.RegexOptions]::IgnoreCase
|
||||||
|
)
|
||||||
|
|
||||||
|
if (-not $downloadCenterMatch.Success) {
|
||||||
|
return $null
|
||||||
|
}
|
||||||
|
|
||||||
|
return ($downloadCenterMatch.Value -replace '/en-us/', '/')
|
||||||
|
}
|
||||||
|
|
||||||
|
function Get-SurfaceDriverModelIndex {
|
||||||
|
[CmdletBinding()]
|
||||||
|
param(
|
||||||
|
[Parameter(Mandatory = $true)]
|
||||||
|
[string]$DriversFolder
|
||||||
|
)
|
||||||
|
|
||||||
|
$url = 'https://learn.microsoft.com/en-us/surface/manage-surface-driver-and-firmware-updates'
|
||||||
|
$minimumExpectedModelCount = 10
|
||||||
|
|
||||||
|
# Load the cached model list first to keep Microsoft model discovery fast.
|
||||||
|
try {
|
||||||
|
$cache = Import-SurfaceDriverIndexCache -DriversFolder $DriversFolder
|
||||||
|
if (@($cache.ModelIndex).Count -gt 0) {
|
||||||
|
WriteLog "Surface cache: Using cached Microsoft model list ($(@($cache.ModelIndex).Count) models)."
|
||||||
|
return @($cache.ModelIndex)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
WriteLog "Surface cache: Failed to load cached Microsoft model list. Falling back to the Learn source. Error: $($_.Exception.Message)"
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
# Download the Learn article that now contains the authoritative Surface package table.
|
||||||
|
WriteLog "Surface cache: Downloading Microsoft model index from $url"
|
||||||
|
$headers = @{
|
||||||
|
'User-Agent' = 'Mozilla/5.0 (Windows NT 10.0; Win64; x64)'
|
||||||
|
}
|
||||||
|
$webContent = Invoke-WebRequest -Uri $url -UseBasicParsing -Headers $headers
|
||||||
|
$html = $webContent.Content
|
||||||
|
|
||||||
|
# Parse each table row and keep only Download Center package links.
|
||||||
|
$rowMatches = [regex]::Matches($html, '<tr[^>]*>(.*?)</tr>', [System.Text.RegularExpressions.RegexOptions]::Singleline)
|
||||||
|
$models = [System.Collections.Generic.List[pscustomobject]]::new()
|
||||||
|
$seenModelKeys = [System.Collections.Generic.HashSet[string]]::new([System.StringComparer]::OrdinalIgnoreCase)
|
||||||
|
|
||||||
|
foreach ($rowMatch in $rowMatches) {
|
||||||
|
$rowContent = $rowMatch.Groups[1].Value
|
||||||
|
$cellMatches = [regex]::Matches($rowContent, '<td[^>]*>\s*(.*?)\s*</td>', [System.Text.RegularExpressions.RegexOptions]::Singleline)
|
||||||
|
if ($cellMatches.Count -lt 2) {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
$rowLabel = ConvertTo-SurfaceHtmlText -HtmlFragment $cellMatches[0].Groups[1].Value
|
||||||
|
if ([string]::IsNullOrWhiteSpace($rowLabel) -or $rowLabel -notmatch '(?i)^Surface') {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
$downloadCellContent = $cellMatches[1].Groups[1].Value
|
||||||
|
$linkMatches = [regex]::Matches(
|
||||||
|
$downloadCellContent,
|
||||||
|
'<a[^>]+href="([^"]+)"[^>]*>(.*?)</a>',
|
||||||
|
[System.Text.RegularExpressions.RegexOptions]::Singleline -bor [System.Text.RegularExpressions.RegexOptions]::IgnoreCase
|
||||||
|
)
|
||||||
|
|
||||||
|
foreach ($linkMatch in $linkMatches) {
|
||||||
|
$modelName = ConvertTo-SurfaceHtmlText -HtmlFragment $linkMatch.Groups[2].Value
|
||||||
|
$modelLink = ConvertTo-SurfaceDownloadCenterLink -LinkValue $linkMatch.Groups[1].Value
|
||||||
|
|
||||||
|
if ([string]::IsNullOrWhiteSpace($modelName) -or [string]::IsNullOrWhiteSpace($modelLink)) {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
$modelKey = "$modelName`n$modelLink"
|
||||||
|
if (-not $seenModelKeys.Add($modelKey)) {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
$models.Add([pscustomobject]@{
|
||||||
|
Make = 'Microsoft'
|
||||||
|
Model = $modelName
|
||||||
|
Link = $modelLink
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($models.Count -eq 0) {
|
||||||
|
throw "No Microsoft driver models were found in the Learn table."
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($models.Count -lt $minimumExpectedModelCount) {
|
||||||
|
WriteLog "Surface cache: Warning - Learn parsing returned only $($models.Count) Microsoft model entries."
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
WriteLog "Surface cache: Parsed $($models.Count) Microsoft model entries from Learn."
|
||||||
|
}
|
||||||
|
|
||||||
|
# Save the refreshed model list into the shared cache for both UI and CLI use.
|
||||||
|
try {
|
||||||
|
$cache = Import-SurfaceDriverIndexCache -DriversFolder $DriversFolder
|
||||||
|
$cache.ModelIndex = @($models)
|
||||||
|
Save-SurfaceDriverIndexCache -Cache $cache -DriversFolder $DriversFolder
|
||||||
|
WriteLog "Surface cache: Saved Microsoft model list to cache."
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
WriteLog "Surface cache: Failed to save Microsoft model list. Error: $($_.Exception.Message)"
|
||||||
|
}
|
||||||
|
|
||||||
|
return @($models)
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
WriteLog "Surface cache: Failed to build Microsoft model list from Learn. Error: $($_.Exception.Message)"
|
||||||
|
|
||||||
|
# Fall back to the last cached model list even if it is stale when the live request fails.
|
||||||
|
try {
|
||||||
|
$cachePath = Get-SurfaceDriverIndexCachePath -DriversFolder $DriversFolder
|
||||||
|
if (Test-Path -Path $cachePath -PathType Leaf) {
|
||||||
|
$staleCache = Get-Content -Path $cachePath -Raw | ConvertFrom-Json -ErrorAction Stop
|
||||||
|
if (@($staleCache.ModelIndex).Count -gt 0) {
|
||||||
|
WriteLog "Surface cache: Using stale Microsoft model list ($(@($staleCache.ModelIndex).Count) models) because the live Learn request failed."
|
||||||
|
return @($staleCache.ModelIndex)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
WriteLog "Surface cache: Failed to load stale Microsoft model list fallback. Error: $($_.Exception.Message)"
|
||||||
|
}
|
||||||
|
|
||||||
|
throw "Failed to retrieve Microsoft Surface models."
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function Get-SurfaceSystemSkuReferenceIndex {
|
||||||
|
[CmdletBinding()]
|
||||||
|
param(
|
||||||
|
[Parameter(Mandatory = $true)]
|
||||||
|
[string]$DriversFolder
|
||||||
|
)
|
||||||
|
|
||||||
|
# Source A: Learn page with authoritative Device / System Model / System SKU table
|
||||||
|
$cache = Import-SurfaceDriverIndexCache -DriversFolder $DriversFolder
|
||||||
|
if ($cache.SkuIndex -and $cache.SkuIndex.Count -gt 0) {
|
||||||
|
return @($cache.SkuIndex)
|
||||||
|
}
|
||||||
|
|
||||||
|
$url = 'https://learn.microsoft.com/en-us/surface/surface-system-sku-reference'
|
||||||
|
WriteLog "Surface cache: Downloading System SKU reference table from $url"
|
||||||
|
|
||||||
|
$headers = @{ 'User-Agent' = 'Mozilla/5.0 (Windows NT 10.0; Win64; x64)' }
|
||||||
|
$webContent = Invoke-WebRequest -Uri $url -UseBasicParsing -Headers $headers
|
||||||
|
$html = $webContent.Content
|
||||||
|
|
||||||
|
$skuRows = [System.Collections.Generic.List[pscustomobject]]::new()
|
||||||
|
|
||||||
|
$rowMatches = [regex]::Matches($html, '<tr[^>]*>(.*?)</tr>', [System.Text.RegularExpressions.RegexOptions]::Singleline)
|
||||||
|
foreach ($rowMatch in $rowMatches) {
|
||||||
|
$rowContent = $rowMatch.Groups[1].Value
|
||||||
|
$cellMatches = [regex]::Matches($rowContent, '<td[^>]*>\s*(?:<p[^>]*>)?(.*?)(?:</p>)?\s*</td>', [System.Text.RegularExpressions.RegexOptions]::Singleline)
|
||||||
|
if ($cellMatches.Count -lt 3) { continue }
|
||||||
|
|
||||||
|
$device = ([System.Net.WebUtility]::HtmlDecode(($cellMatches[0].Groups[1].Value).Trim()))
|
||||||
|
$systemModel = ([System.Net.WebUtility]::HtmlDecode(($cellMatches[1].Groups[1].Value).Trim()))
|
||||||
|
$systemSkuRaw = ([System.Net.WebUtility]::HtmlDecode(($cellMatches[2].Groups[1].Value).Trim()))
|
||||||
|
|
||||||
|
if ([string]::IsNullOrWhiteSpace($device) -or [string]::IsNullOrWhiteSpace($systemSkuRaw)) { continue }
|
||||||
|
|
||||||
|
$skuList = @($systemSkuRaw)
|
||||||
|
|
||||||
|
foreach ($sku in $skuList) {
|
||||||
|
if ([string]::IsNullOrWhiteSpace($sku)) { continue }
|
||||||
|
$skuRows.Add([pscustomobject]@{
|
||||||
|
Device = $device
|
||||||
|
SystemModel = $systemModel
|
||||||
|
SystemSku = $sku.Trim().ToUpperInvariant()
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
$cache.SkuIndex = @($skuRows)
|
||||||
|
Save-SurfaceDriverIndexCache -Cache $cache -DriversFolder $DriversFolder
|
||||||
|
WriteLog "Surface cache: Stored $($skuRows.Count) SKU entries."
|
||||||
|
|
||||||
|
return @($skuRows)
|
||||||
|
}
|
||||||
|
|
||||||
|
function Get-SurfaceDownloadCenterDetails {
|
||||||
|
[CmdletBinding()]
|
||||||
|
param(
|
||||||
|
[Parameter(Mandatory = $true)]
|
||||||
|
[string]$DriversFolder,
|
||||||
|
[Parameter(Mandatory = $true)]
|
||||||
|
[string]$ModelLink,
|
||||||
|
[Parameter()]
|
||||||
|
[string]$ModelName = $null
|
||||||
|
)
|
||||||
|
|
||||||
|
# Source C: Download Center details page (window.__DLCDetails__) containing file names + direct URLs
|
||||||
|
$cache = Import-SurfaceDriverIndexCache -DriversFolder $DriversFolder
|
||||||
|
$existing = @($cache.DownloadCenterDetails | Where-Object { $_.Link -eq $ModelLink } | Select-Object -First 1)
|
||||||
|
if ($existing.Count -gt 0 -and $existing[0].Files -and $existing[0].Files.Count -gt 0) {
|
||||||
|
# Backfill Model into cache when available
|
||||||
|
if (-not [string]::IsNullOrWhiteSpace($ModelName)) {
|
||||||
|
if (-not $existing[0].PSObject.Properties['Model'] -or [string]::IsNullOrWhiteSpace($existing[0].Model)) {
|
||||||
|
try {
|
||||||
|
$existing[0] | Add-Member -NotePropertyName Model -NotePropertyValue $ModelName -Force
|
||||||
|
|
||||||
|
$newDetails = [System.Collections.Generic.List[pscustomobject]]::new()
|
||||||
|
foreach ($item in @($cache.DownloadCenterDetails)) {
|
||||||
|
if ($null -ne $item -and $item.PSObject.Properties['Link'] -and $item.Link -ne $ModelLink) {
|
||||||
|
$newDetails.Add($item)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
$newDetails.Add($existing[0])
|
||||||
|
$cache.DownloadCenterDetails = @($newDetails)
|
||||||
|
Save-SurfaceDriverIndexCache -Cache $cache -DriversFolder $DriversFolder
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
WriteLog "Surface cache: Failed to backfill Model for DownloadCenterDetails entry '$ModelLink'. Error: $($_.Exception.Message)"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return @($existing[0].Files)
|
||||||
|
}
|
||||||
|
|
||||||
|
WriteLog "Surface cache: Downloading Download Center details from $ModelLink"
|
||||||
|
$headers = @{ 'User-Agent' = 'Mozilla/5.0 (Windows NT 10.0; Win64; x64)' }
|
||||||
|
$downloadPageContent = Invoke-WebRequest -Uri $ModelLink -UseBasicParsing -Headers $headers
|
||||||
|
|
||||||
|
$scriptPattern = '<script>window.__DLCDetails__={(.*?)}<\/script>'
|
||||||
|
$scriptMatch = [regex]::Match($downloadPageContent.Content, $scriptPattern)
|
||||||
|
if (-not $scriptMatch.Success) {
|
||||||
|
WriteLog "Surface cache: Could not find window.__DLCDetails__ on $ModelLink"
|
||||||
|
return @()
|
||||||
|
}
|
||||||
|
|
||||||
|
$scriptContent = $scriptMatch.Groups[1].Value
|
||||||
|
$downloadFilePattern = '"name":"([^"]+\.(?:msi|zip))",[^}]*?"url":"(.*?)"'
|
||||||
|
$downloadFileMatches = [regex]::Matches($scriptContent, $downloadFilePattern, [System.Text.RegularExpressions.RegexOptions]::IgnoreCase)
|
||||||
|
|
||||||
|
$files = [System.Collections.Generic.List[pscustomobject]]::new()
|
||||||
|
foreach ($downloadFile in $downloadFileMatches) {
|
||||||
|
$currentFileName = $downloadFile.Groups[1].Value
|
||||||
|
$fileUrl = $downloadFile.Groups[2].Value
|
||||||
|
if ([string]::IsNullOrWhiteSpace($currentFileName) -or [string]::IsNullOrWhiteSpace($fileUrl)) { continue }
|
||||||
|
|
||||||
|
$files.Add([pscustomobject]@{
|
||||||
|
Name = $currentFileName
|
||||||
|
Url = $fileUrl
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
# Persist into cache
|
||||||
|
if ($files.Count -gt 0) {
|
||||||
|
$detailsEntry = [pscustomobject][ordered]@{
|
||||||
|
Model = $ModelName
|
||||||
|
Link = $ModelLink
|
||||||
|
Files = @($files)
|
||||||
|
}
|
||||||
|
|
||||||
|
$newDetails = [System.Collections.Generic.List[pscustomobject]]::new()
|
||||||
|
foreach ($item in @($cache.DownloadCenterDetails)) {
|
||||||
|
if ($null -ne $item -and $item.PSObject.Properties['Link'] -and $item.Link -ne $ModelLink) {
|
||||||
|
$newDetails.Add($item)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
$newDetails.Add($detailsEntry)
|
||||||
|
$cache.DownloadCenterDetails = @($newDetails)
|
||||||
|
Save-SurfaceDriverIndexCache -Cache $cache -DriversFolder $DriversFolder
|
||||||
|
}
|
||||||
|
|
||||||
|
return @($files)
|
||||||
|
}
|
||||||
|
|
||||||
|
function Get-SurfaceSystemSkuListForMicrosoftDriver {
|
||||||
|
[CmdletBinding()]
|
||||||
|
param(
|
||||||
|
[Parameter(Mandatory = $true)]
|
||||||
|
[string]$DriversFolder,
|
||||||
|
[Parameter(Mandatory = $true)]
|
||||||
|
[string]$ModelName,
|
||||||
|
[Parameter(Mandatory = $true)]
|
||||||
|
[string]$ModelLink
|
||||||
|
)
|
||||||
|
|
||||||
|
$skuIndex = Get-SurfaceSystemSkuReferenceIndex -DriversFolder $DriversFolder
|
||||||
|
if ($null -eq $skuIndex -or $skuIndex.Count -eq 0) {
|
||||||
|
return @()
|
||||||
|
}
|
||||||
|
|
||||||
|
$files = Get-SurfaceDownloadCenterDetails -DriversFolder $DriversFolder -ModelLink $ModelLink -ModelName $ModelName
|
||||||
|
$fileNames = @($files | ForEach-Object { $_.Name })
|
||||||
|
|
||||||
|
# Infer architecture hints from the MSI naming convention (best-effort)
|
||||||
|
$archHint = $null
|
||||||
|
if ($fileNames -match '(?i)_ARM_') {
|
||||||
|
$archHint = 'ARM64'
|
||||||
|
}
|
||||||
|
elseif ($fileNames -match '(?i)withIntel|_Intel_|Intel') {
|
||||||
|
$archHint = 'x64'
|
||||||
|
}
|
||||||
|
elseif ($ModelName -match '(?i)\bSQ3\b|\bSnapdragon\b') {
|
||||||
|
$archHint = 'ARM64'
|
||||||
|
}
|
||||||
|
elseif ($ModelName -match '(?i)with Intel') {
|
||||||
|
$archHint = 'x64'
|
||||||
|
}
|
||||||
|
|
||||||
|
# Surface Pro (generic) is ambiguous in the SKU table because Surface Pro (5th Gen) and
|
||||||
|
# Surface Pro with LTE Advanced (5th Gen) both reuse SystemModel="Surface Pro".
|
||||||
|
# The "Surface Pro" driver pack does not have a unique SystemSKU value on the Learn page.
|
||||||
|
if ($ModelName.Trim() -match '(?i)^Surface\s+Pro$') {
|
||||||
|
return @()
|
||||||
|
}
|
||||||
|
|
||||||
|
# Build multiple candidate keys for models that contain multiple variants in one string
|
||||||
|
# Example: "Surface Pro 7+ and Surface Pro 7+ LTE"
|
||||||
|
$familyKeyCandidates = [System.Collections.Generic.List[string]]::new()
|
||||||
|
$familyKeySet = [System.Collections.Generic.HashSet[string]]::new([System.StringComparer]::OrdinalIgnoreCase)
|
||||||
|
|
||||||
|
$primaryKey = ConvertTo-SurfaceComparableName -Text $ModelName
|
||||||
|
if (-not [string]::IsNullOrWhiteSpace($primaryKey) -and $familyKeySet.Add($primaryKey)) {
|
||||||
|
$familyKeyCandidates.Add($primaryKey) | Out-Null
|
||||||
|
}
|
||||||
|
|
||||||
|
$parts = [regex]::Split($ModelName, '(?i)\s+and\s+')
|
||||||
|
|
||||||
|
# Track when the model text contains both LTE and non-LTE variants (e.g. "Surface Go 2 and Surface Go 2 LTE")
|
||||||
|
$hasLtePart = (@($parts | Where-Object { $_ -match '(?i)\bLTE\b' }).Count -gt 0)
|
||||||
|
$hasNonLtePart = (@($parts | Where-Object { $_ -notmatch '(?i)\bLTE\b' }).Count -gt 0)
|
||||||
|
|
||||||
|
foreach ($part in @($parts)) {
|
||||||
|
if ([string]::IsNullOrWhiteSpace($part)) { continue }
|
||||||
|
$candidate = ConvertTo-SurfaceComparableName -Text $part
|
||||||
|
if (-not [string]::IsNullOrWhiteSpace($candidate) -and $familyKeySet.Add($candidate)) {
|
||||||
|
$familyKeyCandidates.Add($candidate) | Out-Null
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($familyKeyCandidates.Count -eq 0) {
|
||||||
|
return @()
|
||||||
|
}
|
||||||
|
|
||||||
|
# Surface 3 has multiple carrier/region variants that share the same SystemModel ("Surface 3").
|
||||||
|
# Add a base key so we can match all Surface 3 SKU rows, then refine down to the correct variant.
|
||||||
|
if ($ModelName -match '(?i)^Surface\s+3\b') {
|
||||||
|
$surface3BaseKey = 'SURFACE 3'
|
||||||
|
if ($familyKeySet.Add($surface3BaseKey)) {
|
||||||
|
$familyKeyCandidates.Add($surface3BaseKey) | Out-Null
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# Surface Go variants share the same SystemModel ("Surface Go") in the SKU table.
|
||||||
|
# Use a generation-aware base key so we don't cross-match Go vs Go 2/3/4 SKU rows.
|
||||||
|
if ($ModelName -match '(?i)^Surface\s+Go\s+2\b') {
|
||||||
|
$surfaceGoBaseKey = 'SURFACE GO 2'
|
||||||
|
if ($familyKeySet.Add($surfaceGoBaseKey)) {
|
||||||
|
$familyKeyCandidates.Add($surfaceGoBaseKey) | Out-Null
|
||||||
|
}
|
||||||
|
}
|
||||||
|
elseif ($ModelName -match '(?i)^Surface\s+Go\s+3\b') {
|
||||||
|
$surfaceGoBaseKey = 'SURFACE GO 3'
|
||||||
|
if ($familyKeySet.Add($surfaceGoBaseKey)) {
|
||||||
|
$familyKeyCandidates.Add($surfaceGoBaseKey) | Out-Null
|
||||||
|
}
|
||||||
|
}
|
||||||
|
elseif ($ModelName -match '(?i)^Surface\s+Go\s+4\b') {
|
||||||
|
$surfaceGoBaseKey = 'SURFACE GO 4'
|
||||||
|
if ($familyKeySet.Add($surfaceGoBaseKey)) {
|
||||||
|
$familyKeyCandidates.Add($surfaceGoBaseKey) | Out-Null
|
||||||
|
}
|
||||||
|
}
|
||||||
|
elseif ($ModelName -match '(?i)^Surface\s+Go\b') {
|
||||||
|
$surfaceGoBaseKey = 'SURFACE GO'
|
||||||
|
if ($familyKeySet.Add($surfaceGoBaseKey)) {
|
||||||
|
$familyKeyCandidates.Add($surfaceGoBaseKey) | Out-Null
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# Surface Pro 9 with 5G: the SKU table rows use SystemModel "Surface Pro 9".
|
||||||
|
# Add a base key so we can match the Pro 9 SKU rows, then refine down to the 5G rows.
|
||||||
|
if (($ModelName -match '(?i)^Surface\s+Pro\s+9\b') -and ($ModelName -match '(?i)\b5G\b')) {
|
||||||
|
$surfacePro9BaseKey = 'SURFACE PRO 9'
|
||||||
|
if ($familyKeySet.Add($surfacePro9BaseKey)) {
|
||||||
|
$familyKeyCandidates.Add($surfacePro9BaseKey) | Out-Null
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# Surface Pro with LTE Advanced maps to the "Surface Pro with LTE Advanced (5th Gen)" SKU table row.
|
||||||
|
# Add a base key so we can match Surface Pro rows, then refine to the LTE Advanced SKU.
|
||||||
|
if ($ModelName -match '(?i)^Surface\s+Pro\s+with\s+LTE\s+Advanced\b') {
|
||||||
|
$surfaceProBaseKey = 'SURFACE PRO'
|
||||||
|
if ($familyKeySet.Add($surfaceProBaseKey)) {
|
||||||
|
$familyKeyCandidates.Add($surfaceProBaseKey) | Out-Null
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# Surface Laptop (1st Gen) maps to the base "Surface Laptop" SKU table row.
|
||||||
|
if (($ModelName -match '(?i)^Surface\s+Laptop\b') -and ($ModelName -match '(?i)\bGen\b')) {
|
||||||
|
$surfaceLaptopBaseKey = 'SURFACE LAPTOP'
|
||||||
|
if ($familyKeySet.Add($surfaceLaptopBaseKey)) {
|
||||||
|
$familyKeyCandidates.Add($surfaceLaptopBaseKey) | Out-Null
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# Surface Studio (1st Gen) maps to the base "Surface Studio" SKU table row.
|
||||||
|
if (($ModelName -match '(?i)^Surface\s+Studio\b') -and ($ModelName -match '(?i)\bGen\b')) {
|
||||||
|
$surfaceStudioBaseKey = 'SURFACE STUDIO'
|
||||||
|
if ($familyKeySet.Add($surfaceStudioBaseKey)) {
|
||||||
|
$familyKeyCandidates.Add($surfaceStudioBaseKey) | Out-Null
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# Surface Laptop 3/4 AMD/Intel packs map to the "Surface Laptop 3/4" SystemModel rows in the SKU table.
|
||||||
|
if ($ModelName -match '(?i)^Surface\s+Laptop\s+(3|4)\b' -and $ModelName -match '(?i)\b(AMD|Intel)\b') {
|
||||||
|
$generationMatch = [regex]::Match($ModelName, '(?i)^Surface\s+Laptop\s+(3|4)\b')
|
||||||
|
if ($generationMatch.Success) {
|
||||||
|
$surfaceLaptopGenBaseKey = "SURFACE LAPTOP $($generationMatch.Groups[1].Value)"
|
||||||
|
if ($familyKeySet.Add($surfaceLaptopGenBaseKey)) {
|
||||||
|
$familyKeyCandidates.Add($surfaceLaptopGenBaseKey) | Out-Null
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# Match by any candidate key against the SKU table
|
||||||
|
$skuMatches = @($skuIndex | Where-Object {
|
||||||
|
$deviceKey = ConvertTo-SurfaceComparableName -Text $_.Device
|
||||||
|
$modelKey = ConvertTo-SurfaceComparableName -Text $_.SystemModel
|
||||||
|
|
||||||
|
foreach ($candidateKey in $familyKeyCandidates) {
|
||||||
|
if ($deviceKey -eq $candidateKey -or $modelKey -eq $candidateKey) {
|
||||||
|
return $true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return $false
|
||||||
|
})
|
||||||
|
|
||||||
|
# Surface Hub 2 driver packs cover Surface Hub 2S + Surface Hub 3 devices.
|
||||||
|
# The System SKU table does not have a "Surface Hub 2" row, so map Hub 2 to all Hub SKUs.
|
||||||
|
if ($ModelName -match '(?i)^Surface\s+Hub\s+2\b') {
|
||||||
|
$hubSkuRows = @($skuIndex | Where-Object { $_.Device -match '(?i)^Surface\s+Hub' })
|
||||||
|
if ($hubSkuRows.Count -gt 0) {
|
||||||
|
$skuMatches = @($hubSkuRows)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# Surface 3: refine down to the correct SKU row based on the model variant text
|
||||||
|
# Use normalized text so punctuation/Unicode differences don't drop matches to zero.
|
||||||
|
if ($ModelName -match '(?i)^Surface\s+3\b') {
|
||||||
|
$modelNorm = ConvertTo-SurfaceComparableName -Text $ModelName
|
||||||
|
|
||||||
|
if ($modelNorm -match '(?i)\bWI\s+FI\b') {
|
||||||
|
$skuMatches = @($skuMatches | Where-Object { (ConvertTo-SurfaceComparableName -Text $_.Device) -match '(?i)\bWI\s+FI\b' })
|
||||||
|
}
|
||||||
|
elseif ($modelNorm -match '(?i)\bVERIZON\b') {
|
||||||
|
$skuMatches = @($skuMatches | Where-Object { (ConvertTo-SurfaceComparableName -Text $_.Device) -match '(?i)\bVERIZON\b' })
|
||||||
|
}
|
||||||
|
elseif ($modelNorm -match '(?i)\bOUTSIDE\s+OF\s+NORTH\s+AMERICA\b|\bY\s+MOBILE\b') {
|
||||||
|
$skuMatches = @($skuMatches | Where-Object { (ConvertTo-SurfaceComparableName -Text $_.Device) -match '(?i)\bOUTSIDE\s+OF\s+NORTH\s+AMERICA\b|\bY\s+MOBILE\b' })
|
||||||
|
}
|
||||||
|
elseif ($modelNorm -match '(?i)\bNORTH\s+AMERICA\b') {
|
||||||
|
# "North America (non-AT&T)" should map to the North America row (not AT&T/Verizon/outside-of-North-America)
|
||||||
|
$skuMatches = @($skuMatches | Where-Object {
|
||||||
|
$deviceNorm = ConvertTo-SurfaceComparableName -Text $_.Device
|
||||||
|
($deviceNorm -match '(?i)\bNORTH\s+AMERICA\b') -and
|
||||||
|
($deviceNorm -notmatch '(?i)\bOUTSIDE\b|\bY\s+MOBILE\b') -and
|
||||||
|
($deviceNorm -notmatch '(?i)\bAT\s+T\b|\bVERIZON\b')
|
||||||
|
})
|
||||||
|
}
|
||||||
|
elseif (($modelNorm -match '(?i)\bAT\s+T\b') -and ($modelNorm -notmatch '(?i)\bNON\s+AT\s+T\b')) {
|
||||||
|
$skuMatches = @($skuMatches | Where-Object { (ConvertTo-SurfaceComparableName -Text $_.Device) -match '(?i)\bAT\s+T\b' })
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# Surface Go: keep LTE SKU only for LTE-only models; exclude LTE SKU for non-LTE-only models.
|
||||||
|
# If the model name includes BOTH LTE and non-LTE variants (joined with "and"), do not filter.
|
||||||
|
# Surface Go 3 driver packs are treated as covering LTE + non-LTE unless explicitly labeled otherwise.
|
||||||
|
if ($ModelName -match '(?i)^Surface\s+Go\b') {
|
||||||
|
$isSurfaceGo3Base = ($ModelName -match '(?i)^Surface\s+Go\s+3\b') -and ($ModelName -notmatch '(?i)\bLTE\b')
|
||||||
|
|
||||||
|
if (-not $isSurfaceGo3Base) {
|
||||||
|
if (-not ($hasLtePart -and $hasNonLtePart)) {
|
||||||
|
if ($ModelName -match '(?i)\bLTE\b') {
|
||||||
|
$skuMatches = @($skuMatches | Where-Object { $_.Device -match '(?i)\bLTE\b' })
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
$skuMatches = @($skuMatches | Where-Object { $_.Device -notmatch '(?i)\bLTE\b' })
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# Surface Pro 9 with 5G (SQ3): keep only the 5G SKU rows (U.S. + outside of U.S.).
|
||||||
|
if (($ModelName -match '(?i)^Surface\s+Pro\s+9\b') -and ($ModelName -match '(?i)\b5G\b')) {
|
||||||
|
$skuMatches = @($skuMatches | Where-Object { $_.Device -match '(?i)\b5G\b' })
|
||||||
|
}
|
||||||
|
|
||||||
|
# Surface Pro 10: split non-5G vs 5G SKU rows so the two driver packs don't share the same SystemSKUs.
|
||||||
|
if ($ModelName -match '(?i)^Surface\s+Pro\s+10\b') {
|
||||||
|
if ($ModelName -match '(?i)\b5G\b') {
|
||||||
|
$skuMatches = @($skuMatches | Where-Object {
|
||||||
|
($_.SystemSku -match '^SURFACE_PRO_10_WITH_5G_FOR_BUSINESS_') -or
|
||||||
|
($_.Device -match '(?i)\bwith\s+5G\b')
|
||||||
|
})
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
$skuMatches = @($skuMatches | Where-Object { $_.SystemSku -eq 'SURFACE_PRO_10_FOR_BUSINESS_2079' })
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# Surface Pro with LTE Advanced: restrict to the LTE Advanced (5th Gen) SKU.
|
||||||
|
if ($ModelName -match '(?i)^Surface\s+Pro\s+with\s+LTE\s+Advanced\b') {
|
||||||
|
$skuMatches = @($skuMatches | Where-Object { $_.SystemSku -eq 'SURFACE_PRO_1807' })
|
||||||
|
}
|
||||||
|
|
||||||
|
# Surface Laptop 3/4: filter to AMD vs Intel rows (prevents AMD packs from inheriting Intel SKUs and vice-versa).
|
||||||
|
if ($ModelName -match '(?i)^Surface\s+Laptop\s+(3|4)\b') {
|
||||||
|
if ($ModelName -match '(?i)\bAMD\b') {
|
||||||
|
$skuMatches = @($skuMatches | Where-Object { $_.Device -match '(?i)\bAMD\b' })
|
||||||
|
}
|
||||||
|
elseif ($ModelName -match '(?i)\bIntel\b') {
|
||||||
|
$skuMatches = @($skuMatches | Where-Object { $_.Device -match '(?i)\bIntel\b' })
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# Apply architecture filtering when we can infer it
|
||||||
|
if ($archHint -eq 'ARM64') {
|
||||||
|
# ARM variants are typically called out as Snapdragon / SQ3 / 5G in the Learn table
|
||||||
|
$skuMatches = @($skuMatches | Where-Object {
|
||||||
|
($_.Device -match '(?i)Snapdragon|SQ3|with 5G') -or
|
||||||
|
($_.SystemModel -match '(?i)Snapdragon|SQ3|with 5G')
|
||||||
|
})
|
||||||
|
}
|
||||||
|
elseif ($archHint -eq 'x64') {
|
||||||
|
# x64 variants are often NOT labeled "Intel" in the Learn table (e.g. Surface Pro 9).
|
||||||
|
# Treat "not Snapdragon/SQ3/5G" as the x64 bucket.
|
||||||
|
$skuMatches = @($skuMatches | Where-Object {
|
||||||
|
($_.Device -notmatch '(?i)Snapdragon|SQ3|with 5G') -and
|
||||||
|
($_.SystemModel -notmatch '(?i)Snapdragon|SQ3|with 5G')
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
$skus = @($skuMatches | ForEach-Object { $_.SystemSku } | Where-Object { -not [string]::IsNullOrWhiteSpace($_) } | Sort-Object -Unique)
|
||||||
|
return $skus
|
||||||
|
}
|
||||||
|
|
||||||
|
Export-ModuleMember -Function `
|
||||||
|
Get-SurfaceDriverIndexCachePath, `
|
||||||
|
Import-SurfaceDriverIndexCache, `
|
||||||
|
Save-SurfaceDriverIndexCache, `
|
||||||
|
ConvertTo-SurfaceComparableName, `
|
||||||
|
ConvertTo-SurfaceHtmlText, `
|
||||||
|
ConvertTo-SurfaceDownloadCenterLink, `
|
||||||
|
Get-SurfaceDriverModelIndex, `
|
||||||
|
Get-SurfaceSystemSkuReferenceIndex, `
|
||||||
|
Get-SurfaceDownloadCenterDetails, `
|
||||||
|
Get-SurfaceSystemSkuListForMicrosoftDriver
|
||||||
@@ -0,0 +1,822 @@
|
|||||||
|
<#
|
||||||
|
.SYNOPSIS
|
||||||
|
Provides common functions for driver management, including compression, mapping, and existence checks.
|
||||||
|
|
||||||
|
.DESCRIPTION
|
||||||
|
The FFU.Common.Drivers module contains a set of shared functions used across the FFU project for handling driver packages.
|
||||||
|
This includes compressing driver folders into WIM files for efficient storage and deployment, maintaining a JSON-based mapping
|
||||||
|
of downloaded drivers to their respective makes and models, and checking for the pre-existence of driver packages to avoid
|
||||||
|
redundant downloads.
|
||||||
|
#>
|
||||||
|
function Compress-DriverFolderToWim {
|
||||||
|
[CmdletBinding(SupportsShouldProcess)]
|
||||||
|
param(
|
||||||
|
[Parameter(Mandatory = $true)]
|
||||||
|
[ValidateScript({ Test-Path -Path $_ -PathType Container })]
|
||||||
|
[string]$SourceFolderPath,
|
||||||
|
|
||||||
|
[Parameter(Mandatory = $true)]
|
||||||
|
[string]$DestinationWimPath,
|
||||||
|
|
||||||
|
[Parameter()]
|
||||||
|
[string]$WimName, # Optional, defaults to folder name
|
||||||
|
|
||||||
|
[Parameter()]
|
||||||
|
[string]$WimDescription, # Optional, defaults to folder name
|
||||||
|
|
||||||
|
[Parameter()]
|
||||||
|
[bool]$PreserveSource = $false # When $true, do not delete source folder; create marker for deferred cleanup
|
||||||
|
)
|
||||||
|
|
||||||
|
WriteLog "Starting compression of folder '$SourceFolderPath' to '$DestinationWimPath'."
|
||||||
|
|
||||||
|
# Default WIM Name and Description to the source folder name if not provided
|
||||||
|
$sourceFolderName = Split-Path -Path $SourceFolderPath -Leaf
|
||||||
|
if ([string]::IsNullOrWhiteSpace($WimName)) {
|
||||||
|
$WimName = $sourceFolderName
|
||||||
|
WriteLog "WIM Name not provided, defaulting to source folder name: '$WimName'."
|
||||||
|
}
|
||||||
|
if ([string]::IsNullOrWhiteSpace($WimDescription)) {
|
||||||
|
$WimDescription = $sourceFolderName
|
||||||
|
WriteLog "WIM Description not provided, defaulting to source folder name: '$WimDescription'."
|
||||||
|
}
|
||||||
|
|
||||||
|
# Ensure destination directory exists
|
||||||
|
$destinationDir = Split-Path -Path $DestinationWimPath -Parent
|
||||||
|
if (-not (Test-Path -Path $destinationDir -PathType Container)) {
|
||||||
|
WriteLog "Creating destination directory: $destinationDir"
|
||||||
|
try {
|
||||||
|
New-Item -Path $destinationDir -ItemType Directory -Force -ErrorAction Stop | Out-Null
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
WriteLog "Failed to create destination directory '$destinationDir': $($_.Exception.Message)"
|
||||||
|
return $false # Indicate failure
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($PSCmdlet.ShouldProcess("Folder '$SourceFolderPath'", "Compress to WIM '$DestinationWimPath'")) {
|
||||||
|
try {
|
||||||
|
# Construct arguments for dism.exe
|
||||||
|
$dismArgs = "/Capture-Image /ImageFile:`"$DestinationWimPath`" /CaptureDir:`"$SourceFolderPath`" /Name:`"$WimName`" /Description:`"$WimDescription`" /Compress:Max /CheckIntegrity /Quiet"
|
||||||
|
|
||||||
|
WriteLog "Executing dism.exe via Invoke-Process with arguments:"
|
||||||
|
WriteLog "dism.exe $dismArgs"
|
||||||
|
|
||||||
|
# Call Invoke-Process (assumed to be available from FFUUI.Core.psm1 or another imported module)
|
||||||
|
# Invoke-Process is expected to throw an exception for non-zero exit codes.
|
||||||
|
Invoke-Process -FilePath "dism.exe" -ArgumentList $dismArgs -Wait $true
|
||||||
|
|
||||||
|
WriteLog "Successfully compressed '$SourceFolderPath' to '$DestinationWimPath' using dism.exe."
|
||||||
|
|
||||||
|
# Remove the source folder after successful compression
|
||||||
|
if ($PreserveSource) {
|
||||||
|
WriteLog "Preserving source driver folder for deferred WinPE driver harvesting: $SourceFolderPath"
|
||||||
|
try {
|
||||||
|
$markerFile = Join-Path -Path $SourceFolderPath -ChildPath '__PreservedForPEDrivers.txt'
|
||||||
|
if (-not (Test-Path -Path $markerFile -PathType Leaf)) {
|
||||||
|
New-Item -Path $markerFile -ItemType File -Force | Out-Null
|
||||||
|
WriteLog "Created preservation marker file: $markerFile"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
WriteLog "Warning: Failed to create preservation marker in $SourceFolderPath. Error: $($_.Exception.Message)"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
WriteLog "Removing source driver folder: $SourceFolderPath"
|
||||||
|
try {
|
||||||
|
Remove-Item -Path $SourceFolderPath -Recurse -Force -ErrorAction Stop
|
||||||
|
WriteLog "Successfully removed source folder '$SourceFolderPath'."
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
WriteLog "Warning: Failed to remove source folder '$SourceFolderPath'. Error: $($_.Exception.Message)"
|
||||||
|
# Do not fail the whole operation, just log a warning.
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return $true # Indicate success
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
WriteLog "Failed to compress folder '$SourceFolderPath' to WIM '$DestinationWimPath' using dism.exe."
|
||||||
|
WriteLog "Error details: $($_.Exception.Message)"
|
||||||
|
# Check if the error message contains details about the DISM log (dism.exe output might be in the exception)
|
||||||
|
if ($_.Exception.Message -match 'DISM log file can be found at (.*)') {
|
||||||
|
$dismLogPath = $matches[1].Trim()
|
||||||
|
WriteLog "Check the DISM log for more details: $dismLogPath"
|
||||||
|
}
|
||||||
|
return $false # Indicate failure
|
||||||
|
}
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
WriteLog "Compression operation skipped due to -WhatIf."
|
||||||
|
return $false # Indicate skipped operation
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# --------------------------------------------------------------------------
|
||||||
|
# SECTION: Driver Mapping Function
|
||||||
|
# --------------------------------------------------------------------------
|
||||||
|
|
||||||
|
function Update-DriverMappingJson {
|
||||||
|
[CmdletBinding()]
|
||||||
|
param(
|
||||||
|
[Parameter(Mandatory = $true)]
|
||||||
|
[array]$DownloadedDrivers, # Array of PSCustomObjects with Make, Model, DriverPath
|
||||||
|
|
||||||
|
[Parameter(Mandatory = $true)]
|
||||||
|
[string]$DriversFolder # Base drivers folder (e.g., C:\FFUDevelopment\Drivers)
|
||||||
|
)
|
||||||
|
|
||||||
|
$mappingFilePath = Join-Path -Path $DriversFolder -ChildPath "DriverMapping.json"
|
||||||
|
WriteLog "Updating driver mapping file at: $mappingFilePath"
|
||||||
|
|
||||||
|
# Load existing mapping file or create a new list
|
||||||
|
$mappingList = [System.Collections.Generic.List[PSCustomObject]]::new()
|
||||||
|
if (Test-Path -Path $mappingFilePath -PathType Leaf) {
|
||||||
|
try {
|
||||||
|
$existingJson = Get-Content -Path $mappingFilePath -Raw | ConvertFrom-Json
|
||||||
|
# Ensure it's a collection before adding to the list
|
||||||
|
if ($existingJson -is [array]) {
|
||||||
|
# Iterate through the array to avoid type conversion issues with AddRange
|
||||||
|
foreach ($item in $existingJson) {
|
||||||
|
$mappingList.Add($item)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
$mappingList.Add($existingJson)
|
||||||
|
}
|
||||||
|
WriteLog "Loaded $($mappingList.Count) existing entries from $mappingFilePath"
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
WriteLog "Warning: Could not read or parse existing DriverMapping.json. A new file will be created. Error: $($_.Exception.Message)"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
$updatedCount = 0
|
||||||
|
$addedCount = 0
|
||||||
|
|
||||||
|
$hpSystemIdCache = @{}
|
||||||
|
$normalizeHpName = {
|
||||||
|
param([string]$text)
|
||||||
|
|
||||||
|
if ([string]::IsNullOrWhiteSpace($text)) {
|
||||||
|
return $null
|
||||||
|
}
|
||||||
|
|
||||||
|
return ([regex]::Replace($text.ToLowerInvariant(), '[^a-z0-9]', ''))
|
||||||
|
}
|
||||||
|
$getHpSystemId = {
|
||||||
|
param([string]$modelName)
|
||||||
|
|
||||||
|
if ([string]::IsNullOrWhiteSpace($modelName)) {
|
||||||
|
return $null
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($hpSystemIdCache.ContainsKey($modelName)) {
|
||||||
|
return $hpSystemIdCache[$modelName]
|
||||||
|
}
|
||||||
|
|
||||||
|
$hpFolder = Join-Path -Path $DriversFolder -ChildPath 'HP'
|
||||||
|
if (-not (Test-Path -Path $hpFolder -PathType Container)) {
|
||||||
|
$hpSystemIdCache[$modelName] = $null
|
||||||
|
return $null
|
||||||
|
}
|
||||||
|
|
||||||
|
$platformListXml = Join-Path -Path $hpFolder -ChildPath 'PlatformList.xml'
|
||||||
|
$platformListCab = Join-Path -Path $hpFolder -ChildPath 'platformList.cab'
|
||||||
|
if (-not (Test-Path -Path $platformListXml -PathType Leaf)) {
|
||||||
|
try {
|
||||||
|
WriteLog "Attempting to refresh HP PlatformList.xml for SystemID lookup."
|
||||||
|
Start-BitsTransferWithRetry -Source 'https://hpia.hpcloud.hp.com/ref/platformList.cab' -Destination $platformListCab -ErrorAction Stop
|
||||||
|
if (Test-Path -Path $platformListXml) { Remove-Item -Path $platformListXml -Force -ErrorAction SilentlyContinue }
|
||||||
|
Invoke-Process -FilePath "expand.exe" -ArgumentList @("`"$platformListCab`"", "`"$platformListXml`"") -ErrorAction Stop | Out-Null
|
||||||
|
if (Test-Path -Path $platformListCab) { Remove-Item -Path $platformListCab -Force -ErrorAction SilentlyContinue }
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
WriteLog "Failed to refresh HP PlatformList.xml: $($_.Exception.Message)"
|
||||||
|
$hpSystemIdCache[$modelName] = $null
|
||||||
|
return $null
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
[xml]$platformListContent = Get-Content -Path $platformListXml -Raw -Encoding UTF8 -ErrorAction Stop
|
||||||
|
|
||||||
|
$targetName = $modelName.Trim()
|
||||||
|
$normalizedTarget = & $normalizeHpName $targetName
|
||||||
|
|
||||||
|
$modelMatch = $platformListContent.ImagePal.Platform | Where-Object {
|
||||||
|
[string]::Equals($_.ProductName.'#text'.Trim(), $targetName, [System.StringComparison]::OrdinalIgnoreCase)
|
||||||
|
} | Select-Object -First 1
|
||||||
|
|
||||||
|
if (-not $modelMatch -and $normalizedTarget) {
|
||||||
|
$modelMatch = $platformListContent.ImagePal.Platform | Where-Object {
|
||||||
|
$candidateName = $_.ProductName.'#text'
|
||||||
|
$normalizedCandidate = & $normalizeHpName $candidateName
|
||||||
|
$normalizedCandidate -eq $normalizedTarget
|
||||||
|
} | Select-Object -First 1
|
||||||
|
}
|
||||||
|
|
||||||
|
if (-not $modelMatch -and $normalizedTarget) {
|
||||||
|
$modelMatch = $platformListContent.ImagePal.Platform | Where-Object {
|
||||||
|
$candidateName = $_.ProductName.'#text'
|
||||||
|
$normalizedCandidate = & $normalizeHpName $candidateName
|
||||||
|
($normalizedCandidate -like "*$normalizedTarget*") -or ($normalizedTarget -like "*$normalizedCandidate*")
|
||||||
|
} | Select-Object -First 1
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($modelMatch -and -not [string]::IsNullOrWhiteSpace($modelMatch.SystemID)) {
|
||||||
|
$resolvedId = $modelMatch.SystemID.Trim().ToUpperInvariant()
|
||||||
|
$hpSystemIdCache[$modelName] = $resolvedId
|
||||||
|
return $resolvedId
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
WriteLog "HP SystemId lookup: no match found in PlatformList.xml for model '$modelName'."
|
||||||
|
}
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
WriteLog "Failed to parse HP PlatformList.xml for model '$modelName': $($_.Exception.Message)"
|
||||||
|
}
|
||||||
|
|
||||||
|
$hpSystemIdCache[$modelName] = $null
|
||||||
|
return $null
|
||||||
|
}
|
||||||
|
|
||||||
|
foreach ($driver in $DownloadedDrivers) {
|
||||||
|
if (-not $driver.PSObject.Properties['Make'] -or -not $driver.PSObject.Properties['Model'] -or -not $driver.PSObject.Properties['DriverPath'] -or [string]::IsNullOrWhiteSpace($driver.DriverPath)) {
|
||||||
|
WriteLog "Skipping driver entry due to missing or empty Make, Model, or DriverPath. Details: $(($driver | ConvertTo-Json -Compress -Depth 3))"
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
$systemIdValue = $null
|
||||||
|
$machineTypeValue = $null
|
||||||
|
|
||||||
|
if ($driver.PSObject.Properties['SystemId'] -and -not [string]::IsNullOrWhiteSpace($driver.SystemId)) {
|
||||||
|
$systemIdValue = $driver.SystemId.Trim().ToUpperInvariant()
|
||||||
|
}
|
||||||
|
if ($driver.PSObject.Properties['MachineType'] -and -not [string]::IsNullOrWhiteSpace($driver.MachineType)) {
|
||||||
|
$machineTypeValue = $driver.MachineType.Trim()
|
||||||
|
}
|
||||||
|
|
||||||
|
switch ($driver.Make) {
|
||||||
|
'Dell' {
|
||||||
|
if (-not $systemIdValue -and $driver.Model -match '\(([^)]+)\)\s*$') {
|
||||||
|
$systemIdValue = $matches[1].Trim().ToUpperInvariant()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
'HP' {
|
||||||
|
if (-not $systemIdValue) {
|
||||||
|
$systemIdValue = & $getHpSystemId $driver.Model
|
||||||
|
}
|
||||||
|
}
|
||||||
|
'Lenovo' {
|
||||||
|
if (-not $machineTypeValue -and $driver.Model -match '\(([^)]+)\)\s*$') {
|
||||||
|
$machineTypeValue = $matches[1].Trim()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# Microsoft Surface: resolve System SKU list (best-effort) using Sources A + C and cached results
|
||||||
|
$surfaceSystemSkuList = @()
|
||||||
|
if ($driver.Make -eq 'Microsoft') {
|
||||||
|
if ($driver.PSObject.Properties['Link'] -and -not [string]::IsNullOrWhiteSpace($driver.Link)) {
|
||||||
|
try {
|
||||||
|
$surfaceSystemSkuList = Get-SurfaceSystemSkuListForMicrosoftDriver -DriversFolder $DriversFolder -ModelName $driver.Model -ModelLink $driver.Link
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
WriteLog "Warning: Failed to resolve Surface SystemSku list for '$($driver.Model)'. Error: $($_.Exception.Message)"
|
||||||
|
$surfaceSystemSkuList = @()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
$existingEntry = $mappingList | Where-Object { $_.Manufacturer -eq $driver.Make -and $_.Model -eq $driver.Model } | Select-Object -First 1
|
||||||
|
|
||||||
|
if ($null -ne $existingEntry) {
|
||||||
|
$entryUpdated = $false
|
||||||
|
if ($existingEntry.DriverPath -ne $driver.DriverPath) {
|
||||||
|
WriteLog "Updating driver path for '$($driver.Make) - $($driver.Model)' from '$($existingEntry.DriverPath)' to '$($driver.DriverPath)'."
|
||||||
|
$existingEntry.DriverPath = $driver.DriverPath
|
||||||
|
$entryUpdated = $true
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($driver.Make -in @('HP', 'Dell') -and -not [string]::IsNullOrWhiteSpace($systemIdValue)) {
|
||||||
|
if ($existingEntry.PSObject.Properties['SystemId']) {
|
||||||
|
if ($existingEntry.SystemId -ne $systemIdValue) {
|
||||||
|
WriteLog "Updating SystemId for '$($driver.Make) - $($driver.Model)' to '$systemIdValue'."
|
||||||
|
$existingEntry.SystemId = $systemIdValue
|
||||||
|
$entryUpdated = $true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
WriteLog "Adding SystemId '$systemIdValue' for '$($driver.Make) - $($driver.Model)'."
|
||||||
|
$existingEntry | Add-Member -NotePropertyName SystemId -NotePropertyValue $systemIdValue
|
||||||
|
$entryUpdated = $true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($driver.Make -eq 'Lenovo' -and -not [string]::IsNullOrWhiteSpace($machineTypeValue)) {
|
||||||
|
if ($existingEntry.PSObject.Properties['MachineType']) {
|
||||||
|
if ($existingEntry.MachineType -ne $machineTypeValue) {
|
||||||
|
WriteLog "Updating MachineType for '$($driver.Make) - $($driver.Model)' to '$machineTypeValue'."
|
||||||
|
$existingEntry.MachineType = $machineTypeValue
|
||||||
|
$entryUpdated = $true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
WriteLog "Adding MachineType '$machineTypeValue' for '$($driver.Make) - $($driver.Model)'."
|
||||||
|
$existingEntry | Add-Member -NotePropertyName MachineType -NotePropertyValue $machineTypeValue
|
||||||
|
$entryUpdated = $true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($driver.Make -eq 'Microsoft' -and $surfaceSystemSkuList -and $surfaceSystemSkuList.Count -gt 0) {
|
||||||
|
$desiredSkus = @($surfaceSystemSkuList | Sort-Object -Unique)
|
||||||
|
if ($existingEntry.PSObject.Properties['SystemSku']) {
|
||||||
|
$currentSkus = @($existingEntry.SystemSku)
|
||||||
|
$currentNormalized = @($currentSkus | ForEach-Object { if ($null -ne $_) { $_.ToString().Trim().ToUpperInvariant() } }) | Sort-Object -Unique
|
||||||
|
$desiredNormalized = @($desiredSkus | ForEach-Object { if ($null -ne $_) { $_.ToString().Trim().ToUpperInvariant() } }) | Sort-Object -Unique
|
||||||
|
|
||||||
|
if (($currentNormalized -join '|') -ne ($desiredNormalized -join '|')) {
|
||||||
|
WriteLog "Updating SystemSku list for 'Microsoft - $($driver.Model)'."
|
||||||
|
$existingEntry.SystemSku = $desiredSkus
|
||||||
|
$entryUpdated = $true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
WriteLog "Adding SystemSku list for 'Microsoft - $($driver.Model)'."
|
||||||
|
$existingEntry | Add-Member -NotePropertyName SystemSku -NotePropertyValue $desiredSkus
|
||||||
|
$entryUpdated = $true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($entryUpdated) {
|
||||||
|
$updatedCount++
|
||||||
|
}
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
$newEntry = [PSCustomObject]@{
|
||||||
|
Manufacturer = $driver.Make
|
||||||
|
Model = $driver.Model
|
||||||
|
DriverPath = $driver.DriverPath
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($driver.Make -in @('HP', 'Dell') -and -not [string]::IsNullOrWhiteSpace($systemIdValue)) {
|
||||||
|
$newEntry | Add-Member -NotePropertyName SystemId -NotePropertyValue $systemIdValue
|
||||||
|
}
|
||||||
|
if ($driver.Make -eq 'Lenovo' -and -not [string]::IsNullOrWhiteSpace($machineTypeValue)) {
|
||||||
|
$newEntry | Add-Member -NotePropertyName MachineType -NotePropertyValue $machineTypeValue
|
||||||
|
}
|
||||||
|
if ($driver.Make -eq 'Microsoft' -and $surfaceSystemSkuList -and $surfaceSystemSkuList.Count -gt 0) {
|
||||||
|
$newEntry | Add-Member -NotePropertyName SystemSku -NotePropertyValue @($surfaceSystemSkuList | Sort-Object -Unique)
|
||||||
|
}
|
||||||
|
|
||||||
|
$mappingList.Add($newEntry)
|
||||||
|
WriteLog "Adding new mapping for '$($driver.Make) - $($driver.Model)' with path '$($driver.DriverPath)'."
|
||||||
|
$addedCount++
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($updatedCount -gt 0 -or $addedCount -gt 0) {
|
||||||
|
try {
|
||||||
|
# Sort the list for consistency before saving
|
||||||
|
$sortedList = $mappingList | Sort-Object -Property Manufacturer, Model
|
||||||
|
$sortedList | ConvertTo-Json -Depth 5 | Set-Content -Path $mappingFilePath -Encoding UTF8
|
||||||
|
WriteLog "Successfully saved DriverMapping.json with $addedCount new entries and $updatedCount updated entries."
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
WriteLog "Error saving updated DriverMapping.json: $($_.Exception.Message)"
|
||||||
|
throw "Failed to save driver mapping file."
|
||||||
|
}
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
WriteLog "No changes needed for DriverMapping.json."
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# --------------------------------------------------------------------------
|
||||||
|
# SECTION: Driver Existence Check Function
|
||||||
|
# --------------------------------------------------------------------------
|
||||||
|
function Test-ExistingDriver {
|
||||||
|
[CmdletBinding()]
|
||||||
|
param(
|
||||||
|
[Parameter(Mandatory = $true)]
|
||||||
|
[string]$Make,
|
||||||
|
|
||||||
|
[Parameter(Mandatory = $true)]
|
||||||
|
[string]$Model,
|
||||||
|
|
||||||
|
[Parameter(Mandatory = $true)]
|
||||||
|
[string]$DriversFolder,
|
||||||
|
|
||||||
|
[Parameter(Mandatory = $true)]
|
||||||
|
[string]$Identifier,
|
||||||
|
|
||||||
|
[Parameter()]
|
||||||
|
[System.Collections.Concurrent.ConcurrentQueue[hashtable]]$ProgressQueue = $null
|
||||||
|
)
|
||||||
|
|
||||||
|
$makeDriversPath = Join-Path -Path $DriversFolder -ChildPath $Make
|
||||||
|
$modelPath = Join-Path -Path $makeDriversPath -ChildPath $Model
|
||||||
|
$driverRelativePath = Join-Path -Path $Make -ChildPath $Model
|
||||||
|
|
||||||
|
# Check for WIM file first
|
||||||
|
$wimFilePath = Join-Path -Path $makeDriversPath -ChildPath "$($Model).wim"
|
||||||
|
if (Test-Path -Path $wimFilePath -PathType Leaf) {
|
||||||
|
$status = "Already downloaded (WIM)"
|
||||||
|
WriteLog "Driver WIM for '$Identifier' already exists at '$wimFilePath'."
|
||||||
|
if ($null -ne $ProgressQueue) { Invoke-ProgressUpdate -ProgressQueue $ProgressQueue -Identifier $Identifier -Status $status }
|
||||||
|
$wimRelativePath = Join-Path -Path $Make -ChildPath "$($Model).wim"
|
||||||
|
return [PSCustomObject]@{
|
||||||
|
Model = $Identifier # Return original identifier
|
||||||
|
Status = $status
|
||||||
|
Success = $true
|
||||||
|
DriverPath = $wimRelativePath
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# Check for existing driver folder
|
||||||
|
if (Test-Path -Path $modelPath -PathType Container) {
|
||||||
|
$folderSize = (Get-ChildItem -Path $modelPath -Recurse | Measure-Object -Property Length -Sum -ErrorAction SilentlyContinue).Sum
|
||||||
|
if ($folderSize -gt 1MB) {
|
||||||
|
$status = "Already downloaded"
|
||||||
|
WriteLog "Drivers for '$Identifier' already exist in '$modelPath'."
|
||||||
|
if ($null -ne $ProgressQueue) { Invoke-ProgressUpdate -ProgressQueue $ProgressQueue -Identifier $Identifier -Status $status }
|
||||||
|
return [PSCustomObject]@{
|
||||||
|
Model = $Identifier # Return original identifier
|
||||||
|
Status = $status
|
||||||
|
Success = $true
|
||||||
|
DriverPath = $driverRelativePath
|
||||||
|
}
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
WriteLog "Driver folder '$modelPath' for '$Identifier' exists but is empty or very small. Re-downloading."
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# If neither WIM nor a valid folder exists, return null
|
||||||
|
return $null
|
||||||
|
}
|
||||||
|
function Get-LenovoPSREFToken {
|
||||||
|
|
||||||
|
<#
|
||||||
|
.DESCRIPTION
|
||||||
|
Retrieves the Lenovo PSREF token from the Edge browser's local storage.
|
||||||
|
|
||||||
|
.NOTES
|
||||||
|
|
||||||
|
Lenovo's PSREF site creates a cookie/token via javascript when navigating to the PSREF site. This cookie only needs
|
||||||
|
to be retrieved once on a single machine, and every machine within the same network will be able to access the PSREF API.
|
||||||
|
|
||||||
|
Using Invoke-Webrequest with sessionvariable or websession doesn't work because the token is created by javascript.
|
||||||
|
Using edge in headless mode with remote debugging enabled allows for the retrieval of the token via the DevTools protocol.
|
||||||
|
|
||||||
|
You couldn't be more unhappy about this solution than I am, but it works.
|
||||||
|
|
||||||
|
Why use PSREF and not catalogv2.xml? Catalogv2.xml doesn't include all models. PSREF provides an API that can be used to retrieve
|
||||||
|
the friendly model and machine type information for both business and consumer models. Many EDU devices are deemed consumer.
|
||||||
|
|
||||||
|
System Update and other tools rely on the user to input machine type and model information, but finding the machine type is difficult for some.
|
||||||
|
Our solution makes it easier to simply type the model name and you can match the machine type to the model name.
|
||||||
|
|
||||||
|
If you have a better solution, please submit a PR or open a discussion on Github. Happy to consider alternatives. An easy way to test
|
||||||
|
if your alternative works is to see if you can retrieve 100e, 300w, 500w, etc. These don't show up in catalogv2.xml, but they do in PSREF.
|
||||||
|
#>
|
||||||
|
|
||||||
|
$token = $null
|
||||||
|
$socket = $null
|
||||||
|
$edgeProcess = $null
|
||||||
|
$tempProfile = $null
|
||||||
|
$port = $null
|
||||||
|
|
||||||
|
function Get-FreeLocalTcpPort {
|
||||||
|
$listener = $null
|
||||||
|
try {
|
||||||
|
$listener = [System.Net.Sockets.TcpListener]::new([System.Net.IPAddress]::Loopback, 0)
|
||||||
|
$listener.Start()
|
||||||
|
$endpoint = [System.Net.IPEndPoint]$listener.LocalEndpoint
|
||||||
|
return $endpoint.Port
|
||||||
|
}
|
||||||
|
finally {
|
||||||
|
if ($null -ne $listener) {
|
||||||
|
$listener.Stop()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function Get-EdgeDevToolsPageTarget {
|
||||||
|
param(
|
||||||
|
[Parameter(Mandatory = $true)][int]$Port,
|
||||||
|
[int]$MaxAttempts = 20,
|
||||||
|
[int]$DelayMilliseconds = 500,
|
||||||
|
[string]$UrlContains
|
||||||
|
)
|
||||||
|
|
||||||
|
for ($attempt = 1; $attempt -le $MaxAttempts; $attempt++) {
|
||||||
|
try {
|
||||||
|
$targets = Invoke-RestMethod -Uri "http://localhost:$Port/json" -ErrorAction Stop
|
||||||
|
if ($null -ne $targets) {
|
||||||
|
if ($targets -isnot [System.Array]) { $targets = @($targets) }
|
||||||
|
$pageTargets = $targets | Where-Object { $_.type -eq 'page' }
|
||||||
|
if (-not [string]::IsNullOrWhiteSpace($UrlContains)) {
|
||||||
|
$pageTargets = $pageTargets | Where-Object {
|
||||||
|
-not [string]::IsNullOrWhiteSpace($_.url) -and $_.url -like "*$UrlContains*"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
$target = $pageTargets | Select-Object -First 1
|
||||||
|
if ($null -ne $target) {
|
||||||
|
return $target
|
||||||
|
}
|
||||||
|
|
||||||
|
WriteLog "DevTools endpoint on port $Port returned targets but no page matched the criteria (attempt $attempt of $MaxAttempts)."
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
WriteLog "DevTools endpoint on port $Port returned no targets (attempt $attempt of $MaxAttempts)."
|
||||||
|
}
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
WriteLog "DevTools endpoint on port $Port not ready (attempt $attempt of $MaxAttempts). Error: $($_.Exception.Message)"
|
||||||
|
}
|
||||||
|
|
||||||
|
Start-Sleep -Milliseconds $DelayMilliseconds
|
||||||
|
}
|
||||||
|
|
||||||
|
throw "Edge DevTools endpoint on port $Port did not expose a matching page target after $MaxAttempts attempts."
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
$ffuDevelopmentRoot = Split-Path -Path $PSScriptRoot -Parent
|
||||||
|
WriteLog "Derived FFUDevelopmentPath from module path: $ffuDevelopmentRoot"
|
||||||
|
|
||||||
|
if ([string]::IsNullOrWhiteSpace($ffuDevelopmentRoot)) {
|
||||||
|
throw "FFUDevelopmentPath could not be resolved. Unable to create Edge profile."
|
||||||
|
}
|
||||||
|
|
||||||
|
if (-not (Test-Path -Path $ffuDevelopmentRoot -PathType Container)) {
|
||||||
|
throw "Resolved FFUDevelopmentPath '$ffuDevelopmentRoot' does not exist."
|
||||||
|
}
|
||||||
|
|
||||||
|
$tempProfile = Join-Path -Path $ffuDevelopmentRoot -ChildPath ("edge-psref-" + [guid]::NewGuid())
|
||||||
|
WriteLog "Creating temporary Edge profile at $tempProfile."
|
||||||
|
New-Item -ItemType Directory -Path $tempProfile -Force | Out-Null
|
||||||
|
|
||||||
|
$edgeExe = "$Env:ProgramFiles (x86)\Microsoft\Edge\Application\msedge.exe"
|
||||||
|
$uri = 'https://psref.lenovo.com'
|
||||||
|
$port = Get-FreeLocalTcpPort
|
||||||
|
WriteLog "Using Edge DevTools port $port for Lenovo PSREF token retrieval."
|
||||||
|
|
||||||
|
$flags = "--headless=new --disable-gpu --remote-debugging-port=$port $uri --user-data-dir=`"$tempProfile`""
|
||||||
|
$edgeProcess = Start-Process -FilePath $edgeExe -ArgumentList $flags -PassThru
|
||||||
|
WriteLog "Edge process started with PID: $($edgeProcess.Id)."
|
||||||
|
|
||||||
|
$pageTarget = Get-EdgeDevToolsPageTarget -Port $port -MaxAttempts 40 -DelayMilliseconds 500 -UrlContains 'psref.lenovo.com'
|
||||||
|
if (-not [string]::IsNullOrWhiteSpace($pageTarget.url)) {
|
||||||
|
WriteLog "Selected DevTools target URL: $($pageTarget.url)"
|
||||||
|
}
|
||||||
|
|
||||||
|
$wsUrl = $pageTarget.webSocketDebuggerUrl
|
||||||
|
if ([string]::IsNullOrWhiteSpace($wsUrl)) {
|
||||||
|
throw "Edge DevTools page target on port $port did not provide a WebSocket URL."
|
||||||
|
}
|
||||||
|
|
||||||
|
$socket = [System.Net.WebSockets.ClientWebSocket]::new()
|
||||||
|
$socket.ConnectAsync($wsUrl, [Threading.CancellationToken]::None).Wait()
|
||||||
|
|
||||||
|
function Send-DevToolsCommand {
|
||||||
|
param([int]$id, [string]$method, [hashtable]$params = @{})
|
||||||
|
$cmd = @{ id = $id; method = $method; params = $params } | ConvertTo-Json -Compress
|
||||||
|
$data = [Text.Encoding]::UTF8.GetBytes($cmd)
|
||||||
|
$socket.SendAsync([ArraySegment[byte]]$data, 'Text', $true, [Threading.CancellationToken]::None).Wait()
|
||||||
|
}
|
||||||
|
|
||||||
|
$buffer = New-Object byte[] 8192
|
||||||
|
|
||||||
|
function Invoke-DevToolsValue {
|
||||||
|
param(
|
||||||
|
[Parameter(Mandatory = $true)][int]$CommandId,
|
||||||
|
[Parameter(Mandatory = $true)][string]$Expression,
|
||||||
|
[int]$MaxPolls = 25
|
||||||
|
)
|
||||||
|
|
||||||
|
Send-DevToolsCommand -id $CommandId -method 'Runtime.evaluate' -params @{
|
||||||
|
expression = $Expression
|
||||||
|
returnByValue = $true
|
||||||
|
awaitPromise = $true
|
||||||
|
}
|
||||||
|
|
||||||
|
for ($poll = 1; $poll -le $MaxPolls; $poll++) {
|
||||||
|
$localStream = $null
|
||||||
|
try {
|
||||||
|
$localStream = New-Object System.IO.MemoryStream
|
||||||
|
do {
|
||||||
|
$segment = [ArraySegment[byte]]::new($buffer)
|
||||||
|
$result = $socket.ReceiveAsync($segment, [Threading.CancellationToken]::None).Result
|
||||||
|
$localStream.Write($buffer, 0, $result.Count)
|
||||||
|
} until ($result.EndOfMessage)
|
||||||
|
|
||||||
|
$jsonBytes = $localStream.ToArray()
|
||||||
|
$jsonText = [Text.Encoding]::UTF8.GetString($jsonBytes)
|
||||||
|
$previewPayload = $jsonText
|
||||||
|
if (-not [string]::IsNullOrEmpty($previewPayload) -and $previewPayload.Length -gt 500) {
|
||||||
|
$previewPayload = $previewPayload.Substring(0, 500) + '...'
|
||||||
|
}
|
||||||
|
WriteLog "DevTools eval payload (cmd $CommandId, poll $poll): $previewPayload"
|
||||||
|
|
||||||
|
$message = $null
|
||||||
|
try {
|
||||||
|
$message = $jsonText | ConvertFrom-Json
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
WriteLog "Failed to parse DevTools eval payload for command id $CommandId (poll $poll): $($_.Exception.Message)"
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($message.PSObject.Properties['id'] -and $message.id -eq $CommandId) {
|
||||||
|
if ($message.PSObject.Properties['error']) {
|
||||||
|
$errorMessage = $message.error.message
|
||||||
|
throw "Edge DevTools reported an error for expression '$Expression': $errorMessage"
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($message.PSObject.Properties['result'] -and $message.result.PSObject.Properties['result']) {
|
||||||
|
$innerResult = $message.result.result
|
||||||
|
return [PSCustomObject]@{
|
||||||
|
Value = $innerResult.value
|
||||||
|
Type = $innerResult.type
|
||||||
|
Subtype = $innerResult.subtype
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
$serializedMessage = $message | ConvertTo-Json -Compress -Depth 5
|
||||||
|
WriteLog "DevTools response for command id $CommandId lacked result data. Message: $serializedMessage"
|
||||||
|
return $null
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($message.PSObject.Properties['method']) {
|
||||||
|
WriteLog "Received DevTools event '$($message.method)' while waiting for command id $CommandId."
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
WriteLog "Received DevTools message without id or method while waiting for command id $CommandId."
|
||||||
|
}
|
||||||
|
}
|
||||||
|
finally {
|
||||||
|
if ($null -ne $localStream) {
|
||||||
|
$localStream.Dispose()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
throw "No DevTools response received for command id $CommandId after $MaxPolls polls."
|
||||||
|
}
|
||||||
|
|
||||||
|
WriteLog "Waiting for PSREF page to initialize local storage context."
|
||||||
|
Start-Sleep -Seconds 2
|
||||||
|
|
||||||
|
$commandCounter = 1000
|
||||||
|
$rawToken = $null
|
||||||
|
$maxTokenAttempts = 12
|
||||||
|
for ($attempt = 1; $attempt -le $maxTokenAttempts -and [string]::IsNullOrWhiteSpace($rawToken); $attempt++) {
|
||||||
|
$commandCounter++
|
||||||
|
$tokenResponse = Invoke-DevToolsValue -CommandId $commandCounter -Expression "window.localStorage?.getItem('asut')" -MaxPolls 25
|
||||||
|
if ($null -ne $tokenResponse -and -not [string]::IsNullOrWhiteSpace($tokenResponse.Value)) {
|
||||||
|
$rawToken = $tokenResponse.Value
|
||||||
|
WriteLog "DevTools response for command id $commandCounter returned token length $($rawToken.Length)."
|
||||||
|
break
|
||||||
|
}
|
||||||
|
|
||||||
|
WriteLog "Lenovo PSREF token not yet available (attempt $attempt of $maxTokenAttempts)."
|
||||||
|
|
||||||
|
$commandCounter++
|
||||||
|
$keysResponse = Invoke-DevToolsValue -CommandId $commandCounter -Expression "JSON.stringify(Object.keys(window.localStorage || {}))" -MaxPolls 10
|
||||||
|
if ($null -ne $keysResponse -and -not [string]::IsNullOrWhiteSpace($keysResponse.Value)) {
|
||||||
|
WriteLog "Current localStorage keys: $($keysResponse.Value)"
|
||||||
|
}
|
||||||
|
|
||||||
|
$commandCounter++
|
||||||
|
$cookieResponse = Invoke-DevToolsValue -CommandId $commandCounter -Expression "document.cookie" -MaxPolls 10
|
||||||
|
if ($null -ne $cookieResponse -and -not [string]::IsNullOrWhiteSpace($cookieResponse.Value)) {
|
||||||
|
WriteLog "document.cookie contents: $($cookieResponse.Value)"
|
||||||
|
$cookieEntry = ($cookieResponse.Value -split ';') | ForEach-Object { $_.Trim() } | Where-Object { $_ -like 'asut=*' } | Select-Object -First 1
|
||||||
|
if ($cookieEntry) {
|
||||||
|
$rawToken = $cookieEntry.Substring($cookieEntry.IndexOf('=') + 1)
|
||||||
|
WriteLog "Extracted Lenovo PSREF token from cookies with length $($rawToken.Length)."
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
Start-Sleep -Milliseconds 750
|
||||||
|
}
|
||||||
|
|
||||||
|
if ([string]::IsNullOrWhiteSpace($rawToken)) {
|
||||||
|
throw "Received empty Lenovo PSREF token from Edge DevTools after $maxTokenAttempts attempts."
|
||||||
|
}
|
||||||
|
|
||||||
|
$token = "X-PSREF-USER-TOKEN=$rawToken"
|
||||||
|
WriteLog "Retrieved Lenovo PSREF token: $token"
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
WriteLog "Failed to retrieve Lenovo PSREF token. Error: $($_.Exception.Message)"
|
||||||
|
throw
|
||||||
|
}
|
||||||
|
finally {
|
||||||
|
if ($null -ne $socket) {
|
||||||
|
try {
|
||||||
|
$socket.Dispose()
|
||||||
|
WriteLog "Edge DevTools WebSocket disposed."
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
WriteLog "Error disposing Edge DevTools WebSocket: $($_.Exception.Message)"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
$listeningPid = $null
|
||||||
|
if ($null -ne $port) {
|
||||||
|
try {
|
||||||
|
$netstatOutput = netstat -ano -p TCP | Where-Object { $_ -match "127\.0\.0\.1:$port.*LISTENING" }
|
||||||
|
if ($netstatOutput) {
|
||||||
|
$listeningPid = ($netstatOutput -split '\s+')[-1]
|
||||||
|
WriteLog "Found Edge process PID $listeningPid listening on port $port."
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
WriteLog "No process reported as listening on port $port."
|
||||||
|
}
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
WriteLog "Could not run netstat to find listening PID for port $port. Error: $($_.Exception.Message)"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
$pidToKill = $null
|
||||||
|
if ($null -ne $listeningPid) {
|
||||||
|
$pidToKill = $listeningPid
|
||||||
|
}
|
||||||
|
elseif ($null -ne $edgeProcess -and -not $edgeProcess.HasExited) {
|
||||||
|
$pidToKill = $edgeProcess.Id
|
||||||
|
WriteLog "Falling back to initial Edge process PID $pidToKill for termination."
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($null -ne $pidToKill) {
|
||||||
|
try {
|
||||||
|
taskkill /PID $pidToKill /T /F | Out-Null
|
||||||
|
WriteLog "Issued termination command for Edge process tree with PID: $pidToKill."
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
WriteLog "Failed to terminate Edge process tree with PID: $pidToKill. Error: $($_.Exception.Message)"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
WriteLog "No active Edge process found to terminate."
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($null -ne $edgeProcess) {
|
||||||
|
try {
|
||||||
|
$edgeProcess.WaitForExit(3000) | Out-Null
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
WriteLog "Error while waiting for Edge process PID $($edgeProcess.Id) to exit: $($_.Exception.Message)"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
Start-Sleep -Milliseconds 250
|
||||||
|
|
||||||
|
if (-not [string]::IsNullOrWhiteSpace($tempProfile) -and (Test-Path -Path $tempProfile -PathType Container)) {
|
||||||
|
$maxRemoveAttempts = 5
|
||||||
|
$originalProgressPreference = $ProgressPreference
|
||||||
|
try {
|
||||||
|
$ProgressPreference = 'SilentlyContinue'
|
||||||
|
for ($removeAttempt = 1; $removeAttempt -le $maxRemoveAttempts; $removeAttempt++) {
|
||||||
|
try {
|
||||||
|
Remove-Item -Path $tempProfile -Recurse -Force -ErrorAction Stop
|
||||||
|
WriteLog "Removed temporary Edge profile at $tempProfile."
|
||||||
|
break
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
if ($removeAttempt -eq $maxRemoveAttempts) {
|
||||||
|
WriteLog "Failed to remove temporary Edge profile at $tempProfile after $maxRemoveAttempts attempts. Error: $($_.Exception.Message)"
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
WriteLog "Temporary Edge profile still locked (attempt $removeAttempt of $maxRemoveAttempts). Retrying..."
|
||||||
|
Start-Sleep -Milliseconds 500
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
finally {
|
||||||
|
$ProgressPreference = $originalProgressPreference
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return $token
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
# --------------------------------------------------------------------------
|
||||||
|
# SECTION: Module Export
|
||||||
|
# --------------------------------------------------------------------------
|
||||||
|
|
||||||
|
Export-ModuleMember -Function `
|
||||||
|
Compress-DriverFolderToWim, `
|
||||||
|
Update-DriverMappingJson, `
|
||||||
|
Test-ExistingDriver, `
|
||||||
|
Get-LenovoPSREFToken
|
||||||
@@ -0,0 +1,522 @@
|
|||||||
|
<#
|
||||||
|
.SYNOPSIS
|
||||||
|
Manages and executes multiple background tasks in parallel, with support for updating a WPF UI with progress.
|
||||||
|
.DESCRIPTION
|
||||||
|
This function provides a generic framework for running tasks in parallel using PowerShell's ForEach-Object -Parallel.
|
||||||
|
It is designed to process an array of items, executing a specific task for each one. It can operate in two modes: UI mode and non-UI mode.
|
||||||
|
|
||||||
|
In UI mode, it updates a specified ListView control in a WPF window with the status of each item as it's being processed
|
||||||
|
(e.g., Queued, Downloading, Completed, Error). It uses a dispatcher to ensure UI updates are thread-safe.
|
||||||
|
|
||||||
|
In non-UI mode, it runs the tasks and logs the status to the FFUDevelopment.log file.
|
||||||
|
|
||||||
|
The function determines the task to run via the -TaskType parameter and passes necessary arguments using -TaskArguments.
|
||||||
|
It handles module imports and log file setup within each parallel runspace to ensure tasks have the necessary dependencies and logging capabilities.
|
||||||
|
.PARAMETER ItemsToProcess
|
||||||
|
An array of objects, where each object represents an item to be processed by a parallel task. This is a mandatory parameter.
|
||||||
|
.PARAMETER ListViewControl
|
||||||
|
(UI Mode) The WPF ListView control that the function will update with the status of each item. Defaults to $null.
|
||||||
|
.PARAMETER IdentifierProperty
|
||||||
|
The name of the property on the item objects that serves as a unique identifier (e.g., 'Name', 'Id').
|
||||||
|
This is used to find and update the correct row in the ListView.
|
||||||
|
.PARAMETER StatusProperty
|
||||||
|
The name of the property on the item objects that holds the status string. This property will be updated with progress messages.
|
||||||
|
.PARAMETER TaskType
|
||||||
|
A string specifying which task to execute for each item. This is mandatory.
|
||||||
|
Valid values are:
|
||||||
|
- 'WingetDownload': Downloads a Winget application.
|
||||||
|
- 'CopyBYO': Copies a user-provided application.
|
||||||
|
- 'DownloadDriverByMake': Downloads drivers for a specific manufacturer.
|
||||||
|
.PARAMETER TaskArguments
|
||||||
|
A hashtable containing arguments required by the specific task being run (e.g., paths, API keys, configuration settings).
|
||||||
|
.PARAMETER CompletedStatusText
|
||||||
|
The status text to display when an item is processed successfully.
|
||||||
|
.PARAMETER ErrorStatusPrefix
|
||||||
|
A prefix for status messages when an error occurs.
|
||||||
|
.PARAMETER WindowObject
|
||||||
|
(UI Mode) The main WPF Window object, used to access the UI dispatcher for safe UI updates from background threads.
|
||||||
|
.PARAMETER MainThreadLogPath
|
||||||
|
The file path for the log file that should be used by all parallel threads. This ensures consistent logging.
|
||||||
|
.PARAMETER ThrottleLimit
|
||||||
|
The maximum number of parallel jobs to run concurrently. The default is 5.
|
||||||
|
.NOTES
|
||||||
|
This function relies on ForEach-Object -Parallel, which was introduced in PowerShell 7.
|
||||||
|
When running in UI mode, both -WindowObject and -ListViewControl must be provided.
|
||||||
|
The function dynamically imports required modules ('FFU.Common' and 'FFUUI.Core') into each parallel runspace.
|
||||||
|
It uses a concurrent queue to manage intermediate progress updates from threads to the main UI thread, preventing UI blocking and providing more granular feedback.
|
||||||
|
#>
|
||||||
|
function Invoke-ParallelProcessing {
|
||||||
|
[CmdletBinding()]
|
||||||
|
param(
|
||||||
|
[Parameter(Mandatory)]
|
||||||
|
[array]$ItemsToProcess,
|
||||||
|
[Parameter(Mandatory = $false)]
|
||||||
|
[object]$ListViewControl = $null,
|
||||||
|
[Parameter(Mandatory = $false)]
|
||||||
|
[string]$IdentifierProperty = 'Identifier',
|
||||||
|
[Parameter(Mandatory = $false)]
|
||||||
|
[string]$StatusProperty = 'Status',
|
||||||
|
[Parameter(Mandatory)]
|
||||||
|
[ValidateSet('WingetDownload', 'CopyBYO', 'DownloadDriverByMake')]
|
||||||
|
[string]$TaskType,
|
||||||
|
[Parameter()]
|
||||||
|
[hashtable]$TaskArguments = @{},
|
||||||
|
[Parameter(Mandatory = $false)]
|
||||||
|
[string]$CompletedStatusText = "Completed",
|
||||||
|
[Parameter(Mandatory = $false)]
|
||||||
|
[string]$ErrorStatusPrefix = "Error: ",
|
||||||
|
[Parameter(Mandatory = $false)]
|
||||||
|
[object]$WindowObject = $null,
|
||||||
|
[Parameter(Mandatory = $false)]
|
||||||
|
[string]$MainThreadLogPath = $null,
|
||||||
|
[Parameter(Mandatory = $false)]
|
||||||
|
[int]$ThrottleLimit = 5
|
||||||
|
)
|
||||||
|
# Check if running in UI mode by verifying the types of the passed objects
|
||||||
|
$isUiMode = ($null -ne $WindowObject -and $WindowObject -is [System.Windows.Window] -and $null -ne $ListViewControl -and $ListViewControl -is [System.Windows.Controls.ListView])
|
||||||
|
|
||||||
|
if ($isUiMode) {
|
||||||
|
WriteLog "Invoke-ParallelProcessing started for $($ItemsToProcess.Count) items in ListView '$($ListViewControl.Name)'."
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
WriteLog "Invoke-ParallelProcessing started for $($ItemsToProcess.Count) items (non-UI mode)."
|
||||||
|
}
|
||||||
|
$resultsCollection = [System.Collections.Generic.List[object]]::new()
|
||||||
|
$jobs = @()
|
||||||
|
$totalItems = $ItemsToProcess.Count
|
||||||
|
$processedCount = 0
|
||||||
|
$completedIdentifiers = [System.Collections.Generic.HashSet[string]]::new([System.StringComparer]::OrdinalIgnoreCase)
|
||||||
|
|
||||||
|
# Create a thread-safe queue for intermediate progress updates
|
||||||
|
$progressQueue = New-Object System.Collections.Concurrent.ConcurrentQueue[hashtable]
|
||||||
|
|
||||||
|
# Define common paths locally within this function's scope
|
||||||
|
$coreModulePath = $MyInvocation.MyCommand.Module.Path
|
||||||
|
$coreModuleDirectory = Split-Path -Path $coreModulePath -Parent
|
||||||
|
$ffuDevelopmentRoot = Split-Path -Path $coreModuleDirectory -Parent
|
||||||
|
|
||||||
|
# Paths to the module DIRECTORIES needed by the parallel threads
|
||||||
|
$commonModulePathForJob = Join-Path -Path $ffuDevelopmentRoot -ChildPath "FFU.Common"
|
||||||
|
$uiCoreModulePathForJob = Join-Path -Path $ffuDevelopmentRoot -ChildPath "FFUUI.Core"
|
||||||
|
|
||||||
|
# Use the explicitly passed MainThreadLogPath for the parallel jobs.
|
||||||
|
# If not provided (e.g., older calls or direct module use without this param), it might be null.
|
||||||
|
# The parallel job's Set-CommonCoreLogPath will handle null/empty paths by warning.
|
||||||
|
$currentLogFilePathForJob = $MainThreadLogPath
|
||||||
|
|
||||||
|
$jobScopeVariables = $TaskArguments.Clone()
|
||||||
|
$jobScopeVariables['_commonModulePath'] = $commonModulePathForJob
|
||||||
|
$jobScopeVariables['_uiCoreModulePath'] = $uiCoreModulePathForJob
|
||||||
|
$jobScopeVariables['_currentLogFilePathForJob'] = $currentLogFilePathForJob
|
||||||
|
$jobScopeVariables['_progressQueue'] = $progressQueue
|
||||||
|
|
||||||
|
# Initial UI update needs to happen *before* starting the jobs
|
||||||
|
# Update all items to a static "Processing..." status
|
||||||
|
if ($isUiMode) {
|
||||||
|
# Use the new $isUiMode flag
|
||||||
|
foreach ($item in $ItemsToProcess) {
|
||||||
|
$identifierValue = $item.$IdentifierProperty
|
||||||
|
$initialStaticStatus = "Queued..."
|
||||||
|
try {
|
||||||
|
# Update the UI on the main thread to show the item is being queued for processing
|
||||||
|
$WindowObject.Dispatcher.Invoke([System.Windows.Threading.DispatcherPriority]::Background, [Action] {
|
||||||
|
Update-ListViewItemStatus -WindowObject $WindowObject -ListView $ListViewControl -IdentifierProperty $IdentifierProperty -IdentifierValue $identifierValue -StatusProperty $StatusProperty -StatusValue $initialStaticStatus
|
||||||
|
})
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
WriteLog "Error setting initial status for item '$identifierValue': $($_.Exception.Message)"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# Queue items and start jobs using the pipeline and $using:
|
||||||
|
try {
|
||||||
|
# $jobScopeVariables and $TaskType are local here
|
||||||
|
# Inside the -Parallel scriptblock, we access them with $using:
|
||||||
|
$jobs = $ItemsToProcess | ForEach-Object -Parallel {
|
||||||
|
$currentItem = $_
|
||||||
|
$localJobArgs = $using:jobScopeVariables
|
||||||
|
$localTaskType = $using:TaskType
|
||||||
|
$localProgressQueue = $localJobArgs['_progressQueue']
|
||||||
|
|
||||||
|
# Initialize result hashtable
|
||||||
|
$taskResult = $null
|
||||||
|
$resultIdentifier = $null
|
||||||
|
$resultStatus = "Error: Task type '$localTaskType' not recognized"
|
||||||
|
$resultCode = 1 # Default to error
|
||||||
|
|
||||||
|
try {
|
||||||
|
# Import modules needed for the task
|
||||||
|
Import-Module $localJobArgs['_commonModulePath'] -Force
|
||||||
|
Import-Module $localJobArgs['_uiCoreModulePath'] -Force
|
||||||
|
|
||||||
|
# Set the log path for this parallel thread
|
||||||
|
Set-CommonCoreLogPath -Path $localJobArgs['_currentLogFilePathForJob']
|
||||||
|
|
||||||
|
# Execute the appropriate background task based on $localTaskType
|
||||||
|
switch ($localTaskType) {
|
||||||
|
'WingetDownload' {
|
||||||
|
# Pass the progress queue and SkipWin32Json to the task function
|
||||||
|
$wingetTaskArgs = @{
|
||||||
|
ApplicationItemData = $currentItem
|
||||||
|
AppListJsonPath = $localJobArgs['AppListJsonPath']
|
||||||
|
AppsPath = $localJobArgs['AppsPath']
|
||||||
|
UserAppListPath = $localJobArgs['UserAppListPath']
|
||||||
|
OrchestrationPath = $localJobArgs['OrchestrationPath']
|
||||||
|
ProgressQueue = $localProgressQueue
|
||||||
|
WindowsArch = $localJobArgs['WindowsArch']
|
||||||
|
SkipWin32Json = [bool]$localJobArgs['SkipWin32Json']
|
||||||
|
}
|
||||||
|
$taskResult = Start-WingetAppDownloadTask @wingetTaskArgs
|
||||||
|
if ($null -ne $taskResult) {
|
||||||
|
$resultIdentifier = $taskResult.Id
|
||||||
|
$resultStatus = $taskResult.Status
|
||||||
|
$resultCode = $taskResult.ResultCode
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
$resultIdentifier = $currentItem.Id # Fallback
|
||||||
|
$resultStatus = "Error: WingetDownload task returned null"
|
||||||
|
$resultCode = 1
|
||||||
|
WriteLog $resultStatus
|
||||||
|
}
|
||||||
|
}
|
||||||
|
'CopyBYO' {
|
||||||
|
# Pass the progress queue to the task function
|
||||||
|
$taskResult = Start-CopyBYOApplicationTask -ApplicationItemData $currentItem `
|
||||||
|
-AppsPath $localJobArgs['AppsPath'] `
|
||||||
|
-ProgressQueue $localProgressQueue
|
||||||
|
if ($null -ne $taskResult) {
|
||||||
|
$resultIdentifier = $taskResult.Name
|
||||||
|
$resultStatus = $taskResult.Status
|
||||||
|
$resultCode = if ($taskResult.Success) { 0 } else { 1 }
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
$resultIdentifier = $currentItem.Name # Fallback
|
||||||
|
$resultStatus = "Error: CopyBYO task returned null"
|
||||||
|
$resultCode = 1
|
||||||
|
WriteLog $resultStatus
|
||||||
|
}
|
||||||
|
}
|
||||||
|
'DownloadDriverByMake' {
|
||||||
|
$make = $currentItem.Make
|
||||||
|
# Ensure $resultIdentifier is set before the switch, using the main IdentifierProperty
|
||||||
|
# This is crucial if a Make is unsupported or a task fails to return a result.
|
||||||
|
$resultIdentifier = $currentItem.$($using:IdentifierProperty)
|
||||||
|
|
||||||
|
switch ($make) {
|
||||||
|
'Microsoft' {
|
||||||
|
$taskResult = Save-MicrosoftDriversTask -DriverItemData $currentItem `
|
||||||
|
-DriversFolder $localJobArgs['DriversFolder'] `
|
||||||
|
-WindowsRelease $localJobArgs['WindowsRelease'] `
|
||||||
|
-Headers $localJobArgs['Headers'] `
|
||||||
|
-UserAgent $localJobArgs['UserAgent'] `
|
||||||
|
-ProgressQueue $localProgressQueue `
|
||||||
|
-CompressToWim $localJobArgs['CompressToWim'] `
|
||||||
|
-PreserveSourceOnCompress $localJobArgs['PreserveSourceOnCompress']
|
||||||
|
}
|
||||||
|
'Dell' {
|
||||||
|
$taskResult = Save-DellDriversTask -DriverItemData $currentItem `
|
||||||
|
-DriversFolder $localJobArgs['DriversFolder'] `
|
||||||
|
-WindowsArch $localJobArgs['WindowsArch'] `
|
||||||
|
-WindowsRelease $localJobArgs['WindowsRelease'] `
|
||||||
|
-ProgressQueue $localProgressQueue `
|
||||||
|
-CompressToWim $localJobArgs['CompressToWim'] `
|
||||||
|
-PreserveSourceOnCompress $localJobArgs['PreserveSourceOnCompress']
|
||||||
|
}
|
||||||
|
'HP' {
|
||||||
|
$taskResult = Save-HPDriversTask -DriverItemData $currentItem `
|
||||||
|
-DriversFolder $localJobArgs['DriversFolder'] `
|
||||||
|
-WindowsArch $localJobArgs['WindowsArch'] `
|
||||||
|
-WindowsRelease $localJobArgs['WindowsRelease'] `
|
||||||
|
-WindowsVersion $localJobArgs['WindowsVersion'] `
|
||||||
|
-ProgressQueue $localProgressQueue `
|
||||||
|
-CompressToWim $localJobArgs['CompressToWim'] `
|
||||||
|
-PreserveSourceOnCompress $localJobArgs['PreserveSourceOnCompress']
|
||||||
|
}
|
||||||
|
'Lenovo' {
|
||||||
|
$taskResult = Save-LenovoDriversTask -DriverItemData $currentItem `
|
||||||
|
-DriversFolder $localJobArgs['DriversFolder'] `
|
||||||
|
-WindowsRelease $localJobArgs['WindowsRelease'] `
|
||||||
|
-Headers $localJobArgs['Headers'] `
|
||||||
|
-UserAgent $localJobArgs['UserAgent'] `
|
||||||
|
-ProgressQueue $localProgressQueue `
|
||||||
|
-CompressToWim $localJobArgs['CompressToWim'] `
|
||||||
|
-PreserveSourceOnCompress $localJobArgs['PreserveSourceOnCompress']
|
||||||
|
}
|
||||||
|
default {
|
||||||
|
$unsupportedMakeMessage = "Error: Unsupported Make '$make' for driver download."
|
||||||
|
WriteLog $unsupportedMakeMessage
|
||||||
|
$resultStatus = $unsupportedMakeMessage
|
||||||
|
$resultCode = 1
|
||||||
|
# $resultIdentifier is already set from $currentItem.$($using:IdentifierProperty)
|
||||||
|
$localProgressQueue.Enqueue(@{ Identifier = $resultIdentifier; Status = $resultStatus })
|
||||||
|
# $taskResult remains null, handled below
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# Consolidate result handling for 'DownloadDriverByMake'
|
||||||
|
if ($null -ne $taskResult) {
|
||||||
|
# $resultIdentifier is already $currentItem.$($using:IdentifierProperty)
|
||||||
|
# We use the task's returned Model/Identifier for logging/status if needed,
|
||||||
|
# but the primary identifier for UI updates should be consistent.
|
||||||
|
$taskSpecificIdentifier = $null
|
||||||
|
if ($taskResult.PSObject.Properties.Name -contains 'Model') { $taskSpecificIdentifier = $taskResult.Model }
|
||||||
|
elseif ($taskResult.PSObject.Properties.Name -contains 'Identifier') { $taskSpecificIdentifier = $taskResult.Identifier }
|
||||||
|
|
||||||
|
$resultStatus = $taskResult.Status
|
||||||
|
# Simplified success check. All driver tasks should now return a 'Success' property.
|
||||||
|
if ($taskResult.PSObject.Properties.Name -contains 'Success') {
|
||||||
|
$resultCode = if ($taskResult.Success) { 0 } else { 1 }
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
# Fallback for any task that *still* doesn't return 'Success'. This is now the exceptional case.
|
||||||
|
WriteLog "Warning: Task for '$taskSpecificIdentifier' did not return a 'Success' property. Inferring from status: '$($taskResult.Status)'"
|
||||||
|
if ($taskResult.Status -like 'Completed*' -or $taskResult.Status -like 'Already downloaded*' -or $taskResult.Status -like 'Compression successful*') {
|
||||||
|
$resultCode = 0 # Treat as success
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
$resultCode = 1 # Treat as error
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
elseif ($make -in ('Microsoft', 'Dell', 'HP', 'Lenovo')) {
|
||||||
|
# This means a specific Make case was hit, but $taskResult was unexpectedly null
|
||||||
|
$nullTaskResultMessage = "Error: Task for Make '$make' returned null."
|
||||||
|
WriteLog $nullTaskResultMessage
|
||||||
|
$resultStatus = $nullTaskResultMessage
|
||||||
|
$resultCode = 1
|
||||||
|
}
|
||||||
|
}
|
||||||
|
Default {
|
||||||
|
# This handles unknown $localTaskType values
|
||||||
|
$resultStatus = "Error: Task type '$localTaskType' not recognized"
|
||||||
|
$resultCode = 1
|
||||||
|
if ($currentItem -is [pscustomobject] -and $currentItem.PSObject.Properties.Name -match $using:IdentifierProperty) {
|
||||||
|
$resultIdentifier = $currentItem.$($using:IdentifierProperty)
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
$resultIdentifier = "UnknownItem"
|
||||||
|
}
|
||||||
|
WriteLog "Error in parallel job: Unknown TaskType '$localTaskType' provided for item '$resultIdentifier'."
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
$resultStatus = "Error: $($_.Exception.Message)"
|
||||||
|
$resultCode = 1
|
||||||
|
# Try to get an identifier
|
||||||
|
if ($currentItem -is [pscustomobject] -and $currentItem.PSObject.Properties.Name -match $using:IdentifierProperty) {
|
||||||
|
$resultIdentifier = $currentItem.$($using:IdentifierProperty)
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
$resultIdentifier = "UnknownItemOnError"
|
||||||
|
}
|
||||||
|
WriteLog "Exception during parallel task '$localTaskType' for item '$resultIdentifier': $($_.Exception.ToString())"
|
||||||
|
$localProgressQueue.Enqueue(@{ Identifier = $resultIdentifier; Status = $resultStatus })
|
||||||
|
}
|
||||||
|
|
||||||
|
$driverPathValue = $null
|
||||||
|
if ($null -ne $taskResult -and $taskResult.PSObject.Properties.Name -contains 'DriverPath') {
|
||||||
|
$driverPathValue = $taskResult.DriverPath
|
||||||
|
}
|
||||||
|
|
||||||
|
# Return a consistent hashtable structure (final result)
|
||||||
|
return @{
|
||||||
|
Identifier = $resultIdentifier
|
||||||
|
Status = $resultStatus
|
||||||
|
ResultCode = $resultCode
|
||||||
|
DriverPath = $driverPathValue
|
||||||
|
}
|
||||||
|
|
||||||
|
} -ThrottleLimit $ThrottleLimit -AsJob
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
WriteLog "Error initiating ForEach-Object -Parallel: $($_.Exception.Message)"
|
||||||
|
# Update all items to show a general startup error
|
||||||
|
$errorStatus = "$ErrorStatusPrefix Failed to start processing"
|
||||||
|
foreach ($item in $ItemsToProcess) {
|
||||||
|
$identifier = $item.$IdentifierProperty
|
||||||
|
$WindowObject.Dispatcher.Invoke([System.Windows.Threading.DispatcherPriority]::Background, [Action] { # Use $WindowObject
|
||||||
|
Update-ListViewItemStatus -WindowObject $WindowObject -ListView $ListViewControl -IdentifierProperty $IdentifierProperty -IdentifierValue $identifier -StatusProperty $StatusProperty -StatusValue $errorStatus # Pass $WindowObject
|
||||||
|
})
|
||||||
|
}
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
# Check if any jobs failed to start immediately (e.g., module loading issues within the job)
|
||||||
|
$failedJobs = $jobs | Where-Object { $_.State -eq 'Failed' -and $_.JobStateInfo.Reason }
|
||||||
|
foreach ($failedJob in $failedJobs) {
|
||||||
|
WriteLog "Job $($failedJob.Id) failed to start or failed early: $($failedJob.JobStateInfo.Reason)"
|
||||||
|
# We don't easily know which item failed here without more complex mapping
|
||||||
|
# Update overall status maybe?
|
||||||
|
$processedCount++
|
||||||
|
}
|
||||||
|
# Filter out jobs that failed immediately
|
||||||
|
$jobs = $jobs | Where-Object { $_.State -ne 'Failed' }
|
||||||
|
|
||||||
|
# Process job results and intermediate status updates without blocking the UI thread
|
||||||
|
while ($jobs.Count -gt 0 -or -not $progressQueue.IsEmpty) {
|
||||||
|
# Continue while jobs are running OR queue has messages
|
||||||
|
|
||||||
|
# 1. Process intermediate status updates from the queue
|
||||||
|
$statusUpdate = $null
|
||||||
|
while ($progressQueue.TryDequeue([ref]$statusUpdate)) {
|
||||||
|
if ($null -ne $statusUpdate) {
|
||||||
|
WriteLog "Dequeued progress update: $($statusUpdate | ConvertTo-Json -Compress)"
|
||||||
|
$intermediateIdentifier = $statusUpdate.Identifier
|
||||||
|
# If this item has already been marked as complete, skip this stale intermediate update
|
||||||
|
if ($completedIdentifiers.Contains($intermediateIdentifier)) {
|
||||||
|
WriteLog "Skipping stale intermediate status for already completed item: $intermediateIdentifier"
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
$intermediateStatus = $statusUpdate.Status
|
||||||
|
if ($isUiMode) {
|
||||||
|
# Update the UI with the intermediate status
|
||||||
|
try {
|
||||||
|
WriteLog "Dispatching INTERMEDIATE status for '$intermediateIdentifier': '$intermediateStatus'"
|
||||||
|
$WindowObject.Dispatcher.Invoke([System.Windows.Threading.DispatcherPriority]::Background, [Action] {
|
||||||
|
Update-ListViewItemStatus -WindowObject $WindowObject -ListView $ListViewControl -IdentifierProperty $IdentifierProperty -IdentifierValue $intermediateIdentifier -StatusProperty $StatusProperty -StatusValue $intermediateStatus
|
||||||
|
})
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
WriteLog "Error setting intermediate status for item '$intermediateIdentifier': $($_.Exception.Message)"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
# Log intermediate status if not in UI mode
|
||||||
|
WriteLog "Intermediate Status for '$intermediateIdentifier': $intermediateStatus"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# 2. Check for completed jobs
|
||||||
|
$completedJobs = $jobs | Where-Object { $_.State -in 'Completed', 'Failed', 'Stopped' }
|
||||||
|
|
||||||
|
if ($completedJobs) {
|
||||||
|
foreach ($completedJob in $completedJobs) {
|
||||||
|
$jobHandled = $false
|
||||||
|
if ($completedJob.State -eq 'Failed') {
|
||||||
|
$jobHandled = $true
|
||||||
|
$finalIdentifier = "UnknownJob"
|
||||||
|
WriteLog "Job $($completedJob.Id) failed: $($completedJob.Error)"
|
||||||
|
$finalStatus = "$ErrorStatusPrefix Job Failed"
|
||||||
|
$finalResultCode = 1
|
||||||
|
$processedCount++
|
||||||
|
|
||||||
|
# --- DISPATCH FOR FAILED JOB ---
|
||||||
|
$completedIdentifiers.Add($finalIdentifier) | Out-Null
|
||||||
|
if ($isUiMode) {
|
||||||
|
try {
|
||||||
|
WriteLog "Dispatching FINAL status for '$finalIdentifier': '$finalStatus'"
|
||||||
|
$WindowObject.Dispatcher.Invoke([System.Windows.Threading.DispatcherPriority]::Background, [Action] { Update-ListViewItemStatus -WindowObject $WindowObject -ListView $ListViewControl -IdentifierProperty $IdentifierProperty -IdentifierValue $finalIdentifier -StatusProperty $StatusProperty -StatusValue $finalStatus })
|
||||||
|
$WindowObject.Dispatcher.Invoke([System.Windows.Threading.DispatcherPriority]::Background, [Action] { Update-OverallProgress -WindowObject $WindowObject -CompletedCount $processedCount -TotalCount $totalItems -StatusText "Processed $processedCount of $totalItems..." -ProgressBarName "progressBar" -StatusLabelName "txtStatus" })
|
||||||
|
}
|
||||||
|
catch { WriteLog "Error setting FINAL status for item '$finalIdentifier': $($_.Exception.Message)" }
|
||||||
|
}
|
||||||
|
else { WriteLog "Final Status for '$finalIdentifier': $finalStatus (ResultCode: $finalResultCode)" }
|
||||||
|
}
|
||||||
|
elseif ($completedJob.HasMoreData) {
|
||||||
|
$jobHandled = $true
|
||||||
|
$jobResults = $completedJob | Receive-Job
|
||||||
|
foreach ($result in $jobResults) {
|
||||||
|
WriteLog "Received FINAL job result: $($result | ConvertTo-Json -Compress -Depth 3)"
|
||||||
|
if ($null -ne $result -and $result -is [hashtable] -and $result.ContainsKey('Identifier')) {
|
||||||
|
$finalIdentifier = $result.Identifier
|
||||||
|
$status = $result.Status
|
||||||
|
$finalResultCode = $result.ResultCode
|
||||||
|
$finalStatus = if ($finalResultCode -eq 0) { $status } else { "$($ErrorStatusPrefix)$($status)" }
|
||||||
|
$processedCount++
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
$finalIdentifier = "UnknownResult"
|
||||||
|
WriteLog "Warning: Received unexpected final job result format: $($result | Out-String)"
|
||||||
|
$finalStatus = "$ErrorStatusPrefix Invalid Result Format"
|
||||||
|
$finalResultCode = 1
|
||||||
|
$processedCount++
|
||||||
|
}
|
||||||
|
if ($null -ne $result) { $resultsCollection.Add($result) }
|
||||||
|
|
||||||
|
# --- DISPATCH PER RESULT ---
|
||||||
|
$completedIdentifiers.Add($finalIdentifier) | Out-Null
|
||||||
|
if ($isUiMode) {
|
||||||
|
try {
|
||||||
|
WriteLog "Dispatching FINAL status for '$finalIdentifier': '$finalStatus'"
|
||||||
|
$WindowObject.Dispatcher.Invoke([System.Windows.Threading.DispatcherPriority]::Background, [Action] { Update-ListViewItemStatus -WindowObject $WindowObject -ListView $ListViewControl -IdentifierProperty $IdentifierProperty -IdentifierValue $finalIdentifier -StatusProperty $StatusProperty -StatusValue $finalStatus })
|
||||||
|
$WindowObject.Dispatcher.Invoke([System.Windows.Threading.DispatcherPriority]::Background, [Action] { Update-OverallProgress -WindowObject $WindowObject -CompletedCount $processedCount -TotalCount $totalItems -StatusText "Processed $processedCount of $totalItems..." -ProgressBarName "progressBar" -StatusLabelName "txtStatus" })
|
||||||
|
}
|
||||||
|
catch { WriteLog "Error setting FINAL status for item '$finalIdentifier': $($_.Exception.Message)" }
|
||||||
|
}
|
||||||
|
else { WriteLog "Final Status for '$finalIdentifier': $finalStatus (ResultCode: $finalResultCode)" }
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if (-not $jobHandled) {
|
||||||
|
# Catches 'Completed' with no data
|
||||||
|
$finalIdentifier = "UnknownJob"
|
||||||
|
WriteLog "Job $($completedJob.Id) completed with state '$($completedJob.State)' but had no data."
|
||||||
|
$finalStatus = "$ErrorStatusPrefix No Result Data"
|
||||||
|
$finalResultCode = 1
|
||||||
|
$processedCount++
|
||||||
|
|
||||||
|
# --- DISPATCH FOR NO-DATA JOB ---
|
||||||
|
$completedIdentifiers.Add($finalIdentifier) | Out-Null
|
||||||
|
if ($isUiMode) {
|
||||||
|
try {
|
||||||
|
WriteLog "Dispatching FINAL status for '$finalIdentifier': '$finalStatus'"
|
||||||
|
$WindowObject.Dispatcher.Invoke([System.Windows.Threading.DispatcherPriority]::Background, [Action] { Update-ListViewItemStatus -WindowObject $WindowObject -ListView $ListViewControl -IdentifierProperty $IdentifierProperty -IdentifierValue $finalIdentifier -StatusProperty $StatusProperty -StatusValue $finalStatus })
|
||||||
|
$WindowObject.Dispatcher.Invoke([System.Windows.Threading.DispatcherPriority]::Background, [Action] { Update-OverallProgress -WindowObject $WindowObject -CompletedCount $processedCount -TotalCount $totalItems -StatusText "Processed $processedCount of $totalItems..." -ProgressBarName "progressBar" -StatusLabelName "txtStatus" })
|
||||||
|
}
|
||||||
|
catch { WriteLog "Error setting FINAL status for item '$finalIdentifier': $($_.Exception.Message)" }
|
||||||
|
}
|
||||||
|
else { WriteLog "Final Status for '$finalIdentifier': $finalStatus (ResultCode: $finalResultCode)" }
|
||||||
|
}
|
||||||
|
|
||||||
|
# Remove the completed/failed job from the list and clean it up
|
||||||
|
$jobs = $jobs | Where-Object { $_.Id -ne $completedJob.Id }
|
||||||
|
Remove-Job -Job $completedJob -Force -ErrorAction SilentlyContinue
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# 3. Allow UI events to process and sleep briefly
|
||||||
|
if ($isUiMode) {
|
||||||
|
# Only sleep if jobs are still running AND the queue is empty (to avoid delaying UI updates)
|
||||||
|
if ($jobs.Count -gt 0 -and $progressQueue.IsEmpty) {
|
||||||
|
$WindowObject.Dispatcher.Invoke([System.Windows.Threading.DispatcherPriority]::Background, [action] { }) | Out-Null
|
||||||
|
Start-Sleep -Milliseconds 100
|
||||||
|
}
|
||||||
|
elseif (-not $progressQueue.IsEmpty) {
|
||||||
|
# If queue has messages, process them immediately without sleeping
|
||||||
|
$WindowObject.Dispatcher.Invoke([System.Windows.Threading.DispatcherPriority]::Background, [action] { }) | Out-Null
|
||||||
|
}
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
# Non-UI mode, just sleep if jobs are running
|
||||||
|
if ($jobs.Count -gt 0) {
|
||||||
|
Start-Sleep -Milliseconds 100
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
# Final cleanup of any remaining jobs (shouldn't be necessary with this loop logic, but good practice)
|
||||||
|
if ($jobs.Count -gt 0) {
|
||||||
|
WriteLog "Cleaning up $($jobs.Count) remaining jobs after loop exit."
|
||||||
|
Remove-Job -Job $jobs -Force -ErrorAction SilentlyContinue
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($isUiMode) {
|
||||||
|
WriteLog "Invoke-ParallelProcessing finished for ListView '$($ListViewControl.Name)'."
|
||||||
|
# Final overall progress update
|
||||||
|
$WindowObject.Dispatcher.Invoke([System.Windows.Threading.DispatcherPriority]::Background, [Action] {
|
||||||
|
Update-OverallProgress -WindowObject $WindowObject -CompletedCount $processedCount -TotalCount $totalItems -StatusText "Processing complete. Processed $processedCount of $totalItems." -ProgressBarName "progressBar" -StatusLabelName "txtStatus"
|
||||||
|
})
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
WriteLog "Invoke-ParallelProcessing finished (non-UI mode). Processed $processedCount of $totalItems."
|
||||||
|
}
|
||||||
|
|
||||||
|
# Return all collected final results from jobs
|
||||||
|
return $resultsCollection
|
||||||
|
}
|
||||||
|
|
||||||
|
Export-ModuleMember -Function Invoke-ParallelProcessing
|
||||||
@@ -0,0 +1,137 @@
|
|||||||
|
#
|
||||||
|
# Module manifest for module 'FFU.Common'
|
||||||
|
#
|
||||||
|
# Generated by: Richard Balsley
|
||||||
|
#
|
||||||
|
# Generated on: 6/11/2025
|
||||||
|
#
|
||||||
|
|
||||||
|
@{
|
||||||
|
|
||||||
|
# Script module or binary module file associated with this manifest.
|
||||||
|
RootModule = 'FFU.Common.Core.psm1'
|
||||||
|
|
||||||
|
# Version number of this module.
|
||||||
|
ModuleVersion = '0.0.1'
|
||||||
|
|
||||||
|
# Supported PSEditions
|
||||||
|
# CompatiblePSEditions = @()
|
||||||
|
|
||||||
|
# ID used to uniquely identify this module
|
||||||
|
GUID = '7dac2b8f-e65a-4997-961e-7a5ef5161901'
|
||||||
|
|
||||||
|
# Author of this module
|
||||||
|
Author = 'Richard Balsley'
|
||||||
|
|
||||||
|
# Company or vendor of this module
|
||||||
|
CompanyName = 'Unknown'
|
||||||
|
|
||||||
|
# Copyright statement for this module
|
||||||
|
Copyright = '(c) Richard Balsley. All rights reserved.'
|
||||||
|
|
||||||
|
# Description of the functionality provided by this module
|
||||||
|
Description = 'Common functions shared between FFU Builder UI and the BuildFFUVM.ps1 build script.'
|
||||||
|
|
||||||
|
# Minimum version of the PowerShell engine required by this module
|
||||||
|
# PowerShellVersion = ''
|
||||||
|
|
||||||
|
# Name of the PowerShell host required by this module
|
||||||
|
# PowerShellHostName = ''
|
||||||
|
|
||||||
|
# Minimum version of the PowerShell host required by this module
|
||||||
|
# PowerShellHostVersion = ''
|
||||||
|
|
||||||
|
# Minimum version of Microsoft .NET Framework required by this module. This prerequisite is valid for the PowerShell Desktop edition only.
|
||||||
|
# DotNetFrameworkVersion = ''
|
||||||
|
|
||||||
|
# Minimum version of the common language runtime (CLR) required by this module. This prerequisite is valid for the PowerShell Desktop edition only.
|
||||||
|
# ClrVersion = ''
|
||||||
|
|
||||||
|
# Processor architecture (None, X86, Amd64) required by this module
|
||||||
|
# ProcessorArchitecture = ''
|
||||||
|
|
||||||
|
# Modules that must be imported into the global environment prior to importing this module
|
||||||
|
# RequiredModules = @()
|
||||||
|
|
||||||
|
# Assemblies that must be loaded prior to importing this module
|
||||||
|
# RequiredAssemblies = @()
|
||||||
|
|
||||||
|
# Script files (.ps1) that are run in the caller's environment prior to importing this module.
|
||||||
|
# ScriptsToProcess = @()
|
||||||
|
|
||||||
|
# Type files (.ps1xml) to be loaded when importing this module
|
||||||
|
# TypesToProcess = @()
|
||||||
|
|
||||||
|
# Format files (.ps1xml) to be loaded when importing this module
|
||||||
|
# FormatsToProcess = @()
|
||||||
|
|
||||||
|
# Modules to import as nested modules of the module specified in RootModule/ModuleToProcess
|
||||||
|
NestedModules = @('FFU.Common.Drivers.psm1',
|
||||||
|
'FFU.Common.Drivers.Microsoft.psm1',
|
||||||
|
'FFU.Common.Drivers.Dell.psm1',
|
||||||
|
'FFU.Common.Winget.psm1',
|
||||||
|
'FFU.Common.Parallel.psm1',
|
||||||
|
'FFU.Common.Cleanup.psm1')
|
||||||
|
|
||||||
|
# Functions to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no functions to export.
|
||||||
|
FunctionsToExport = '*'
|
||||||
|
|
||||||
|
# Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export.
|
||||||
|
CmdletsToExport = '*'
|
||||||
|
|
||||||
|
# Variables to export from this module
|
||||||
|
VariablesToExport = '*'
|
||||||
|
|
||||||
|
# Aliases to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no aliases to export.
|
||||||
|
AliasesToExport = '*'
|
||||||
|
|
||||||
|
# DSC resources to export from this module
|
||||||
|
# DscResourcesToExport = @()
|
||||||
|
|
||||||
|
# List of all modules packaged with this module
|
||||||
|
# ModuleList = @()
|
||||||
|
|
||||||
|
# List of all files packaged with this module
|
||||||
|
# FileList = @()
|
||||||
|
|
||||||
|
# Private data to pass to the module specified in RootModule/ModuleToProcess. This may also contain a PSData hashtable with additional module metadata used by PowerShell.
|
||||||
|
PrivateData = @{
|
||||||
|
|
||||||
|
PSData = @{
|
||||||
|
|
||||||
|
# Tags applied to this module. These help with module discovery in online galleries.
|
||||||
|
# Tags = @()
|
||||||
|
|
||||||
|
# A URL to the license for this module.
|
||||||
|
# LicenseUri = ''
|
||||||
|
|
||||||
|
# A URL to the main website for this project.
|
||||||
|
# ProjectUri = ''
|
||||||
|
|
||||||
|
# A URL to an icon representing this module.
|
||||||
|
# IconUri = ''
|
||||||
|
|
||||||
|
# ReleaseNotes of this module
|
||||||
|
# ReleaseNotes = ''
|
||||||
|
|
||||||
|
# Prerelease string of this module
|
||||||
|
# Prerelease = ''
|
||||||
|
|
||||||
|
# Flag to indicate whether the module requires explicit user acceptance for install/update/save
|
||||||
|
# RequireLicenseAcceptance = $false
|
||||||
|
|
||||||
|
# External dependent modules of this module
|
||||||
|
# ExternalModuleDependencies = @()
|
||||||
|
|
||||||
|
} # End of PSData hashtable
|
||||||
|
|
||||||
|
} # End of PrivateData hashtable
|
||||||
|
|
||||||
|
# HelpInfo URI of this module
|
||||||
|
# HelpInfoURI = ''
|
||||||
|
|
||||||
|
# Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix.
|
||||||
|
# DefaultCommandPrefix = ''
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
@@ -0,0 +1,592 @@
|
|||||||
|
<#
|
||||||
|
.SYNOPSIS
|
||||||
|
Manages the UI business logic for the "Applications" tab, including "Bring Your Own (BYO) Applications" and "Apps Script Variables".
|
||||||
|
.DESCRIPTION
|
||||||
|
This module contains all the functions that power the "Applications" tab in the BuildFFUVM_UI. It handles user interactions for managing custom application lists (BYO Apps), such as adding, removing, reordering, and saving/loading the list from a JSON file (UserAppList.json). It also includes the logic for copying the application source files to the designated staging directory in parallel. Additionally, it manages the UI for creating and removing key-value pairs for the AppsScriptVariables.json file, which allows for custom parameterization of user-provided scripts.
|
||||||
|
#>
|
||||||
|
|
||||||
|
# Function to update the enabled state of BYO Apps action buttons based on selection
|
||||||
|
function Update-BYOAppsActionButtonsState {
|
||||||
|
param(
|
||||||
|
[psobject]$State
|
||||||
|
)
|
||||||
|
$listView = $State.Controls.lstApplications
|
||||||
|
$removeButton = $State.Controls.btnRemoveSelectedBYOApps
|
||||||
|
$editButton = $State.Controls.btnEditApplication
|
||||||
|
|
||||||
|
if ($listView -and $removeButton -and $editButton) {
|
||||||
|
# Count selected items
|
||||||
|
$selectedItems = @($listView.Items | Where-Object { $_.IsSelected })
|
||||||
|
$selectedCount = $selectedItems.Count
|
||||||
|
|
||||||
|
# Enable the remove button if any item is selected
|
||||||
|
$removeButton.IsEnabled = ($selectedCount -gt 0)
|
||||||
|
|
||||||
|
# Enable the edit button only if exactly one item is selected
|
||||||
|
$editButton.IsEnabled = ($selectedCount -eq 1)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# Function to resolve the configured BYO app list path
|
||||||
|
function Get-BYOApplicationListPath {
|
||||||
|
[CmdletBinding()]
|
||||||
|
param(
|
||||||
|
[Parameter(Mandatory)]
|
||||||
|
[psobject]$State
|
||||||
|
)
|
||||||
|
|
||||||
|
# Fall back to the legacy default path when the textbox is empty.
|
||||||
|
if (-not [string]::IsNullOrWhiteSpace($State.Controls.txtUserAppListPath.Text)) {
|
||||||
|
return $State.Controls.txtUserAppListPath.Text
|
||||||
|
}
|
||||||
|
|
||||||
|
return (Join-Path -Path $State.Controls.txtApplicationPath.Text -ChildPath 'UserAppList.json')
|
||||||
|
}
|
||||||
|
|
||||||
|
# Function to remove all selected BYO applications
|
||||||
|
function Remove-SelectedBYOApplications {
|
||||||
|
[CmdletBinding()]
|
||||||
|
param(
|
||||||
|
[Parameter(Mandatory)]
|
||||||
|
[psobject]$State
|
||||||
|
)
|
||||||
|
|
||||||
|
$listView = $State.Controls.lstApplications
|
||||||
|
$itemsToRemove = @($listView.Items | Where-Object { $_.IsSelected })
|
||||||
|
|
||||||
|
if ($itemsToRemove.Count -eq 0) {
|
||||||
|
# This should not happen if the button is correctly disabled, but as a safeguard:
|
||||||
|
[System.Windows.MessageBox]::Show("No applications are selected for removal.", "Remove Applications", [System.Windows.MessageBoxButton]::OK, [System.Windows.MessageBoxImage]::Information)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
# Check if the item being edited is among those being removed
|
||||||
|
if ($null -ne $State.Data.editingBYOApplication -and $itemsToRemove.Contains($State.Data.editingBYOApplication)) {
|
||||||
|
# Reset the edit state
|
||||||
|
$State.Data.editingBYOApplication = $null
|
||||||
|
$State.Controls.btnAddApplication.Content = "Add Application"
|
||||||
|
# Clear the form fields
|
||||||
|
$State.Controls.txtAppName.Clear()
|
||||||
|
$State.Controls.txtAppCommandLine.Clear()
|
||||||
|
$State.Controls.txtAppArguments.Clear()
|
||||||
|
$State.Controls.txtAppSource.Clear()
|
||||||
|
$State.Controls.txtAppAdditionalExitCodes.Clear()
|
||||||
|
$State.Controls.chkIgnoreExitCodes.IsChecked = $false
|
||||||
|
}
|
||||||
|
|
||||||
|
foreach ($item in $itemsToRemove) {
|
||||||
|
$listView.Items.Remove($item)
|
||||||
|
}
|
||||||
|
|
||||||
|
# Re-calculate priorities for the remaining items
|
||||||
|
Update-ListViewPriorities -ListView $listView
|
||||||
|
|
||||||
|
# Update button states (Copy and Remove)
|
||||||
|
Update-CopyButtonState -State $State
|
||||||
|
Update-BYOAppsActionButtonsState -State $State
|
||||||
|
|
||||||
|
# Update the header checkbox state
|
||||||
|
$headerChk = $State.Controls.chkSelectAllBYOApps
|
||||||
|
if ($null -ne $headerChk) {
|
||||||
|
Update-SelectAllHeaderCheckBoxState -ListView $listView -HeaderCheckBox $headerChk
|
||||||
|
}
|
||||||
|
|
||||||
|
# Ask user if they want to save the changes
|
||||||
|
$result = [System.Windows.MessageBox]::Show("The selected applications have been removed from the list. Do you want to save these changes to the configured BYO app list now?", "Save Changes", [System.Windows.MessageBoxButton]::YesNo, [System.Windows.MessageBoxImage]::Question)
|
||||||
|
|
||||||
|
if ($result -eq 'Yes') {
|
||||||
|
$userAppListPath = Get-BYOApplicationListPath -State $State
|
||||||
|
Save-BYOApplicationList -Path $userAppListPath -State $State
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# Function to update the enabled state of the Copy Apps button
|
||||||
|
function Update-CopyButtonState {
|
||||||
|
param(
|
||||||
|
[psobject]$State
|
||||||
|
)
|
||||||
|
$listView = $State.Controls.lstApplications
|
||||||
|
$copyButton = $State.Controls.btnCopyBYOApps
|
||||||
|
if ($listView -and $copyButton) {
|
||||||
|
$hasSource = $false
|
||||||
|
foreach ($item in $listView.Items) {
|
||||||
|
if ($null -ne $item -and $item.PSObject.Properties['Source'] -and -not [string]::IsNullOrWhiteSpace($item.Source)) {
|
||||||
|
$hasSource = $true
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
$copyButton.IsEnabled = $hasSource
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# Function to remove application and reorder priorities
|
||||||
|
function Remove-Application {
|
||||||
|
param(
|
||||||
|
$priority,
|
||||||
|
[psobject]$State
|
||||||
|
)
|
||||||
|
|
||||||
|
$listView = $State.Controls.lstApplications
|
||||||
|
# Remove the item with the specified priority
|
||||||
|
$itemToRemove = $listView.Items | Where-Object { $_.Priority -eq $priority } | Select-Object -First 1
|
||||||
|
if ($itemToRemove) {
|
||||||
|
$listView.Items.Remove($itemToRemove)
|
||||||
|
# Reorder priorities for remaining items
|
||||||
|
Update-ListViewPriorities -ListView $listView
|
||||||
|
# Update the Copy Apps button state
|
||||||
|
Update-CopyButtonState -State $State
|
||||||
|
Update-BYOAppsActionButtonsState -State $State
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# Function to add a new BYO application from the UI
|
||||||
|
function Add-BYOApplication {
|
||||||
|
[CmdletBinding()]
|
||||||
|
param(
|
||||||
|
[Parameter(Mandatory)]
|
||||||
|
[psobject]$State
|
||||||
|
)
|
||||||
|
|
||||||
|
$name = $State.Controls.txtAppName.Text
|
||||||
|
$commandLine = $State.Controls.txtAppCommandLine.Text
|
||||||
|
$arguments = $State.Controls.txtAppArguments.Text
|
||||||
|
$source = $State.Controls.txtAppSource.Text
|
||||||
|
$additionalExitCodes = $State.Controls.txtAppAdditionalExitCodes.Text
|
||||||
|
$ignoreNonZeroExitCodes = $State.Controls.chkIgnoreExitCodes.IsChecked
|
||||||
|
|
||||||
|
if ([string]::IsNullOrWhiteSpace($name) -or [string]::IsNullOrWhiteSpace($commandLine)) {
|
||||||
|
[System.Windows.MessageBox]::Show("Please fill in all fields (Name and Command Line)", "Missing Information", [System.Windows.MessageBoxButton]::OK, [System.Windows.MessageBoxImage]::Warning)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
$listView = $State.Controls.lstApplications
|
||||||
|
|
||||||
|
# Check if we are in edit mode
|
||||||
|
if ($null -ne $State.Data.editingBYOApplication) {
|
||||||
|
$itemToUpdate = $State.Data.editingBYOApplication
|
||||||
|
|
||||||
|
# Check for duplicate names, excluding the item being edited
|
||||||
|
$existingApp = $listView.Items | Where-Object { $_.Name -eq $name -and $_ -ne $itemToUpdate }
|
||||||
|
if ($existingApp) {
|
||||||
|
[System.Windows.MessageBox]::Show("An application with the name '$name' already exists.", "Duplicate Name", [System.Windows.MessageBoxButton]::OK, [System.Windows.MessageBoxImage]::Warning)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
# Update the properties of the existing object
|
||||||
|
$itemToUpdate.Name = $name
|
||||||
|
$itemToUpdate.CommandLine = $commandLine
|
||||||
|
$itemToUpdate.Arguments = $arguments
|
||||||
|
$itemToUpdate.Source = $source
|
||||||
|
$itemToUpdate.AdditionalExitCodes = $additionalExitCodes
|
||||||
|
$itemToUpdate.IgnoreNonZeroExitCodes = $ignoreNonZeroExitCodes
|
||||||
|
$itemToUpdate.IgnoreExitCodes = if ($ignoreNonZeroExitCodes) { "Yes" } else { "No" }
|
||||||
|
|
||||||
|
# Refresh the ListView to show the changes
|
||||||
|
$listView.Items.Refresh()
|
||||||
|
Request-ListViewColumnAutoResize -ListView $listView
|
||||||
|
|
||||||
|
# Reset state
|
||||||
|
$State.Data.editingBYOApplication = $null
|
||||||
|
$State.Controls.btnAddApplication.Content = "Add Application"
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
# This is a new application
|
||||||
|
# Check for duplicate names
|
||||||
|
$existingApp = $listView.Items | Where-Object { $_.Name -eq $name }
|
||||||
|
if ($existingApp) {
|
||||||
|
[System.Windows.MessageBox]::Show("An application with the name '$name' already exists.", "Duplicate Name", [System.Windows.MessageBoxButton]::OK, [System.Windows.MessageBoxImage]::Warning)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
$priority = 1
|
||||||
|
if ($listView.Items.Count -gt 0) {
|
||||||
|
$priority = ($listView.Items | Measure-Object -Property Priority -Maximum).Maximum + 1
|
||||||
|
}
|
||||||
|
$application = [PSCustomObject]@{
|
||||||
|
IsSelected = $false
|
||||||
|
Priority = $priority
|
||||||
|
Name = $name
|
||||||
|
CommandLine = $commandLine
|
||||||
|
Arguments = $arguments
|
||||||
|
Source = $source
|
||||||
|
AdditionalExitCodes = $additionalExitCodes
|
||||||
|
IgnoreNonZeroExitCodes = $ignoreNonZeroExitCodes
|
||||||
|
IgnoreExitCodes = if ($ignoreNonZeroExitCodes) { "Yes" } else { "No" }
|
||||||
|
CopyStatus = ""
|
||||||
|
}
|
||||||
|
$listView.Items.Add($application)
|
||||||
|
Request-ListViewColumnAutoResize -ListView $listView
|
||||||
|
}
|
||||||
|
|
||||||
|
# Clear form and update button states for both add and update operations
|
||||||
|
$State.Controls.txtAppName.Text = ""
|
||||||
|
$State.Controls.txtAppCommandLine.Text = ""
|
||||||
|
$State.Controls.txtAppArguments.Text = ""
|
||||||
|
$State.Controls.txtAppSource.Text = ""
|
||||||
|
$State.Controls.txtAppAdditionalExitCodes.Text = ""
|
||||||
|
$State.Controls.chkIgnoreExitCodes.IsChecked = $false
|
||||||
|
Update-CopyButtonState -State $State
|
||||||
|
Update-BYOAppsActionButtonsState -State $State
|
||||||
|
}
|
||||||
|
|
||||||
|
# Function to populate the form for editing a BYO application
|
||||||
|
function Start-EditBYOApplication {
|
||||||
|
[CmdletBinding()]
|
||||||
|
param(
|
||||||
|
[Parameter(Mandatory)]
|
||||||
|
[psobject]$State
|
||||||
|
)
|
||||||
|
|
||||||
|
$listView = $State.Controls.lstApplications
|
||||||
|
$itemToEdit = @($listView.Items | Where-Object { $_.IsSelected }) | Select-Object -First 1
|
||||||
|
|
||||||
|
if ($null -eq $itemToEdit) {
|
||||||
|
[System.Windows.MessageBox]::Show("No application selected or multiple applications selected.", "Edit Error", "OK", "Warning")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
# Store the item being edited in the state
|
||||||
|
$State.Data.editingBYOApplication = $itemToEdit
|
||||||
|
|
||||||
|
# Populate the form fields
|
||||||
|
$State.Controls.txtAppName.Text = $itemToEdit.Name
|
||||||
|
$State.Controls.txtAppCommandLine.Text = $itemToEdit.CommandLine
|
||||||
|
$State.Controls.txtAppArguments.Text = $itemToEdit.Arguments
|
||||||
|
$State.Controls.txtAppSource.Text = $itemToEdit.Source
|
||||||
|
$State.Controls.txtAppAdditionalExitCodes.Text = $itemToEdit.AdditionalExitCodes
|
||||||
|
$State.Controls.chkIgnoreExitCodes.IsChecked = $itemToEdit.IgnoreNonZeroExitCodes
|
||||||
|
|
||||||
|
# Change the Add button to Update
|
||||||
|
$State.Controls.btnAddApplication.Content = "Update App"
|
||||||
|
}
|
||||||
|
|
||||||
|
# Function to add a new Apps Script Variable from the UI
|
||||||
|
function Add-AppsScriptVariable {
|
||||||
|
[CmdletBinding()]
|
||||||
|
param(
|
||||||
|
[Parameter(Mandatory)]
|
||||||
|
[psobject]$State
|
||||||
|
)
|
||||||
|
|
||||||
|
$key = $State.Controls.txtAppsScriptKey.Text.Trim()
|
||||||
|
$value = $State.Controls.txtAppsScriptValue.Text.Trim()
|
||||||
|
|
||||||
|
if ([string]::IsNullOrWhiteSpace($key)) {
|
||||||
|
[System.Windows.MessageBox]::Show("Apps Script Variable Key cannot be empty.", "Input Error", "OK", "Warning")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
# Check for duplicate keys
|
||||||
|
$existingKey = $State.Controls.lstAppsScriptVariables.Items | Where-Object { $_.Key -eq $key }
|
||||||
|
if ($existingKey) {
|
||||||
|
[System.Windows.MessageBox]::Show("An Apps Script Variable with the key '$key' already exists.", "Duplicate Key", "OK", "Warning")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
$newItem = [PSCustomObject]@{
|
||||||
|
IsSelected = $false # Add IsSelected property
|
||||||
|
Key = $key
|
||||||
|
Value = $value
|
||||||
|
}
|
||||||
|
$State.Data.appsScriptVariablesDataList.Add($newItem)
|
||||||
|
$State.Controls.lstAppsScriptVariables.ItemsSource = $State.Data.appsScriptVariablesDataList.ToArray()
|
||||||
|
Request-ListViewColumnAutoResize -ListView $State.Controls.lstAppsScriptVariables
|
||||||
|
$State.Controls.txtAppsScriptKey.Clear()
|
||||||
|
$State.Controls.txtAppsScriptValue.Clear()
|
||||||
|
# Update the header checkbox state
|
||||||
|
if ($null -ne $State.Controls.chkSelectAllAppsScriptVariables) {
|
||||||
|
Update-SelectAllHeaderCheckBoxState -ListView $State.Controls.lstAppsScriptVariables -HeaderCheckBox $State.Controls.chkSelectAllAppsScriptVariables
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# Function to remove selected Apps Script Variables from the list
|
||||||
|
function Remove-SelectedAppsScriptVariable {
|
||||||
|
[CmdletBinding()]
|
||||||
|
param(
|
||||||
|
[Parameter(Mandatory)]
|
||||||
|
[psobject]$State
|
||||||
|
)
|
||||||
|
|
||||||
|
$itemsToRemove = @($State.Data.appsScriptVariablesDataList | Where-Object { $_.IsSelected })
|
||||||
|
if ($itemsToRemove.Count -eq 0) {
|
||||||
|
[System.Windows.MessageBox]::Show("Please select one or more Apps Script Variables to remove.", "Selection Error", "OK", "Warning")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
foreach ($itemToRemove in $itemsToRemove) {
|
||||||
|
$State.Data.appsScriptVariablesDataList.Remove($itemToRemove)
|
||||||
|
}
|
||||||
|
$State.Controls.lstAppsScriptVariables.ItemsSource = $State.Data.appsScriptVariablesDataList.ToArray()
|
||||||
|
Request-ListViewColumnAutoResize -ListView $State.Controls.lstAppsScriptVariables
|
||||||
|
|
||||||
|
# Update the header checkbox state
|
||||||
|
if ($null -ne $State.Controls.chkSelectAllAppsScriptVariables) {
|
||||||
|
Update-SelectAllHeaderCheckBoxState -ListView $State.Controls.lstAppsScriptVariables -HeaderCheckBox $State.Controls.chkSelectAllAppsScriptVariables
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# Function to save BYO applications to JSON
|
||||||
|
function Save-BYOApplicationList {
|
||||||
|
[CmdletBinding()]
|
||||||
|
param(
|
||||||
|
[Parameter(Mandatory)]
|
||||||
|
[string]$Path,
|
||||||
|
[Parameter(Mandatory)]
|
||||||
|
[psobject]$State
|
||||||
|
)
|
||||||
|
|
||||||
|
$listView = $State.Controls.lstApplications
|
||||||
|
if (-not $listView -or $listView.Items.Count -eq 0) {
|
||||||
|
[System.Windows.MessageBox]::Show("No applications to save.", "Save Applications", [System.Windows.MessageBoxButton]::OK, [System.Windows.MessageBoxImage]::Information)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
# Ensure items are sorted by current priority before saving
|
||||||
|
# Exclude UI-only properties (CopyStatus, IgnoreExitCodes) and ensure Priority is an integer
|
||||||
|
$propertiesToSave = 'Priority', 'Name', 'CommandLine', 'Arguments', 'Source', 'AdditionalExitCodes', 'IgnoreNonZeroExitCodes'
|
||||||
|
$applications = $listView.Items | Sort-Object Priority | Select-Object @{N = 'Priority'; E = { [int]$_.Priority } }, Name, CommandLine, Arguments, Source, AdditionalExitCodes, IgnoreNonZeroExitCodes
|
||||||
|
|
||||||
|
$applications | ConvertTo-Json -Depth 5 | Set-Content -Path $Path -Force -Encoding UTF8
|
||||||
|
[System.Windows.MessageBox]::Show("Applications saved successfully to `"$Path`".", "Save Applications", [System.Windows.MessageBoxButton]::OK, [System.Windows.MessageBoxImage]::Information)
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
[System.Windows.MessageBox]::Show("Failed to save applications: $_", "Error", [System.Windows.MessageBoxButton]::OK, [System.Windows.MessageBoxImage]::Error)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# Function to load BYO applications from JSON
|
||||||
|
function Import-BYOApplicationList {
|
||||||
|
[CmdletBinding()]
|
||||||
|
param(
|
||||||
|
[Parameter(Mandatory)]
|
||||||
|
[string]$Path,
|
||||||
|
[Parameter(Mandatory)]
|
||||||
|
[psobject]$State
|
||||||
|
)
|
||||||
|
|
||||||
|
if (-not (Test-Path $Path)) {
|
||||||
|
[System.Windows.MessageBox]::Show("Application list file not found at `"$Path`".", "Import Applications", [System.Windows.MessageBoxButton]::OK, [System.Windows.MessageBoxImage]::Warning)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
$applications = Get-Content -Path $Path -Raw | ConvertFrom-Json
|
||||||
|
$listView = $State.Controls.lstApplications
|
||||||
|
$listView.Items.Clear()
|
||||||
|
|
||||||
|
# Add items and sort by priority from the file
|
||||||
|
$sortedApps = $applications | Sort-Object Priority
|
||||||
|
foreach ($app in $sortedApps) {
|
||||||
|
$ignoreNonZero = if ($app.PSObject.Properties['IgnoreNonZeroExitCodes']) { $app.IgnoreNonZeroExitCodes } else { $false }
|
||||||
|
$appObject = [PSCustomObject]@{
|
||||||
|
IsSelected = $false
|
||||||
|
Priority = $app.Priority
|
||||||
|
Name = $app.Name
|
||||||
|
CommandLine = $app.CommandLine
|
||||||
|
Arguments = if ($app.PSObject.Properties['Arguments']) { $app.Arguments } else { "" }
|
||||||
|
Source = $app.Source
|
||||||
|
AdditionalExitCodes = if ($app.PSObject.Properties['AdditionalExitCodes']) { $app.AdditionalExitCodes } else { "" }
|
||||||
|
IgnoreNonZeroExitCodes = $ignoreNonZero
|
||||||
|
IgnoreExitCodes = if ($ignoreNonZero) { "Yes" } else { "No" }
|
||||||
|
CopyStatus = ""
|
||||||
|
}
|
||||||
|
$listView.Items.Add($appObject)
|
||||||
|
}
|
||||||
|
|
||||||
|
# Reorder priorities sequentially after loading
|
||||||
|
Update-ListViewPriorities -ListView $listView
|
||||||
|
# Update the Copy Apps button state
|
||||||
|
Update-CopyButtonState -State $State
|
||||||
|
Update-BYOAppsActionButtonsState -State $State
|
||||||
|
[System.Windows.MessageBox]::Show("Applications imported successfully from `"$Path`".", "Import Applications", [System.Windows.MessageBoxButton]::OK, [System.Windows.MessageBoxImage]::Information)
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
[System.Windows.MessageBox]::Show("Failed to import applications: $_", "Error", [System.Windows.MessageBoxButton]::OK, [System.Windows.MessageBoxImage]::Error)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# Function to invoke the parallel copy process for BYO apps
|
||||||
|
function Invoke-CopyBYOApps {
|
||||||
|
param(
|
||||||
|
[psobject]$State,
|
||||||
|
[System.Windows.Controls.Button]$Button
|
||||||
|
)
|
||||||
|
|
||||||
|
$localAppsPath = $State.Controls.txtApplicationPath.Text
|
||||||
|
$userAppListPath = Get-BYOApplicationListPath -State $State
|
||||||
|
$listView = $State.Controls.lstApplications
|
||||||
|
|
||||||
|
try {
|
||||||
|
# Ensure the configured BYO app list folder exists before writing the manifest.
|
||||||
|
$userAppListDirectory = Split-Path -Path $userAppListPath -Parent
|
||||||
|
if (-not [string]::IsNullOrWhiteSpace($userAppListDirectory) -and -not (Test-Path -Path $userAppListDirectory -PathType Container)) {
|
||||||
|
New-Item -Path $userAppListDirectory -ItemType Directory -Force | Out-Null
|
||||||
|
}
|
||||||
|
|
||||||
|
# Ensure items are sorted by current priority before saving.
|
||||||
|
# Exclude CopyStatus when saving and ensure Priority is an integer; include AdditionalExitCodes and IgnoreNonZeroExitCodes for parity with Save-BYOApplicationList.
|
||||||
|
$applications = $listView.Items | Sort-Object Priority | Select-Object @{N = 'Priority'; E = { [int]$_.Priority } }, Name, CommandLine, Arguments, Source, AdditionalExitCodes, IgnoreNonZeroExitCodes
|
||||||
|
$applications | ConvertTo-Json -Depth 5 | Set-Content -Path $userAppListPath -Force -Encoding UTF8
|
||||||
|
WriteLog "Successfully updated BYO app list at $userAppListPath with all applications from the UI."
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
$errorMessage = "Failed to update BYO app list at $($userAppListPath): $_"
|
||||||
|
WriteLog $errorMessage
|
||||||
|
[System.Windows.MessageBox]::Show($errorMessage, "Error", [System.Windows.MessageBoxButton]::OK, [System.Windows.MessageBoxImage]::Error)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
$allAppsWithSource = $State.Controls.lstApplications.Items | Where-Object { -not [string]::IsNullOrWhiteSpace($_.Source) }
|
||||||
|
if (-not $allAppsWithSource) {
|
||||||
|
[System.Windows.MessageBox]::Show("No applications with a source path were found to copy.", "Copy BYO Apps", "OK", "Information")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
$win32BasePath = Join-Path -Path $localAppsPath -ChildPath "Win32"
|
||||||
|
|
||||||
|
$appsToProcess = [System.Collections.Generic.List[object]]::new()
|
||||||
|
$appsThatExist = [System.Collections.Generic.List[string]]::new()
|
||||||
|
$appsToConfirm = [System.Collections.Generic.List[object]]::new()
|
||||||
|
|
||||||
|
foreach ($app in $allAppsWithSource) {
|
||||||
|
$destinationPath = Join-Path -Path $win32BasePath -ChildPath $app.Name
|
||||||
|
if (Test-Path -Path $destinationPath -PathType Container) {
|
||||||
|
$appsThatExist.Add($app.Name)
|
||||||
|
$appsToConfirm.Add($app)
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
$appsToProcess.Add($app)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($appsThatExist.Count -gt 0) {
|
||||||
|
$message = "The following application folders already exist in the destination and will be overwritten:`n`n$($appsThatExist -join "`n")`n`nDo you want to proceed with copying and overwriting them?"
|
||||||
|
$result = [System.Windows.MessageBox]::Show($message, "Confirm Overwrite", [System.Windows.MessageBoxButton]::YesNo, [System.Windows.MessageBoxImage]::Warning)
|
||||||
|
|
||||||
|
if ($result -eq 'Yes') {
|
||||||
|
$appsToProcess.AddRange($appsToConfirm)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($appsToProcess.Count -eq 0) {
|
||||||
|
# This message can be suppressed if you prefer no notification when the user clicks "No"
|
||||||
|
# [System.Windows.MessageBox]::Show("No applications selected for copying.", "Copy BYO Apps", "OK", "Information")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
$Button.IsEnabled = $false
|
||||||
|
$State.Controls.pbOverallProgress.Visibility = 'Visible'
|
||||||
|
$State.Controls.pbOverallProgress.Value = 0
|
||||||
|
$State.Controls.txtStatus.Text = "Starting BYO app copy..."
|
||||||
|
|
||||||
|
# Create hashtable for task-specific arguments
|
||||||
|
$taskArguments = @{
|
||||||
|
AppsPath = $localAppsPath
|
||||||
|
}
|
||||||
|
|
||||||
|
# Select only necessary properties before passing
|
||||||
|
$itemsToProcess = $appsToProcess | Select-Object Priority, Name, CommandLine, Arguments, Source
|
||||||
|
|
||||||
|
# Invoke the centralized parallel processing function
|
||||||
|
# Pass task type and task-specific arguments
|
||||||
|
Invoke-ParallelProcessing -ItemsToProcess $itemsToProcess `
|
||||||
|
-ListViewControl $State.Controls.lstApplications `
|
||||||
|
-IdentifierProperty 'Name' `
|
||||||
|
-StatusProperty 'CopyStatus' `
|
||||||
|
-TaskType 'CopyBYO' `
|
||||||
|
-TaskArguments $taskArguments `
|
||||||
|
-CompletedStatusText "Copied" `
|
||||||
|
-ErrorStatusPrefix "Error: " `
|
||||||
|
-WindowObject $State.Window `
|
||||||
|
-MainThreadLogPath $State.LogFilePath `
|
||||||
|
-ThrottleLimit $State.Controls.txtThreads.Text
|
||||||
|
|
||||||
|
# Final status update (handled by Invoke-ParallelProcessing)
|
||||||
|
$State.Controls.pbOverallProgress.Visibility = 'Collapsed'
|
||||||
|
$Button.IsEnabled = $true
|
||||||
|
}
|
||||||
|
|
||||||
|
# Function to copy a single BYO application (Modified for ForEach-Object -Parallel)
|
||||||
|
function Start-CopyBYOApplicationTask {
|
||||||
|
[CmdletBinding()]
|
||||||
|
param(
|
||||||
|
[Parameter(Mandatory)]
|
||||||
|
[PSCustomObject]$ApplicationItemData, # Pass data, not the UI object
|
||||||
|
[Parameter(Mandatory)]
|
||||||
|
[string]$AppsPath, # Pass necessary path
|
||||||
|
[Parameter(Mandatory = $true)]
|
||||||
|
[System.Collections.Concurrent.ConcurrentQueue[hashtable]]$ProgressQueue # Add queue parameter
|
||||||
|
# REMOVED: UI-related parameters
|
||||||
|
)
|
||||||
|
|
||||||
|
$priority = $ApplicationItemData.Priority
|
||||||
|
$appName = $ApplicationItemData.Name
|
||||||
|
$commandLine = $ApplicationItemData.CommandLine
|
||||||
|
$arguments = $ApplicationItemData.Arguments
|
||||||
|
$sourcePath = $ApplicationItemData.Source
|
||||||
|
$status = "Starting..." # Initial local status
|
||||||
|
$success = $false
|
||||||
|
|
||||||
|
# Initial status update
|
||||||
|
Invoke-ProgressUpdate -ProgressQueue $ProgressQueue -Identifier $appName -Status $status
|
||||||
|
|
||||||
|
if ([string]::IsNullOrWhiteSpace($AppsPath)) {
|
||||||
|
$status = "Error: Apps Path not set"
|
||||||
|
Invoke-ProgressUpdate -ProgressQueue $ProgressQueue -Identifier $appName -Status $status
|
||||||
|
WriteLog "Copy error for $($appName): Apps Path not set."
|
||||||
|
return [PSCustomObject]@{ Name = $appName; Status = $status; Success = $success }
|
||||||
|
}
|
||||||
|
|
||||||
|
if ([string]::IsNullOrWhiteSpace($sourcePath)) {
|
||||||
|
$status = "No source specified"
|
||||||
|
Invoke-ProgressUpdate -ProgressQueue $ProgressQueue -Identifier $appName -Status $status
|
||||||
|
# This isn't an error, just nothing to do. Consider it success.
|
||||||
|
$success = $true
|
||||||
|
return [PSCustomObject]@{ Name = $appName; Status = $status; Success = $success }
|
||||||
|
}
|
||||||
|
|
||||||
|
if (-not (Test-Path -Path $sourcePath -PathType Container)) {
|
||||||
|
$status = "Source path not found"
|
||||||
|
Invoke-ProgressUpdate -ProgressQueue $ProgressQueue -Identifier $appName -Status $status
|
||||||
|
WriteLog "Copy error for $($appName): Source path '$sourcePath' not found."
|
||||||
|
return [PSCustomObject]@{ Name = $appName; Status = $status; Success = $success }
|
||||||
|
}
|
||||||
|
|
||||||
|
$win32BasePath = Join-Path -Path $AppsPath -ChildPath "Win32"
|
||||||
|
$destinationPath = Join-Path -Path $win32BasePath -ChildPath $appName
|
||||||
|
|
||||||
|
try {
|
||||||
|
# Ensure base directory exists
|
||||||
|
if (-not (Test-Path -Path $win32BasePath -PathType Container)) {
|
||||||
|
New-Item -Path $win32BasePath -ItemType Directory -Force | Out-Null
|
||||||
|
WriteLog "Created directory: $win32BasePath"
|
||||||
|
}
|
||||||
|
|
||||||
|
# If destination exists, remove it to ensure a clean copy and prevent nesting.
|
||||||
|
if (Test-Path -Path $destinationPath -PathType Container) {
|
||||||
|
WriteLog "Removing existing destination folder: $destinationPath"
|
||||||
|
Remove-Item -Path $destinationPath -Recurse -Force -ErrorAction Stop
|
||||||
|
}
|
||||||
|
|
||||||
|
# Perform the copy
|
||||||
|
$status = "Copying..."
|
||||||
|
Invoke-ProgressUpdate -ProgressQueue $ProgressQueue -Identifier $appName -Status $status
|
||||||
|
WriteLog "Copying '$sourcePath' to '$destinationPath'..."
|
||||||
|
Copy-Item -Path $sourcePath -Destination $destinationPath -Recurse -Force -ErrorAction Stop
|
||||||
|
$status = "Copied successfully"
|
||||||
|
$success = $true
|
||||||
|
WriteLog "Successfully copied '$appName' to '$destinationPath'."
|
||||||
|
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
$errorMessage = $_.Exception.Message
|
||||||
|
$status = "Error: $($errorMessage)"
|
||||||
|
WriteLog "Copy error for $($appName): $($errorMessage)"
|
||||||
|
$success = $false
|
||||||
|
# Enqueue error status
|
||||||
|
Invoke-ProgressUpdate -ProgressQueue $ProgressQueue -Identifier $appName -Status $status
|
||||||
|
}
|
||||||
|
|
||||||
|
# Return the final status
|
||||||
|
return [PSCustomObject]@{ Name = $appName; Status = $status; Success = $success }
|
||||||
|
}
|
||||||
|
|
||||||
|
Export-ModuleMember -Function *
|
||||||
@@ -0,0 +1,379 @@
|
|||||||
|
<#
|
||||||
|
.SYNOPSIS
|
||||||
|
Provides functions for discovering, downloading, and processing Dell device drivers.
|
||||||
|
.DESCRIPTION
|
||||||
|
This module contains the logic specific to handling Dell drivers for the FFU Builder UI. It includes functions to parse Dell's large XML driver catalog to retrieve a list of supported models (Get-DellDriversModelList). It also provides a parallel-capable task function (Save-DellDriversTask) that finds, downloads, extracts, and optionally compresses all the latest driver packages for a specified Dell model and operating system.
|
||||||
|
#>
|
||||||
|
|
||||||
|
# Function to get the list of Dell models from the catalog using XML streaming
|
||||||
|
function Get-DellDriversModelList {
|
||||||
|
[CmdletBinding()]
|
||||||
|
param(
|
||||||
|
[Parameter(Mandatory = $true)]
|
||||||
|
[int]$WindowsRelease,
|
||||||
|
[Parameter(Mandatory = $true)]
|
||||||
|
[string]$DriversFolder,
|
||||||
|
[Parameter(Mandatory = $true)]
|
||||||
|
[string]$Make
|
||||||
|
)
|
||||||
|
|
||||||
|
# Client pathway (<=11) uses CatalogIndexPC to build full Brand Model (SystemID) strings.
|
||||||
|
if ($WindowsRelease -le 11) {
|
||||||
|
$dellModels = Get-DellClientModels -CatalogIndexXmlPath (Get-DellCatalogIndex -DriversFolder $DriversFolder)
|
||||||
|
$final = [System.Collections.Generic.List[pscustomobject]]::new()
|
||||||
|
foreach ($m in $dellModels) {
|
||||||
|
$final.Add([pscustomobject]@{
|
||||||
|
Make = $Make
|
||||||
|
Model = $m.ModelDisplay
|
||||||
|
Brand = $m.Brand
|
||||||
|
ModelNumber = $m.ModelNumber
|
||||||
|
SystemId = $m.SystemId
|
||||||
|
CabRelativePath = $m.CabRelativePath
|
||||||
|
CabUrl = $m.CabUrl
|
||||||
|
})
|
||||||
|
}
|
||||||
|
return $final
|
||||||
|
}
|
||||||
|
|
||||||
|
# Server pathway (unchanged – still uses Catalog.cab)
|
||||||
|
$dellDriversFolder = Join-Path -Path $DriversFolder -ChildPath "Dell"
|
||||||
|
$catalogBaseName = "Catalog"
|
||||||
|
$dellCabFile = Join-Path -Path $dellDriversFolder -ChildPath "$($catalogBaseName).cab"
|
||||||
|
$dellCatalogXML = Join-Path -Path $dellDriversFolder -ChildPath "$($catalogBaseName).xml"
|
||||||
|
$catalogUrl = "https://downloads.dell.com/catalog/Catalog.cab"
|
||||||
|
|
||||||
|
if (-not (Test-Path -Path $dellDriversFolder)) {
|
||||||
|
New-Item -Path $dellDriversFolder -ItemType Directory -Force | Out-Null
|
||||||
|
}
|
||||||
|
|
||||||
|
$download = $true
|
||||||
|
if (Test-Path -Path $dellCatalogXML) {
|
||||||
|
if (((Get-Date) - (Get-Item $dellCatalogXML).CreationTime).TotalDays -lt 7) {
|
||||||
|
$download = $false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($download) {
|
||||||
|
if (Test-Path $dellCabFile) { Remove-Item $dellCabFile -Force -ErrorAction SilentlyContinue }
|
||||||
|
if (Test-Path $dellCatalogXML) { Remove-Item $dellCatalogXML -Force -ErrorAction SilentlyContinue }
|
||||||
|
Start-BitsTransferWithRetry -Source $catalogUrl -Destination $dellCabFile
|
||||||
|
Invoke-Process -FilePath Expand.exe -ArgumentList """$dellCabFile"" ""$dellCatalogXML""" | Out-Null
|
||||||
|
Remove-Item $dellCabFile -Force -ErrorAction SilentlyContinue
|
||||||
|
}
|
||||||
|
|
||||||
|
if (-not (Test-Path $dellCatalogXML)) { throw "Dell server catalog XML missing: $dellCatalogXML" }
|
||||||
|
|
||||||
|
$settings = New-Object System.Xml.XmlReaderSettings
|
||||||
|
$settings.IgnoreWhitespace = $true
|
||||||
|
$settings.IgnoreComments = $true
|
||||||
|
$reader = [System.Xml.XmlReader]::Create($dellCatalogXML, $settings)
|
||||||
|
$inDriver = $false
|
||||||
|
$inModel = $false
|
||||||
|
$depthModel = -1
|
||||||
|
$modelsHash = [System.Collections.Generic.HashSet[string]]::new([System.StringComparer]::OrdinalIgnoreCase)
|
||||||
|
try {
|
||||||
|
while ($reader.Read()) {
|
||||||
|
switch ($reader.NodeType) {
|
||||||
|
([System.Xml.XmlNodeType]::Element) {
|
||||||
|
switch ($reader.Name) {
|
||||||
|
'SoftwareComponent' { $inDriver = $false }
|
||||||
|
'ComponentType' { if ($reader.GetAttribute('value') -eq 'DRVR') { $inDriver = $true } }
|
||||||
|
'Model' { if ($inDriver) { $inModel = $true; $depthModel = $reader.Depth } }
|
||||||
|
}
|
||||||
|
}
|
||||||
|
([System.Xml.XmlNodeType]::CDATA) {
|
||||||
|
if ($inDriver -and $inModel) {
|
||||||
|
$val = $reader.Value.Trim()
|
||||||
|
if ($val) { $modelsHash.Add($val) | Out-Null }
|
||||||
|
$inModel = $false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
([System.Xml.XmlNodeType]::EndElement) {
|
||||||
|
if ($reader.Name -eq 'SoftwareComponent') { $inDriver = $false; $inModel = $false }
|
||||||
|
elseif ($reader.Name -eq 'Model' -and $reader.Depth -eq $depthModel) { $inModel = $false; $depthModel = -1 }
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
finally {
|
||||||
|
$reader.Dispose()
|
||||||
|
}
|
||||||
|
|
||||||
|
$out = [System.Collections.Generic.List[pscustomobject]]::new()
|
||||||
|
foreach ($nm in ($modelsHash | Sort-Object)) {
|
||||||
|
$out.Add([pscustomobject]@{ Make = $Make; Model = $nm })
|
||||||
|
}
|
||||||
|
return $out
|
||||||
|
}
|
||||||
|
|
||||||
|
# Function to download and extract drivers for a specific Dell model (Modified for ForEach-Object -Parallel)
|
||||||
|
function Save-DellDriversTask {
|
||||||
|
[CmdletBinding()]
|
||||||
|
param(
|
||||||
|
[Parameter(Mandatory = $true)]
|
||||||
|
[pscustomobject]$DriverItemData,
|
||||||
|
[Parameter(Mandatory = $true)]
|
||||||
|
[string]$DriversFolder,
|
||||||
|
[Parameter(Mandatory = $true)]
|
||||||
|
[string]$WindowsArch,
|
||||||
|
[Parameter(Mandatory = $true)]
|
||||||
|
[int]$WindowsRelease,
|
||||||
|
[Parameter()]
|
||||||
|
[System.Collections.Concurrent.ConcurrentQueue[hashtable]]$ProgressQueue = $null,
|
||||||
|
[Parameter()]
|
||||||
|
[bool]$CompressToWim = $false,
|
||||||
|
[Parameter()]
|
||||||
|
[bool]$PreserveSourceOnCompress = $false
|
||||||
|
)
|
||||||
|
|
||||||
|
$modelDisplay = $DriverItemData.Model
|
||||||
|
$make = 'Dell'
|
||||||
|
if ($null -ne $ProgressQueue) { Invoke-ProgressUpdate -ProgressQueue $ProgressQueue -Identifier $modelDisplay -Status 'Checking...' }
|
||||||
|
|
||||||
|
$sanitizedModelName = ConvertTo-SafeName -Name $modelDisplay
|
||||||
|
$makeDriversPath = Join-Path -Path $DriversFolder -ChildPath $make
|
||||||
|
$modelPath = Join-Path -Path $makeDriversPath -ChildPath $sanitizedModelName
|
||||||
|
$driverRelativePath = Join-Path -Path $make -ChildPath $sanitizedModelName
|
||||||
|
|
||||||
|
# Helper: safe folder removal
|
||||||
|
function Remove-SafeFolder {
|
||||||
|
param([string]$Path)
|
||||||
|
if ([string]::IsNullOrWhiteSpace($Path)) { return }
|
||||||
|
# Never allow deleting the entire Dell root folder accidentally
|
||||||
|
$dellRoot = (Resolve-Path $makeDriversPath).ProviderPath
|
||||||
|
$target = (Resolve-Path $Path -ErrorAction SilentlyContinue)?.ProviderPath
|
||||||
|
if ($null -eq $target) { return }
|
||||||
|
if ($target -eq $dellRoot) { return }
|
||||||
|
if (-not ($target.StartsWith($dellRoot, [System.StringComparison]::OrdinalIgnoreCase))) { return }
|
||||||
|
Remove-Item -Path $target -Recurse -Force -ErrorAction SilentlyContinue
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
# Existing drivers short‑circuit
|
||||||
|
$existing = Test-ExistingDriver -Make $make -Model $sanitizedModelName -DriversFolder $DriversFolder -Identifier $modelDisplay -ProgressQueue $ProgressQueue
|
||||||
|
if ($existing) {
|
||||||
|
if (-not $existing.PSObject.Properties['Model']) {
|
||||||
|
$existing | Add-Member -MemberType NoteProperty -Name 'Model' -Value $modelDisplay
|
||||||
|
}
|
||||||
|
if ($CompressToWim -and $existing.Status -eq 'Already downloaded') {
|
||||||
|
$wimPath = Join-Path $makeDriversPath "$sanitizedModelName.wim"
|
||||||
|
$wimRelativePath = Join-Path $make "$sanitizedModelName.wim"
|
||||||
|
$srcPath = Join-Path $makeDriversPath $sanitizedModelName
|
||||||
|
if ($null -ne $ProgressQueue) { Invoke-ProgressUpdate -ProgressQueue $ProgressQueue -Identifier $modelDisplay -Status 'Compressing existing...' }
|
||||||
|
try {
|
||||||
|
$null = Compress-DriverFolderToWim -SourceFolderPath $srcPath -DestinationWimPath $wimPath -WimName $modelDisplay -WimDescription "Drivers for $modelDisplay" -PreserveSource:$PreserveSourceOnCompress -ErrorAction Stop
|
||||||
|
$existing.Status = 'Compression successful'
|
||||||
|
$existing.DriverPath = $wimRelativePath
|
||||||
|
$existing.Success = $true
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
WriteLog "Compression failed for $($modelDisplay): $($_.Exception.Message)"
|
||||||
|
$existing.Status = 'Already downloaded (Compression failed)'
|
||||||
|
$existing.Success = $false
|
||||||
|
}
|
||||||
|
if ($null -ne $ProgressQueue) { Invoke-ProgressUpdate -ProgressQueue $ProgressQueue -Identifier $modelDisplay -Status $existing.Status }
|
||||||
|
}
|
||||||
|
return $existing
|
||||||
|
}
|
||||||
|
|
||||||
|
if (-not (Test-Path $makeDriversPath)) { New-Item -Path $makeDriversPath -ItemType Directory -Force | Out-Null }
|
||||||
|
if (-not (Test-Path $modelPath)) { New-Item -Path $modelPath -ItemType Directory -Force | Out-Null }
|
||||||
|
|
||||||
|
$packages = @()
|
||||||
|
|
||||||
|
if ($WindowsRelease -le 11) {
|
||||||
|
$cabUrl = $DriverItemData.CabUrl
|
||||||
|
if ([string]::IsNullOrWhiteSpace($cabUrl)) {
|
||||||
|
WriteLog "CabUrl missing for '$modelDisplay' – resolving via CatalogIndexPC."
|
||||||
|
$resolved = Resolve-DellCabUrlFromModel -DriversFolder $DriversFolder -ModelDisplay $modelDisplay
|
||||||
|
if ($null -eq $resolved -or [string]::IsNullOrWhiteSpace($resolved.CabUrl)) {
|
||||||
|
throw "Unable to resolve CabUrl for $modelDisplay from CatalogIndexPC."
|
||||||
|
}
|
||||||
|
$cabUrl = $resolved.CabUrl
|
||||||
|
# Optionally persist back into the incoming object if property exists
|
||||||
|
if ($DriverItemData.PSObject.Properties['CabUrl']) {
|
||||||
|
$DriverItemData.CabUrl = $cabUrl
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# Model-based workflow (always used for client pathway now)
|
||||||
|
$modelCabName = [IO.Path]::GetFileName($cabUrl)
|
||||||
|
if ([string]::IsNullOrWhiteSpace($modelCabName)) { throw "Derived model cab name empty for $modelDisplay" }
|
||||||
|
$modelCabPath = Join-Path $makeDriversPath $modelCabName
|
||||||
|
$modelXmlPath = Join-Path $makeDriversPath ([IO.Path]::GetFileNameWithoutExtension($modelCabName) + '.xml')
|
||||||
|
|
||||||
|
if ($null -ne $ProgressQueue) { Invoke-ProgressUpdate -ProgressQueue $ProgressQueue -Identifier $modelDisplay -Status 'Downloading catalog...' }
|
||||||
|
if (Test-Path $modelCabPath) { Remove-SafeFolder $modelCabPath }
|
||||||
|
if (Test-Path $modelXmlPath) { Remove-SafeFolder $modelXmlPath }
|
||||||
|
|
||||||
|
WriteLog "Downloading Dell model catalog from $cabUrl to $modelCabPath"
|
||||||
|
Start-BitsTransferWithRetry -Source $cabUrl -Destination $modelCabPath
|
||||||
|
Invoke-Process -FilePath Expand.exe -ArgumentList """$modelCabPath"" ""$modelXmlPath""" | Out-Null
|
||||||
|
Remove-Item $modelCabPath -Force -ErrorAction SilentlyContinue
|
||||||
|
if (-not (Test-Path $modelXmlPath)) { throw "Model XML not found after extraction: $modelXmlPath" }
|
||||||
|
|
||||||
|
# Track extracted model XML so cancel cleanup can remove it even if file timestamps are preserved from source metadata.
|
||||||
|
try {
|
||||||
|
Register-CurrentRunDownloadTarget -Destination $modelXmlPath
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
WriteLog "Failed to register Dell model XML for current-run cleanup ($modelXmlPath): $($_.Exception.Message)"
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($null -ne $ProgressQueue) { Invoke-ProgressUpdate -ProgressQueue $ProgressQueue -Identifier $modelDisplay -Status 'Selecting latest drivers...' }
|
||||||
|
$packages = Get-DellLatestDriverPackages -ModelXmlPath $modelXmlPath -WindowsArch $WindowsArch -WindowsRelease $WindowsRelease
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
# Server legacy logic unchanged (kept as before)
|
||||||
|
if ($null -ne $ProgressQueue) { Invoke-ProgressUpdate -ProgressQueue $ProgressQueue -Identifier $modelDisplay -Status 'Preparing server catalog...' }
|
||||||
|
$catalogCab = Join-Path $makeDriversPath 'Catalog.cab'
|
||||||
|
$catalogXml = Join-Path $makeDriversPath 'Catalog.xml'
|
||||||
|
$catalogUrl = 'https://downloads.dell.com/catalog/Catalog.cab'
|
||||||
|
$need = $true
|
||||||
|
if (Test-Path $catalogXml) {
|
||||||
|
if (((Get-Date) - (Get-Item $catalogXml).CreationTime).TotalDays -lt 7) { $need = $false }
|
||||||
|
}
|
||||||
|
if ($need) {
|
||||||
|
if (Test-Path $catalogCab) { Remove-SafeFolder $catalogCab }
|
||||||
|
if (Test-Path $catalogXml) { Remove-SafeFolder $catalogXml }
|
||||||
|
WriteLog "Downloading Dell server catalog from $catalogUrl to $catalogCab"
|
||||||
|
Start-BitsTransferWithRetry -Source $catalogUrl -Destination $catalogCab
|
||||||
|
Invoke-Process -FilePath Expand.exe -ArgumentList """$catalogCab"" ""$catalogXml""" | Out-Null
|
||||||
|
Remove-Item $catalogCab -Force -ErrorAction SilentlyContinue
|
||||||
|
}
|
||||||
|
if (-not (Test-Path $catalogXml)) { throw "Server catalog XML missing: $catalogXml" }
|
||||||
|
|
||||||
|
[xml]$xmlContent = Get-Content -Path $catalogXml -Raw
|
||||||
|
$baseLocation = "https://$($xmlContent.manifest.baseLocation)/"
|
||||||
|
$softwareComponents = $xmlContent.Manifest.SoftwareComponent | Where-Object { $_.ComponentType.value -eq 'DRVR' }
|
||||||
|
$latestDrivers = @{}
|
||||||
|
foreach ($component in $softwareComponents) {
|
||||||
|
$models = $component.SupportedSystems.Brand.Model
|
||||||
|
foreach ($m in $models) {
|
||||||
|
if ($m.Display.'#cdata-section' -eq $modelDisplay) {
|
||||||
|
$validOS = $component.SupportedOperatingSystems.OperatingSystem | Where-Object { $_.osArch -eq $WindowsArch }
|
||||||
|
if (-not $validOS) { continue }
|
||||||
|
$driverPath = $component.path
|
||||||
|
$downloadUrl = $baseLocation + $driverPath
|
||||||
|
$fileName = [IO.Path]::GetFileName($driverPath)
|
||||||
|
$name = $component.Name.Display.'#cdata-section' -replace '[\\\/\:\*\?\"\<\>\| ]', '_' -replace '[\,]', '-'
|
||||||
|
$category = $component.Category.Display.'#cdata-section' -replace '[\\\/\:\*\?\"\<\>\| ]', '_'
|
||||||
|
$version = [version]$component.vendorVersion
|
||||||
|
$namePrefix = ($name -split '-')[0]
|
||||||
|
if (-not $latestDrivers[$category]) { $latestDrivers[$category] = @{} }
|
||||||
|
if (-not $latestDrivers[$category][$namePrefix] -or $latestDrivers[$category][$namePrefix].Version -lt $version) {
|
||||||
|
$latestDrivers[$category][$namePrefix] = [pscustomobject]@{
|
||||||
|
Name = $name
|
||||||
|
DownloadUrl = $downloadUrl
|
||||||
|
DriverFileName = $fileName
|
||||||
|
Version = $version
|
||||||
|
Category = $category
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
foreach ($cat in $latestDrivers.Keys) { foreach ($drv in $latestDrivers[$cat].Values) { $packages += $drv } }
|
||||||
|
}
|
||||||
|
|
||||||
|
if (-not $packages -or $packages.Count -eq 0) {
|
||||||
|
if ($null -ne $ProgressQueue) { Invoke-ProgressUpdate -ProgressQueue $ProgressQueue -Identifier $modelDisplay -Status 'No drivers found for OS' }
|
||||||
|
return [pscustomobject]@{ Model = $modelDisplay; Status = 'No drivers found for OS'; Success = $true; DriverPath = $driverRelativePath }
|
||||||
|
}
|
||||||
|
|
||||||
|
$total = $packages.Count
|
||||||
|
$idx = 0
|
||||||
|
foreach ($pkg in $packages) {
|
||||||
|
$idx++
|
||||||
|
$driverName = $pkg.Name
|
||||||
|
if ([string]::IsNullOrWhiteSpace($driverName)) { $driverName = $pkg.DriverFileName }
|
||||||
|
$status = "$idx/$total Downloading $driverName"
|
||||||
|
if ($null -ne $ProgressQueue) { Invoke-ProgressUpdate -ProgressQueue $ProgressQueue -Identifier $modelDisplay -Status $status }
|
||||||
|
|
||||||
|
$categorySafe = ($pkg.Category -replace '[\\\/\:\*\?\"\<\>\| ]', '_')
|
||||||
|
$downloadFolder = Join-Path $modelPath $categorySafe
|
||||||
|
if (-not (Test-Path $downloadFolder)) { New-Item -Path $downloadFolder -ItemType Directory -Force | Out-Null }
|
||||||
|
$driverFilePath = Join-Path $downloadFolder $pkg.DriverFileName
|
||||||
|
$plainName = [IO.Path]::GetFileNameWithoutExtension($pkg.DriverFileName)
|
||||||
|
if ([string]::IsNullOrWhiteSpace($plainName)) { $plainName = "_extract" }
|
||||||
|
$extractFolder = Join-Path $downloadFolder $plainName
|
||||||
|
|
||||||
|
if (Test-Path $extractFolder) {
|
||||||
|
$sz = (Get-ChildItem -Path $extractFolder -Recurse -Exclude *.log | Measure-Object -Property Length -Sum -ErrorAction SilentlyContinue).Sum
|
||||||
|
if ($sz -gt 1KB) { continue }
|
||||||
|
}
|
||||||
|
|
||||||
|
if (-not (Test-Path $driverFilePath)) {
|
||||||
|
WriteLog "$status URL: $($pkg.DownloadUrl)"
|
||||||
|
try { Start-BitsTransferWithRetry -Source $pkg.DownloadUrl -Destination $driverFilePath }
|
||||||
|
catch {
|
||||||
|
$failureMessage = "Failed to download driver '$driverName' from $($pkg.DownloadUrl): $($_.Exception.Message)"
|
||||||
|
WriteLog $failureMessage
|
||||||
|
throw (New-Object System.Exception($failureMessage, $_.Exception))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
$status = "$idx/$total Extracting $driverName"
|
||||||
|
if ($null -ne $ProgressQueue) { Invoke-ProgressUpdate -ProgressQueue $ProgressQueue -Identifier $modelDisplay -Status $status }
|
||||||
|
|
||||||
|
if (-not (Test-Path $extractFolder)) { New-Item -Path $extractFolder -ItemType Directory -Force | Out-Null }
|
||||||
|
|
||||||
|
$arg1 = "/s /e=`"$extractFolder`" /l=`"$extractFolder\log.log`""
|
||||||
|
$arg2 = "/s /drivers=`"$extractFolder`" /l=`"$extractFolder\log.log`""
|
||||||
|
$ok = $false
|
||||||
|
try {
|
||||||
|
Invoke-Process -FilePath $driverFilePath -ArgumentList $arg1 | Out-Null
|
||||||
|
$sz = (Get-ChildItem -Path $extractFolder -Recurse -Exclude *.log | Measure-Object -Property Length -Sum -ErrorAction SilentlyContinue).Sum
|
||||||
|
if ($sz -gt 1KB) { $ok = $true }
|
||||||
|
if (-not $ok) {
|
||||||
|
Remove-SafeFolder $extractFolder
|
||||||
|
New-Item -Path $extractFolder -ItemType Directory -Force | Out-Null
|
||||||
|
Invoke-Process -FilePath $driverFilePath -ArgumentList $arg2 | Out-Null
|
||||||
|
$sz = (Get-ChildItem -Path $extractFolder -Recurse -Exclude *.log | Measure-Object -Property Length -Sum -ErrorAction SilentlyContinue).Sum
|
||||||
|
if ($sz -gt 1KB) { $ok = $true }
|
||||||
|
}
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
WriteLog "Extraction error: $($_.Exception.Message)"
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($ok) {
|
||||||
|
Remove-Item $driverFilePath -Force -ErrorAction SilentlyContinue
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
$failureMessage = "Failed to extract driver '$driverName'."
|
||||||
|
WriteLog $failureMessage
|
||||||
|
throw (New-Object System.Exception($failureMessage))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($CompressToWim) {
|
||||||
|
if ($null -ne $ProgressQueue) { Invoke-ProgressUpdate -ProgressQueue $ProgressQueue -Identifier $modelDisplay -Status 'Compressing...' }
|
||||||
|
$wimPath = Join-Path $makeDriversPath "$sanitizedModelName.wim"
|
||||||
|
try {
|
||||||
|
$null = Compress-DriverFolderToWim -SourceFolderPath $modelPath -DestinationWimPath $wimPath -WimName $modelDisplay -WimDescription $modelDisplay -PreserveSource:$PreserveSourceOnCompress -ErrorAction Stop
|
||||||
|
$driverRelativePath = Join-Path $make "$sanitizedModelName.wim"
|
||||||
|
$statusFinal = 'Completed & Compressed'
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
WriteLog "Compression failed for $($modelDisplay): $($_.Exception.Message)"
|
||||||
|
$statusFinal = 'Completed (Compression Failed)'
|
||||||
|
}
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
$statusFinal = 'Completed'
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($null -ne $ProgressQueue) { Invoke-ProgressUpdate -ProgressQueue $ProgressQueue -Identifier $modelDisplay -Status $statusFinal }
|
||||||
|
return [pscustomobject]@{ Model = $modelDisplay; Status = $statusFinal; Success = $true; DriverPath = $driverRelativePath }
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
$errorStatus = "Error: $($_.Exception.Message)"
|
||||||
|
WriteLog "Save-DellDriversTask error for $($modelDisplay): $($_.Exception.ToString())"
|
||||||
|
Remove-DriverModelFolder -DriversFolder $DriversFolder -TargetFolder $modelPath -Description $modelDisplay
|
||||||
|
if ($null -ne $ProgressQueue) { Invoke-ProgressUpdate -ProgressQueue $ProgressQueue -Identifier $modelDisplay -Status $errorStatus }
|
||||||
|
return [pscustomobject]@{ Model = $modelDisplay; Status = $errorStatus; Success = $false; DriverPath = $null }
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
Export-ModuleMember -Function *
|
||||||
@@ -0,0 +1,436 @@
|
|||||||
|
<#
|
||||||
|
.SYNOPSIS
|
||||||
|
Provides functions to retrieve HP model lists and download corresponding driver packs.
|
||||||
|
.DESCRIPTION
|
||||||
|
This module contains the logic specific to handling HP drivers for the FFU Builder UI. It includes functions to:
|
||||||
|
- Download and parse the HP PlatformList.xml to generate a list of supported HP computer models.
|
||||||
|
- For a selected model, find the most appropriate driver pack based on the specified Windows release and version, with intelligent fallback logic.
|
||||||
|
- Download the driver pack, extract all individual driver installers, and then extract the driver files from each installer.
|
||||||
|
- Optionally, compress the final extracted drivers into a single WIM file for easier deployment.
|
||||||
|
These functions are designed to be called by the main UI logic, often in parallel, to efficiently manage driver acquisition.
|
||||||
|
#>
|
||||||
|
|
||||||
|
# Function to get the list of HP models from the PlatformList.xml
|
||||||
|
function Get-HPDriversModelList {
|
||||||
|
[CmdletBinding()]
|
||||||
|
param (
|
||||||
|
[Parameter(Mandatory = $true)]
|
||||||
|
[string]$DriversFolder,
|
||||||
|
[Parameter(Mandatory = $true)]
|
||||||
|
[string]$Make # Expected to be 'HP'
|
||||||
|
)
|
||||||
|
|
||||||
|
WriteLog "Getting HP driver model list..."
|
||||||
|
$hpDriversFolder = Join-Path -Path $DriversFolder -ChildPath $Make
|
||||||
|
$platformListUrl = 'https://hpia.hpcloud.hp.com/ref/platformList.cab'
|
||||||
|
$platformListCab = Join-Path -Path $hpDriversFolder -ChildPath "platformList.cab"
|
||||||
|
$platformListXml = Join-Path -Path $hpDriversFolder -ChildPath "PlatformList.xml"
|
||||||
|
$modelList = [System.Collections.Generic.List[PSCustomObject]]::new()
|
||||||
|
|
||||||
|
try {
|
||||||
|
# Ensure HP drivers folder exists
|
||||||
|
if (-not (Test-Path -Path $hpDriversFolder)) {
|
||||||
|
WriteLog "Creating HP Drivers folder: $hpDriversFolder"
|
||||||
|
New-Item -Path $hpDriversFolder -ItemType Directory -Force | Out-Null
|
||||||
|
}
|
||||||
|
|
||||||
|
# Download PlatformList.cab if it doesn't exist or is outdated (e.g., older than 7 days)
|
||||||
|
if (-not (Test-Path -Path $platformListCab) -or ((Get-Date) - (Get-Item $platformListCab).LastWriteTime).TotalDays -gt 7) {
|
||||||
|
WriteLog "Downloading $platformListUrl to $platformListCab"
|
||||||
|
# Use the private helper function for download with retry
|
||||||
|
Start-BitsTransferWithRetry -Source $platformListUrl -Destination $platformListCab -ErrorAction Stop
|
||||||
|
WriteLog "PlatformList.cab download complete."
|
||||||
|
# Force extraction if downloaded
|
||||||
|
if (Test-Path -Path $platformListXml) {
|
||||||
|
Remove-Item -Path $platformListXml -Force
|
||||||
|
}
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
WriteLog "Using existing PlatformList.cab found at $platformListCab"
|
||||||
|
}
|
||||||
|
|
||||||
|
# Extract PlatformList.xml if it doesn't exist
|
||||||
|
if (-not (Test-Path -Path $platformListXml)) {
|
||||||
|
WriteLog "Expanding $platformListCab to $platformListXml"
|
||||||
|
# Use the private helper function for process invocation
|
||||||
|
Invoke-Process -FilePath "expand.exe" -ArgumentList @("`"$platformListCab`"", "`"$platformListXml`"") -ErrorAction Stop | Out-Null
|
||||||
|
WriteLog "PlatformList.xml extraction complete."
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
WriteLog "Using existing PlatformList.xml found at $platformListXml"
|
||||||
|
}
|
||||||
|
|
||||||
|
# Parse the PlatformList.xml using XmlReader for efficiency
|
||||||
|
WriteLog "Parsing PlatformList.xml to extract HP models..."
|
||||||
|
$settings = New-Object System.Xml.XmlReaderSettings
|
||||||
|
$settings.Async = $false # Ensure synchronous reading
|
||||||
|
|
||||||
|
$reader = [System.Xml.XmlReader]::Create($platformListXml, $settings)
|
||||||
|
$uniqueEntries = [System.Collections.Generic.HashSet[string]]::new([System.StringComparer]::OrdinalIgnoreCase)
|
||||||
|
|
||||||
|
while ($reader.Read()) {
|
||||||
|
if ($reader.NodeType -eq [System.Xml.XmlNodeType]::Element -and $reader.Name -eq 'Platform') {
|
||||||
|
$platformReader = $reader.ReadSubtree()
|
||||||
|
$platformNames = [System.Collections.Generic.List[string]]::new()
|
||||||
|
$platformSystemId = $null
|
||||||
|
|
||||||
|
while ($platformReader.Read()) {
|
||||||
|
if ($platformReader.NodeType -eq [System.Xml.XmlNodeType]::Element) {
|
||||||
|
if ($platformReader.Name -eq 'ProductName') {
|
||||||
|
$modelName = $platformReader.ReadElementContentAsString()
|
||||||
|
if (-not [string]::IsNullOrWhiteSpace($modelName)) {
|
||||||
|
$platformNames.Add($modelName.Trim())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
elseif ($platformReader.Name -eq 'SystemID') {
|
||||||
|
$platformSystemId = $platformReader.ReadElementContentAsString().Trim()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
$platformReader.Close()
|
||||||
|
|
||||||
|
foreach ($name in $platformNames) {
|
||||||
|
$systemIdKey = if (-not [string]::IsNullOrWhiteSpace($platformSystemId)) { $platformSystemId } else { '' }
|
||||||
|
$compositeKey = "$name|$systemIdKey"
|
||||||
|
if ($uniqueEntries.Add($compositeKey)) {
|
||||||
|
$modelList.Add([PSCustomObject]@{
|
||||||
|
Make = $Make
|
||||||
|
Model = $name
|
||||||
|
SystemId = $platformSystemId
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
$reader.Close()
|
||||||
|
|
||||||
|
WriteLog "Successfully parsed $($modelList.Count) HP model and SystemID combinations from PlatformList.xml."
|
||||||
|
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
WriteLog "Error getting HP driver model list: $($_.Exception.Message)"
|
||||||
|
}
|
||||||
|
|
||||||
|
# Sort the list alphabetically by Model name before returning
|
||||||
|
return $modelList | Sort-Object -Property Model, SystemId
|
||||||
|
}
|
||||||
|
# Function to download and extract drivers for a specific HP model (Designed for ForEach-Object -Parallel)
|
||||||
|
function Save-HPDriversTask {
|
||||||
|
[CmdletBinding()]
|
||||||
|
param (
|
||||||
|
[Parameter(Mandatory = $true)]
|
||||||
|
[PSCustomObject]$DriverItemData, # Contains Make, Model
|
||||||
|
[Parameter(Mandatory = $true)]
|
||||||
|
[string]$DriversFolder,
|
||||||
|
[Parameter(Mandatory = $true)]
|
||||||
|
[ValidateSet("x64", "x86", "ARM64")]
|
||||||
|
[string]$WindowsArch,
|
||||||
|
[Parameter(Mandatory = $true)]
|
||||||
|
[ValidateSet(10, 11)]
|
||||||
|
[int]$WindowsRelease,
|
||||||
|
[Parameter(Mandatory = $true)]
|
||||||
|
[string]$WindowsVersion, # e.g., 22H2, 23H2, etc.
|
||||||
|
[Parameter()] # Made optional
|
||||||
|
[System.Collections.Concurrent.ConcurrentQueue[hashtable]]$ProgressQueue = $null, # Default to null
|
||||||
|
[Parameter()]
|
||||||
|
[bool]$CompressToWim = $false, # New parameter for compression
|
||||||
|
[Parameter()]
|
||||||
|
[bool]$PreserveSourceOnCompress = $false
|
||||||
|
)
|
||||||
|
|
||||||
|
$displayModelName = if (-not [string]::IsNullOrWhiteSpace($DriverItemData.Model)) { $DriverItemData.Model } else { $DriverItemData.Id }
|
||||||
|
$make = $DriverItemData.Make # Should be 'HP'
|
||||||
|
$productName = if ($DriverItemData.PSObject.Properties['ProductName'] -and -not [string]::IsNullOrWhiteSpace($DriverItemData.ProductName)) { $DriverItemData.ProductName } else { ConvertTo-DriverBaseName -ModelString $displayModelName }
|
||||||
|
if ([string]::IsNullOrWhiteSpace($productName)) { $productName = $displayModelName }
|
||||||
|
$systemIdentifier = if ($DriverItemData.PSObject.Properties['SystemId'] -and -not [string]::IsNullOrWhiteSpace($DriverItemData.SystemId)) { $DriverItemData.SystemId } else { $null }
|
||||||
|
if ([string]::IsNullOrWhiteSpace($displayModelName)) {
|
||||||
|
$displayModelName = if ([string]::IsNullOrWhiteSpace($systemIdentifier)) { $productName } else { Get-DriverDisplayName -BaseName $productName -Identifier $systemIdentifier }
|
||||||
|
}
|
||||||
|
$identifier = $displayModelName # Unique identifier for progress updates
|
||||||
|
$sanitizedModelName = ConvertTo-SafeName -Name $identifier
|
||||||
|
if ($sanitizedModelName -ne $identifier) { WriteLog "Sanitized model name: '$identifier' -> '$sanitizedModelName'" }
|
||||||
|
$hpDriversBaseFolder = Join-Path -Path $DriversFolder -ChildPath $make # Changed variable name for clarity
|
||||||
|
$platformListXml = Join-Path -Path $hpDriversBaseFolder -ChildPath "PlatformList.xml"
|
||||||
|
$modelSpecificFolder = Join-Path -Path $hpDriversBaseFolder -ChildPath $sanitizedModelName # Sanitize model name for folder path
|
||||||
|
$driverRelativePath = Join-Path -Path $make -ChildPath $sanitizedModelName # Relative path for the driver folder
|
||||||
|
$finalStatus = "" # Initialize final status
|
||||||
|
$successState = $true # Assume success unless an operation fails
|
||||||
|
|
||||||
|
if (-not (Test-Path -Path $DriversFolder -PathType Container)) {
|
||||||
|
WriteLog "Creating Drivers folder: $DriversFolder"
|
||||||
|
New-Item -Path $DriversFolder -ItemType Directory -Force | Out-Null
|
||||||
|
}
|
||||||
|
if (-not (Test-Path -Path $hpDriversBaseFolder -PathType Container)) {
|
||||||
|
WriteLog "Creating HP drivers folder: $hpDriversBaseFolder"
|
||||||
|
New-Item -Path $hpDriversBaseFolder -ItemType Directory -Force | Out-Null
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($null -ne $ProgressQueue) { Invoke-ProgressUpdate -ProgressQueue $ProgressQueue -Identifier $identifier -Status "Checking HP drivers for $displayModelName..." }
|
||||||
|
|
||||||
|
try {
|
||||||
|
# Check for existing drivers
|
||||||
|
$existingDriver = Test-ExistingDriver -Make $make -Model $sanitizedModelName -DriversFolder $DriversFolder -Identifier $identifier -ProgressQueue $ProgressQueue
|
||||||
|
if ($null -ne $existingDriver) {
|
||||||
|
# The return object from Test-ExistingDriver uses 'Model' as the identifier key.
|
||||||
|
# We need to return 'Identifier' for HP's logic.
|
||||||
|
$existingDriver | Add-Member -MemberType NoteProperty -Name 'Identifier' -Value $identifier -Force
|
||||||
|
$existingDriver.PSObject.Properties.Remove('Model')
|
||||||
|
|
||||||
|
# Special handling for existing folders that need compression
|
||||||
|
if ($CompressToWim -and $existingDriver.Status -eq 'Already downloaded') {
|
||||||
|
$wimFilePath = Join-Path -Path $hpDriversBaseFolder -ChildPath "$($sanitizedModelName).wim"
|
||||||
|
$wimRelativePath = Join-Path -Path $make -ChildPath "$($sanitizedModelName).wim"
|
||||||
|
$sourceFolderPath = Join-Path -Path $hpDriversBaseFolder -ChildPath $sanitizedModelName
|
||||||
|
WriteLog "Attempting compression of existing folder '$sourceFolderPath' to '$wimFilePath'."
|
||||||
|
if ($null -ne $ProgressQueue) { Invoke-ProgressUpdate -ProgressQueue $ProgressQueue -Identifier $identifier -Status "Compressing existing..." }
|
||||||
|
try {
|
||||||
|
$null = Compress-DriverFolderToWim -SourceFolderPath $sourceFolderPath -DestinationWimPath $wimFilePath -WimName $identifier -WimDescription "Drivers for $identifier" -PreserveSource:$PreserveSourceOnCompress -ErrorAction Stop
|
||||||
|
$existingDriver.Status = "Compression successful"
|
||||||
|
$existingDriver.DriverPath = $wimRelativePath
|
||||||
|
$existingDriver.Success = $true
|
||||||
|
WriteLog "Successfully compressed existing drivers for $identifier to $wimFilePath."
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
WriteLog "Error compressing existing drivers for $($identifier): $($_.Exception.Message)"
|
||||||
|
$existingDriver.Status = "Already downloaded (Compression failed)"
|
||||||
|
$existingDriver.Success = $false
|
||||||
|
}
|
||||||
|
if ($null -ne $ProgressQueue) { Invoke-ProgressUpdate -ProgressQueue $ProgressQueue -Identifier $identifier -Status $existingDriver.Status }
|
||||||
|
}
|
||||||
|
|
||||||
|
return $existingDriver
|
||||||
|
}
|
||||||
|
|
||||||
|
# If folder does not exist, proceed with download and extraction
|
||||||
|
WriteLog "HP drivers for '$identifier' not found locally. Starting download process..."
|
||||||
|
if ($null -ne $ProgressQueue) { Invoke-ProgressUpdate -ProgressQueue $ProgressQueue -Identifier $identifier -Status "Downloading..." }
|
||||||
|
|
||||||
|
# Ensure PlatformList.xml exists (it should have been downloaded by Get-HPDriversModelList)
|
||||||
|
if (-not (Test-Path -Path $platformListXml)) {
|
||||||
|
# Attempt to download/extract it again if missing
|
||||||
|
WriteLog "PlatformList.xml not found for HP task, attempting download/extract..."
|
||||||
|
$platformListUrl = 'https://hpia.hpcloud.hp.com/ref/platformList.cab'
|
||||||
|
$platformListCab = Join-Path -Path $hpDriversBaseFolder -ChildPath "platformList.cab"
|
||||||
|
# Base folder already checked/created
|
||||||
|
Start-BitsTransferWithRetry -Source $platformListUrl -Destination $platformListCab -ErrorAction Stop
|
||||||
|
if (Test-Path -Path $platformListXml) { Remove-Item -Path $platformListXml -Force }
|
||||||
|
Invoke-Process -FilePath "expand.exe" -ArgumentList @("`"$platformListCab`"", "`"$platformListXml`"") -ErrorAction Stop | Out-Null
|
||||||
|
WriteLog "PlatformList.xml download/extract complete for HP task."
|
||||||
|
if (-not (Test-Path -Path $platformListXml)) {
|
||||||
|
throw "Failed to obtain PlatformList.xml for HP driver task."
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# Parse the PlatformList.xml to find the SystemID based on the ProductName
|
||||||
|
WriteLog "Parsing $platformListXml for model '$displayModelName' (SystemID: $systemIdentifier) details..."
|
||||||
|
[xml]$platformListContent = Get-Content -Path $platformListXml -Raw -Encoding UTF8 -ErrorAction Stop
|
||||||
|
$platformNode = $null
|
||||||
|
if (-not [string]::IsNullOrWhiteSpace($systemIdentifier)) {
|
||||||
|
$platformNode = $platformListContent.ImagePal.Platform | Where-Object { $_.SystemID -eq $systemIdentifier } | Select-Object -First 1
|
||||||
|
if ($null -eq $platformNode) {
|
||||||
|
WriteLog "SystemID '$systemIdentifier' not found in PlatformList.xml. Falling back to ProductName search."
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if ($null -eq $platformNode) {
|
||||||
|
$searchName = if (-not [string]::IsNullOrWhiteSpace($productName)) { $productName } else { $displayModelName }
|
||||||
|
$platformNode = $platformListContent.ImagePal.Platform | Where-Object { $_.ProductName.'#text' -match "^$([regex]::Escape($searchName))$" } | Select-Object -First 1
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($null -eq $platformNode) {
|
||||||
|
throw "Model '$displayModelName' (SystemID: $systemIdentifier) not found in PlatformList.xml."
|
||||||
|
}
|
||||||
|
|
||||||
|
$systemID = $platformNode.SystemID
|
||||||
|
# --- OS Node Selection with Fallback Logic ---
|
||||||
|
$selectedOSNode = $null
|
||||||
|
$selectedOSVersion = $null
|
||||||
|
$selectedOSRelease = $WindowsRelease # Start with the requested release
|
||||||
|
|
||||||
|
# Complete list of Windows 11 feature-update versions (newest to oldest)
|
||||||
|
$win11Versions = @(
|
||||||
|
"24H2", "23H2", "22H2", "21H2"
|
||||||
|
)
|
||||||
|
|
||||||
|
# Complete list of Windows 10 feature-update versions (newest to oldest)
|
||||||
|
$win10Versions = @(
|
||||||
|
"22H2", "21H2", "21H1", "20H2", "2004", "1909", "1903", "1809", "1803", "1709", "1703", "1607", "1511", "1507"
|
||||||
|
)
|
||||||
|
|
||||||
|
# Helper function to find a matching OS node for a given release and version list
|
||||||
|
function Find-MatchingOSNode {
|
||||||
|
param(
|
||||||
|
[int]$ReleaseToSearch,
|
||||||
|
[array]$VersionsToSearch
|
||||||
|
)
|
||||||
|
$osNodesForRelease = $platformNode.OS | Where-Object {
|
||||||
|
($ReleaseToSearch -eq 11 -and $_.IsWindows11 -contains 'true') -or
|
||||||
|
($ReleaseToSearch -eq 10 -and ($null -eq $_.IsWindows11 -or $_.IsWindows11 -notcontains 'true'))
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($null -eq $osNodesForRelease) { return $null }
|
||||||
|
|
||||||
|
foreach ($version in $VersionsToSearch) {
|
||||||
|
foreach ($osNode in $osNodesForRelease) {
|
||||||
|
$releaseIDs = $osNode.OSReleaseIdFileName -replace 'H', 'h' -split ' '
|
||||||
|
if ($releaseIDs -contains $version.ToLower()) {
|
||||||
|
return @{ Node = $osNode; Version = $version }
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return $null
|
||||||
|
}
|
||||||
|
|
||||||
|
# 1. Attempt Exact Match (Requested Release and Version)
|
||||||
|
WriteLog "Attempting to find exact match for Win$($WindowsRelease) ($($WindowsVersion))..."
|
||||||
|
$exactMatchResult = Find-MatchingOSNode -ReleaseToSearch $WindowsRelease -VersionsToSearch @($WindowsVersion)
|
||||||
|
if ($null -ne $exactMatchResult) {
|
||||||
|
$selectedOSNode = $exactMatchResult.Node
|
||||||
|
$selectedOSVersion = $exactMatchResult.Version
|
||||||
|
WriteLog "Exact match found: Win$($selectedOSRelease) ($($selectedOSVersion))."
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
WriteLog "Exact match not found for Win$($WindowsRelease) ($($WindowsVersion))."
|
||||||
|
# 2. Fallback: Same Release, Other Versions (Newest First)
|
||||||
|
WriteLog "Attempting fallback within Win$($WindowsRelease)..."
|
||||||
|
$versionsForCurrentRelease = if ($WindowsRelease -eq 11) { $win11Versions } else { $win10Versions }
|
||||||
|
$fallbackVersions = $versionsForCurrentRelease | Where-Object { $_ -ne $WindowsVersion }
|
||||||
|
$fallbackResult = Find-MatchingOSNode -ReleaseToSearch $WindowsRelease -VersionsToSearch $fallbackVersions
|
||||||
|
if ($null -ne $fallbackResult) {
|
||||||
|
$selectedOSNode = $fallbackResult.Node
|
||||||
|
$selectedOSVersion = $fallbackResult.Version
|
||||||
|
WriteLog "Fallback successful within Win$($selectedOSRelease). Using version: $($selectedOSVersion)."
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
WriteLog "Fallback within Win$($WindowsRelease) unsuccessful."
|
||||||
|
# 3. Fallback: Other Release, Versions (Newest First)
|
||||||
|
$otherRelease = if ($WindowsRelease -eq 11) { 10 } else { 11 }
|
||||||
|
WriteLog "Attempting fallback to Win$($otherRelease)..."
|
||||||
|
$versionsForOtherRelease = if ($otherRelease -eq 11) { $win11Versions } else { $win10Versions }
|
||||||
|
$otherFallbackResult = Find-MatchingOSNode -ReleaseToSearch $otherRelease -VersionsToSearch $versionsForOtherRelease
|
||||||
|
if ($null -ne $otherFallbackResult) {
|
||||||
|
$selectedOSNode = $otherFallbackResult.Node
|
||||||
|
$selectedOSVersion = $otherFallbackResult.Version
|
||||||
|
$selectedOSRelease = $otherRelease
|
||||||
|
WriteLog "Fallback successful to Win$($selectedOSRelease). Using version: $($selectedOSVersion)."
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
WriteLog "Fallback to Win$($otherRelease) also failed."
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($null -eq $selectedOSNode) {
|
||||||
|
$allAvailableVersions = @()
|
||||||
|
if ($platformNode.OS) {
|
||||||
|
foreach ($osNode in $platformNode.OS) {
|
||||||
|
$osRel = if ($osNode.IsWindows11 -contains 'true') { 11 } else { 10 }
|
||||||
|
$relIDs = $osNode.OSReleaseIdFileName -replace 'H', 'h' -split ' '
|
||||||
|
foreach ($id in $relIDs) { $allAvailableVersions += "Win$($osRel) $($id)" }
|
||||||
|
}
|
||||||
|
}
|
||||||
|
$availableVersionsString = ($allAvailableVersions | Select-Object -Unique) -join ', '
|
||||||
|
if ([string]::IsNullOrWhiteSpace($availableVersionsString)) { $availableVersionsString = "None" }
|
||||||
|
throw "Could not find any suitable OS driver pack for model '$displayModelName' matching requested or fallback versions (Win$($WindowsRelease) $WindowsVersion). Available: $availableVersionsString"
|
||||||
|
}
|
||||||
|
|
||||||
|
$osReleaseIdFileName = $selectedOSNode.OSReleaseIdFileName -replace 'H', 'h'
|
||||||
|
WriteLog "Using SystemID: $systemID and OS Info: Win$($selectedOSRelease) ($($selectedOSVersion)) for '$displayModelName'"
|
||||||
|
$archSuffix = $WindowsArch -replace "^x", ""
|
||||||
|
$modelRelease = "$($systemID)_$($archSuffix)_$($selectedOSRelease).0.$($selectedOSVersion.ToLower())"
|
||||||
|
$driverCabUrl = "https://hpia.hpcloud.hp.com/ref/$systemID/$modelRelease.cab"
|
||||||
|
$driverCabFile = Join-Path -Path $hpDriversBaseFolder -ChildPath "$modelRelease.cab" # Store in base HP folder
|
||||||
|
$driverXmlFile = Join-Path -Path $hpDriversBaseFolder -ChildPath "$modelRelease.xml" # Store in base HP folder
|
||||||
|
|
||||||
|
if ($null -ne $ProgressQueue) { Invoke-ProgressUpdate -ProgressQueue $ProgressQueue -Identifier $identifier -Status "Downloading driver index..." }
|
||||||
|
WriteLog "Downloading HP Driver cab from $driverCabUrl to $driverCabFile"
|
||||||
|
Start-BitsTransferWithRetry -Source $driverCabUrl -Destination $driverCabFile -ErrorAction Stop
|
||||||
|
WriteLog "Expanding HP Driver cab $driverCabFile to $driverXmlFile"
|
||||||
|
if (Test-Path -Path $driverXmlFile) { Remove-Item -Path $driverXmlFile -Force }
|
||||||
|
Invoke-Process -FilePath "expand.exe" -ArgumentList @("`"$driverCabFile`"", "`"$driverXmlFile`"") -ErrorAction Stop | Out-Null
|
||||||
|
|
||||||
|
WriteLog "Parsing driver XML $driverXmlFile"
|
||||||
|
[xml]$driverXmlContent = Get-Content -Path $driverXmlFile -Raw -Encoding UTF8 -ErrorAction Stop
|
||||||
|
$updates = $driverXmlContent.ImagePal.Solutions.UpdateInfo | Where-Object { $_.Category -match '^Driver' }
|
||||||
|
$totalDrivers = ($updates | Measure-Object).Count
|
||||||
|
$downloadedCount = 0
|
||||||
|
WriteLog "Found $totalDrivers driver updates for $displayModelName."
|
||||||
|
if ($null -ne $ProgressQueue) { Invoke-ProgressUpdate -ProgressQueue $ProgressQueue -Identifier $identifier -Status "Found $totalDrivers drivers. Downloading..." }
|
||||||
|
|
||||||
|
if (-not (Test-Path -Path $modelSpecificFolder)) {
|
||||||
|
New-Item -Path $modelSpecificFolder -ItemType Directory -Force -ErrorAction Stop | Out-Null
|
||||||
|
}
|
||||||
|
|
||||||
|
foreach ($update in $updates) {
|
||||||
|
$driverName = $update.Name -replace '[\\/:"*?<>|]', '_'
|
||||||
|
$category = $update.Category -replace '[\\/:"*?<>|]', '_'
|
||||||
|
$version = $update.Version -replace '[\\/:"*?<>|]', '_'
|
||||||
|
$driverUrl = "https://$($update.URL)"
|
||||||
|
$driverFileName = Split-Path -Path $driverUrl -Leaf
|
||||||
|
$downloadFolder = Join-Path -Path $modelSpecificFolder -ChildPath $category
|
||||||
|
$driverFilePath = Join-Path -Path $downloadFolder -ChildPath $driverFileName
|
||||||
|
$extractFolder = Join-Path -Path $downloadFolder -ChildPath ($driverName + "_" + $version + "_" + ($driverFileName -replace '\.exe$', ''))
|
||||||
|
|
||||||
|
$downloadedCount++
|
||||||
|
$progressMsg = "$downloadedCount/$totalDrivers Downloading $driverName"
|
||||||
|
if ($null -ne $ProgressQueue) { Invoke-ProgressUpdate -ProgressQueue $ProgressQueue -Identifier $identifier -Status $progressMsg }
|
||||||
|
WriteLog "$progressMsg URL: $driverUrl"
|
||||||
|
|
||||||
|
if (Test-Path -Path $extractFolder) {
|
||||||
|
WriteLog "Driver already extracted to $extractFolder, skipping download."
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if (-not (Test-Path -Path $downloadFolder)) {
|
||||||
|
New-Item -Path $downloadFolder -ItemType Directory -Force -ErrorAction Stop | Out-Null
|
||||||
|
}
|
||||||
|
WriteLog "Downloading driver to: $driverFilePath"
|
||||||
|
Start-BitsTransferWithRetry -Source $driverUrl -Destination $driverFilePath -ErrorAction Stop
|
||||||
|
WriteLog "Driver downloaded: $driverFilePath"
|
||||||
|
$progressMsg = "$downloadedCount/$totalDrivers Extracting $driverName"
|
||||||
|
if ($null -ne $ProgressQueue) { Invoke-ProgressUpdate -ProgressQueue $ProgressQueue -Identifier $identifier -Status $progressMsg }
|
||||||
|
WriteLog "Creating extraction folder: $extractFolder"
|
||||||
|
New-Item -Path $extractFolder -ItemType Directory -Force -ErrorAction Stop | Out-Null
|
||||||
|
$arguments = "/s /e /f `"$extractFolder`""
|
||||||
|
WriteLog "Extracting driver $driverFilePath with args: $arguments"
|
||||||
|
WriteLog "Running HP Driver Extraction Command: $driverFilePath $arguments"
|
||||||
|
Invoke-Process -FilePath $driverFilePath -ArgumentList $arguments -ErrorAction Stop | Out-Null
|
||||||
|
# Start-Process -FilePath $driverFilePath -ArgumentList $arguments -Wait -NoNewWindow -ErrorAction Stop | Out-Null
|
||||||
|
WriteLog "Driver extracted to: $extractFolder"
|
||||||
|
Remove-Item -Path $driverFilePath -Force -ErrorAction SilentlyContinue
|
||||||
|
WriteLog "Deleted driver installer: $driverFilePath"
|
||||||
|
}
|
||||||
|
|
||||||
|
Remove-Item -Path $driverCabFile, $driverXmlFile -Force -ErrorAction SilentlyContinue
|
||||||
|
WriteLog "Cleaned up driver cab and xml files for $displayModelName"
|
||||||
|
|
||||||
|
$finalStatus = "Completed"
|
||||||
|
if ($CompressToWim) {
|
||||||
|
if ($null -ne $ProgressQueue) { Invoke-ProgressUpdate -ProgressQueue $ProgressQueue -Identifier $identifier -Status "Compressing..." }
|
||||||
|
$wimFilePath = Join-Path -Path $hpDriversBaseFolder -ChildPath "$($identifier).wim"
|
||||||
|
WriteLog "Compressing '$modelSpecificFolder' to '$wimFilePath'..."
|
||||||
|
try {
|
||||||
|
$null = Compress-DriverFolderToWim -SourceFolderPath $modelSpecificFolder -DestinationWimPath $wimFilePath -WimName $identifier -WimDescription "Drivers for $identifier" -PreserveSource:$PreserveSourceOnCompress -ErrorAction Stop
|
||||||
|
WriteLog "Compression successful for '$identifier'."
|
||||||
|
$finalStatus = "Completed & Compressed"
|
||||||
|
$driverRelativePath = Join-Path -Path $make -ChildPath "$($identifier).wim" # Update relative path to the WIM
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
WriteLog "Error during compression for '$identifier': $($_.Exception.Message)"
|
||||||
|
$finalStatus = "Completed (Compression Failed)"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
$successState = $true
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
$errorMessage = "Error saving HP drivers for $($displayModelName): $($_.Exception.Message)"
|
||||||
|
WriteLog $errorMessage
|
||||||
|
$finalStatus = "Error: $($_.Exception.Message.Split([Environment]::NewLine)[0])"
|
||||||
|
$successState = $false
|
||||||
|
$driverRelativePath = $null # Ensure path is null on error
|
||||||
|
Remove-DriverModelFolder -DriversFolder $DriversFolder -TargetFolder $modelSpecificFolder -Description $identifier
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($null -ne $ProgressQueue) { Invoke-ProgressUpdate -ProgressQueue $ProgressQueue -Identifier $identifier -Status $finalStatus }
|
||||||
|
return [PSCustomObject]@{ Identifier = $identifier; Status = $finalStatus; Success = $successState; DriverPath = $driverRelativePath }
|
||||||
|
}
|
||||||
|
|
||||||
|
Export-ModuleMember -Function *
|
||||||
@@ -0,0 +1,477 @@
|
|||||||
|
<#
|
||||||
|
.SYNOPSIS
|
||||||
|
Provides functions for discovering, downloading, and processing Lenovo drivers.
|
||||||
|
.DESCRIPTION
|
||||||
|
This module contains the logic specific to handling Lenovo drivers for the FFU Builder UI. It includes functions to query the Lenovo PSREF (Product Specification Reference) API to find and list available system models based on user search terms. It also provides the core background task for downloading all relevant driver packages for a selected model and Windows release. The download process involves parsing XML catalogs, downloading individual driver executables, silently extracting their contents, and organizing them into a structured folder. The module includes robust error handling, long path mitigation by using temporary extraction locations, and an option to compress the final driver set into a WIM archive.
|
||||||
|
#>
|
||||||
|
|
||||||
|
# Function to get the list of Lenovo models using the PSREF API
|
||||||
|
function Get-LenovoDriversModelList {
|
||||||
|
[CmdletBinding()]
|
||||||
|
param(
|
||||||
|
[Parameter(Mandatory = $true)]
|
||||||
|
[string]$ModelSearchTerm, # User input for model/machine type
|
||||||
|
[Parameter(Mandatory = $true)]
|
||||||
|
[hashtable]$Headers,
|
||||||
|
[Parameter(Mandatory = $true)]
|
||||||
|
[string]$UserAgent
|
||||||
|
)
|
||||||
|
|
||||||
|
# Lenovo is special - they prevent access to the PSREF API without a cookie as of July 2025.
|
||||||
|
# This cookie must be retrieved via Javascript
|
||||||
|
# It appears that the cookie is hard-coded. We'll see how long this lasts.
|
||||||
|
# If anyone knows how to reliably get the the model and machine type information from Lenovo, let me know.
|
||||||
|
# https://download.lenovo.com/cdrt/td/catalogv2.xml only provides a subset of the information available from PSREF (e.g. it's missing 300w, 500w, and other consumer models).
|
||||||
|
|
||||||
|
$lenovoCookie = "X-PSREF-USER-TOKEN=eyJ0eXAiOiJKV1QifQ.bjVTdWk0YklZeUc2WnFzL0lXU0pTeU1JcFo0aExzRXl1UGxHN3lnS1BtckI0ZVU5WEJyVGkvaFE0NmVNU2U1ZjNrK3ZqTEVIZ29nTk1TNS9DQmIwQ0pTN1Q1VytlY1RpNzZTUldXbm4wZ1g2RGJuQWg4MXRkTmxKT2YrOW9LRjBzQUZzV05HM3NpcU92WFVTM0o0blM1SDQyUlVXNThIV1VBS2R0c1B2NjJyQjIrUGxNZ2x6RTRhUjY5UDZWclBX.ZDBmM2EyMWRjZTg2N2JmYWMxZDIxY2NiYjQzMWFhNjg1YjEzZTAxNmU2M2RmN2M5ZjIyZWJhMzZkOWI1OWJhZg"
|
||||||
|
|
||||||
|
# Wrote a separate function to grab the token. Check the function notes for more details. Keep the above comment for now to see if the cookie ever changes.
|
||||||
|
# 3/25/2026 - The cookie is still the same after 8 months, but we'll keep the retrieval function in case it changes in the future or if we need to get a new one.
|
||||||
|
# $lenovoCookie = Get-LenovoPSREFToken
|
||||||
|
|
||||||
|
# Add the cookie to the headers
|
||||||
|
$Headers["Cookie"] = $lenovoCookie
|
||||||
|
|
||||||
|
WriteLog "Querying Lenovo PSREF API for model/machine type: $ModelSearchTerm"
|
||||||
|
$url = "https://psref.lenovo.com/api/search/DefinitionFilterAndSearch/Suggest?kw=$([uri]::EscapeDataString($ModelSearchTerm))"
|
||||||
|
$models = [System.Collections.Generic.List[PSCustomObject]]::new()
|
||||||
|
|
||||||
|
try {
|
||||||
|
$OriginalVerbosePreference = $VerbosePreference
|
||||||
|
$VerbosePreference = 'SilentlyContinue'
|
||||||
|
$response = Invoke-WebRequest -Uri $url -UseBasicParsing -Headers $Headers -UserAgent $UserAgent -ErrorAction Stop
|
||||||
|
$VerbosePreference = $OriginalVerbosePreference
|
||||||
|
WriteLog "PSREF API query complete."
|
||||||
|
|
||||||
|
$jsonResponse = $response.Content | ConvertFrom-Json
|
||||||
|
|
||||||
|
if ($null -ne $jsonResponse.data -and $jsonResponse.data.Count -gt 0) {
|
||||||
|
foreach ($item in $jsonResponse.data) {
|
||||||
|
$productName = $item.ProductName
|
||||||
|
$machineTypes = $item.MachineType -split " / " # Split if multiple machine types are listed
|
||||||
|
|
||||||
|
foreach ($machineTypeRaw in $machineTypes) {
|
||||||
|
$machineType = $machineTypeRaw.Trim()
|
||||||
|
# Only add if machine type is not empty
|
||||||
|
if (-not [string]::IsNullOrWhiteSpace($machineType)) {
|
||||||
|
# Create the combined display string
|
||||||
|
$displayModel = "$productName ($machineType)"
|
||||||
|
# Add each combination as a separate entry
|
||||||
|
$models.Add([PSCustomObject]@{
|
||||||
|
Make = 'Lenovo'
|
||||||
|
Model = $displayModel
|
||||||
|
ProductName = $productName
|
||||||
|
MachineType = $machineType
|
||||||
|
})
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
WriteLog "Skipping entry for product '$productName' due to missing machine type."
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
WriteLog "Found $($models.Count) potential model/machine type combinations for '$ModelSearchTerm'."
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
WriteLog "No models found matching '$ModelSearchTerm' in Lenovo PSREF."
|
||||||
|
}
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
WriteLog "Error querying Lenovo PSREF API: $($_.Exception.Message)"
|
||||||
|
# Return empty list on error
|
||||||
|
}
|
||||||
|
return $models
|
||||||
|
}
|
||||||
|
# Function to download and extract drivers for a specific Lenovo model (Background Task)
|
||||||
|
function Save-LenovoDriversTask {
|
||||||
|
[CmdletBinding()]
|
||||||
|
param(
|
||||||
|
[Parameter(Mandatory = $true)]
|
||||||
|
[PSCustomObject]$DriverItemData, # Contains Model (ProductName) and MachineType
|
||||||
|
[Parameter(Mandatory = $true)]
|
||||||
|
[string]$DriversFolder,
|
||||||
|
[Parameter(Mandatory = $true)]
|
||||||
|
[int]$WindowsRelease,
|
||||||
|
[Parameter(Mandatory = $true)]
|
||||||
|
[hashtable]$Headers,
|
||||||
|
[Parameter(Mandatory = $true)]
|
||||||
|
[string]$UserAgent,
|
||||||
|
[Parameter()]
|
||||||
|
[System.Collections.Concurrent.ConcurrentQueue[hashtable]]$ProgressQueue = $null,
|
||||||
|
[Parameter()]
|
||||||
|
[bool]$CompressToWim = $false,
|
||||||
|
[Parameter()]
|
||||||
|
[bool]$PreserveSourceOnCompress = $false
|
||||||
|
)
|
||||||
|
|
||||||
|
# The Model property from the UI already contains the combined "ProductName (MachineType)" string
|
||||||
|
$identifier = $DriverItemData.Model
|
||||||
|
$machineType = $DriverItemData.MachineType
|
||||||
|
$make = "Lenovo"
|
||||||
|
$sanitizedIdentifier = ConvertTo-SafeName -Name $identifier
|
||||||
|
if ($sanitizedIdentifier -ne $identifier) { WriteLog "Sanitized model identifier: '$identifier' -> '$sanitizedIdentifier'" }
|
||||||
|
$status = "Starting..."
|
||||||
|
$success = $false
|
||||||
|
|
||||||
|
# Define paths
|
||||||
|
$makeDriversPath = Join-Path -Path $DriversFolder -ChildPath $Make
|
||||||
|
# Use the identifier (which contains the model name and machine type) and sanitize it for the path
|
||||||
|
$modelPath = Join-Path -Path $makeDriversPath -ChildPath $sanitizedIdentifier
|
||||||
|
$driverRelativePath = Join-Path -Path $make -ChildPath $sanitizedIdentifier # Relative path for the driver folder
|
||||||
|
$tempDownloadPath = Join-Path -Path $makeDriversPath -ChildPath "_TEMP_$($machineType)_$($PID)" # Temp folder for catalog/package XMLs
|
||||||
|
|
||||||
|
if ($null -ne $ProgressQueue) { Invoke-ProgressUpdate -ProgressQueue $ProgressQueue -Identifier $identifier -Status "Checking..." }
|
||||||
|
|
||||||
|
try {
|
||||||
|
# Check for existing drivers
|
||||||
|
$existingDriver = Test-ExistingDriver -Make $make -Model $sanitizedIdentifier -DriversFolder $DriversFolder -Identifier $identifier -ProgressQueue $ProgressQueue
|
||||||
|
if ($null -ne $existingDriver) {
|
||||||
|
# The return object from Test-ExistingDriver uses 'Model' as the identifier key.
|
||||||
|
# We need to return 'Identifier' for Lenovo's logic.
|
||||||
|
$existingDriver | Add-Member -MemberType NoteProperty -Name 'Identifier' -Value $identifier -Force
|
||||||
|
$existingDriver.PSObject.Properties.Remove('Model')
|
||||||
|
|
||||||
|
# Special handling for existing folders that need compression
|
||||||
|
if ($CompressToWim -and $existingDriver.Status -eq 'Already downloaded') {
|
||||||
|
$wimFilePath = Join-Path -Path $makeDriversPath -ChildPath "$($sanitizedIdentifier).wim"
|
||||||
|
$wimRelativePath = Join-Path -Path $make -ChildPath "$($sanitizedIdentifier).wim"
|
||||||
|
$sourceFolderPath = Join-Path -Path $makeDriversPath -ChildPath $sanitizedIdentifier
|
||||||
|
WriteLog "Attempting compression of existing folder '$sourceFolderPath' to '$wimFilePath'."
|
||||||
|
if ($null -ne $ProgressQueue) { Invoke-ProgressUpdate -ProgressQueue $ProgressQueue -Identifier $identifier -Status "Compressing existing..." }
|
||||||
|
try {
|
||||||
|
$null = Compress-DriverFolderToWim -SourceFolderPath $sourceFolderPath -DestinationWimPath $wimFilePath -WimName $identifier -WimDescription "Drivers for $identifier" -PreserveSource:$PreserveSourceOnCompress -ErrorAction Stop
|
||||||
|
$existingDriver.Status = "Compression successful"
|
||||||
|
$existingDriver.DriverPath = $wimRelativePath
|
||||||
|
$existingDriver.Success = $true
|
||||||
|
WriteLog "Successfully compressed existing drivers for $identifier to $wimFilePath."
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
WriteLog "Error compressing existing drivers for $($identifier): $($_.Exception.Message)"
|
||||||
|
$existingDriver.Status = "Already downloaded (Compression failed)"
|
||||||
|
$existingDriver.Success = $false
|
||||||
|
}
|
||||||
|
if ($null -ne $ProgressQueue) { Invoke-ProgressUpdate -ProgressQueue $ProgressQueue -Identifier $identifier -Status $existingDriver.Status }
|
||||||
|
}
|
||||||
|
|
||||||
|
return $existingDriver
|
||||||
|
}
|
||||||
|
|
||||||
|
# Ensure base directories exist
|
||||||
|
if (-not (Test-Path -Path $makeDriversPath)) { New-Item -Path $makeDriversPath -ItemType Directory -Force | Out-Null }
|
||||||
|
if (-not (Test-Path -Path $modelPath)) { New-Item -Path $modelPath -ItemType Directory -Force | Out-Null }
|
||||||
|
if (-not (Test-Path -Path $tempDownloadPath)) { New-Item -Path $tempDownloadPath -ItemType Directory -Force | Out-Null }
|
||||||
|
|
||||||
|
# 2. Construct and Download Catalog URL
|
||||||
|
$modelRelease = $machineType + "_Win" + $WindowsRelease
|
||||||
|
$catalogUrl = "https://download.lenovo.com/catalog/$modelRelease.xml"
|
||||||
|
$lenovoCatalogXML = Join-Path -Path $tempDownloadPath -ChildPath "$modelRelease.xml"
|
||||||
|
|
||||||
|
$status = "Downloading Catalog..."
|
||||||
|
if ($null -ne $ProgressQueue) { Invoke-ProgressUpdate -ProgressQueue $ProgressQueue -Identifier $identifier -Status $status }
|
||||||
|
WriteLog "Downloading Lenovo Driver catalog for '$identifier' from $catalogUrl"
|
||||||
|
|
||||||
|
# Check URL accessibility first
|
||||||
|
try {
|
||||||
|
$request = [System.Net.WebRequest]::Create($catalogUrl); $request.Method = 'HEAD'; $response = $request.GetResponse(); $response.Close()
|
||||||
|
}
|
||||||
|
catch { throw "Lenovo Driver catalog URL is not accessible: $catalogUrl. Error: $($_.Exception.Message)" }
|
||||||
|
|
||||||
|
Start-BitsTransferWithRetry -Source $catalogUrl -Destination $lenovoCatalogXML
|
||||||
|
WriteLog "Catalog download Complete: $lenovoCatalogXML"
|
||||||
|
|
||||||
|
# 3. Parse Catalog and Process Packages
|
||||||
|
$status = "Parsing Catalog..."
|
||||||
|
if ($null -ne $ProgressQueue) { Invoke-ProgressUpdate -ProgressQueue $ProgressQueue -Identifier $identifier -Status $status }
|
||||||
|
[xml]$xmlContent = Get-Content -Path $lenovoCatalogXML -Encoding UTF8
|
||||||
|
|
||||||
|
$packages = @($xmlContent.packages.package) # Ensure it's an array
|
||||||
|
$totalPackages = $packages.Count
|
||||||
|
$processedPackages = 0
|
||||||
|
WriteLog "Found $totalPackages packages in catalog for '$identifier'."
|
||||||
|
|
||||||
|
foreach ($package in $packages) {
|
||||||
|
$processedPackages++
|
||||||
|
$category = $package.category
|
||||||
|
$packageUrl = $package.location # URL to the package's *XML* file
|
||||||
|
|
||||||
|
# Skip BIOS/Firmware based on category
|
||||||
|
if ($category -like 'BIOS*' -or $category -like 'Firmware*') {
|
||||||
|
WriteLog "($processedPackages/$totalPackages) Skipping BIOS/Firmware package: $category"
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
# Sanitize category for path
|
||||||
|
$categoryClean = $category -replace '[\\/:"*?<>|]', '_'
|
||||||
|
if ($categoryClean -eq 'Motherboard Devices Backplanes core chipset onboard video PCIe switches') {
|
||||||
|
$categoryClean = 'Motherboard Devices' # Shorten long category name
|
||||||
|
}
|
||||||
|
|
||||||
|
$packageName = [System.IO.Path]::GetFileName($packageUrl)
|
||||||
|
$packageXMLPath = Join-Path -Path $tempDownloadPath -ChildPath $packageName
|
||||||
|
$baseURL = $packageUrl -replace [regex]::Escape($packageName), "" # Base URL for the driver file
|
||||||
|
|
||||||
|
# Download the package XML
|
||||||
|
WriteLog "($processedPackages/$totalPackages) Downloading package XML: $packageUrl"
|
||||||
|
try {
|
||||||
|
Start-BitsTransferWithRetry -Source $packageUrl -Destination $packageXMLPath
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
$failureMessage = "Failed to download Lenovo package XML '$packageUrl': $($_.Exception.Message)"
|
||||||
|
WriteLog "($processedPackages/$totalPackages) $failureMessage"
|
||||||
|
Remove-Item -Path $packageXMLPath -Force -ErrorAction SilentlyContinue
|
||||||
|
throw (New-Object System.Exception($failureMessage, $_.Exception))
|
||||||
|
}
|
||||||
|
|
||||||
|
# Load and parse the package XML
|
||||||
|
[xml]$packageXmlContent = Get-Content -Path $packageXMLPath -Encoding UTF8
|
||||||
|
$packageType = $packageXmlContent.Package.PackageType.type
|
||||||
|
$packageTitleRaw = $packageXmlContent.Package.title.InnerText
|
||||||
|
|
||||||
|
# Filter out non-driver packages (Type 2 = Driver)
|
||||||
|
if ($packageType -ne 2) {
|
||||||
|
WriteLog "($processedPackages/$totalPackages) Skipping package '$packageTitleRaw' (Type: $packageType) - Not a driver."
|
||||||
|
Remove-Item -Path $packageXMLPath -Force -ErrorAction SilentlyContinue # Clean up package XML
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
# Sanitize title for folder name
|
||||||
|
$packageTitle = $packageTitleRaw -replace '[\\/:"*?<>|]', '_' -replace ' - .*', ''
|
||||||
|
|
||||||
|
# Extract driver file name and extract command
|
||||||
|
$driverFileName = $null
|
||||||
|
$extractCommand = $null
|
||||||
|
try {
|
||||||
|
$driverFileName = $packageXmlContent.Package.Files.Installer.File.Name
|
||||||
|
$extractCommand = $packageXmlContent.Package.ExtractCommand
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
WriteLog "($processedPackages/$totalPackages) Error parsing package XML '$packageXMLPath' for file name/command. Skipping. Error: $($_.Exception.Message)"
|
||||||
|
Remove-Item -Path $packageXMLPath -Force -ErrorAction SilentlyContinue
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
# Skip if essential info is missing
|
||||||
|
if ([string]::IsNullOrWhiteSpace($driverFileName) -or [string]::IsNullOrWhiteSpace($extractCommand)) {
|
||||||
|
WriteLog "($processedPackages/$totalPackages) Skipping package '$packageTitleRaw' - Missing driver file name or extract command in XML."
|
||||||
|
Remove-Item -Path $packageXMLPath -Force -ErrorAction SilentlyContinue
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
# Construct paths
|
||||||
|
$driverUrl = $baseURL + $driverFileName
|
||||||
|
$categoryPath = Join-Path -Path $modelPath -ChildPath $categoryClean
|
||||||
|
$downloadFolder = Join-Path -Path $categoryPath -ChildPath $packageTitle # Final destination subfolder
|
||||||
|
$driverFilePath = Join-Path -Path $downloadFolder -ChildPath $driverFileName
|
||||||
|
$extractFolder = Join-Path -Path $downloadFolder -ChildPath ($driverFileName -replace '\.exe$', '') # Extract to subfolder named after exe
|
||||||
|
# Check if already extracted
|
||||||
|
if (Test-Path -Path $extractFolder -PathType Container) {
|
||||||
|
$extractSize = (Get-ChildItem -Path $extractFolder -Recurse | Measure-Object -Property Length -Sum -ErrorAction SilentlyContinue).Sum
|
||||||
|
if ($extractSize -gt 1KB) {
|
||||||
|
WriteLog "($processedPackages/$totalPackages) Driver '$packageTitleRaw' already extracted to '$extractFolder'. Skipping."
|
||||||
|
Remove-Item -Path $packageXMLPath -Force -ErrorAction SilentlyContinue # Clean up package XML
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# Ensure download folder exists
|
||||||
|
if (-not (Test-Path -Path $downloadFolder)) {
|
||||||
|
New-Item -Path $downloadFolder -ItemType Directory -Force | Out-Null
|
||||||
|
}
|
||||||
|
|
||||||
|
# Download the driver .exe
|
||||||
|
$status = "$processedPackages/$totalPackages Downloading $packageTitle"
|
||||||
|
if ($null -ne $ProgressQueue) { Invoke-ProgressUpdate -ProgressQueue $ProgressQueue -Identifier $identifier -Status $status }
|
||||||
|
WriteLog "($processedPackages/$totalPackages) Downloading driver: $driverUrl to $driverFilePath"
|
||||||
|
try {
|
||||||
|
Start-BitsTransferWithRetry -Source $driverUrl -Destination $driverFilePath
|
||||||
|
WriteLog "($processedPackages/$totalPackages) Driver downloaded: $driverFileName"
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
$failureMessage = "Failed to download driver '$packageTitle' from $($driverUrl): $($_.Exception.Message)"
|
||||||
|
WriteLog "($processedPackages/$totalPackages) $failureMessage"
|
||||||
|
Remove-Item -Path $packageXMLPath -Force -ErrorAction SilentlyContinue
|
||||||
|
throw (New-Object System.Exception($failureMessage, $_.Exception))
|
||||||
|
}
|
||||||
|
|
||||||
|
# --- Extraction Logic ---
|
||||||
|
$status = "$processedPackages/$totalPackages Extracting $packageTitle"
|
||||||
|
if ($null -ne $ProgressQueue) { Invoke-ProgressUpdate -ProgressQueue $ProgressQueue -Identifier $identifier -Status $status }
|
||||||
|
|
||||||
|
# Always use a temporary extraction path to avoid long path issues
|
||||||
|
$originalExtractFolder = $extractFolder # Store the originally intended final path
|
||||||
|
$extractionSucceeded = $false
|
||||||
|
$tempExtractBase = $null # Initialize
|
||||||
|
|
||||||
|
# Create randomized number for use with temp folder name
|
||||||
|
$randomNumber = Get-Random -Minimum 1000 -Maximum 9999
|
||||||
|
$tempExtractBase = Join-Path $env:TEMP "LenovoDriverExtract_$randomNumber"
|
||||||
|
$extractFolder = Join-Path $tempExtractBase ($driverFileName -replace '\.exe$', '') # Actual temp extraction folder
|
||||||
|
WriteLog "($processedPackages/$totalPackages) Using temporary extraction path: $extractFolder"
|
||||||
|
|
||||||
|
# Ensure the base temp directory exists
|
||||||
|
if (-not (Test-Path -Path $tempExtractBase)) {
|
||||||
|
New-Item -Path $tempExtractBase -ItemType Directory -Force | Out-Null
|
||||||
|
}
|
||||||
|
# Ensure the target temporary extraction folder exists
|
||||||
|
if (-not (Test-Path -Path $extractFolder)) {
|
||||||
|
New-Item -Path $extractFolder -ItemType Directory -Force | Out-Null
|
||||||
|
}
|
||||||
|
|
||||||
|
# Modify the extract command to point to the temporary folder
|
||||||
|
$modifiedExtractCommand = $extractCommand -replace '%PACKAGEPATH%', "`"$extractFolder`""
|
||||||
|
WriteLog "$processedPackages/$totalPackages Extracting driver: $driverFilePath using command: $modifiedExtractCommand"
|
||||||
|
|
||||||
|
try {
|
||||||
|
Invoke-Process -FilePath $driverFilePath -ArgumentList $modifiedExtractCommand -Wait $true | Out-Null
|
||||||
|
WriteLog "($processedPackages/$totalPackages) Driver extracted to temporary path: $extractFolder"
|
||||||
|
$extractionSucceeded = $true
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
$failureMessage = "Failed to extract driver package '$packageTitle': $($_.Exception.Message)"
|
||||||
|
WriteLog "($processedPackages/$totalPackages) $failureMessage"
|
||||||
|
Remove-Item -Path $packageXMLPath -Force -ErrorAction SilentlyContinue
|
||||||
|
if ($tempExtractBase -and (Test-Path -Path $tempExtractBase)) {
|
||||||
|
Remove-Item -Path $tempExtractBase -Recurse -Force -ErrorAction SilentlyContinue
|
||||||
|
}
|
||||||
|
throw (New-Object System.Exception($failureMessage, $_.Exception))
|
||||||
|
}
|
||||||
|
|
||||||
|
# --- Post-Extraction Handling (Move from Temp to Final Destination) ---
|
||||||
|
if ($extractionSucceeded) {
|
||||||
|
WriteLog "($processedPackages/$totalPackages) Performing post-extraction move from temp to final destination..."
|
||||||
|
try {
|
||||||
|
# Ensure the *original* final destination folder exists and is empty
|
||||||
|
if (Test-Path -Path $originalExtractFolder) {
|
||||||
|
WriteLog "($processedPackages/$totalPackages) Clearing existing final destination folder: $originalExtractFolder"
|
||||||
|
Get-ChildItem -Path $originalExtractFolder -Recurse | Remove-Item -Recurse -Force -ErrorAction SilentlyContinue
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
WriteLog "($processedPackages/$totalPackages) Creating final destination folder: $originalExtractFolder"
|
||||||
|
New-Item -Path $originalExtractFolder -ItemType Directory -Force | Out-Null
|
||||||
|
}
|
||||||
|
|
||||||
|
# Get all items (files and folders) directly inside the temp extraction folder
|
||||||
|
$extractedItems = Get-ChildItem -Path $extractFolder -ErrorAction Stop
|
||||||
|
|
||||||
|
foreach ($item in $extractedItems) {
|
||||||
|
$itemName = $item.Name
|
||||||
|
$finalDestinationPath = $null
|
||||||
|
|
||||||
|
# Check if it's a directory containing 'Liteon'
|
||||||
|
if ($item.PSIsContainer -and $itemName -like '*Liteon*') {
|
||||||
|
# Rename Liteon folders with a random number suffix
|
||||||
|
$randomNumber = Get-Random -Minimum 1000 -Maximum 9999
|
||||||
|
$finalFolderName = "Liteon_$randomNumber"
|
||||||
|
$finalDestinationPath = Join-Path -Path $originalExtractFolder -ChildPath $finalFolderName
|
||||||
|
WriteLog "($processedPackages/$totalPackages) Moving Liteon folder '$itemName' to '$finalDestinationPath'"
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
# For other files/folders, move them directly
|
||||||
|
$finalDestinationPath = Join-Path -Path $originalExtractFolder -ChildPath $itemName
|
||||||
|
WriteLog "($processedPackages/$totalPackages) Moving item '$itemName' to '$finalDestinationPath'"
|
||||||
|
}
|
||||||
|
|
||||||
|
# Perform the move
|
||||||
|
try {
|
||||||
|
Move-Item -Path $item.FullName -Destination $finalDestinationPath -Force -ErrorAction Stop
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
$failureMessage = "Failed to move extracted item '$($item.FullName)' to '$finalDestinationPath': $($_.Exception.Message)"
|
||||||
|
WriteLog "($processedPackages/$totalPackages) $failureMessage"
|
||||||
|
throw (New-Object System.Exception($failureMessage, $_.Exception))
|
||||||
|
}
|
||||||
|
} # End foreach ($item in $extractedItems)
|
||||||
|
|
||||||
|
if ($extractionSucceeded) {
|
||||||
|
WriteLog "($processedPackages/$totalPackages) All driver contents moved successfully from temp to final destination."
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
WriteLog "($processedPackages/$totalPackages) Some driver contents failed to move. Check logs."
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
WriteLog "($processedPackages/$totalPackages) Error during post-extraction move: $($_.Exception.Message). Files might remain in temp."
|
||||||
|
$extractionSucceeded = $false # Mark as failed for cleanup logic below
|
||||||
|
}
|
||||||
|
finally {
|
||||||
|
# Clean up the base temporary directory regardless of move success/failure
|
||||||
|
if ($tempExtractBase -and (Test-Path -Path $tempExtractBase)) {
|
||||||
|
WriteLog "($processedPackages/$totalPackages) Cleaning up temporary extraction base: $tempExtractBase"
|
||||||
|
Remove-Item -Path $tempExtractBase -Recurse -Force -ErrorAction SilentlyContinue
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# --- Final Cleanup ---
|
||||||
|
# Delete the downloaded .exe only if extraction AND move were successful
|
||||||
|
if ($extractionSucceeded) {
|
||||||
|
WriteLog "($processedPackages/$totalPackages) Deleting driver installation file: $driverFilePath"
|
||||||
|
Remove-Item -Path $driverFilePath -Force -ErrorAction SilentlyContinue
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
WriteLog "($processedPackages/$totalPackages) Keeping driver installation file due to extraction/move failure: $driverFilePath"
|
||||||
|
}
|
||||||
|
# Always delete the package XML
|
||||||
|
WriteLog "($processedPackages/$totalPackages) Deleting package XML file: $packageXMLPath"
|
||||||
|
Remove-Item -Path $packageXMLPath -Force -ErrorAction SilentlyContinue
|
||||||
|
if (-not $extractionSucceeded) {
|
||||||
|
throw (New-Object System.Exception("Failed to extract driver '$packageTitle'. See log for details."))
|
||||||
|
}
|
||||||
|
|
||||||
|
} # End foreach package
|
||||||
|
|
||||||
|
# --- Compress to WIM if requested (after all drivers processed) ---
|
||||||
|
if ($CompressToWim) {
|
||||||
|
$status = "Compressing..."
|
||||||
|
if ($null -ne $ProgressQueue) { Invoke-ProgressUpdate -ProgressQueue $ProgressQueue -Identifier $identifier -Status $status }
|
||||||
|
$wimFileName = "$($sanitizedIdentifier).wim" # Use sanitized identifier for filename
|
||||||
|
$destinationWimPath = Join-Path -Path $makeDriversPath -ChildPath $wimFileName
|
||||||
|
$driverRelativePath = Join-Path -Path $make -ChildPath $wimFileName # Update relative path to the WIM file
|
||||||
|
WriteLog "Compressing '$modelPath' to '$destinationWimPath'..."
|
||||||
|
try {
|
||||||
|
$compressResult = Compress-DriverFolderToWim -SourceFolderPath $modelPath -DestinationWimPath $destinationWimPath -WimName $identifier -WimDescription $identifier -PreserveSource:$PreserveSourceOnCompress -ErrorAction Stop
|
||||||
|
if ($compressResult) {
|
||||||
|
WriteLog "Compression successful for '$identifier'."
|
||||||
|
$status = "Completed & Compressed"
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
WriteLog "Compression failed for '$identifier'. Check verbose/error output from Compress-DriverFolderToWim."
|
||||||
|
$status = "Completed (Compression Failed)"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
WriteLog "Error during compression for '$identifier': $($_.Exception.Message)"
|
||||||
|
$status = "Completed (Compression Error)"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
$status = "Completed"
|
||||||
|
}
|
||||||
|
# --- End Compression ---
|
||||||
|
|
||||||
|
$success = $true # Mark success as download/extract was okay
|
||||||
|
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
$status = "Error: $($_.Exception.Message)"
|
||||||
|
WriteLog "Error saving Lenovo drivers for '$identifier': $($_.Exception.ToString())"
|
||||||
|
$success = $false
|
||||||
|
Remove-DriverModelFolder -DriversFolder $DriversFolder -TargetFolder $modelPath -Description $identifier
|
||||||
|
if ($null -ne $ProgressQueue) { Invoke-ProgressUpdate -ProgressQueue $ProgressQueue -Identifier $identifier -Status $status }
|
||||||
|
return [PSCustomObject]@{ Identifier = $identifier; Status = $status; Success = $success; DriverPath = $null }
|
||||||
|
}
|
||||||
|
finally {
|
||||||
|
# Clean up the main catalog XML and temp folder
|
||||||
|
WriteLog "Cleaning up temporary download folder: $tempDownloadPath"
|
||||||
|
Remove-Item -Path $tempDownloadPath -Recurse -Force -ErrorAction SilentlyContinue
|
||||||
|
}
|
||||||
|
|
||||||
|
# Enqueue the final status (success or error) before returning
|
||||||
|
if ($null -ne $ProgressQueue) { Invoke-ProgressUpdate -ProgressQueue $ProgressQueue -Identifier $identifier -Status $status }
|
||||||
|
|
||||||
|
# Return the final status
|
||||||
|
return [PSCustomObject]@{ Identifier = $identifier; Status = $status; Success = $success; DriverPath = $driverRelativePath }
|
||||||
|
}
|
||||||
|
|
||||||
|
Export-ModuleMember -Function *
|
||||||
@@ -0,0 +1,454 @@
|
|||||||
|
<#
|
||||||
|
.SYNOPSIS
|
||||||
|
Provides functions for discovering, downloading, and processing Microsoft Surface device drivers.
|
||||||
|
.DESCRIPTION
|
||||||
|
This module contains the logic specific to handling Microsoft Surface drivers for the FFU UI. It includes a function to scrape the official Microsoft support website to build a list of available Surface models and their driver download pages. It also provides a robust, parallel-capable function to download the correct driver package (MSI or ZIP) based on the selected Windows release, extract its contents, and optionally compress them into a WIM archive. The download process includes logic to handle MSI installer mutexes to prevent conflicts during parallel execution.
|
||||||
|
#>
|
||||||
|
|
||||||
|
# Function to get the list of Microsoft Surface models
|
||||||
|
function Get-MicrosoftDriversModelList {
|
||||||
|
[CmdletBinding()]
|
||||||
|
param(
|
||||||
|
[hashtable]$Headers, # Pass necessary headers
|
||||||
|
[string]$UserAgent, # Pass UserAgent
|
||||||
|
[Parameter(Mandatory = $true)]
|
||||||
|
[string]$DriversFolder
|
||||||
|
)
|
||||||
|
|
||||||
|
# Keep the UI signature unchanged while using the shared Learn-based source.
|
||||||
|
return @(Get-SurfaceDriverModelIndex -DriversFolder $DriversFolder)
|
||||||
|
}
|
||||||
|
# Function to download and extract drivers for a specific Microsoft model (Modified for ForEach-Object -Parallel)
|
||||||
|
function Save-MicrosoftDriversTask {
|
||||||
|
[CmdletBinding()]
|
||||||
|
param(
|
||||||
|
[Parameter(Mandatory = $true)]
|
||||||
|
[PSCustomObject]$DriverItemData, # Pass data, not the UI object
|
||||||
|
[Parameter(Mandatory = $true)]
|
||||||
|
[string]$DriversFolder,
|
||||||
|
[Parameter(Mandatory = $true)]
|
||||||
|
[int]$WindowsRelease,
|
||||||
|
[Parameter(Mandatory = $true)]
|
||||||
|
[hashtable]$Headers, # Pass necessary headers
|
||||||
|
[Parameter(Mandatory = $true)]
|
||||||
|
[string]$UserAgent, # Pass UserAgent
|
||||||
|
[Parameter()] # Made optional
|
||||||
|
[System.Collections.Concurrent.ConcurrentQueue[hashtable]]$ProgressQueue = $null, # Default to null
|
||||||
|
[Parameter()]
|
||||||
|
[bool]$CompressToWim = $false, # New parameter for compression
|
||||||
|
[Parameter()]
|
||||||
|
[bool]$PreserveSourceOnCompress = $false
|
||||||
|
# REMOVED: UI-related parameters
|
||||||
|
)
|
||||||
|
|
||||||
|
$modelName = $DriverItemData.Model
|
||||||
|
$modelLink = $DriverItemData.Link
|
||||||
|
$make = $DriverItemData.Make
|
||||||
|
$driverRelativePath = Join-Path -Path $make -ChildPath $modelName # Relative path for the driver folder
|
||||||
|
$status = "Getting download link..." # Initial local status
|
||||||
|
$success = $false
|
||||||
|
$sanitizedModelName = ConvertTo-SafeName -Name $modelName
|
||||||
|
if ($sanitizedModelName -ne $modelName) { WriteLog "Sanitized model name: '$modelName' -> '$sanitizedModelName'" }
|
||||||
|
$makeDriversPath = Join-Path -Path $DriversFolder -ChildPath $make
|
||||||
|
$modelPath = Join-Path -Path $makeDriversPath -ChildPath $sanitizedModelName
|
||||||
|
|
||||||
|
# Initial status update
|
||||||
|
if ($null -ne $ProgressQueue) { Invoke-ProgressUpdate -ProgressQueue $ProgressQueue -Identifier $modelName -Status "Checking..." }
|
||||||
|
|
||||||
|
try {
|
||||||
|
# Check for existing drivers
|
||||||
|
$existingDriver = Test-ExistingDriver -Make $make -Model $modelName -DriversFolder $DriversFolder -Identifier $modelName -ProgressQueue $ProgressQueue
|
||||||
|
if ($null -ne $existingDriver) {
|
||||||
|
# Add the 'Model' property to the return object for consistency if it's not there
|
||||||
|
if (-not $existingDriver.PSObject.Properties['Model']) {
|
||||||
|
$existingDriver | Add-Member -MemberType NoteProperty -Name 'Model' -Value $modelName
|
||||||
|
}
|
||||||
|
|
||||||
|
# Special handling for existing folders that need compression
|
||||||
|
if ($CompressToWim -and $existingDriver.Status -eq 'Already downloaded') {
|
||||||
|
$makeDriversPath = Join-Path -Path $DriversFolder -ChildPath $make
|
||||||
|
$wimFilePath = Join-Path -Path $makeDriversPath -ChildPath "$($modelName).wim"
|
||||||
|
$wimRelativePath = Join-Path -Path $make -ChildPath "$($modelName).wim"
|
||||||
|
$sourceFolderPath = Join-Path -Path $makeDriversPath -ChildPath $modelName
|
||||||
|
WriteLog "Attempting compression of existing folder '$sourceFolderPath' to '$wimFilePath'."
|
||||||
|
if ($null -ne $ProgressQueue) { Invoke-ProgressUpdate -ProgressQueue $ProgressQueue -Identifier $modelName -Status "Compressing existing..." }
|
||||||
|
try {
|
||||||
|
$null = Compress-DriverFolderToWim -SourceFolderPath $sourceFolderPath -DestinationWimPath $wimFilePath -WimName $modelName -WimDescription "Drivers for $modelName" -PreserveSource:$PreserveSourceOnCompress -ErrorAction Stop
|
||||||
|
$existingDriver.Status = "Compression successful"
|
||||||
|
$existingDriver.DriverPath = $wimRelativePath
|
||||||
|
$existingDriver.Success = $true
|
||||||
|
WriteLog "Successfully compressed existing drivers for $modelName to $wimFilePath."
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
WriteLog "Error compressing existing drivers for $($modelName): $($_.Exception.Message)"
|
||||||
|
$existingDriver.Status = "Already downloaded (Compression failed)"
|
||||||
|
$existingDriver.Success = $false
|
||||||
|
}
|
||||||
|
if ($null -ne $ProgressQueue) { Invoke-ProgressUpdate -ProgressQueue $ProgressQueue -Identifier $modelName -Status $existingDriver.Status }
|
||||||
|
}
|
||||||
|
|
||||||
|
return $existingDriver
|
||||||
|
}
|
||||||
|
|
||||||
|
### GET THE DOWNLOAD LINK
|
||||||
|
$status = "Getting download link..."
|
||||||
|
if ($null -ne $ProgressQueue) { Invoke-ProgressUpdate -ProgressQueue $ProgressQueue -Identifier $modelName -Status $status }
|
||||||
|
|
||||||
|
# Initialize Win10/Win11 link variables
|
||||||
|
$win10Link = $null
|
||||||
|
$win10FileName = $null
|
||||||
|
$win11Link = $null
|
||||||
|
$win11FileName = $null
|
||||||
|
|
||||||
|
# Prefer cached Download Center details (Source C) to avoid unnecessary internet calls and cache rewrites
|
||||||
|
$useCachedDownloadCenterDetails = $false
|
||||||
|
try {
|
||||||
|
$cache = Import-SurfaceDriverIndexCache -DriversFolder $DriversFolder
|
||||||
|
$cachedDetails = @($cache.DownloadCenterDetails | Where-Object { $_.Link -eq $modelLink } | Select-Object -First 1)
|
||||||
|
if ($cachedDetails.Count -gt 0 -and $cachedDetails[0].Files -and $cachedDetails[0].Files.Count -gt 0) {
|
||||||
|
$useCachedDownloadCenterDetails = $true
|
||||||
|
WriteLog "Surface cache: Using cached Download Center details for $modelName from $modelLink"
|
||||||
|
|
||||||
|
foreach ($downloadFile in @($cachedDetails[0].Files)) {
|
||||||
|
if ($null -eq $downloadFile) { continue }
|
||||||
|
$currentFileName = $downloadFile.Name
|
||||||
|
$fileUrl = $downloadFile.Url
|
||||||
|
if ([string]::IsNullOrWhiteSpace($currentFileName) -or [string]::IsNullOrWhiteSpace($fileUrl)) { continue }
|
||||||
|
|
||||||
|
if ($currentFileName -match "Win10") {
|
||||||
|
$win10Link = $fileUrl
|
||||||
|
$win10FileName = $currentFileName
|
||||||
|
WriteLog "Found Win10 link (cached): $win10FileName"
|
||||||
|
}
|
||||||
|
elseif ($currentFileName -match "Win11") {
|
||||||
|
$win11Link = $fileUrl
|
||||||
|
$win11FileName = $currentFileName
|
||||||
|
WriteLog "Found Win11 link (cached): $win11FileName"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
WriteLog "Surface cache: Failed loading cached Download Center details for '$modelName'. Error: $($_.Exception.Message)"
|
||||||
|
}
|
||||||
|
|
||||||
|
# Cache miss: download and parse the model's Download Center page (Source C), then backfill the cache
|
||||||
|
if (-not $useCachedDownloadCenterDetails) {
|
||||||
|
WriteLog "Getting download page content for $modelName from $modelLink"
|
||||||
|
$OriginalVerbosePreference = $VerbosePreference
|
||||||
|
$VerbosePreference = 'SilentlyContinue'
|
||||||
|
# Use passed-in UserAgent and Headers
|
||||||
|
$downloadPageContent = Invoke-WebRequest -Uri $modelLink -UseBasicParsing -Headers $Headers -UserAgent $UserAgent
|
||||||
|
$VerbosePreference = $OriginalVerbosePreference
|
||||||
|
WriteLog "Complete"
|
||||||
|
|
||||||
|
$status = "Parsing download page..."
|
||||||
|
if ($null -ne $ProgressQueue) { Invoke-ProgressUpdate -ProgressQueue $ProgressQueue -Identifier $modelName -Status $status }
|
||||||
|
WriteLog "Parsing download page for file"
|
||||||
|
$scriptPattern = '<script>window.__DLCDetails__={(.*?)}<\/script>'
|
||||||
|
$scriptMatch = [regex]::Match($downloadPageContent.Content, $scriptPattern)
|
||||||
|
|
||||||
|
if ($scriptMatch.Success) {
|
||||||
|
$scriptContent = $scriptMatch.Groups[1].Value
|
||||||
|
# $downloadFilePattern = '"name":"(.*?)",.*?"url":"(.*?)"'
|
||||||
|
$downloadFilePattern = '"name":"([^"]+\.(?:msi|zip))",[^}]*?"url":"(.*?)"'
|
||||||
|
$downloadFileMatches = [regex]::Matches($scriptContent, $downloadFilePattern, [System.Text.RegularExpressions.RegexOptions]::IgnoreCase)
|
||||||
|
|
||||||
|
# Iterate through all matches to find potential Win10 and Win11 links
|
||||||
|
foreach ($downloadFile in $downloadFileMatches) {
|
||||||
|
$currentFileName = $downloadFile.Groups[1].Value
|
||||||
|
$fileUrl = $downloadFile.Groups[2].Value
|
||||||
|
|
||||||
|
if ($currentFileName -match "Win10") {
|
||||||
|
$win10Link = $fileUrl
|
||||||
|
$win10FileName = $currentFileName
|
||||||
|
WriteLog "Found Win10 link: $win10FileName"
|
||||||
|
}
|
||||||
|
elseif ($currentFileName -match "Win11") {
|
||||||
|
$win11Link = $fileUrl
|
||||||
|
$win11FileName = $currentFileName
|
||||||
|
WriteLog "Found Win11 link: $win11FileName"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# Update local cache with Download Center file details (Source C) for this model.
|
||||||
|
# This runs during download (not during Get Models) so it won't slow the listview population.
|
||||||
|
try {
|
||||||
|
$filesForCache = [System.Collections.Generic.List[pscustomobject]]::new()
|
||||||
|
if ($win10Link -and $win10FileName) {
|
||||||
|
$filesForCache.Add([pscustomobject]@{ Name = $win10FileName; Url = $win10Link })
|
||||||
|
}
|
||||||
|
if ($win11Link -and $win11FileName) {
|
||||||
|
$filesForCache.Add([pscustomobject]@{ Name = $win11FileName; Url = $win11Link })
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($filesForCache.Count -gt 0) {
|
||||||
|
$cache = Import-SurfaceDriverIndexCache -DriversFolder $DriversFolder
|
||||||
|
$detailsEntry = [pscustomobject][ordered]@{
|
||||||
|
Model = $modelName
|
||||||
|
Link = $modelLink
|
||||||
|
Files = @($filesForCache)
|
||||||
|
}
|
||||||
|
|
||||||
|
$newDetails = [System.Collections.Generic.List[pscustomobject]]::new()
|
||||||
|
foreach ($item in @($cache.DownloadCenterDetails)) {
|
||||||
|
if ($null -ne $item -and $item.PSObject.Properties['Link'] -and $item.Link -ne $modelLink) {
|
||||||
|
$newDetails.Add($item)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
$newDetails.Add($detailsEntry)
|
||||||
|
$cache.DownloadCenterDetails = @($newDetails)
|
||||||
|
Save-SurfaceDriverIndexCache -Cache $cache -DriversFolder $DriversFolder
|
||||||
|
}
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
WriteLog "Surface cache: Failed updating Download Center details cache for '$modelName'. Error: $($_.Exception.Message)"
|
||||||
|
}
|
||||||
|
|
||||||
|
$useCachedDownloadCenterDetails = $true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($useCachedDownloadCenterDetails) {
|
||||||
|
# Decision logic to select the appropriate download link
|
||||||
|
$downloadLink = $null
|
||||||
|
$fileName = $null
|
||||||
|
$downloadedVersion = $null # Track which version we are actually downloading
|
||||||
|
|
||||||
|
if ($WindowsRelease -eq 10 -and $win10Link) {
|
||||||
|
$downloadLink = $win10Link
|
||||||
|
$fileName = $win10FileName
|
||||||
|
$downloadedVersion = 10
|
||||||
|
WriteLog "Exact match found for Win10."
|
||||||
|
}
|
||||||
|
elseif ($WindowsRelease -eq 11 -and $win11Link) {
|
||||||
|
$downloadLink = $win11Link
|
||||||
|
$fileName = $win11FileName
|
||||||
|
$downloadedVersion = 11
|
||||||
|
WriteLog "Exact match found for Win11."
|
||||||
|
}
|
||||||
|
elseif (-not $win10Link -and $win11Link) {
|
||||||
|
# Only Win11 available, regardless of $WindowsRelease
|
||||||
|
$downloadLink = $win11Link
|
||||||
|
$fileName = $win11FileName
|
||||||
|
$downloadedVersion = 11
|
||||||
|
WriteLog "Exact match for Win$($WindowsRelease) not found. Falling back to available Win11 driver."
|
||||||
|
}
|
||||||
|
elseif ($win10Link -and -not $win11Link) {
|
||||||
|
# Only Win10 available, regardless of $WindowsRelease
|
||||||
|
$downloadLink = $win10Link
|
||||||
|
$fileName = $win10FileName
|
||||||
|
$downloadedVersion = 10
|
||||||
|
WriteLog "Exact match for Win$($WindowsRelease) not found. Falling back to available Win10 driver."
|
||||||
|
}
|
||||||
|
# If both Win10 and Win11 links exist, but neither matches $WindowsRelease, $downloadLink remains $null.
|
||||||
|
|
||||||
|
### DOWNLOAD AND EXTRACT
|
||||||
|
if ($downloadLink) {
|
||||||
|
WriteLog "Selected Download Link for $modelName (Actual: Windows $downloadedVersion): $downloadLink"
|
||||||
|
$status = "Downloading Win$downloadedVersion $fileName"
|
||||||
|
if ($null -ne $ProgressQueue) { Invoke-ProgressUpdate -ProgressQueue $ProgressQueue -Identifier $modelName -Status $status }
|
||||||
|
|
||||||
|
# Create directories
|
||||||
|
if (-not (Test-Path -Path $DriversFolder)) {
|
||||||
|
WriteLog "Creating Drivers folder: $DriversFolder"
|
||||||
|
New-Item -Path $DriversFolder -ItemType Directory -Force | Out-Null
|
||||||
|
}
|
||||||
|
if (-Not (Test-Path -Path $modelPath)) {
|
||||||
|
WriteLog "Creating model folder: $modelPath"
|
||||||
|
New-Item -Path $modelPath -ItemType Directory -Force | Out-Null
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
WriteLog "Model folder already exists: $modelPath"
|
||||||
|
}
|
||||||
|
|
||||||
|
### DOWNLOAD
|
||||||
|
$filePath = Join-Path -Path $makeDriversPath -ChildPath ($fileName)
|
||||||
|
WriteLog "Downloading $modelName driver file to $filePath"
|
||||||
|
# Use Start-BitsTransferWithRetry
|
||||||
|
Start-BitsTransferWithRetry -Source $downloadLink -Destination $filePath
|
||||||
|
WriteLog "Download complete"
|
||||||
|
|
||||||
|
$fileExtension = [System.IO.Path]::GetExtension($filePath).ToLower()
|
||||||
|
|
||||||
|
### EXTRACT
|
||||||
|
if ($fileExtension -eq ".msi") {
|
||||||
|
$status = "Waiting for MSI lock..."
|
||||||
|
if ($null -ne $ProgressQueue) { Invoke-ProgressUpdate -ProgressQueue $ProgressQueue -Identifier $modelName -Status $status }
|
||||||
|
|
||||||
|
# Use a named mutex to ensure only one MSI extraction happens at a time across all parallel tasks
|
||||||
|
$msiMutexName = "Global\FFUDevelopmentMSIExtractionMutex"
|
||||||
|
$msiMutex = New-Object System.Threading.Mutex($false, $msiMutexName)
|
||||||
|
|
||||||
|
try {
|
||||||
|
WriteLog "Waiting to acquire global MSI extraction lock for '$modelName'..."
|
||||||
|
$msiMutex.WaitOne() | Out-Null
|
||||||
|
WriteLog "Acquired global MSI extraction lock for '$modelName'."
|
||||||
|
|
||||||
|
# Loop indefinitely to wait for system mutex and handle MSIExec exit codes
|
||||||
|
while ($true) {
|
||||||
|
$mutexClear = $false
|
||||||
|
|
||||||
|
# 1. Check System-level MSI Mutex
|
||||||
|
try {
|
||||||
|
$sysMutex = [System.Threading.Mutex]::OpenExisting("Global\_MSIExecute")
|
||||||
|
$sysMutex.Dispose()
|
||||||
|
$status = "Waiting for MSIExec..."
|
||||||
|
if ($null -ne $ProgressQueue) { Invoke-ProgressUpdate -ProgressQueue $ProgressQueue -Identifier $modelName -Status $status }
|
||||||
|
WriteLog "Another MSIExec installer is running (System Mutex Held). Waiting 5 seconds before rechecking for $modelName..."
|
||||||
|
Start-Sleep -Seconds 5
|
||||||
|
continue # Go back to start of while loop to re-check mutex
|
||||||
|
}
|
||||||
|
catch [System.Threading.WaitHandleCannotBeOpenedException] {
|
||||||
|
# Mutex is clear, proceed to extraction attempt
|
||||||
|
WriteLog "System MSI mutex clear. Proceeding with MSI extraction attempt for $modelName."
|
||||||
|
$status = "Extracting Win$downloadedVersion $fileName"
|
||||||
|
if ($null -ne $ProgressQueue) { Invoke-ProgressUpdate -ProgressQueue $ProgressQueue -Identifier $modelName -Status $status }
|
||||||
|
$mutexClear = $true
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
# Handle other potential errors when checking the mutex
|
||||||
|
WriteLog "Warning: Error checking system MSI mutex for $($modelName): $_. Proceeding with caution."
|
||||||
|
$status = "Extracting Win$downloadedVersion $fileName (Mutex Error)"
|
||||||
|
if ($null -ne $ProgressQueue) { Invoke-ProgressUpdate -ProgressQueue $ProgressQueue -Identifier $modelName -Status $status }
|
||||||
|
$mutexClear = $true # Proceed despite mutex error
|
||||||
|
}
|
||||||
|
|
||||||
|
# 2. Attempt Extraction (only if mutex was clear)
|
||||||
|
if ($mutexClear) {
|
||||||
|
WriteLog "Extracting MSI file to $modelPath"
|
||||||
|
$arguments = "/a `"$($filePath)`" /qn TARGETDIR=`"$($modelPath)`""
|
||||||
|
try {
|
||||||
|
# Use Invoke-Process. It will throw an error for any non-zero exit code.
|
||||||
|
Invoke-Process -FilePath "msiexec.exe" -ArgumentList $arguments -Wait $true -ErrorAction Stop | Out-Null
|
||||||
|
|
||||||
|
# If Invoke-Process succeeded (didn't throw), extraction is complete.
|
||||||
|
WriteLog "Extraction complete for $modelName (Exit Code 0)."
|
||||||
|
|
||||||
|
# Verification Step: Ensure the target folder is not empty.
|
||||||
|
$itemsInDest = Get-ChildItem -Path $modelPath -Recurse
|
||||||
|
if ($itemsInDest.Count -eq 0) {
|
||||||
|
WriteLog "VERIFICATION FAILED: MSI extraction for '$modelName' produced an empty folder. Retrying..."
|
||||||
|
$status = "Retrying (Empty Folder)"
|
||||||
|
if ($null -ne $ProgressQueue) { Invoke-ProgressUpdate -ProgressQueue $ProgressQueue -Identifier $modelName -Status $status }
|
||||||
|
Start-Sleep -Seconds 5
|
||||||
|
continue # Retry the whole process
|
||||||
|
}
|
||||||
|
|
||||||
|
WriteLog "VERIFICATION PASSED: Target folder for '$modelName' is not empty."
|
||||||
|
break # Success, exit the while loop
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
# Catch errors thrown by Invoke-Process
|
||||||
|
$errorMessage = $_.Exception.Message
|
||||||
|
if ($errorMessage -match 'Process exited with code 1618') {
|
||||||
|
# Specific handling for MSIExec busy error (1618)
|
||||||
|
WriteLog "MSIExec collision detected (Exit Code 1618) for $modelName. Retrying after wait..."
|
||||||
|
$status = "Waiting (MSI Collision)..."
|
||||||
|
if ($null -ne $ProgressQueue) { Invoke-ProgressUpdate -ProgressQueue $ProgressQueue -Identifier $modelName -Status $status }
|
||||||
|
Start-Sleep -Seconds 5 # Wait before retrying
|
||||||
|
continue # Go back to start of while loop to re-check mutex/retry
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
# Handle other errors from Invoke-Process (e.g., file not found, permissions, other exit codes)
|
||||||
|
WriteLog "Error during MSI extraction process for $($modelName): $errorMessage"
|
||||||
|
throw # Re-throw the original exception to be caught by the outer try/catch
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} # End if ($mutexClear)
|
||||||
|
} # End while ($true)
|
||||||
|
}
|
||||||
|
finally {
|
||||||
|
if ($null -ne $msiMutex) {
|
||||||
|
$msiMutex.ReleaseMutex()
|
||||||
|
$msiMutex.Dispose()
|
||||||
|
WriteLog "Released global MSI extraction lock for '$modelName'."
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
elseif ($fileExtension -eq ".zip") {
|
||||||
|
$status = "Extracting Win$downloadedVersion $fileName"
|
||||||
|
if ($null -ne $ProgressQueue) { Invoke-ProgressUpdate -ProgressQueue $ProgressQueue -Identifier $modelName -Status $status }
|
||||||
|
WriteLog "Extracting ZIP file to $modelPath"
|
||||||
|
$ProgressPreference = 'SilentlyContinue'
|
||||||
|
Expand-Archive -Path $filePath -DestinationPath $modelPath -Force
|
||||||
|
$ProgressPreference = 'Continue'
|
||||||
|
WriteLog "Extraction complete"
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
WriteLog "Unsupported file type: $fileExtension"
|
||||||
|
throw "Unsupported file type: $fileExtension"
|
||||||
|
}
|
||||||
|
# Remove downloaded file
|
||||||
|
$status = "Cleaning up..."
|
||||||
|
if ($null -ne $ProgressQueue) { Invoke-ProgressUpdate -ProgressQueue $ProgressQueue -Identifier $modelName -Status $status }
|
||||||
|
WriteLog "Removing $filePath"
|
||||||
|
Remove-Item -Path $filePath -Force
|
||||||
|
WriteLog "Cleanup complete." # Changed log message slightly
|
||||||
|
|
||||||
|
# --- Compress to WIM if requested ---
|
||||||
|
if ($CompressToWim) {
|
||||||
|
$status = "Compressing..."
|
||||||
|
if ($null -ne $ProgressQueue) { Invoke-ProgressUpdate -ProgressQueue $ProgressQueue -Identifier $modelName -Status $status }
|
||||||
|
$wimFileName = "$($modelName).wim"
|
||||||
|
# Corrected WIM path: WIM file should be next to the model folder, not inside it.
|
||||||
|
$destinationWimPath = Join-Path -Path $makeDriversPath -ChildPath $wimFileName
|
||||||
|
$driverRelativePath = Join-Path -Path $make -ChildPath $wimFileName # Update relative path to the WIM file
|
||||||
|
WriteLog "Compressing '$modelPath' to '$destinationWimPath'..."
|
||||||
|
try {
|
||||||
|
# Use the function from the imported common module
|
||||||
|
$compressResult = Compress-DriverFolderToWim -SourceFolderPath $modelPath -DestinationWimPath $destinationWimPath -WimName $modelName -WimDescription $modelName -PreserveSource:$PreserveSourceOnCompress -ErrorAction Stop
|
||||||
|
if ($compressResult) {
|
||||||
|
WriteLog "Compression successful for '$modelName'."
|
||||||
|
$status = "Completed & Compressed"
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
WriteLog "Compression failed for '$modelName'. Check verbose/error output from Compress-DriverFolderToWim."
|
||||||
|
$status = "Completed (Compression Failed)"
|
||||||
|
# Don't mark overall success as false, download/extract succeeded
|
||||||
|
}
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
WriteLog "Error during compression for '$modelName': $($_.Exception.Message)"
|
||||||
|
$status = "Completed (Compression Error)"
|
||||||
|
# Don't mark overall success as false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
$status = "Completed" # Final status if not compressing
|
||||||
|
}
|
||||||
|
# --- End Compression ---
|
||||||
|
|
||||||
|
$success = $true # Mark success as download/extract was okay
|
||||||
|
} # End if/elseif for .msi/.zip
|
||||||
|
else {
|
||||||
|
WriteLog "No suitable download link found for Windows $WindowsRelease (or fallback) for model $modelName."
|
||||||
|
$status = "Error: No Win$($WindowsRelease)/Fallback link"
|
||||||
|
$success = $false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
WriteLog "Failed to parse the download page for the driver file for model $modelName."
|
||||||
|
$status = "Error: Parse failed"
|
||||||
|
$success = $false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
$status = "Error: $($_.Exception.Message.Split('.')[0])" # Shorten error message
|
||||||
|
WriteLog "Error saving Microsoft drivers for $($modelName): $($_.Exception.Message)"
|
||||||
|
$success = $false
|
||||||
|
Remove-DriverModelFolder -DriversFolder $DriversFolder -TargetFolder $modelPath -Description $modelName
|
||||||
|
# Enqueue the error status before returning
|
||||||
|
if ($null -ne $ProgressQueue) { Invoke-ProgressUpdate -ProgressQueue $ProgressQueue -Identifier $modelName -Status $status }
|
||||||
|
# Ensure return object is created even on error
|
||||||
|
return [PSCustomObject]@{ Model = $modelName; Status = $status; Success = $success; DriverPath = $null }
|
||||||
|
}
|
||||||
|
|
||||||
|
# Enqueue the final status (success or error) before returning
|
||||||
|
if ($null -ne $ProgressQueue) { Invoke-ProgressUpdate -ProgressQueue $ProgressQueue -Identifier $modelName -Status $status }
|
||||||
|
|
||||||
|
# Return the final status (this is still used by Receive-Job for final confirmation)
|
||||||
|
return [PSCustomObject]@{ Model = $modelName; Status = $status; Success = $success; DriverPath = $driverRelativePath }
|
||||||
|
}
|
||||||
|
|
||||||
|
Export-ModuleMember -Function *
|
||||||
@@ -0,0 +1,998 @@
|
|||||||
|
<#
|
||||||
|
.SYNOPSIS
|
||||||
|
Initializes the user interface for the BuildFFUVM_UI application.
|
||||||
|
|
||||||
|
.DESCRIPTION
|
||||||
|
This script module contains functions responsible for initializing the WPF user interface.
|
||||||
|
It handles several key tasks:
|
||||||
|
- Caching references to all UI controls for efficient access.
|
||||||
|
- Populating UI elements like combo boxes with data (e.g., Hyper-V switches).
|
||||||
|
- Setting default values for all controls based on configuration or predefined settings.
|
||||||
|
- Dynamically creating and configuring complex UI components, such as sortable/selectable GridView columns and feature selection grids.
|
||||||
|
|
||||||
|
This module is critical for setting up the initial state of the application window when it first loads.
|
||||||
|
#>
|
||||||
|
|
||||||
|
function Initialize-FluentTheme {
|
||||||
|
param(
|
||||||
|
[Parameter(Mandatory = $true)]
|
||||||
|
[System.Windows.Window]$Window,
|
||||||
|
[Parameter(Mandatory = $false)]
|
||||||
|
[string]$ThemeMode = "System",
|
||||||
|
[Parameter(Mandatory = $false)]
|
||||||
|
[PSCustomObject]$State
|
||||||
|
)
|
||||||
|
|
||||||
|
# Check if the current .NET runtime supports Window.ThemeMode (requires .NET 9+ / PowerShell 7.5+)
|
||||||
|
$themeModeProperty = [System.Windows.Window].GetProperty("ThemeMode")
|
||||||
|
if ($null -eq $themeModeProperty) {
|
||||||
|
WriteLog "Fluent theme not available. Window.ThemeMode requires PowerShell 7.5+ (.NET 9+). Using default Aero2 theme."
|
||||||
|
if ($null -ne $State) {
|
||||||
|
$State.Flags.isFluentSupported = $false
|
||||||
|
}
|
||||||
|
# Still create tooltip styles for non-Fluent mode so Tag-to-ToolTip binding works
|
||||||
|
$controlTypes = @(
|
||||||
|
[System.Windows.Controls.TextBox],
|
||||||
|
[System.Windows.Controls.TextBlock],
|
||||||
|
[System.Windows.Controls.CheckBox]
|
||||||
|
)
|
||||||
|
foreach ($controlType in $controlTypes) {
|
||||||
|
$newStyle = New-Object System.Windows.Style($controlType)
|
||||||
|
$toolTipBinding = New-Object System.Windows.Data.Binding("Tag")
|
||||||
|
$toolTipBinding.RelativeSource = [System.Windows.Data.RelativeSource]::new([System.Windows.Data.RelativeSourceMode]::Self)
|
||||||
|
$toolTipSetter = New-Object System.Windows.Setter([System.Windows.FrameworkElement]::ToolTipProperty, $toolTipBinding)
|
||||||
|
$newStyle.Setters.Add($toolTipSetter)
|
||||||
|
if ($Window.Resources.Contains($controlType)) {
|
||||||
|
$Window.Resources.Remove($controlType)
|
||||||
|
}
|
||||||
|
$Window.Resources.Add($controlType, $newStyle)
|
||||||
|
}
|
||||||
|
WriteLog "Tooltip styles created for non-Fluent mode."
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
# Mark Fluent as supported in state
|
||||||
|
if ($null -ne $State) {
|
||||||
|
$State.Flags.isFluentSupported = $true
|
||||||
|
}
|
||||||
|
|
||||||
|
# Resolve the ThemeMode enum value using reflection to avoid compile-time experimental attribute issues
|
||||||
|
$themeModeType = [System.Windows.Window].GetProperty("ThemeMode").PropertyType
|
||||||
|
$themeModeValue = $null
|
||||||
|
switch ($ThemeMode) {
|
||||||
|
"Light" { $themeModeValue = $themeModeType::Light }
|
||||||
|
"Dark" { $themeModeValue = $themeModeType::Dark }
|
||||||
|
"System" { $themeModeValue = $themeModeType::System }
|
||||||
|
default { $themeModeValue = $themeModeType::System }
|
||||||
|
}
|
||||||
|
|
||||||
|
# Apply the Fluent theme mode to the window
|
||||||
|
$themeModeProperty.SetValue($Window, $themeModeValue)
|
||||||
|
WriteLog "Applied Fluent theme: $ThemeMode"
|
||||||
|
|
||||||
|
# Re-create implicit tooltip styles with BasedOn pointing to the Fluent base style
|
||||||
|
# This preserves the Tag-to-ToolTip binding while inheriting Fluent visual styling
|
||||||
|
$controlTypes = @(
|
||||||
|
[System.Windows.Controls.TextBox],
|
||||||
|
[System.Windows.Controls.TextBlock],
|
||||||
|
[System.Windows.Controls.CheckBox]
|
||||||
|
)
|
||||||
|
|
||||||
|
foreach ($controlType in $controlTypes) {
|
||||||
|
# Get the Fluent base style that was loaded by ThemeMode
|
||||||
|
$fluentBaseStyle = $Window.TryFindResource($controlType)
|
||||||
|
|
||||||
|
# Create a new implicit style with ToolTip binding
|
||||||
|
$newStyle = New-Object System.Windows.Style($controlType)
|
||||||
|
if ($null -ne $fluentBaseStyle) {
|
||||||
|
$newStyle.BasedOn = $fluentBaseStyle
|
||||||
|
}
|
||||||
|
|
||||||
|
# Add the ToolTip setter that binds to the Tag property
|
||||||
|
$toolTipBinding = New-Object System.Windows.Data.Binding("Tag")
|
||||||
|
$toolTipBinding.RelativeSource = [System.Windows.Data.RelativeSource]::new([System.Windows.Data.RelativeSourceMode]::Self)
|
||||||
|
$toolTipSetter = New-Object System.Windows.Setter([System.Windows.FrameworkElement]::ToolTipProperty, $toolTipBinding)
|
||||||
|
$newStyle.Setters.Add($toolTipSetter)
|
||||||
|
|
||||||
|
# Remove any existing implicit style for this type before adding the new one
|
||||||
|
if ($Window.Resources.Contains($controlType)) {
|
||||||
|
$Window.Resources.Remove($controlType)
|
||||||
|
}
|
||||||
|
$Window.Resources.Add($controlType, $newStyle)
|
||||||
|
}
|
||||||
|
|
||||||
|
WriteLog "Tooltip styles updated with Fluent base styles."
|
||||||
|
}
|
||||||
|
|
||||||
|
function Initialize-UIControls {
|
||||||
|
param([PSCustomObject]$State)
|
||||||
|
WriteLog "Initializing UI control references..."
|
||||||
|
$window = $State.Window
|
||||||
|
# Find all controls ONCE and store them in the state object
|
||||||
|
$State.Controls.cmbWindowsRelease = $window.FindName('cmbWindowsRelease')
|
||||||
|
$State.Controls.cmbWindowsVersion = $window.FindName('cmbWindowsVersion')
|
||||||
|
$State.Controls.txtISOPath = $window.FindName('txtISOPath')
|
||||||
|
$State.Controls.rbDownloadESD = $window.FindName('rbDownloadESD')
|
||||||
|
$State.Controls.rbProvideISO = $window.FindName('rbProvideISO')
|
||||||
|
$State.Controls.isoPathPanel = $window.FindName('isoPathPanel')
|
||||||
|
$State.Controls.btnBrowseISO = $window.FindName('btnBrowseISO')
|
||||||
|
$State.Controls.cmbWindowsArch = $window.FindName('cmbWindowsArch')
|
||||||
|
$State.Controls.cmbWindowsLang = $window.FindName('cmbWindowsLang')
|
||||||
|
$State.Controls.WindowsLangStackPanel = $window.FindName('WindowsLangStackPanel')
|
||||||
|
$State.Controls.cmbWindowsSKU = $window.FindName('cmbWindowsSKU')
|
||||||
|
$State.Controls.cmbMediaType = $window.FindName('cmbMediaType')
|
||||||
|
$State.Controls.MediaTypeStackPanel = $window.FindName('MediaTypeStackPanel')
|
||||||
|
$State.Controls.featuresPanel = $window.FindName('stackFeaturesContainer')
|
||||||
|
$State.Controls.chkDownloadDrivers = $window.FindName('chkDownloadDrivers')
|
||||||
|
$State.Controls.cmbMake = $window.FindName('cmbMake')
|
||||||
|
$State.Controls.spMakeSection = $window.FindName('spMakeSection')
|
||||||
|
$State.Controls.btnGetModels = $window.FindName('btnGetModels')
|
||||||
|
$State.Controls.spModelFilterSection = $window.FindName('spModelFilterSection')
|
||||||
|
$State.Controls.txtModelFilter = $window.FindName('txtModelFilter')
|
||||||
|
$State.Controls.lstDriverModels = $window.FindName('lstDriverModels')
|
||||||
|
$State.Controls.spDriverActionButtons = $window.FindName('spDriverActionButtons')
|
||||||
|
$State.Controls.btnSaveDriversJson = $window.FindName('btnSaveDriversJson')
|
||||||
|
$State.Controls.btnImportDriversJson = $window.FindName('btnImportDriversJson')
|
||||||
|
$State.Controls.btnDownloadSelectedDrivers = $window.FindName('btnDownloadSelectedDrivers')
|
||||||
|
$State.Controls.btnClearDriverList = $window.FindName('btnClearDriverList')
|
||||||
|
$State.Controls.chkInstallOffice = $window.FindName('chkInstallOffice')
|
||||||
|
$State.Controls.chkInstallApps = $window.FindName('chkInstallApps')
|
||||||
|
$State.Controls.OfficePathStackPanel = $window.FindName('OfficePathStackPanel')
|
||||||
|
$State.Controls.OfficePathGrid = $window.FindName('OfficePathGrid')
|
||||||
|
$State.Controls.CopyOfficeConfigXMLStackPanel = $window.FindName('CopyOfficeConfigXMLStackPanel')
|
||||||
|
$State.Controls.OfficeConfigurationXMLFileStackPanel = $window.FindName('OfficeConfigurationXMLFileStackPanel')
|
||||||
|
$State.Controls.OfficeConfigurationXMLFileGrid = $window.FindName('OfficeConfigurationXMLFileGrid')
|
||||||
|
$State.Controls.chkCopyOfficeConfigXML = $window.FindName('chkCopyOfficeConfigXML')
|
||||||
|
$State.Controls.chkLatestCU = $window.FindName('chkUpdateLatestCU')
|
||||||
|
$State.Controls.chkPreviewCU = $window.FindName('chkUpdatePreviewCU')
|
||||||
|
$State.Controls.btnCheckUSBDrives = $window.FindName('btnCheckUSBDrives')
|
||||||
|
$State.Controls.lstUSBDrives = $window.FindName('lstUSBDrives')
|
||||||
|
$State.Controls.chkBuildUSBDriveEnable = $window.FindName('chkBuildUSBDriveEnable')
|
||||||
|
$State.Controls.usbSection = $window.FindName('usbDriveSection')
|
||||||
|
$State.Controls.chkSelectSpecificUSBDrives = $window.FindName('chkSelectSpecificUSBDrives')
|
||||||
|
$State.Controls.usbSelectionPanel = $window.FindName('usbDriveSelectionPanel')
|
||||||
|
$State.Controls.chkAllowExternalHardDiskMedia = $window.FindName('chkAllowExternalHardDiskMedia')
|
||||||
|
$State.Controls.chkPromptExternalHardDiskMedia = $window.FindName('chkPromptExternalHardDiskMedia')
|
||||||
|
$State.Controls.chkCopyAdditionalFFUFiles = $window.FindName('chkCopyAdditionalFFUFiles')
|
||||||
|
$State.Controls.additionalFFUPanel = $window.FindName('additionalFFUPanel')
|
||||||
|
$State.Controls.lstAdditionalFFUs = $window.FindName('lstAdditionalFFUs')
|
||||||
|
$State.Controls.btnRefreshAdditionalFFUs = $window.FindName('btnRefreshAdditionalFFUs')
|
||||||
|
$State.Controls.chkInstallWingetApps = $window.FindName('chkInstallWingetApps')
|
||||||
|
$State.Controls.wingetPanel = $window.FindName('wingetPanel')
|
||||||
|
$State.Controls.btnCheckWingetModule = $window.FindName('btnCheckWingetModule')
|
||||||
|
$State.Controls.txtWingetVersion = $window.FindName('txtWingetVersion')
|
||||||
|
$State.Controls.txtWingetModuleVersion = $window.FindName('txtWingetModuleVersion')
|
||||||
|
$State.Controls.applicationPathPanel = $window.FindName('applicationPathPanel')
|
||||||
|
$State.Controls.appListJsonPathPanel = $window.FindName('appListJsonPathPanel')
|
||||||
|
$State.Controls.userAppListPathPanel = $window.FindName('userAppListPathPanel')
|
||||||
|
$State.Controls.btnBrowseApplicationPath = $window.FindName('btnBrowseApplicationPath')
|
||||||
|
$State.Controls.btnBrowseAppListJsonPath = $window.FindName('btnBrowseAppListJsonPath')
|
||||||
|
$State.Controls.btnBrowseUserAppListPath = $window.FindName('btnBrowseUserAppListPath')
|
||||||
|
$State.Controls.chkBringYourOwnApps = $window.FindName('chkBringYourOwnApps')
|
||||||
|
$State.Controls.byoApplicationPanel = $window.FindName('byoApplicationPanel')
|
||||||
|
$State.Controls.wingetSearchPanel = $window.FindName('wingetSearchPanel')
|
||||||
|
$State.Controls.txtWingetSearch = $window.FindName('txtWingetSearch')
|
||||||
|
$State.Controls.btnWingetSearch = $window.FindName('btnWingetSearch')
|
||||||
|
$State.Controls.lstWingetResults = $window.FindName('lstWingetResults')
|
||||||
|
$State.Controls.btnSaveWingetList = $window.FindName('btnSaveWingetList')
|
||||||
|
$State.Controls.btnImportWingetList = $window.FindName('btnImportWingetList')
|
||||||
|
$State.Controls.btnClearWingetList = $window.FindName('btnClearWingetList')
|
||||||
|
$State.Controls.btnDownloadSelected = $window.FindName('btnDownloadSelected')
|
||||||
|
$State.Controls.btnBrowseAppSource = $window.FindName('btnBrowseAppSource')
|
||||||
|
$State.Controls.btnBrowseFFUDevPath = $window.FindName('btnBrowseFFUDevPath')
|
||||||
|
$State.Controls.btnBrowseFFUCaptureLocation = $window.FindName('btnBrowseFFUCaptureLocation')
|
||||||
|
$State.Controls.btnBrowseOfficePath = $window.FindName('btnBrowseOfficePath')
|
||||||
|
$State.Controls.btnBrowseDriversFolder = $window.FindName('btnBrowseDriversFolder')
|
||||||
|
$State.Controls.btnBrowsePEDriversFolder = $window.FindName('btnBrowsePEDriversFolder')
|
||||||
|
$State.Controls.txtAppName = $window.FindName('txtAppName')
|
||||||
|
$State.Controls.txtAppCommandLine = $window.FindName('txtAppCommandLine')
|
||||||
|
$State.Controls.txtAppArguments = $window.FindName('txtAppArguments')
|
||||||
|
$State.Controls.txtAppSource = $window.FindName('txtAppSource')
|
||||||
|
$State.Controls.txtAppAdditionalExitCodes = $window.FindName('txtAppAdditionalExitCodes')
|
||||||
|
$State.Controls.chkIgnoreExitCodes = $window.FindName('chkIgnoreExitCodes')
|
||||||
|
$State.Controls.btnAddApplication = $window.FindName('btnAddApplication')
|
||||||
|
$State.Controls.btnSaveBYOApplications = $window.FindName('btnSaveBYOApplications')
|
||||||
|
$State.Controls.btnLoadBYOApplications = $window.FindName('btnLoadBYOApplications')
|
||||||
|
$State.Controls.btnEditApplication = $window.FindName('btnEditApplication')
|
||||||
|
$State.Controls.btnClearBYOApplications = $window.FindName('btnClearBYOApplications')
|
||||||
|
$State.Controls.btnRemoveSelectedBYOApps = $window.FindName('btnRemoveSelectedBYOApps')
|
||||||
|
$State.Controls.btnCopyBYOApps = $window.FindName('btnCopyBYOApps')
|
||||||
|
$State.Controls.lstApplications = $window.FindName('lstApplications')
|
||||||
|
$State.Controls.btnMoveTop = $window.FindName('btnMoveTop')
|
||||||
|
$State.Controls.btnMoveUp = $window.FindName('btnMoveUp')
|
||||||
|
$State.Controls.btnMoveDown = $window.FindName('btnMoveDown')
|
||||||
|
$State.Controls.btnMoveBottom = $window.FindName('btnMoveBottom')
|
||||||
|
$State.Controls.txtStatus = $window.FindName('txtStatus')
|
||||||
|
$State.Controls.pbOverallProgress = $window.FindName('progressBar')
|
||||||
|
$State.Controls.txtOverallStatus = $window.FindName('txtStatus')
|
||||||
|
$State.Controls.chkEnableVMNetworking = $window.FindName('chkEnableVMNetworking')
|
||||||
|
$State.Controls.spVMNetworkingSettings = $window.FindName('spVMNetworkingSettings')
|
||||||
|
$State.Controls.cmbVMSwitchName = $window.FindName('cmbVMSwitchName')
|
||||||
|
$State.Controls.txtCustomVMSwitchName = $window.FindName('txtCustomVMSwitchName')
|
||||||
|
$State.Controls.txtFFUDevPath = $window.FindName('txtFFUDevPath')
|
||||||
|
$State.Controls.txtCustomFFUNameTemplate = $window.FindName('txtCustomFFUNameTemplate')
|
||||||
|
$State.Controls.txtFFUCaptureLocation = $window.FindName('txtFFUCaptureLocation')
|
||||||
|
$State.Controls.txtThreads = $window.FindName('txtThreads')
|
||||||
|
$State.Controls.cmbBitsPriority = $window.FindName('cmbBitsPriority')
|
||||||
|
$State.Controls.txtMaxUSBDrives = $window.FindName('txtMaxUSBDrives')
|
||||||
|
$State.Controls.chkCompactOS = $window.FindName('chkCompactOS')
|
||||||
|
$State.Controls.chkOptimize = $window.FindName('chkOptimize')
|
||||||
|
$State.Controls.chkAllowVHDXCaching = $window.FindName('chkAllowVHDXCaching')
|
||||||
|
$State.Controls.chkCreateDeploymentMedia = $window.FindName('chkCreateDeploymentMedia')
|
||||||
|
$State.Controls.chkInjectUnattend = $window.FindName('chkInjectUnattend')
|
||||||
|
$State.Controls.txtUnattendX64FilePath = $window.FindName('txtUnattendX64FilePath')
|
||||||
|
$State.Controls.btnBrowseUnattendX64FilePath = $window.FindName('btnBrowseUnattendX64FilePath')
|
||||||
|
$State.Controls.txtUnattendArm64FilePath = $window.FindName('txtUnattendArm64FilePath')
|
||||||
|
$State.Controls.btnBrowseUnattendArm64FilePath = $window.FindName('btnBrowseUnattendArm64FilePath')
|
||||||
|
$State.Controls.rbDeviceNamingNone = $window.FindName('rbDeviceNamingNone')
|
||||||
|
$State.Controls.rbDeviceNamingPrompt = $window.FindName('rbDeviceNamingPrompt')
|
||||||
|
$State.Controls.rbDeviceNamingTemplate = $window.FindName('rbDeviceNamingTemplate')
|
||||||
|
$State.Controls.rbDeviceNamingPrefixes = $window.FindName('rbDeviceNamingPrefixes')
|
||||||
|
$State.Controls.rbDeviceNamingSerialComputerNames = $window.FindName('rbDeviceNamingSerialComputerNames')
|
||||||
|
$State.Controls.deviceNameTemplatePanel = $window.FindName('deviceNameTemplatePanel')
|
||||||
|
$State.Controls.deviceNamePrefixesPanel = $window.FindName('deviceNamePrefixesPanel')
|
||||||
|
$State.Controls.deviceNameSerialComputerNamesPanel = $window.FindName('deviceNameSerialComputerNamesPanel')
|
||||||
|
$State.Controls.txtDeviceNameTemplate = $window.FindName('txtDeviceNameTemplate')
|
||||||
|
$State.Controls.txtDeviceNamePrefixesPath = $window.FindName('txtDeviceNamePrefixesPath')
|
||||||
|
$State.Controls.btnBrowseDeviceNamePrefixesPath = $window.FindName('btnBrowseDeviceNamePrefixesPath')
|
||||||
|
$State.Controls.txtDeviceNamePrefixes = $window.FindName('txtDeviceNamePrefixes')
|
||||||
|
$State.Controls.btnSaveDeviceNamePrefixes = $window.FindName('btnSaveDeviceNamePrefixes')
|
||||||
|
$State.Controls.txtDeviceNameSerialComputerNamesPath = $window.FindName('txtDeviceNameSerialComputerNamesPath')
|
||||||
|
$State.Controls.btnBrowseDeviceNameSerialComputerNamesPath = $window.FindName('btnBrowseDeviceNameSerialComputerNamesPath')
|
||||||
|
$State.Controls.txtDeviceNameSerialComputerNames = $window.FindName('txtDeviceNameSerialComputerNames')
|
||||||
|
$State.Controls.btnSaveDeviceNameSerialComputerNames = $window.FindName('btnSaveDeviceNameSerialComputerNames')
|
||||||
|
$State.Controls.chkVerbose = $window.FindName('chkVerbose')
|
||||||
|
$State.Controls.chkCopyAutopilot = $window.FindName('chkCopyAutopilot')
|
||||||
|
$State.Controls.chkCopyUnattend = $window.FindName('chkCopyUnattend')
|
||||||
|
$State.Controls.chkCopyPPKG = $window.FindName('chkCopyPPKG')
|
||||||
|
$State.Controls.chkCleanupAppsISO = $window.FindName('chkCleanupAppsISO')
|
||||||
|
$State.Controls.chkCleanupDeployISO = $window.FindName('chkCleanupDeployISO')
|
||||||
|
$State.Controls.chkCleanupDrivers = $window.FindName('chkCleanupDrivers')
|
||||||
|
$State.Controls.chkRemoveFFU = $window.FindName('chkRemoveFFU')
|
||||||
|
$State.Controls.chkRemoveDownloadedESD = $window.FindName('chkRemoveDownloadedESD')
|
||||||
|
$State.Controls.txtDiskSize = $window.FindName('txtDiskSize')
|
||||||
|
$State.Controls.txtMemory = $window.FindName('txtMemory')
|
||||||
|
$State.Controls.txtProcessors = $window.FindName('txtProcessors')
|
||||||
|
$State.Controls.txtVMLocation = $window.FindName('txtVMLocation')
|
||||||
|
$State.Controls.txtVMNamePrefix = $window.FindName('txtVMNamePrefix')
|
||||||
|
$State.Controls.cmbLogicalSectorSize = $window.FindName('cmbLogicalSectorSize')
|
||||||
|
$State.Controls.txtProductKey = $window.FindName('txtProductKey')
|
||||||
|
$State.Controls.txtOfficePath = $window.FindName('txtOfficePath')
|
||||||
|
$State.Controls.txtOfficeConfigXMLFilePath = $window.FindName('txtOfficeConfigXMLFilePath')
|
||||||
|
$State.Controls.btnBrowseOfficeConfigXMLFile = $window.FindName('btnBrowseOfficeConfigXMLFile')
|
||||||
|
$State.Controls.txtDriversFolder = $window.FindName('txtDriversFolder')
|
||||||
|
$State.Controls.txtPEDriversFolder = $window.FindName('txtPEDriversFolder')
|
||||||
|
$State.Controls.chkCopyPEDrivers = $window.FindName('chkCopyPEDrivers')
|
||||||
|
$State.Controls.chkUseDriversAsPEDrivers = $window.FindName('chkUseDriversAsPEDrivers')
|
||||||
|
$State.Controls.chkUpdateLatestCU = $window.FindName('chkUpdateLatestCU')
|
||||||
|
$State.Controls.chkUpdateLatestNet = $window.FindName('chkUpdateLatestNet')
|
||||||
|
$State.Controls.chkUpdateLatestDefender = $window.FindName('chkUpdateLatestDefender')
|
||||||
|
$State.Controls.chkUpdateEdge = $window.FindName('chkUpdateEdge')
|
||||||
|
$State.Controls.chkUpdateOneDrive = $window.FindName('chkUpdateOneDrive')
|
||||||
|
$State.Controls.chkUpdateLatestMSRT = $window.FindName('chkUpdateLatestMSRT')
|
||||||
|
$State.Controls.chkUpdatePreviewCU = $window.FindName('chkUpdatePreviewCU')
|
||||||
|
$State.Controls.txtApplicationPath = $window.FindName('txtApplicationPath')
|
||||||
|
$State.Controls.txtAppListJsonPath = $window.FindName('txtAppListJsonPath')
|
||||||
|
$State.Controls.txtUserAppListPath = $window.FindName('txtUserAppListPath')
|
||||||
|
$State.Controls.chkInstallDrivers = $window.FindName('chkInstallDrivers')
|
||||||
|
$State.Controls.chkCopyDrivers = $window.FindName('chkCopyDrivers')
|
||||||
|
$State.Controls.chkCompressDriversToWIM = $window.FindName('chkCompressDriversToWIM')
|
||||||
|
$State.Controls.chkRemoveApps = $window.FindName('chkRemoveApps')
|
||||||
|
$State.Controls.chkRemoveUpdates = $window.FindName('chkRemoveUpdates')
|
||||||
|
$State.Controls.chkUpdateLatestMicrocode = $window.FindName('chkUpdateLatestMicrocode')
|
||||||
|
$State.Controls.chkDefineAppsScriptVariables = $window.FindName('chkDefineAppsScriptVariables')
|
||||||
|
$State.Controls.appsScriptVariablesPanel = $window.FindName('appsScriptVariablesPanel')
|
||||||
|
$State.Controls.txtAppsScriptKey = $window.FindName('txtAppsScriptKey')
|
||||||
|
$State.Controls.txtAppsScriptValue = $window.FindName('txtAppsScriptValue')
|
||||||
|
$State.Controls.btnAddAppsScriptVariable = $window.FindName('btnAddAppsScriptVariable')
|
||||||
|
$State.Controls.lstAppsScriptVariables = $window.FindName('lstAppsScriptVariables')
|
||||||
|
$State.Controls.btnRemoveSelectedAppsScriptVariables = $window.FindName('btnRemoveSelectedAppsScriptVariables')
|
||||||
|
$State.Controls.btnClearAppsScriptVariables = $window.FindName('btnClearAppsScriptVariables')
|
||||||
|
$State.Controls.txtDriversJsonPath = $window.FindName('txtDriversJsonPath')
|
||||||
|
$State.Controls.btnBrowseDriversJsonPath = $window.FindName('btnBrowseDriversJsonPath')
|
||||||
|
$State.Controls.chkUpdateADK = $window.FindName('chkUpdateADK')
|
||||||
|
$State.Controls.btnLoadConfig = $window.FindName('btnLoadConfig')
|
||||||
|
$State.Controls.btnRestoreDefaults = $window.FindName('btnRestoreDefaults')
|
||||||
|
$State.Controls.btnBuildConfig = $window.FindName('btnBuildConfig')
|
||||||
|
|
||||||
|
# Home page
|
||||||
|
$State.Controls.txtHomeCurrentBuildValue = $window.FindName('txtHomeCurrentBuildValue')
|
||||||
|
$State.Controls.txtHomeLatestReleaseValue = $window.FindName('txtHomeLatestReleaseValue')
|
||||||
|
$State.Controls.txtHomeReleaseStatusValue = $window.FindName('txtHomeReleaseStatusValue')
|
||||||
|
$State.Controls.spHomeReleaseNotesSections = $window.FindName('spHomeReleaseNotesSections')
|
||||||
|
$State.Controls.ellipseHomeDiskSpaceStatus = $window.FindName('ellipseHomeDiskSpaceStatus')
|
||||||
|
$State.Controls.txtHomeDiskSpaceStatusValue = $window.FindName('txtHomeDiskSpaceStatusValue')
|
||||||
|
$State.Controls.ellipseHomeHyperVStatus = $window.FindName('ellipseHomeHyperVStatus')
|
||||||
|
$State.Controls.txtHomeHyperVStatusValue = $window.FindName('txtHomeHyperVStatusValue')
|
||||||
|
$State.Controls.txtHomeDiscussionsStatusValue = $window.FindName('txtHomeDiscussionsStatusValue')
|
||||||
|
$State.Controls.tbDiscussion1 = $window.FindName('tbDiscussion1')
|
||||||
|
$State.Controls.linkDiscussion1 = $window.FindName('linkDiscussion1')
|
||||||
|
$State.Controls.runDiscussion1 = $window.FindName('runDiscussion1')
|
||||||
|
$State.Controls.tbDiscussion2 = $window.FindName('tbDiscussion2')
|
||||||
|
$State.Controls.linkDiscussion2 = $window.FindName('linkDiscussion2')
|
||||||
|
$State.Controls.runDiscussion2 = $window.FindName('runDiscussion2')
|
||||||
|
$State.Controls.tbDiscussion3 = $window.FindName('tbDiscussion3')
|
||||||
|
$State.Controls.linkDiscussion3 = $window.FindName('linkDiscussion3')
|
||||||
|
$State.Controls.runDiscussion3 = $window.FindName('runDiscussion3')
|
||||||
|
$State.Controls.tbDiscussion4 = $window.FindName('tbDiscussion4')
|
||||||
|
$State.Controls.linkDiscussion4 = $window.FindName('linkDiscussion4')
|
||||||
|
$State.Controls.runDiscussion4 = $window.FindName('runDiscussion4')
|
||||||
|
$State.Controls.tbDiscussion5 = $window.FindName('tbDiscussion5')
|
||||||
|
$State.Controls.linkDiscussion5 = $window.FindName('linkDiscussion5')
|
||||||
|
$State.Controls.runDiscussion5 = $window.FindName('runDiscussion5')
|
||||||
|
$State.Controls.tbDiscussionsLink = $window.FindName('tbDiscussionsLink')
|
||||||
|
$State.Controls.linkDiscussions = $window.FindName('linkDiscussions')
|
||||||
|
|
||||||
|
# Settings page
|
||||||
|
$State.Controls.cmbThemeMode = $window.FindName('cmbThemeMode')
|
||||||
|
|
||||||
|
# Shared page shell
|
||||||
|
$State.Controls.txtPageTitle = $window.FindName('txtPageTitle')
|
||||||
|
|
||||||
|
# Navigation controls
|
||||||
|
$State.Controls.lstNavigation = $window.FindName('lstNavigation')
|
||||||
|
$State.Controls.lstNavSettings = $window.FindName('lstNavSettings')
|
||||||
|
$State.Controls.lstLogOutput = $window.FindName('lstLogOutput')
|
||||||
|
|
||||||
|
# Content pages (for navigation visibility toggling)
|
||||||
|
$State.Controls.navigationPages = @(
|
||||||
|
$window.FindName('pageHome'),
|
||||||
|
$window.FindName('pageHyperV'),
|
||||||
|
$window.FindName('pageWindows'),
|
||||||
|
$window.FindName('pageUpdates'),
|
||||||
|
$window.FindName('pageApplications'),
|
||||||
|
$window.FindName('pageOffice'),
|
||||||
|
$window.FindName('pageDrivers'),
|
||||||
|
$window.FindName('pageBuild'),
|
||||||
|
$window.FindName('pageMonitor')
|
||||||
|
)
|
||||||
|
$State.Controls.pageSettings = $window.FindName('pageSettings')
|
||||||
|
|
||||||
|
# Initialize and bind the log data collection
|
||||||
|
$State.Data.logData = New-Object System.Collections.ObjectModel.ObservableCollection[string]
|
||||||
|
$State.Controls.lstLogOutput.ItemsSource = $State.Data.logData
|
||||||
|
}
|
||||||
|
|
||||||
|
function Initialize-VMSwitchData {
|
||||||
|
param([PSCustomObject]$State)
|
||||||
|
|
||||||
|
WriteLog "Initializing VM Switch data..."
|
||||||
|
|
||||||
|
# Hyper-V Settings: Populate VM Switch ComboBox
|
||||||
|
$vmSwitchData = Get-VMSwitchData
|
||||||
|
$State.Data.vmSwitchMap = $vmSwitchData.SwitchMap
|
||||||
|
$State.Controls.cmbVMSwitchName.Items.Clear()
|
||||||
|
foreach ($switchName in $vmSwitchData.SwitchNames) {
|
||||||
|
$State.Controls.cmbVMSwitchName.Items.Add($switchName) | Out-Null
|
||||||
|
}
|
||||||
|
$State.Controls.cmbVMSwitchName.Items.Add('Other') | Out-Null
|
||||||
|
if ($State.Controls.cmbVMSwitchName.Items.Count -gt 1) {
|
||||||
|
$State.Controls.cmbVMSwitchName.SelectedIndex = 0
|
||||||
|
$State.Controls.txtCustomVMSwitchName.Visibility = 'Collapsed'
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
$State.Controls.cmbVMSwitchName.SelectedItem = 'Other'
|
||||||
|
$State.Controls.txtCustomVMSwitchName.Visibility = 'Visible'
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function Initialize-UIDefaults {
|
||||||
|
param([PSCustomObject]$State)
|
||||||
|
WriteLog "Initializing UI defaults..."
|
||||||
|
|
||||||
|
# Get default values from helper functions
|
||||||
|
$State.Defaults.windowsSettingsDefaults = Get-WindowsSettingsDefaults
|
||||||
|
$State.Defaults.generalDefaults = Get-GeneralDefaults -FFUDevelopmentPath $State.FFUDevelopmentPath
|
||||||
|
|
||||||
|
# Build tab defaults from General Defaults
|
||||||
|
$State.Controls.txtFFUDevPath.Text = $State.FFUDevelopmentPath
|
||||||
|
$State.Controls.txtCustomFFUNameTemplate.Text = $State.Defaults.generalDefaults.CustomFFUNameTemplate
|
||||||
|
$State.Controls.txtFFUCaptureLocation.Text = $State.Defaults.generalDefaults.FFUCaptureLocation
|
||||||
|
$State.Controls.txtThreads.Text = $State.Defaults.generalDefaults.Threads
|
||||||
|
$State.Controls.cmbBitsPriority.SelectedItem = $State.Defaults.generalDefaults.BitsPriority
|
||||||
|
$State.Controls.txtMaxUSBDrives.Text = $State.Defaults.generalDefaults.MaxUSBDrives
|
||||||
|
$State.Controls.chkBuildUSBDriveEnable.IsChecked = $State.Defaults.generalDefaults.BuildUSBDriveEnable
|
||||||
|
$State.Controls.chkCompactOS.IsChecked = $State.Defaults.generalDefaults.CompactOS
|
||||||
|
$State.Controls.chkUpdateADK.IsChecked = $State.Defaults.generalDefaults.UpdateADK
|
||||||
|
$State.Controls.chkOptimize.IsChecked = $State.Defaults.generalDefaults.Optimize
|
||||||
|
$State.Controls.chkAllowVHDXCaching.IsChecked = $State.Defaults.generalDefaults.AllowVHDXCaching
|
||||||
|
$State.Controls.chkInjectUnattend.IsChecked = $State.Defaults.generalDefaults.InjectUnattend
|
||||||
|
$State.Controls.txtUnattendX64FilePath.Text = $State.Defaults.generalDefaults.UnattendX64FilePath
|
||||||
|
$State.Controls.txtUnattendArm64FilePath.Text = $State.Defaults.generalDefaults.UnattendArm64FilePath
|
||||||
|
$State.Controls.chkCreateDeploymentMedia.IsChecked = $State.Defaults.generalDefaults.CreateDeploymentMedia
|
||||||
|
$State.Controls.chkAllowExternalHardDiskMedia.IsChecked = $State.Defaults.generalDefaults.AllowExternalHardDiskMedia
|
||||||
|
$State.Controls.chkPromptExternalHardDiskMedia.IsChecked = $State.Defaults.generalDefaults.PromptExternalHardDiskMedia
|
||||||
|
$State.Controls.chkSelectSpecificUSBDrives.IsChecked = $State.Defaults.generalDefaults.SelectSpecificUSBDrives
|
||||||
|
$State.Controls.chkCopyAutopilot.IsChecked = $State.Defaults.generalDefaults.CopyAutopilot
|
||||||
|
$State.Controls.chkCopyUnattend.IsChecked = $State.Defaults.generalDefaults.CopyUnattend
|
||||||
|
$State.Controls.chkCopyPPKG.IsChecked = $State.Defaults.generalDefaults.CopyPPKG
|
||||||
|
$defaultDeviceNamingMode = if ($State.Defaults.generalDefaults.DeviceNamingMode -in @('None', 'Prompt', 'Template', 'Prefixes', 'SerialComputerNames')) {
|
||||||
|
$State.Defaults.generalDefaults.DeviceNamingMode
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
'None'
|
||||||
|
}
|
||||||
|
Set-DeviceNamingModeState -State $State -DisplayMode $defaultDeviceNamingMode -LoadedMode $null
|
||||||
|
$State.Controls.txtDeviceNameTemplate.Text = $State.Defaults.generalDefaults.DeviceNameTemplate
|
||||||
|
$State.Controls.txtDeviceNamePrefixesPath.Text = $State.Defaults.generalDefaults.DeviceNamePrefixesPath
|
||||||
|
$State.Controls.txtDeviceNamePrefixes.Text = ($State.Defaults.generalDefaults.DeviceNamePrefixes -join [System.Environment]::NewLine)
|
||||||
|
$State.Controls.txtDeviceNameSerialComputerNamesPath.Text = $State.Defaults.generalDefaults.DeviceNameSerialComputerNamesPath
|
||||||
|
$State.Controls.txtDeviceNameSerialComputerNames.Text = ($State.Defaults.generalDefaults.DeviceNameSerialComputerNames -join [System.Environment]::NewLine)
|
||||||
|
Import-DeviceNamePrefixesFromConfiguredPath -State $State
|
||||||
|
Import-SerialComputerNamesFromConfiguredPath -State $State
|
||||||
|
Update-DeviceNamingControls -State $State
|
||||||
|
$State.Controls.chkCleanupAppsISO.IsChecked = $State.Defaults.generalDefaults.CleanupAppsISO
|
||||||
|
$State.Controls.chkCleanupDeployISO.IsChecked = $State.Defaults.generalDefaults.CleanupDeployISO
|
||||||
|
$State.Controls.chkCleanupDrivers.IsChecked = $State.Defaults.generalDefaults.CleanupDrivers
|
||||||
|
$State.Controls.chkRemoveFFU.IsChecked = $State.Defaults.generalDefaults.RemoveFFU
|
||||||
|
$State.Controls.chkRemoveApps.IsChecked = $State.Defaults.generalDefaults.RemoveApps
|
||||||
|
$State.Controls.chkRemoveUpdates.IsChecked = $State.Defaults.generalDefaults.RemoveUpdates
|
||||||
|
$State.Controls.chkRemoveDownloadedESD.IsChecked = $State.Defaults.generalDefaults.RemoveDownloadedESD
|
||||||
|
$State.Controls.chkVerbose.IsChecked = $State.Defaults.generalDefaults.Verbose
|
||||||
|
$State.Controls.usbSelectionPanel.Visibility = if ($State.Controls.chkSelectSpecificUSBDrives.IsChecked) { 'Visible' } else { 'Collapsed' }
|
||||||
|
$State.Controls.chkSelectSpecificUSBDrives.IsEnabled = $State.Controls.chkBuildUSBDriveEnable.IsChecked
|
||||||
|
$State.Controls.chkPromptExternalHardDiskMedia.IsEnabled = $State.Controls.chkAllowExternalHardDiskMedia.IsChecked
|
||||||
|
$State.Controls.chkCopyAdditionalFFUFiles.IsChecked = $State.Defaults.generalDefaults.CopyAdditionalFFUFiles
|
||||||
|
$State.Controls.additionalFFUPanel.Visibility = if ($State.Controls.chkCopyAdditionalFFUFiles.IsChecked) { 'Visible' } else { 'Collapsed' }
|
||||||
|
Update-BitsPrioritySetting -State $State
|
||||||
|
|
||||||
|
# Hyper-V Settings defaults from General Defaults
|
||||||
|
$State.Controls.chkEnableVMNetworking.IsChecked = $State.Defaults.generalDefaults.EnableVMNetworking
|
||||||
|
Initialize-VMSwitchData -State $State
|
||||||
|
$State.Controls.spVMNetworkingSettings.IsEnabled = $true -eq $State.Controls.chkEnableVMNetworking.IsChecked
|
||||||
|
$State.Controls.txtDiskSize.Text = $State.Defaults.generalDefaults.DiskSizeGB
|
||||||
|
$State.Controls.txtMemory.Text = $State.Defaults.generalDefaults.MemoryGB
|
||||||
|
$State.Controls.txtProcessors.Text = $State.Defaults.generalDefaults.Processors
|
||||||
|
$State.Controls.txtVMLocation.Text = $State.Defaults.generalDefaults.VMLocation
|
||||||
|
$State.Controls.txtVMNamePrefix.Text = $State.Defaults.generalDefaults.VMNamePrefix
|
||||||
|
$State.Controls.cmbLogicalSectorSize.SelectedItem = ($State.Controls.cmbLogicalSectorSize.Items | Where-Object { $_.Content -eq $State.Defaults.generalDefaults.LogicalSectorSize.ToString() })
|
||||||
|
|
||||||
|
# Populate Windows Release, Version, and SKU comboboxes
|
||||||
|
# Initialize Windows settings combos based on media source mode
|
||||||
|
$initIsoPath = $State.Defaults.windowsSettingsDefaults.DefaultISOPath
|
||||||
|
if ($null -ne $State.Controls.rbProvideISO -and -not $State.Controls.rbProvideISO.IsChecked) {
|
||||||
|
$initIsoPath = ''
|
||||||
|
}
|
||||||
|
Get-WindowsSettingsCombos -isoPath $initIsoPath -State $State
|
||||||
|
|
||||||
|
# Windows Settings tab defaults
|
||||||
|
$State.Controls.cmbWindowsLang.ItemsSource = $State.Defaults.windowsSettingsDefaults.AllowedLanguages
|
||||||
|
$State.Controls.cmbWindowsLang.SelectedItem = $State.Defaults.windowsSettingsDefaults.DefaultWindowsLang
|
||||||
|
$State.Controls.cmbMediaType.ItemsSource = $State.Defaults.windowsSettingsDefaults.AllowedMediaTypes
|
||||||
|
$State.Controls.cmbMediaType.SelectedItem = $State.Defaults.windowsSettingsDefaults.DefaultMediaType
|
||||||
|
$State.Controls.txtProductKey.Text = $State.Defaults.windowsSettingsDefaults.DefaultProductKey
|
||||||
|
|
||||||
|
# Updates tab defaults from General Defaults
|
||||||
|
$State.Controls.chkUpdateLatestCU.IsChecked = $State.Defaults.generalDefaults.UpdateLatestCU
|
||||||
|
$State.Controls.chkUpdateLatestNet.IsChecked = $State.Defaults.generalDefaults.UpdateLatestNet
|
||||||
|
$State.Controls.chkUpdateLatestDefender.IsChecked = $State.Defaults.generalDefaults.UpdateLatestDefender
|
||||||
|
$State.Controls.chkUpdateEdge.IsChecked = $State.Defaults.generalDefaults.UpdateEdge
|
||||||
|
$State.Controls.chkUpdateOneDrive.IsChecked = $State.Defaults.generalDefaults.UpdateOneDrive
|
||||||
|
$State.Controls.chkUpdateLatestMSRT.IsChecked = $State.Defaults.generalDefaults.UpdateLatestMSRT
|
||||||
|
$State.Controls.chkUpdateLatestMicrocode.IsChecked = $State.Defaults.generalDefaults.UpdateLatestMicrocode
|
||||||
|
$State.Controls.chkUpdatePreviewCU.IsChecked = $State.Defaults.generalDefaults.UpdatePreviewCU
|
||||||
|
# Set initial state for CU checkbox interplay
|
||||||
|
$State.Controls.chkPreviewCU.IsEnabled = -not $State.Controls.chkLatestCU.IsChecked
|
||||||
|
$State.Controls.chkLatestCU.IsEnabled = -not $State.Controls.chkPreviewCU.IsChecked
|
||||||
|
|
||||||
|
# Applications tab defaults from General Defaults
|
||||||
|
$State.Controls.chkInstallApps.IsChecked = $State.Defaults.generalDefaults.InstallApps
|
||||||
|
$State.Controls.txtApplicationPath.Text = $State.Defaults.generalDefaults.ApplicationPath
|
||||||
|
$State.Controls.txtAppListJsonPath.Text = $State.Defaults.generalDefaults.AppListJsonPath
|
||||||
|
$State.Controls.txtUserAppListPath.Text = $State.Defaults.generalDefaults.UserAppListPath
|
||||||
|
$State.Controls.chkInstallWingetApps.IsChecked = $State.Defaults.generalDefaults.InstallWingetApps
|
||||||
|
$State.Controls.chkBringYourOwnApps.IsChecked = $State.Defaults.generalDefaults.BringYourOwnApps
|
||||||
|
|
||||||
|
# M365 Apps/Office tab defaults from General Defaults
|
||||||
|
$State.Controls.chkInstallOffice.IsChecked = $State.Defaults.generalDefaults.InstallOffice
|
||||||
|
$State.Controls.txtOfficePath.Text = $State.Defaults.generalDefaults.OfficePath
|
||||||
|
$State.Controls.chkCopyOfficeConfigXML.IsChecked = $State.Defaults.generalDefaults.CopyOfficeConfigXML
|
||||||
|
$State.Controls.txtOfficeConfigXMLFilePath.Text = $State.Defaults.generalDefaults.OfficeConfigXMLFilePath
|
||||||
|
|
||||||
|
# Drivers tab defaults from General Defaults
|
||||||
|
$State.Controls.txtDriversFolder.Text = $State.Defaults.generalDefaults.DriversFolder
|
||||||
|
$State.Controls.txtPEDriversFolder.Text = $State.Defaults.generalDefaults.PEDriversFolder
|
||||||
|
$State.Controls.txtDriversJsonPath.Text = $State.Defaults.generalDefaults.DriversJsonPath
|
||||||
|
$State.Controls.chkDownloadDrivers.IsChecked = $State.Defaults.generalDefaults.DownloadDrivers
|
||||||
|
$State.Controls.chkInstallDrivers.IsChecked = $State.Defaults.generalDefaults.InstallDrivers
|
||||||
|
$State.Controls.chkCopyDrivers.IsChecked = $State.Defaults.generalDefaults.CopyDrivers
|
||||||
|
$State.Controls.chkCopyPEDrivers.IsChecked = $State.Defaults.generalDefaults.CopyPEDrivers
|
||||||
|
$State.Controls.chkUseDriversAsPEDrivers.IsChecked = $State.Defaults.generalDefaults.UseDriversAsPEDrivers
|
||||||
|
$State.Controls.chkCompressDriversToWIM.IsChecked = $State.Defaults.generalDefaults.CompressDownloadedDriversToWim
|
||||||
|
|
||||||
|
# Drivers tab UI logic
|
||||||
|
$makeList = @('Microsoft', 'Dell', 'HP', 'Lenovo')
|
||||||
|
if ($null -ne $State.Controls.cmbMake) {
|
||||||
|
# Clear existing items to prevent duplication on re-initialization (e.g., after Restore Defaults)
|
||||||
|
$State.Controls.cmbMake.Items.Clear()
|
||||||
|
foreach ($m in $makeList) {
|
||||||
|
[void]$State.Controls.cmbMake.Items.Add($m)
|
||||||
|
}
|
||||||
|
if ($State.Controls.cmbMake.Items.Count -gt 0) {
|
||||||
|
$State.Controls.cmbMake.SelectedIndex = 0
|
||||||
|
}
|
||||||
|
}
|
||||||
|
Update-DriverDownloadPanelVisibility -State $State
|
||||||
|
|
||||||
|
# Set initial state for driver checkbox interplay
|
||||||
|
Update-DriverCheckboxStates -State $State
|
||||||
|
|
||||||
|
# Set initial state for InstallApps checkbox based on updates
|
||||||
|
Update-InstallAppsState -State $State
|
||||||
|
|
||||||
|
# Set default theme mode and disable if Fluent is not supported
|
||||||
|
if ($null -ne $State.Controls.cmbThemeMode) {
|
||||||
|
$State.Controls.cmbThemeMode.SelectedItem = "System"
|
||||||
|
if (-not $State.Flags.isFluentSupported) {
|
||||||
|
$State.Controls.cmbThemeMode.IsEnabled = $false
|
||||||
|
$State.Controls.cmbThemeMode.Tag = "Fluent theme requires PowerShell 7.5+ (.NET 9+). Best experience on PowerShell 7.6+ (.NET 10)."
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# Set default navigation selection to Home and initialize the shared page title
|
||||||
|
if ($null -ne $State.Controls.lstNavigation) {
|
||||||
|
$State.Controls.lstNavigation.SelectedIndex = 0
|
||||||
|
|
||||||
|
# Keep the shell header aligned with the selected navigation item on first render
|
||||||
|
if ($null -ne $State.Controls.txtPageTitle) {
|
||||||
|
$selectedNavigationItem = $State.Controls.lstNavigation.SelectedItem
|
||||||
|
if ($null -ne $selectedNavigationItem -and -not [string]::IsNullOrWhiteSpace([string]$selectedNavigationItem.Tag)) {
|
||||||
|
$State.Controls.txtPageTitle.Text = [string]$selectedNavigationItem.Tag
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
$State.Controls.txtPageTitle.Text = 'Home'
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# Set initial state for Office panel visibility
|
||||||
|
Update-OfficePanelVisibility -State $State
|
||||||
|
|
||||||
|
# Set initial state for Application panel visibility
|
||||||
|
Update-ApplicationPanelVisibility -State $State
|
||||||
|
|
||||||
|
# Set initial state for BYO Apps copy button
|
||||||
|
Update-CopyButtonState -State $State
|
||||||
|
|
||||||
|
# Apply accent color to primary action button only (per Windows design guidance)
|
||||||
|
if ($State.Flags.isFluentSupported) {
|
||||||
|
try {
|
||||||
|
$State.Controls.btnRun = $State.Window.FindName('btnRun')
|
||||||
|
if ($null -ne $State.Controls.btnRun) {
|
||||||
|
# Use SetResourceReference for live accent color updates when user changes Windows theme
|
||||||
|
$State.Controls.btnRun.SetResourceReference(
|
||||||
|
[System.Windows.Controls.Control]::BackgroundProperty,
|
||||||
|
[System.Windows.SystemColors]::AccentColorBrushKey
|
||||||
|
)
|
||||||
|
$State.Controls.btnRun.Foreground = [System.Windows.Media.Brushes]::White
|
||||||
|
}
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
WriteLog "Could not apply accent color to Build FFU button: $($_.Exception.Message)"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function Initialize-DynamicUIElements {
|
||||||
|
param([PSCustomObject]$State)
|
||||||
|
WriteLog "Initializing dynamic UI elements (Grids, Columns)..."
|
||||||
|
|
||||||
|
# Get the Fluent base style for ListViewItem in GridView mode
|
||||||
|
# Must use GridViewItemContainerStyleKey (not the generic ListViewItem type key) because the
|
||||||
|
# generic Fluent ListViewItem style has a template without GridViewRowPresenter, which breaks
|
||||||
|
# column-based rendering and causes items to display their ToString() representation.
|
||||||
|
$listViewItemBaseStyle = $State.Window.TryFindResource([System.Windows.Controls.GridView]::GridViewItemContainerStyleKey)
|
||||||
|
|
||||||
|
# Driver Models ListView setup
|
||||||
|
# Set ListViewItem style to stretch content horizontally so cell templates fill the cell
|
||||||
|
$itemStyleDriverModels = New-Object System.Windows.Style([System.Windows.Controls.ListViewItem])
|
||||||
|
if ($null -ne $listViewItemBaseStyle) { $itemStyleDriverModels.BasedOn = $listViewItemBaseStyle }
|
||||||
|
$itemStyleDriverModels.Setters.Add((New-Object System.Windows.Setter([System.Windows.Controls.ListViewItem]::HorizontalContentAlignmentProperty, [System.Windows.HorizontalAlignment]::Stretch)))
|
||||||
|
$State.Controls.lstDriverModels.ItemContainerStyle = $itemStyleDriverModels
|
||||||
|
|
||||||
|
$driverModelsGridView = New-Object System.Windows.Controls.GridView
|
||||||
|
$State.Controls.lstDriverModels.View = $driverModelsGridView # Assign GridView to ListView first
|
||||||
|
|
||||||
|
# Add the selectable column and scope header select-all to visible filtered rows.
|
||||||
|
Add-SelectableGridViewColumn -ListView $State.Controls.lstDriverModels -State $State -HeaderCheckBoxKeyName "chkSelectAllDriverModels" -ColumnWidth 70 -HeaderSelectionAffectsVisibleItemsOnly
|
||||||
|
|
||||||
|
# Add other sortable columns with left-aligned headers
|
||||||
|
Add-SortableColumn -gridView $driverModelsGridView -header "Make" -binding "Make" -width 100 -headerHorizontalAlignment Left
|
||||||
|
Add-SortableColumn -gridView $driverModelsGridView -header "Model" -binding "Model" -width 200 -headerHorizontalAlignment Left
|
||||||
|
Add-SortableColumn -gridView $driverModelsGridView -header "Status" -binding "DownloadStatus" -width 150 -headerHorizontalAlignment Left
|
||||||
|
$State.Controls.lstDriverModels.AddHandler(
|
||||||
|
[System.Windows.Controls.GridViewColumnHeader]::ClickEvent,
|
||||||
|
[System.Windows.RoutedEventHandler] {
|
||||||
|
param($eventSource, $e) # $eventSource is the ListView control
|
||||||
|
$header = $e.OriginalSource
|
||||||
|
if ($header -is [System.Windows.Controls.GridViewColumnHeader] -and $header.Tag) {
|
||||||
|
# Retrieve the main UI state object from the window's Tag property
|
||||||
|
$listViewControl = $eventSource
|
||||||
|
$window = [System.Windows.Window]::GetWindow($listViewControl)
|
||||||
|
$uiStateFromWindowTag = $window.Tag
|
||||||
|
|
||||||
|
Invoke-ListViewSort -listView $eventSource -property $header.Tag -State $uiStateFromWindowTag
|
||||||
|
}
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
# Keep driver model columns sized to the current visible content.
|
||||||
|
Enable-ListViewColumnAutoResize -ListView $State.Controls.lstDriverModels -FixedColumnIndexes @(0)
|
||||||
|
|
||||||
|
# Winget Search ListView setup
|
||||||
|
$wingetGridView = New-Object System.Windows.Controls.GridView
|
||||||
|
$State.Controls.lstWingetResults.View = $wingetGridView # Assign GridView to ListView first
|
||||||
|
|
||||||
|
# Set ListViewItem style to stretch content horizontally so cell templates fill the cell
|
||||||
|
$itemStyleWingetResults = New-Object System.Windows.Style([System.Windows.Controls.ListViewItem])
|
||||||
|
if ($null -ne $listViewItemBaseStyle) { $itemStyleWingetResults.BasedOn = $listViewItemBaseStyle }
|
||||||
|
$itemStyleWingetResults.Setters.Add((New-Object System.Windows.Setter([System.Windows.Controls.ListViewItem]::HorizontalContentAlignmentProperty, [System.Windows.HorizontalAlignment]::Stretch)))
|
||||||
|
$State.Controls.lstWingetResults.ItemContainerStyle = $itemStyleWingetResults
|
||||||
|
|
||||||
|
# Add the selectable column using the new function
|
||||||
|
Add-SelectableGridViewColumn -ListView $State.Controls.lstWingetResults -State $State -HeaderCheckBoxKeyName "chkSelectAllWingetResults" -ColumnWidth 60
|
||||||
|
|
||||||
|
# Add other sortable columns with left-aligned headers
|
||||||
|
Add-SortableColumn -gridView $wingetGridView -header "Name" -binding "Name" -width 200 -headerHorizontalAlignment Left
|
||||||
|
Add-SortableColumn -gridView $wingetGridView -header "Id" -binding "Id" -width 200 -headerHorizontalAlignment Left
|
||||||
|
Add-SortableColumn -gridView $wingetGridView -header "Version" -binding "Version" -width 100 -headerHorizontalAlignment Left
|
||||||
|
Add-SortableColumn -gridView $wingetGridView -header "Source" -binding "Source" -width 100 -headerHorizontalAlignment Left
|
||||||
|
|
||||||
|
# --- START: Add Architecture Column ---
|
||||||
|
$archColumn = New-Object System.Windows.Controls.GridViewColumn
|
||||||
|
$archHeader = New-Object System.Windows.Controls.GridViewColumnHeader
|
||||||
|
$archHeader.Tag = "Architecture" # For sorting
|
||||||
|
$archHeader.HorizontalContentAlignment = [System.Windows.HorizontalAlignment]::Left
|
||||||
|
|
||||||
|
# Create header content with correct padding to match other columns
|
||||||
|
$commonPaddingForHeader = New-Object System.Windows.Thickness(5, 2, 5, 2)
|
||||||
|
$headerTextElementFactory = New-Object System.Windows.FrameworkElementFactory([System.Windows.Controls.TextBlock])
|
||||||
|
$headerTextElementFactory.SetValue([System.Windows.Controls.TextBlock]::TextProperty, "Architecture")
|
||||||
|
$headerTextBlockPadding = New-Object System.Windows.Thickness($commonPaddingForHeader.Left, $commonPaddingForHeader.Top, $commonPaddingForHeader.Right, $commonPaddingForHeader.Bottom)
|
||||||
|
$headerTextElementFactory.SetValue([System.Windows.Controls.TextBlock]::PaddingProperty, $headerTextBlockPadding)
|
||||||
|
$headerTextElementFactory.SetValue([System.Windows.FrameworkElement]::VerticalAlignmentProperty, [System.Windows.VerticalAlignment]::Center)
|
||||||
|
|
||||||
|
$headerDataTemplate = New-Object System.Windows.DataTemplate
|
||||||
|
$headerDataTemplate.VisualTree = $headerTextElementFactory
|
||||||
|
$archHeader.ContentTemplate = $headerDataTemplate
|
||||||
|
|
||||||
|
$archColumn.Header = $archHeader
|
||||||
|
$archColumn.Width = 120
|
||||||
|
|
||||||
|
# Create the CellTemplate with a ComboBox
|
||||||
|
$archCellTemplate = New-Object System.Windows.DataTemplate
|
||||||
|
$comboBoxFactory = New-Object System.Windows.FrameworkElementFactory([System.Windows.Controls.ComboBox])
|
||||||
|
|
||||||
|
# The ItemsSource for the ComboBox
|
||||||
|
$availableArchitectures = @('x86', 'x64', 'arm64', 'x86 x64', 'NA')
|
||||||
|
$comboBoxFactory.SetValue([System.Windows.Controls.ItemsControl]::ItemsSourceProperty, $availableArchitectures)
|
||||||
|
|
||||||
|
# Bind the text property to the 'Architecture' property of the data item.
|
||||||
|
# This ensures the initial value is displayed correctly.
|
||||||
|
$binding = New-Object System.Windows.Data.Binding("Architecture")
|
||||||
|
$binding.Mode = [System.Windows.Data.BindingMode]::TwoWay
|
||||||
|
$comboBoxFactory.SetBinding([System.Windows.Controls.ComboBox]::TextProperty, $binding)
|
||||||
|
|
||||||
|
# Create a style to disable the ComboBox for 'msstore' source, inheriting the Fluent base style
|
||||||
|
$comboBoxStyle = New-Object System.Windows.Style
|
||||||
|
$comboBoxStyle.TargetType = [System.Windows.Controls.ComboBox]
|
||||||
|
$comboBoxBaseStyle = $State.Window.TryFindResource([System.Windows.Controls.ComboBox])
|
||||||
|
if ($null -ne $comboBoxBaseStyle) { $comboBoxStyle.BasedOn = $comboBoxBaseStyle }
|
||||||
|
|
||||||
|
$dataTrigger = New-Object System.Windows.DataTrigger
|
||||||
|
$dataTrigger.Binding = New-Object System.Windows.Data.Binding("Source")
|
||||||
|
$dataTrigger.Value = "msstore"
|
||||||
|
$dataTrigger.Setters.Add((New-Object System.Windows.Setter([System.Windows.Controls.ComboBox]::IsEnabledProperty, $false)))
|
||||||
|
|
||||||
|
$comboBoxStyle.Triggers.Add($dataTrigger)
|
||||||
|
$comboBoxFactory.SetValue([System.Windows.FrameworkElement]::StyleProperty, $comboBoxStyle)
|
||||||
|
|
||||||
|
$archCellTemplate.VisualTree = $comboBoxFactory
|
||||||
|
$archColumn.CellTemplate = $archCellTemplate
|
||||||
|
$wingetGridView.Columns.Add($archColumn)
|
||||||
|
# --- END: Add Architecture Column ---
|
||||||
|
|
||||||
|
# --- START: Add Additional Exit Codes Column ---
|
||||||
|
$exitCodesColumn = New-Object System.Windows.Controls.GridViewColumn
|
||||||
|
$exitCodesHeader = New-Object System.Windows.Controls.GridViewColumnHeader
|
||||||
|
$exitCodesHeader.Tag = "AdditionalExitCodes"
|
||||||
|
$exitCodesHeader.HorizontalContentAlignment = [System.Windows.HorizontalAlignment]::Left
|
||||||
|
|
||||||
|
$exitHeaderTextFactory = New-Object System.Windows.FrameworkElementFactory([System.Windows.Controls.TextBlock])
|
||||||
|
$exitHeaderTextFactory.SetValue([System.Windows.Controls.TextBlock]::TextProperty, "Additional Exit Codes")
|
||||||
|
$exitHeaderTextFactory.SetValue([System.Windows.Controls.TextBlock]::PaddingProperty, (New-Object System.Windows.Thickness(5, 2, 5, 2)))
|
||||||
|
$exitHeaderTextFactory.SetValue([System.Windows.FrameworkElement]::VerticalAlignmentProperty, [System.Windows.VerticalAlignment]::Center)
|
||||||
|
|
||||||
|
$exitHeaderTemplate = New-Object System.Windows.DataTemplate
|
||||||
|
$exitHeaderTemplate.VisualTree = $exitHeaderTextFactory
|
||||||
|
$exitCodesHeader.ContentTemplate = $exitHeaderTemplate
|
||||||
|
|
||||||
|
$exitCodesColumn.Header = $exitCodesHeader
|
||||||
|
$exitCodesColumn.Width = 140
|
||||||
|
|
||||||
|
$exitCodesCellTemplate = New-Object System.Windows.DataTemplate
|
||||||
|
$exitCodesTextBoxFactory = New-Object System.Windows.FrameworkElementFactory([System.Windows.Controls.TextBox])
|
||||||
|
$exitBinding = New-Object System.Windows.Data.Binding("AdditionalExitCodes")
|
||||||
|
$exitBinding.Mode = [System.Windows.Data.BindingMode]::TwoWay
|
||||||
|
$exitCodesTextBoxFactory.SetBinding([System.Windows.Controls.TextBox]::TextProperty, $exitBinding)
|
||||||
|
$exitCodesCellTemplate.VisualTree = $exitCodesTextBoxFactory
|
||||||
|
$exitCodesColumn.CellTemplate = $exitCodesCellTemplate
|
||||||
|
$wingetGridView.Columns.Add($exitCodesColumn)
|
||||||
|
# --- END: Add Additional Exit Codes Column ---
|
||||||
|
|
||||||
|
# --- START: Add Ignore Non-Zero Exit Codes Column ---
|
||||||
|
$ignoreColumn = New-Object System.Windows.Controls.GridViewColumn
|
||||||
|
$ignoreHeader = New-Object System.Windows.Controls.GridViewColumnHeader
|
||||||
|
$ignoreHeader.Tag = "IgnoreNonZeroExitCodes"
|
||||||
|
$ignoreHeader.HorizontalContentAlignment = [System.Windows.HorizontalAlignment]::Left
|
||||||
|
|
||||||
|
$ignoreHeaderTextFactory = New-Object System.Windows.FrameworkElementFactory([System.Windows.Controls.TextBlock])
|
||||||
|
$ignoreHeaderTextFactory.SetValue([System.Windows.Controls.TextBlock]::TextProperty, "Ignore Exit Codes")
|
||||||
|
$ignoreHeaderTextFactory.SetValue([System.Windows.Controls.TextBlock]::PaddingProperty, (New-Object System.Windows.Thickness(5, 2, 5, 2)))
|
||||||
|
$ignoreHeaderTextFactory.SetValue([System.Windows.FrameworkElement]::VerticalAlignmentProperty, [System.Windows.VerticalAlignment]::Center)
|
||||||
|
|
||||||
|
$ignoreHeaderTemplate = New-Object System.Windows.DataTemplate
|
||||||
|
$ignoreHeaderTemplate.VisualTree = $ignoreHeaderTextFactory
|
||||||
|
$ignoreHeader.ContentTemplate = $ignoreHeaderTemplate
|
||||||
|
|
||||||
|
$ignoreColumn.Header = $ignoreHeader
|
||||||
|
$ignoreColumn.Width = 140
|
||||||
|
|
||||||
|
$ignoreCellTemplate = New-Object System.Windows.DataTemplate
|
||||||
|
|
||||||
|
# Center the checkbox in the cell
|
||||||
|
$ignoreCellGridFactory = New-Object System.Windows.FrameworkElementFactory([System.Windows.Controls.Grid])
|
||||||
|
$ignoreCellGridFactory.SetValue([System.Windows.FrameworkElement]::HorizontalAlignmentProperty, [System.Windows.HorizontalAlignment]::Stretch)
|
||||||
|
$ignoreCellGridFactory.SetValue([System.Windows.FrameworkElement]::VerticalAlignmentProperty, [System.Windows.VerticalAlignment]::Stretch)
|
||||||
|
|
||||||
|
$ignoreCheckFactory = New-Object System.Windows.FrameworkElementFactory([System.Windows.Controls.CheckBox])
|
||||||
|
$ignoreCheckFactory.SetValue([System.Windows.FrameworkElement]::HorizontalAlignmentProperty, [System.Windows.HorizontalAlignment]::Center)
|
||||||
|
$ignoreCheckFactory.SetValue([System.Windows.FrameworkElement]::VerticalAlignmentProperty, [System.Windows.VerticalAlignment]::Center)
|
||||||
|
|
||||||
|
$ignoreBinding = New-Object System.Windows.Data.Binding("IgnoreNonZeroExitCodes")
|
||||||
|
$ignoreBinding.Mode = [System.Windows.Data.BindingMode]::TwoWay
|
||||||
|
$ignoreCheckFactory.SetBinding([System.Windows.Controls.Primitives.ToggleButton]::IsCheckedProperty, $ignoreBinding)
|
||||||
|
|
||||||
|
# Build the visual tree: Grid -> CheckBox
|
||||||
|
$ignoreCellGridFactory.AppendChild($ignoreCheckFactory)
|
||||||
|
$ignoreCellTemplate.VisualTree = $ignoreCellGridFactory
|
||||||
|
|
||||||
|
$ignoreColumn.CellTemplate = $ignoreCellTemplate
|
||||||
|
$wingetGridView.Columns.Add($ignoreColumn)
|
||||||
|
# --- END: Add Ignore Non-Zero Exit Codes Column ---
|
||||||
|
|
||||||
|
Add-SortableColumn -gridView $wingetGridView -header "Download Status" -binding "DownloadStatus" -width 150 -headerHorizontalAlignment Left
|
||||||
|
$State.Controls.lstWingetResults.AddHandler(
|
||||||
|
[System.Windows.Controls.GridViewColumnHeader]::ClickEvent,
|
||||||
|
[System.Windows.RoutedEventHandler] {
|
||||||
|
param($eventSource, $e) # $eventSource is the ListView control
|
||||||
|
$header = $e.OriginalSource
|
||||||
|
if ($header -is [System.Windows.Controls.GridViewColumnHeader] -and $header.Tag) {
|
||||||
|
# Retrieve the main UI state object from the window's Tag property
|
||||||
|
$listViewControl = $eventSource
|
||||||
|
$window = [System.Windows.Window]::GetWindow($listViewControl)
|
||||||
|
$uiStateFromWindowTag = $window.Tag
|
||||||
|
|
||||||
|
Invoke-ListViewSort -listView $eventSource -property $header.Tag -State $uiStateFromWindowTag
|
||||||
|
}
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
# Keep Winget result columns sized to the current visible content.
|
||||||
|
Enable-ListViewColumnAutoResize -ListView $State.Controls.lstWingetResults -FixedColumnIndexes @(0)
|
||||||
|
|
||||||
|
# BYO Applications ListView setup
|
||||||
|
$byoAppsGridView = New-Object System.Windows.Controls.GridView
|
||||||
|
$State.Controls.lstApplications.View = $byoAppsGridView
|
||||||
|
|
||||||
|
# Set ListViewItem style to stretch content horizontally
|
||||||
|
$itemStyleBYOApps = New-Object System.Windows.Style([System.Windows.Controls.ListViewItem])
|
||||||
|
if ($null -ne $listViewItemBaseStyle) { $itemStyleBYOApps.BasedOn = $listViewItemBaseStyle }
|
||||||
|
$itemStyleBYOApps.Setters.Add((New-Object System.Windows.Setter([System.Windows.Controls.ListViewItem]::HorizontalContentAlignmentProperty, [System.Windows.HorizontalAlignment]::Stretch)))
|
||||||
|
$State.Controls.lstApplications.ItemContainerStyle = $itemStyleBYOApps
|
||||||
|
|
||||||
|
# Add the selectable column
|
||||||
|
Add-SelectableGridViewColumn -ListView $State.Controls.lstApplications -State $State -HeaderCheckBoxKeyName "chkSelectAllBYOApps" -ColumnWidth 60
|
||||||
|
|
||||||
|
# Add other sortable columns
|
||||||
|
Add-SortableColumn -gridView $byoAppsGridView -header "Priority" -binding "Priority" -width 60 -headerHorizontalAlignment Left
|
||||||
|
Add-SortableColumn -gridView $byoAppsGridView -header "Name" -binding "Name" -width 150 -headerHorizontalAlignment Left
|
||||||
|
Add-SortableColumn -gridView $byoAppsGridView -header "Command Line" -binding "CommandLine" -width 200 -headerHorizontalAlignment Left
|
||||||
|
Add-SortableColumn -gridView $byoAppsGridView -header "Arguments" -binding "Arguments" -width 200 -headerHorizontalAlignment Left
|
||||||
|
Add-SortableColumn -gridView $byoAppsGridView -header "Source" -binding "Source" -width 150 -headerHorizontalAlignment Left
|
||||||
|
Add-SortableColumn -gridView $byoAppsGridView -header "Exit Codes" -binding "AdditionalExitCodes" -width 100 -headerHorizontalAlignment Left
|
||||||
|
Add-SortableColumn -gridView $byoAppsGridView -header "Ignore Exit Codes" -binding "IgnoreExitCodes" -width 120 -headerHorizontalAlignment Left
|
||||||
|
Add-SortableColumn -gridView $byoAppsGridView -header "Copy Status" -binding "CopyStatus" -width 150 -headerHorizontalAlignment Left
|
||||||
|
|
||||||
|
# Keep BYO application columns sized to the current visible content.
|
||||||
|
Enable-ListViewColumnAutoResize -ListView $State.Controls.lstApplications -FixedColumnIndexes @(0)
|
||||||
|
|
||||||
|
# Apps Script Variables ListView setup
|
||||||
|
# Bind ItemsSource to the data list
|
||||||
|
$State.Controls.lstAppsScriptVariables.ItemsSource = $State.Data.appsScriptVariablesDataList.ToArray()
|
||||||
|
|
||||||
|
# Set ListViewItem style to stretch content horizontally so cell templates fill the cell
|
||||||
|
$itemStyleAppsScriptVars = New-Object System.Windows.Style([System.Windows.Controls.ListViewItem])
|
||||||
|
if ($null -ne $listViewItemBaseStyle) { $itemStyleAppsScriptVars.BasedOn = $listViewItemBaseStyle }
|
||||||
|
$itemStyleAppsScriptVars.Setters.Add((New-Object System.Windows.Setter([System.Windows.Controls.ListViewItem]::HorizontalContentAlignmentProperty, [System.Windows.HorizontalAlignment]::Stretch)))
|
||||||
|
$State.Controls.lstAppsScriptVariables.ItemContainerStyle = $itemStyleAppsScriptVars
|
||||||
|
|
||||||
|
# The GridView for lstAppsScriptVariables is defined in XAML. We need to get it and add the column.
|
||||||
|
if ($State.Controls.lstAppsScriptVariables.View -is [System.Windows.Controls.GridView]) {
|
||||||
|
Add-SelectableGridViewColumn -ListView $State.Controls.lstAppsScriptVariables -State $State -HeaderCheckBoxKeyName "chkSelectAllAppsScriptVariables" -ColumnWidth 60
|
||||||
|
|
||||||
|
# Make Key and Value columns sortable
|
||||||
|
$appsScriptVarsGridView = $State.Controls.lstAppsScriptVariables.View
|
||||||
|
|
||||||
|
# Key Column (should be at index 1 after selectable column is inserted at 0)
|
||||||
|
if ($appsScriptVarsGridView.Columns.Count -gt 1) {
|
||||||
|
$keyColumn = $appsScriptVarsGridView.Columns[1]
|
||||||
|
$keyHeader = New-Object System.Windows.Controls.GridViewColumnHeader
|
||||||
|
$keyHeader.Content = "Key"
|
||||||
|
$keyHeader.Tag = "Key" # Property to sort by
|
||||||
|
$keyHeader.HorizontalContentAlignment = [System.Windows.HorizontalAlignment]::Left
|
||||||
|
$keyColumn.Header = $keyHeader
|
||||||
|
}
|
||||||
|
|
||||||
|
# Value Column (should be at index 2)
|
||||||
|
if ($appsScriptVarsGridView.Columns.Count -gt 2) {
|
||||||
|
$valueColumn = $appsScriptVarsGridView.Columns[2]
|
||||||
|
$valueHeader = New-Object System.Windows.Controls.GridViewColumnHeader
|
||||||
|
$valueHeader.Content = "Value"
|
||||||
|
$valueHeader.Tag = "Value" # Property to sort by
|
||||||
|
$valueHeader.HorizontalContentAlignment = [System.Windows.HorizontalAlignment]::Left
|
||||||
|
$valueColumn.Header = $valueHeader
|
||||||
|
}
|
||||||
|
|
||||||
|
# Add Click event handler for sorting
|
||||||
|
$State.Controls.lstAppsScriptVariables.AddHandler(
|
||||||
|
[System.Windows.Controls.GridViewColumnHeader]::ClickEvent,
|
||||||
|
[System.Windows.RoutedEventHandler] {
|
||||||
|
param($eventSource, $e) # $eventSource is the ListView control
|
||||||
|
$header = $e.OriginalSource
|
||||||
|
if ($header -is [System.Windows.Controls.GridViewColumnHeader] -and $header.Tag) {
|
||||||
|
# Retrieve the main UI state object from the window's Tag property
|
||||||
|
$listViewControl = $eventSource
|
||||||
|
$window = [System.Windows.Window]::GetWindow($listViewControl)
|
||||||
|
$uiStateFromWindowTag = $window.Tag
|
||||||
|
|
||||||
|
Invoke-ListViewSort -listView $eventSource -property $header.Tag -State $uiStateFromWindowTag
|
||||||
|
}
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
# Keep apps script variable columns sized to the current visible content.
|
||||||
|
Enable-ListViewColumnAutoResize -ListView $State.Controls.lstAppsScriptVariables -FixedColumnIndexes @(0)
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
WriteLog "Warning: lstAppsScriptVariables.View is not a GridView. Selectable column not added, and sorting cannot be enabled."
|
||||||
|
}
|
||||||
|
|
||||||
|
# Build dynamic multi-column checkboxes for optional features
|
||||||
|
if ($State.Controls.featuresPanel -and $State.Defaults.windowsSettingsDefaults) {
|
||||||
|
BuildFeaturesGrid -parent $State.Controls.featuresPanel -allowedFeatures $State.Defaults.windowsSettingsDefaults.AllowedFeatures -State $State
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
WriteLog "Initialize-DynamicUIElements: Could not build features grid. Panel or defaults missing."
|
||||||
|
}
|
||||||
|
|
||||||
|
# USB Drives ListView setup
|
||||||
|
# Set ListViewItem style to stretch content horizontally so cell templates fill the cell
|
||||||
|
$itemStyleUSBDrives = New-Object System.Windows.Style([System.Windows.Controls.ListViewItem])
|
||||||
|
if ($null -ne $listViewItemBaseStyle) { $itemStyleUSBDrives.BasedOn = $listViewItemBaseStyle }
|
||||||
|
$itemStyleUSBDrives.Setters.Add((New-Object System.Windows.Setter([System.Windows.Controls.ListViewItem]::HorizontalContentAlignmentProperty, [System.Windows.HorizontalAlignment]::Stretch)))
|
||||||
|
$State.Controls.lstUSBDrives.ItemContainerStyle = $itemStyleUSBDrives
|
||||||
|
|
||||||
|
if ($State.Controls.lstUSBDrives.View -is [System.Windows.Controls.GridView]) {
|
||||||
|
# Add the selectable column using the shared function
|
||||||
|
Add-SelectableGridViewColumn -ListView $State.Controls.lstUSBDrives -State $State -HeaderCheckBoxKeyName "chkSelectAllUSBDrivesHeader" -ColumnWidth 70
|
||||||
|
|
||||||
|
# Make other columns sortable
|
||||||
|
$usbDrivesGridView = $State.Controls.lstUSBDrives.View
|
||||||
|
|
||||||
|
# Model Column (index 0 in XAML, now 1)
|
||||||
|
if ($usbDrivesGridView.Columns.Count -gt 1) {
|
||||||
|
$modelColumn = $usbDrivesGridView.Columns[1]
|
||||||
|
$modelHeader = New-Object System.Windows.Controls.GridViewColumnHeader
|
||||||
|
$modelHeader.Content = "Model"
|
||||||
|
$modelHeader.Tag = "Model" # Property to sort by
|
||||||
|
$modelHeader.HorizontalContentAlignment = [System.Windows.HorizontalAlignment]::Left
|
||||||
|
$modelColumn.Header = $modelHeader
|
||||||
|
}
|
||||||
|
|
||||||
|
# Unique ID Column (index 1 in XAML, now 2)
|
||||||
|
if ($usbDrivesGridView.Columns.Count -gt 2) {
|
||||||
|
$uniqueIdColumn = $usbDrivesGridView.Columns[2]
|
||||||
|
$uniqueIdHeader = New-Object System.Windows.Controls.GridViewColumnHeader
|
||||||
|
$uniqueIdHeader.Content = "Unique ID"
|
||||||
|
$uniqueIdHeader.Tag = "UniqueId" # Property to sort by
|
||||||
|
$uniqueIdHeader.HorizontalContentAlignment = [System.Windows.HorizontalAlignment]::Left
|
||||||
|
$uniqueIdColumn.Header = $uniqueIdHeader
|
||||||
|
}
|
||||||
|
|
||||||
|
# Size Column (index 2 in XAML, now 3)
|
||||||
|
if ($usbDrivesGridView.Columns.Count -gt 3) {
|
||||||
|
$sizeColumn = $usbDrivesGridView.Columns[3]
|
||||||
|
$sizeHeader = New-Object System.Windows.Controls.GridViewColumnHeader
|
||||||
|
$sizeHeader.Content = "Size (GB)"
|
||||||
|
$sizeHeader.Tag = "Size" # Property to sort by
|
||||||
|
$sizeHeader.HorizontalContentAlignment = [System.Windows.HorizontalAlignment]::Left
|
||||||
|
$sizeColumn.Header = $sizeHeader
|
||||||
|
}
|
||||||
|
|
||||||
|
# Add Click event handler for sorting
|
||||||
|
$State.Controls.lstUSBDrives.AddHandler(
|
||||||
|
[System.Windows.Controls.GridViewColumnHeader]::ClickEvent,
|
||||||
|
[System.Windows.RoutedEventHandler] {
|
||||||
|
param($eventSource, $e) # $eventSource is the ListView control
|
||||||
|
$header = $e.OriginalSource
|
||||||
|
if ($header -is [System.Windows.Controls.GridViewColumnHeader] -and $header.Tag) {
|
||||||
|
# Retrieve the main UI state object from the window's Tag property
|
||||||
|
$listViewControl = $eventSource
|
||||||
|
$window = [System.Windows.Window]::GetWindow($listViewControl)
|
||||||
|
$uiStateFromWindowTag = $window.Tag
|
||||||
|
|
||||||
|
Invoke-ListViewSort -listView $eventSource -property $header.Tag -State $uiStateFromWindowTag
|
||||||
|
}
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
# Keep USB drive columns sized to the current visible content.
|
||||||
|
Enable-ListViewColumnAutoResize -ListView $State.Controls.lstUSBDrives -FixedColumnIndexes @(0)
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
WriteLog "Warning: lstUSBDrives.View is not a GridView. Selectable column not added, and sorting cannot be enabled."
|
||||||
|
}
|
||||||
|
|
||||||
|
# Additional FFUs ListView setup
|
||||||
|
$itemStyleAdditionalFFUs = New-Object System.Windows.Style([System.Windows.Controls.ListViewItem])
|
||||||
|
if ($null -ne $listViewItemBaseStyle) { $itemStyleAdditionalFFUs.BasedOn = $listViewItemBaseStyle }
|
||||||
|
$itemStyleAdditionalFFUs.Setters.Add((New-Object System.Windows.Setter([System.Windows.Controls.ListViewItem]::HorizontalContentAlignmentProperty, [System.Windows.HorizontalAlignment]::Stretch)))
|
||||||
|
$State.Controls.lstAdditionalFFUs.ItemContainerStyle = $itemStyleAdditionalFFUs
|
||||||
|
|
||||||
|
if ($State.Controls.lstAdditionalFFUs.View -is [System.Windows.Controls.GridView]) {
|
||||||
|
Add-SelectableGridViewColumn -ListView $State.Controls.lstAdditionalFFUs -State $State -HeaderCheckBoxKeyName "chkSelectAllAdditionalFFUs" -ColumnWidth 70
|
||||||
|
|
||||||
|
$additionalFFUsGridView = $State.Controls.lstAdditionalFFUs.View
|
||||||
|
|
||||||
|
if ($additionalFFUsGridView.Columns.Count -gt 1) {
|
||||||
|
$nameColumn = $additionalFFUsGridView.Columns[1]
|
||||||
|
$nameHeader = New-Object System.Windows.Controls.GridViewColumnHeader
|
||||||
|
$nameHeader.Content = "FFU Name"
|
||||||
|
$nameHeader.Tag = "Name"
|
||||||
|
$nameHeader.HorizontalContentAlignment = [System.Windows.HorizontalAlignment]::Left
|
||||||
|
$nameColumn.Header = $nameHeader
|
||||||
|
}
|
||||||
|
if ($additionalFFUsGridView.Columns.Count -gt 2) {
|
||||||
|
$lastModColumn = $additionalFFUsGridView.Columns[2]
|
||||||
|
$lastModHeader = New-Object System.Windows.Controls.GridViewColumnHeader
|
||||||
|
$lastModHeader.Content = "Last Modified"
|
||||||
|
$lastModHeader.Tag = "LastModified"
|
||||||
|
$lastModHeader.HorizontalContentAlignment = [System.Windows.HorizontalAlignment]::Left
|
||||||
|
$lastModColumn.Header = $lastModHeader
|
||||||
|
}
|
||||||
|
|
||||||
|
$State.Controls.lstAdditionalFFUs.AddHandler(
|
||||||
|
[System.Windows.Controls.GridViewColumnHeader]::ClickEvent,
|
||||||
|
[System.Windows.RoutedEventHandler] {
|
||||||
|
param($eventSource, $e)
|
||||||
|
$header = $e.OriginalSource
|
||||||
|
if ($header -is [System.Windows.Controls.GridViewColumnHeader] -and $header.Tag) {
|
||||||
|
$listViewControl = $eventSource
|
||||||
|
$window = [System.Windows.Window]::GetWindow($listViewControl)
|
||||||
|
$uiStateFromWindowTag = $window.Tag
|
||||||
|
Invoke-ListViewSort -listView $eventSource -property $header.Tag -State $uiStateFromWindowTag
|
||||||
|
}
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
# Keep additional FFU columns sized to the current visible content.
|
||||||
|
Enable-ListViewColumnAutoResize -ListView $State.Controls.lstAdditionalFFUs -FixedColumnIndexes @(0)
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
WriteLog "Warning: lstAdditionalFFUs.View is not a GridView. Selectable column not added, and sorting cannot be enabled."
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
Export-ModuleMember -Function *
|
||||||
@@ -0,0 +1,687 @@
|
|||||||
|
<#
|
||||||
|
.SYNOPSIS
|
||||||
|
Manages the business logic for the 'Windows Settings' tab in the FFU Builder UI.
|
||||||
|
.DESCRIPTION
|
||||||
|
This module contains all the functions and data required to populate and manage the controls on the 'Windows Settings' tab. It handles dynamic updates for Windows Release, Version, SKU, and Architecture ComboBoxes based on user input, such as specifying an ISO path. It also includes logic for populating available languages, media types, and the grid of optional Windows features.
|
||||||
|
#>
|
||||||
|
|
||||||
|
# --------------------------------------------------------------------------
|
||||||
|
# SECTION: Module Variables (Static Data)
|
||||||
|
# --------------------------------------------------------------------------
|
||||||
|
|
||||||
|
$script:allowedFeatures = @(
|
||||||
|
"AppServerClient", "Client-DeviceLockdown", "Client-EmbeddedBootExp", "Client-EmbeddedLogon",
|
||||||
|
"Client-EmbeddedShellLauncher", "Client-KeyboardFilter", "Client-ProjFS", "Client-UnifiedWriteFilter",
|
||||||
|
"Containers", "Containers-DisposableClientVM", "Containers-HNS", "Containers-SDN", "DataCenterBridging",
|
||||||
|
"DirectoryServices-ADAM-Client", "DirectPlay", "HostGuardian", "HypervisorPlatform", "IIS-ApplicationDevelopment",
|
||||||
|
"IIS-ApplicationInit", "IIS-ASP", "IIS-ASPNET45", "IIS-BasicAuthentication", "IIS-CertProvider",
|
||||||
|
"IIS-CGI", "IIS-ClientCertificateMappingAuthentication", "IIS-CommonHttpFeatures", "IIS-CustomLogging",
|
||||||
|
"IIS-DefaultDocument", "IIS-DirectoryBrowsing", "IIS-DigestAuthentication", "IIS-ESP", "IIS-FTPServer",
|
||||||
|
"IIS-FTPExtensibility", "IIS-FTPSvc", "IIS-HealthAndDiagnostics", "IIS-HostableWebCore", "IIS-HttpCompressionDynamic",
|
||||||
|
"IIS-HttpCompressionStatic", "IIS-HttpErrors", "IIS-HttpLogging", "IIS-HttpRedirect", "IIS-HttpTracing",
|
||||||
|
"IIS-IPSecurity", "IIS-IIS6ManagementCompatibility", "IIS-IISCertificateMappingAuthentication",
|
||||||
|
"IIS-ISAPIExtensions", "IIS-ISAPIFilter", "IIS-LoggingLibraries", "IIS-ManagementConsole", "IIS-ManagementService",
|
||||||
|
"IIS-ManagementScriptingTools", "IIS-Metabase", "IIS-NetFxExtensibility", "IIS-NetFxExtensibility45",
|
||||||
|
"IIS-ODBCLogging", "IIS-Performance", "IIS-RequestFiltering", "IIS-RequestMonitor", "IIS-Security", "IIS-ServerSideIncludes",
|
||||||
|
"IIS-StaticContent", "IIS-URLAuthorization", "IIS-WebDAV", "IIS-WebServer", "IIS-WebServerManagementTools",
|
||||||
|
"IIS-WebServerRole", "IIS-WebSockets", "LegacyComponents", "MediaPlayback", "Microsoft-Hyper-V", "Microsoft-Hyper-V-All",
|
||||||
|
"Microsoft-Hyper-V-Hypervisor", "Microsoft-Hyper-V-Management-Clients", "Microsoft-Hyper-V-Management-PowerShell",
|
||||||
|
"Microsoft-Hyper-V-Services", "Microsoft-Windows-Subsystem-Linux", "MSMQ-ADIntegration", "MSMQ-Container", "MSMQ-DCOMProxy",
|
||||||
|
"MSMQ-HTTP", "MSMQ-Multicast", "MSMQ-Server", "MSMQ-Triggers", "MultiPoint-Connector", "MultiPoint-Connector-Services",
|
||||||
|
"MultiPoint-Tools", "NetFx3", "NetFx4-AdvSrvs", "NetFx4Extended-ASPNET45", "NFS-Administration", "Printing-Foundation-Features",
|
||||||
|
"Printing-Foundation-InternetPrinting-Client", "Printing-Foundation-LPDPrintService", "Printing-Foundation-LPRPortMonitor",
|
||||||
|
"Printing-PrintToPDFServices-Features", "Printing-XPSServices-Features", "SearchEngine-Client-Package",
|
||||||
|
"ServicesForNFS-ClientOnly", "SimpleTCP", "SMB1Protocol", "SMB1Protocol-Client", "SMB1Protocol-Deprecation",
|
||||||
|
"SMB1Protocol-Server", "SmbDirect", "TFTP", "TelnetClient", "TIFFIFilter", "VirtualMachinePlatform", "WAS-ConfigurationAPI",
|
||||||
|
"WAS-NetFxEnvironment", "WAS-ProcessModel", "WAS-WindowsActivationService", "WCF-HTTP-Activation", "WCF-HTTP-Activation45",
|
||||||
|
"WCF-MSMQ-Activation45", "WCF-MSMQ-Activation", "WCF-NonHTTP-Activation", "WCF-Pipe-Activation45", "WCF-Services45",
|
||||||
|
"WCF-TCP-Activation45", "WCF-TCP-PortSharing45", "Windows-Defender-ApplicationGuard",
|
||||||
|
"Windows-Defender-Default-Definitions", "Windows-Identity-Foundation", "WindowsMediaPlayer", "WorkFolders-Client"
|
||||||
|
)
|
||||||
|
|
||||||
|
$script:skuList = @(
|
||||||
|
'Home',
|
||||||
|
'Home N',
|
||||||
|
'Home Single Language',
|
||||||
|
'Education',
|
||||||
|
'Education N',
|
||||||
|
'Pro',
|
||||||
|
'Pro N',
|
||||||
|
'Pro Education',
|
||||||
|
'Pro Education N',
|
||||||
|
'Pro for Workstations',
|
||||||
|
'Pro N for Workstations',
|
||||||
|
'Enterprise',
|
||||||
|
'Enterprise N',
|
||||||
|
'Enterprise 2016 LTSB',
|
||||||
|
'Enterprise N 2016 LTSB',
|
||||||
|
'Enterprise LTSC',
|
||||||
|
'Enterprise N LTSC',
|
||||||
|
'IoT Enterprise LTSC',
|
||||||
|
'IoT Enterprise N LTSC',
|
||||||
|
'Standard',
|
||||||
|
'Standard (Desktop Experience)',
|
||||||
|
'Datacenter',
|
||||||
|
'Datacenter (Desktop Experience)'
|
||||||
|
)
|
||||||
|
|
||||||
|
$script:allowedLangs = @(
|
||||||
|
'ar-sa',
|
||||||
|
'bg-bg',
|
||||||
|
'cs-cz',
|
||||||
|
'da-dk',
|
||||||
|
'de-de',
|
||||||
|
'el-gr',
|
||||||
|
'en-gb',
|
||||||
|
'en-us',
|
||||||
|
'es-es',
|
||||||
|
'es-mx',
|
||||||
|
'et-ee',
|
||||||
|
'fi-fi',
|
||||||
|
'fr-ca',
|
||||||
|
'fr-fr',
|
||||||
|
'he-il',
|
||||||
|
'hr-hr',
|
||||||
|
'hu-hu',
|
||||||
|
'it-it',
|
||||||
|
'ja-jp',
|
||||||
|
'ko-kr',
|
||||||
|
'lt-lt',
|
||||||
|
'lv-lv',
|
||||||
|
'nb-no',
|
||||||
|
'nl-nl',
|
||||||
|
'pl-pl',
|
||||||
|
'pt-br',
|
||||||
|
'pt-pt',
|
||||||
|
'ro-ro',
|
||||||
|
'ru-ru',
|
||||||
|
'sk-sk',
|
||||||
|
'sl-si',
|
||||||
|
'sr-latn-rs',
|
||||||
|
'sv-se',
|
||||||
|
'th-th',
|
||||||
|
'tr-tr',
|
||||||
|
'uk-ua',
|
||||||
|
'zh-cn',
|
||||||
|
'zh-tw'
|
||||||
|
)
|
||||||
|
|
||||||
|
$script:allWindowsReleases = @(
|
||||||
|
[PSCustomObject]@{ Display = "Windows 10"; Value = 10 },
|
||||||
|
[PSCustomObject]@{ Display = "Windows 11"; Value = 11 },
|
||||||
|
[PSCustomObject]@{ Display = "Windows Server 2016"; Value = 2016 },
|
||||||
|
[PSCustomObject]@{ Display = "Windows Server 2019"; Value = 2019 },
|
||||||
|
[PSCustomObject]@{ Display = "Windows Server 2022"; Value = 2022 },
|
||||||
|
[PSCustomObject]@{ Display = "Windows Server 2025"; Value = 2025 },
|
||||||
|
[PSCustomObject]@{ Display = "Windows 10 LTSB 2016"; Value = 2016 }, # Changed Value from 1607
|
||||||
|
[PSCustomObject]@{ Display = "Windows 10 LTSC 2019"; Value = 2019 }, # Changed Value from 1809
|
||||||
|
[PSCustomObject]@{ Display = "Windows 10 LTSC 2021"; Value = 2021 },
|
||||||
|
[PSCustomObject]@{ Display = "Windows 11 LTSC 2024"; Value = 2024 }
|
||||||
|
)
|
||||||
|
|
||||||
|
$script:mctWindowsReleases = @(
|
||||||
|
[PSCustomObject]@{ Display = "Windows 10"; Value = 10 },
|
||||||
|
[PSCustomObject]@{ Display = "Windows 11"; Value = 11 }
|
||||||
|
)
|
||||||
|
|
||||||
|
$script:windowsVersionMap = @{
|
||||||
|
10 = @("22H2")
|
||||||
|
11 = @("25H2", "24H2", "23H2", "22H2")
|
||||||
|
2016 = @("1607") # Windows 10 LTSB 2016 & Server 2016
|
||||||
|
2019 = @("1809") # Windows 10 LTSC 2019 & Server 2019
|
||||||
|
# Note: Server 2016 and LTSB 2016 now share the key 2016, mapping to version "1607"
|
||||||
|
# Note: Server 2019 and LTSC 2019 now share the key 2019, mapping to version "1809"
|
||||||
|
2021 = @("21H2") # LTSC 2021
|
||||||
|
2022 = @("21H2") # Server 2022
|
||||||
|
2024 = @("24H2") # LTSC 2024
|
||||||
|
2025 = @("24H2") # Server 2025
|
||||||
|
}
|
||||||
|
|
||||||
|
# SKU Groups
|
||||||
|
$script:clientSKUs = @(
|
||||||
|
'Home',
|
||||||
|
'Home N',
|
||||||
|
'Home Single Language',
|
||||||
|
'Education',
|
||||||
|
'Education N',
|
||||||
|
'Pro',
|
||||||
|
'Pro N',
|
||||||
|
'Pro Education',
|
||||||
|
'Pro Education N',
|
||||||
|
'Pro for Workstations',
|
||||||
|
'Pro N for Workstations',
|
||||||
|
'Enterprise',
|
||||||
|
'Enterprise N'
|
||||||
|
)
|
||||||
|
|
||||||
|
$script:serverSKUs = @(
|
||||||
|
'Standard',
|
||||||
|
'Standard (Desktop Experience)',
|
||||||
|
'Datacenter',
|
||||||
|
'Datacenter (Desktop Experience)'
|
||||||
|
)
|
||||||
|
|
||||||
|
$script:ltsc2016SKUs = @(
|
||||||
|
'Enterprise 2016 LTSB',
|
||||||
|
'Enterprise N 2016 LTSB'
|
||||||
|
)
|
||||||
|
|
||||||
|
$script:ltscGenericSKUs = @( # For LTSC 2019, 2021, 2024
|
||||||
|
'Enterprise LTSC',
|
||||||
|
'Enterprise N LTSC'
|
||||||
|
)
|
||||||
|
|
||||||
|
$script:iotLtscSKUs = @(
|
||||||
|
'IoT Enterprise LTSC',
|
||||||
|
'IoT Enterprise N LTSC'
|
||||||
|
)
|
||||||
|
|
||||||
|
# Map Windows Release Values to their corresponding SKU lists
|
||||||
|
$script:windowsReleaseSkuMap = @{
|
||||||
|
10 = $script:clientSKUs # Windows 10 Client
|
||||||
|
11 = $script:clientSKUs # Windows 11 Client
|
||||||
|
2016 = $script:serverSKUs # Windows Server 2016 (LTSB 2016 handled by Get-AvailableSkusForRelease)
|
||||||
|
2019 = $script:serverSKUs # Windows Server 2019 (LTSC 2019 handled by Get-AvailableSkusForRelease)
|
||||||
|
2022 = $script:serverSKUs # Windows Server 2022
|
||||||
|
2025 = $script:serverSKUs # Windows Server 2025
|
||||||
|
2021 = $script:ltscGenericSKUs + $script:iotLtscSKUs # Windows 10 LTSC 2021
|
||||||
|
2024 = $script:ltscGenericSKUs + $script:iotLtscSKUs # Windows 10 LTSC 2024
|
||||||
|
# Note: LTSC 2016 and LTSC 2019 SKUs are now conditionally returned by Get-AvailableSkusForRelease
|
||||||
|
}
|
||||||
|
|
||||||
|
# --------------------------------------------------------------------------
|
||||||
|
# SECTION: Functions
|
||||||
|
# --------------------------------------------------------------------------
|
||||||
|
|
||||||
|
# Function to return the default settings and static lists
|
||||||
|
function Get-WindowsSettingsDefaults {
|
||||||
|
[CmdletBinding()]
|
||||||
|
param()
|
||||||
|
|
||||||
|
return [PSCustomObject]@{
|
||||||
|
DefaultISOPath = ""
|
||||||
|
DefaultWindowsArch = "x64"
|
||||||
|
DefaultWindowsLang = "en-us"
|
||||||
|
DefaultWindowsSKU = "Pro"
|
||||||
|
DefaultMediaType = "Consumer"
|
||||||
|
DefaultOptionalFeatures = ""
|
||||||
|
DefaultProductKey = ""
|
||||||
|
AllowedFeatures = $script:allowedFeatures
|
||||||
|
AllowedLanguages = $script:allowedLangs
|
||||||
|
AllowedArchitectures = @('x86', 'x64', 'arm64')
|
||||||
|
AllowedMediaTypes = @('Consumer', 'Business')
|
||||||
|
SkuList = $script:skuList
|
||||||
|
AllWindowsReleases = $script:allWindowsReleases
|
||||||
|
MctWindowsReleases = $script:mctWindowsReleases
|
||||||
|
WindowsVersionMap = $script:windowsVersionMap
|
||||||
|
ClientSKUs = $script:clientSKUs
|
||||||
|
ServerSKUs = $script:serverSKUs
|
||||||
|
Ltsc2016SKUs = $script:ltsc2016SKUs
|
||||||
|
LtscGenericSKUs = $script:ltscGenericSKUs
|
||||||
|
IotLtscSKUs = $script:iotLtscSKUs
|
||||||
|
WindowsReleaseSkuMap = $script:windowsReleaseSkuMap
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# Function to get the appropriate list of Windows Releases based on ISO path
|
||||||
|
function Get-AvailableWindowsReleases {
|
||||||
|
[CmdletBinding()]
|
||||||
|
param(
|
||||||
|
[string]$IsoPath,
|
||||||
|
[Parameter(Mandatory = $true)]
|
||||||
|
[psobject]$State
|
||||||
|
)
|
||||||
|
|
||||||
|
if (-not [string]::IsNullOrEmpty($IsoPath) -and $IsoPath.EndsWith('.iso', [System.StringComparison]::OrdinalIgnoreCase)) {
|
||||||
|
return $State.Defaults.WindowsSettingsDefaults.AllWindowsReleases
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
return $State.Defaults.WindowsSettingsDefaults.MctWindowsReleases
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# Function to get available Windows Versions for a given release and ISO path
|
||||||
|
function Get-AvailableWindowsVersions {
|
||||||
|
[CmdletBinding()]
|
||||||
|
param(
|
||||||
|
[Parameter(Mandatory)]
|
||||||
|
[int]$SelectedRelease,
|
||||||
|
|
||||||
|
[string]$IsoPath,
|
||||||
|
[Parameter(Mandatory = $true)]
|
||||||
|
[psobject]$State
|
||||||
|
)
|
||||||
|
|
||||||
|
$result = [PSCustomObject]@{
|
||||||
|
Versions = @()
|
||||||
|
DefaultVersion = $null
|
||||||
|
IsEnabled = $false
|
||||||
|
}
|
||||||
|
|
||||||
|
if (-not $State.Defaults.WindowsSettingsDefaults.WindowsVersionMap.ContainsKey($SelectedRelease)) {
|
||||||
|
return $result
|
||||||
|
}
|
||||||
|
|
||||||
|
$validVersions = $State.Defaults.WindowsSettingsDefaults.WindowsVersionMap[$SelectedRelease]
|
||||||
|
|
||||||
|
if (-not [string]::IsNullOrEmpty($IsoPath) -and $IsoPath.EndsWith('.iso', [System.StringComparison]::OrdinalIgnoreCase)) {
|
||||||
|
# Logic for when an ISO is specified
|
||||||
|
$result.Versions = $validVersions
|
||||||
|
# Set default selection logic (e.g., latest for Win11)
|
||||||
|
if ($SelectedRelease -eq 11) {
|
||||||
|
if ($validVersions -contains "25H2") {
|
||||||
|
$result.DefaultVersion = "25H2"
|
||||||
|
}
|
||||||
|
elseif ($validVersions -contains "24H2") {
|
||||||
|
$result.DefaultVersion = "24H2"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if (-not $result.DefaultVersion -and $validVersions.Count -gt 0) {
|
||||||
|
$result.DefaultVersion = $validVersions[0]
|
||||||
|
}
|
||||||
|
$result.IsEnabled = $true
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
# Logic for when no ISO is specified (MCT scenario)
|
||||||
|
switch ($SelectedRelease) {
|
||||||
|
10 { $result.DefaultVersion = "22H2" }
|
||||||
|
11 { $result.DefaultVersion = "25H2" }
|
||||||
|
# Server versions typically require an ISO, but handle just in case
|
||||||
|
2016 { $result.DefaultVersion = "1607" }
|
||||||
|
2019 { $result.DefaultVersion = "1809" }
|
||||||
|
2022 { $result.DefaultVersion = "21H2" }
|
||||||
|
2025 { $result.DefaultVersion = "24H2" }
|
||||||
|
default {
|
||||||
|
if ($validVersions.Count -gt 0) { $result.DefaultVersion = $validVersions[0] }
|
||||||
|
}
|
||||||
|
}
|
||||||
|
$result.Versions = @($result.DefaultVersion) # Only the default is available/relevant
|
||||||
|
$result.IsEnabled = $false # Combo should be disabled
|
||||||
|
}
|
||||||
|
|
||||||
|
return $result
|
||||||
|
}
|
||||||
|
|
||||||
|
# Function to get available SKUs for a given Windows Release value and display name
|
||||||
|
function Get-AvailableSkusForRelease {
|
||||||
|
[CmdletBinding()]
|
||||||
|
param(
|
||||||
|
[Parameter(Mandatory)]
|
||||||
|
[int]$SelectedReleaseValue,
|
||||||
|
|
||||||
|
[Parameter(Mandatory)]
|
||||||
|
[string]$SelectedReleaseDisplayName,
|
||||||
|
[Parameter(Mandatory = $true)]
|
||||||
|
[psobject]$State
|
||||||
|
)
|
||||||
|
|
||||||
|
WriteLog "Get-AvailableSkusForRelease: Getting SKUs for Release Value '$SelectedReleaseValue', Display Name '$SelectedReleaseDisplayName'."
|
||||||
|
|
||||||
|
# Handle LTSC 2016 specifically
|
||||||
|
if ($SelectedReleaseValue -eq 2016 -and $SelectedReleaseDisplayName -like '*LTSB*') {
|
||||||
|
WriteLog "Get-AvailableSkusForRelease: Matched LTSB 2016. Returning LTSC 2016 SKUs."
|
||||||
|
return $State.Defaults.WindowsSettingsDefaults.Ltsc2016SKUs
|
||||||
|
}
|
||||||
|
# Handle LTSC 2019 specifically
|
||||||
|
# Ensure "Server" is not in the display name to avoid matching "Windows Server 2019"
|
||||||
|
elseif ($SelectedReleaseValue -eq 2019 -and $SelectedReleaseDisplayName -like '*LTSC*' -and $SelectedReleaseDisplayName -notlike '*Server*') {
|
||||||
|
WriteLog "Get-AvailableSkusForRelease: Matched LTSC 2019. Returning generic LTSC SKUs (including IoT)."
|
||||||
|
# Assuming LTSC 2019 uses the generic LTSC SKUs + IoT LTSC SKUs
|
||||||
|
return ($State.Defaults.WindowsSettingsDefaults.LtscGenericSKUs + $State.Defaults.WindowsSettingsDefaults.IotLtscSKUs | Select-Object -Unique)
|
||||||
|
}
|
||||||
|
# For all other cases, use the main SKU map
|
||||||
|
elseif ($State.Defaults.WindowsSettingsDefaults.WindowsReleaseSkuMap.ContainsKey($SelectedReleaseValue)) {
|
||||||
|
$availableSkus = $State.Defaults.WindowsSettingsDefaults.WindowsReleaseSkuMap[$SelectedReleaseValue]
|
||||||
|
WriteLog "Get-AvailableSkusForRelease: Found $($availableSkus.Count) SKUs for Release '$SelectedReleaseValue' using standard map."
|
||||||
|
return $availableSkus
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
WriteLog "Get-AvailableSkusForRelease: Warning - Release Value '$SelectedReleaseValue' not found in SKU map. Returning default client SKUs."
|
||||||
|
# Fallback to a default list (e.g., client SKUs) or an empty list
|
||||||
|
return $State.Defaults.WindowsSettingsDefaults.ClientSKUs
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# Function to refresh the Windows Release ComboBox based on ISO path
|
||||||
|
function Update-WindowsReleaseCombo {
|
||||||
|
param(
|
||||||
|
[string]$isoPath,
|
||||||
|
[Parameter(Mandatory = $true)]
|
||||||
|
[psobject]$State
|
||||||
|
)
|
||||||
|
|
||||||
|
if (-not $State.Controls.cmbWindowsRelease) { return }
|
||||||
|
|
||||||
|
$oldSelectedItemValue = $null
|
||||||
|
if ($null -ne $State.Controls.cmbWindowsRelease.SelectedItem) {
|
||||||
|
$oldSelectedItemValue = $State.Controls.cmbWindowsRelease.SelectedItem.Value
|
||||||
|
}
|
||||||
|
|
||||||
|
# Get the appropriate list of releases from the helper module
|
||||||
|
$availableReleases = Get-AvailableWindowsReleases -IsoPath $isoPath -State $State
|
||||||
|
|
||||||
|
# Update the ComboBox ItemsSource
|
||||||
|
$State.Controls.cmbWindowsRelease.ItemsSource = $availableReleases
|
||||||
|
$State.Controls.cmbWindowsRelease.DisplayMemberPath = 'Display'
|
||||||
|
$State.Controls.cmbWindowsRelease.SelectedValuePath = 'Value'
|
||||||
|
|
||||||
|
# Try to re-select the previously selected item, or default
|
||||||
|
$itemToSelect = $availableReleases | Where-Object { $_.Value -eq $oldSelectedItemValue } | Select-Object -First 1
|
||||||
|
if ($null -ne $itemToSelect) {
|
||||||
|
$State.Controls.cmbWindowsRelease.SelectedItem = $itemToSelect
|
||||||
|
}
|
||||||
|
elseif ($availableReleases.Count -gt 0) {
|
||||||
|
# Default to Windows 11 if available, otherwise the first item
|
||||||
|
$defaultItem = $availableReleases | Where-Object { $_.Value -eq 11 } | Select-Object -First 1
|
||||||
|
if ($null -eq $defaultItem) {
|
||||||
|
$defaultItem = $availableReleases[0]
|
||||||
|
}
|
||||||
|
$State.Controls.cmbWindowsRelease.SelectedItem = $defaultItem
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
# No items available (should not happen with current logic)
|
||||||
|
$State.Controls.cmbWindowsRelease.SelectedIndex = -1
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# Function to refresh the Windows Version ComboBox based on selected release and ISO path
|
||||||
|
function Update-WindowsVersionCombo {
|
||||||
|
param(
|
||||||
|
[int]$selectedRelease,
|
||||||
|
[string]$isoPath,
|
||||||
|
[Parameter(Mandatory = $true)]
|
||||||
|
[psobject]$State
|
||||||
|
)
|
||||||
|
|
||||||
|
$combo = $State.Controls.cmbWindowsVersion
|
||||||
|
if (-not $combo) { return }
|
||||||
|
|
||||||
|
# Get available versions and default from the helper module
|
||||||
|
$versionData = Get-AvailableWindowsVersions -SelectedRelease $selectedRelease -IsoPath $isoPath -State $State
|
||||||
|
|
||||||
|
# Update the ComboBox ItemsSource and IsEnabled state
|
||||||
|
$combo.ItemsSource = $versionData.Versions
|
||||||
|
$combo.IsEnabled = $versionData.IsEnabled
|
||||||
|
|
||||||
|
# Set the selected item
|
||||||
|
if ($null -ne $versionData.DefaultVersion -and $versionData.Versions -contains $versionData.DefaultVersion) {
|
||||||
|
$combo.SelectedItem = $versionData.DefaultVersion
|
||||||
|
}
|
||||||
|
elseif ($versionData.Versions.Count -gt 0) {
|
||||||
|
$combo.SelectedIndex = 0
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
$combo.SelectedIndex = -1 # No items available
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# Function to refresh the Windows SKU ComboBox based on selected release
|
||||||
|
function Update-WindowsSkuCombo {
|
||||||
|
param(
|
||||||
|
[Parameter(Mandatory = $true)]
|
||||||
|
[psobject]$State
|
||||||
|
)
|
||||||
|
|
||||||
|
$skuCombo = $State.Controls.cmbWindowsSKU
|
||||||
|
if (-not $skuCombo) {
|
||||||
|
WriteLog "Update-WindowsSkuCombo: SKU ComboBox not found."
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
$releaseCombo = $State.Controls.cmbWindowsRelease
|
||||||
|
if (-not $releaseCombo -or $null -eq $releaseCombo.SelectedItem) {
|
||||||
|
WriteLog "Update-WindowsSkuCombo: Windows Release ComboBox not found or no item selected. Cannot update SKUs."
|
||||||
|
$skuCombo.ItemsSource = @() # Clear SKUs
|
||||||
|
$skuCombo.SelectedIndex = -1
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
$selectedReleaseItem = $releaseCombo.SelectedItem
|
||||||
|
$selectedReleaseValue = $selectedReleaseItem.Value
|
||||||
|
$selectedReleaseDisplayName = $selectedReleaseItem.Display
|
||||||
|
|
||||||
|
$previousSelectedSku = $null
|
||||||
|
if ($null -ne $skuCombo.SelectedItem) {
|
||||||
|
$previousSelectedSku = $skuCombo.SelectedItem
|
||||||
|
}
|
||||||
|
|
||||||
|
WriteLog "Update-WindowsSkuCombo: Updating SKUs for Release Value '$selectedReleaseValue' (Display: '$selectedReleaseDisplayName')."
|
||||||
|
# Call Get-AvailableSkusForRelease with both Value and DisplayName
|
||||||
|
$availableSkus = Get-AvailableSkusForRelease -SelectedReleaseValue $selectedReleaseValue -SelectedReleaseDisplayName $selectedReleaseDisplayName -State $State
|
||||||
|
|
||||||
|
$skuCombo.ItemsSource = $availableSkus
|
||||||
|
WriteLog "Update-WindowsSkuCombo: Set ItemsSource with $($availableSkus.Count) SKUs."
|
||||||
|
|
||||||
|
# Attempt to re-select the previous SKU, or "Pro", or the first available
|
||||||
|
if ($null -ne $previousSelectedSku -and $availableSkus -contains $previousSelectedSku) {
|
||||||
|
$skuCombo.SelectedItem = $previousSelectedSku
|
||||||
|
WriteLog "Update-WindowsSkuCombo: Re-selected previous SKU '$previousSelectedSku'."
|
||||||
|
}
|
||||||
|
elseif ($availableSkus -contains "Pro") {
|
||||||
|
$skuCombo.SelectedItem = "Pro"
|
||||||
|
WriteLog "Update-WindowsSkuCombo: Selected default SKU 'Pro'."
|
||||||
|
}
|
||||||
|
elseif ($availableSkus.Count -gt 0) {
|
||||||
|
$skuCombo.SelectedIndex = 0
|
||||||
|
WriteLog "Update-WindowsSkuCombo: Selected first available SKU '$($skuCombo.SelectedItem)'."
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
$skuCombo.SelectedIndex = -1 # No SKUs available
|
||||||
|
WriteLog "Update-WindowsSkuCombo: No SKUs available for Release '$selectedReleaseValue' (Display: '$selectedReleaseDisplayName')."
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# Function to refresh the Windows Architecture ComboBox based on selected release, version, and SKU
|
||||||
|
function Update-WindowsArchCombo {
|
||||||
|
param(
|
||||||
|
[Parameter(Mandatory = $true)]
|
||||||
|
[psobject]$State
|
||||||
|
)
|
||||||
|
|
||||||
|
$archCombo = $State.Controls.cmbWindowsArch
|
||||||
|
if (-not $archCombo) {
|
||||||
|
WriteLog "Update-WindowsArchCombo: Architecture ComboBox not found."
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
$previousSelectedArch = $archCombo.SelectedItem
|
||||||
|
|
||||||
|
# Start with a safe, common default
|
||||||
|
$availableArchitectures = @('x64')
|
||||||
|
|
||||||
|
$releaseItem = $State.Controls.cmbWindowsRelease.SelectedItem
|
||||||
|
$versionItem = $State.Controls.cmbWindowsVersion.SelectedItem
|
||||||
|
$skuItem = $State.Controls.cmbWindowsSKU.SelectedItem
|
||||||
|
|
||||||
|
if ($null -eq $releaseItem) {
|
||||||
|
WriteLog "Update-WindowsArchCombo: No release selected. Defaulting to x64."
|
||||||
|
$archCombo.ItemsSource = $availableArchitectures
|
||||||
|
$archCombo.SelectedItem = 'x64'
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
$releaseDisplay = $releaseItem.Display
|
||||||
|
$versionValue = if ($null -ne $versionItem) { $versionItem } else { "" }
|
||||||
|
$skuValue = if ($null -ne $skuItem) { $skuItem } else { "" }
|
||||||
|
|
||||||
|
if ($releaseDisplay -like 'Windows Server*') {
|
||||||
|
# All servers are x64 only
|
||||||
|
$availableArchitectures = @('x64')
|
||||||
|
}
|
||||||
|
elseif ($releaseDisplay -like 'Windows 11*') {
|
||||||
|
if ($releaseDisplay -like '*LTSC*') {
|
||||||
|
# Windows 11 LTSC 2024
|
||||||
|
if ($skuValue -like 'IoT*') {
|
||||||
|
$availableArchitectures = @('x64', 'arm64')
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
$availableArchitectures = @('x64')
|
||||||
|
}
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
# Standard Windows 11
|
||||||
|
if ($versionValue -in @('24H2', '25H2')) {
|
||||||
|
$availableArchitectures = @('x64', 'arm64')
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
# 22H2, 23H2
|
||||||
|
$availableArchitectures = @('x64')
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
elseif ($releaseDisplay -like 'Windows 10*') {
|
||||||
|
if ($releaseDisplay -like '*LTSB*' -or $releaseDisplay -like '*LTSC*') {
|
||||||
|
# Windows 10 LTSB 2016, LTSC 2019, LTSC 2021
|
||||||
|
if ($releaseDisplay -like '*2021*' -and $skuValue -like 'IoT*') {
|
||||||
|
$availableArchitectures = @('x64', 'arm64')
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
# LTSB 2016, LTSC 2019, LTSC 2021 (non-IoT)
|
||||||
|
$availableArchitectures = @('x86', 'x64')
|
||||||
|
}
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
# Standard Windows 10 (22H2)
|
||||||
|
$availableArchitectures = @('x86', 'x64')
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
$archCombo.ItemsSource = $availableArchitectures
|
||||||
|
|
||||||
|
if ($availableArchitectures -contains $previousSelectedArch) {
|
||||||
|
$archCombo.SelectedItem = $previousSelectedArch
|
||||||
|
}
|
||||||
|
elseif ($availableArchitectures -contains 'x64') {
|
||||||
|
$archCombo.SelectedItem = 'x64'
|
||||||
|
}
|
||||||
|
elseif ($availableArchitectures.Count -gt 0) {
|
||||||
|
$archCombo.SelectedIndex = 0
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
$archCombo.SelectedIndex = -1
|
||||||
|
}
|
||||||
|
WriteLog "Update-WindowsArchCombo: Updated available architectures to ($($availableArchitectures -join ', ')). Selected: $($archCombo.SelectedItem)"
|
||||||
|
}
|
||||||
|
|
||||||
|
# Combined function to initialize the Release, Version, and SKU combos
|
||||||
|
function Get-WindowsSettingsCombos {
|
||||||
|
param(
|
||||||
|
[string]$isoPath,
|
||||||
|
[Parameter(Mandatory = $true)]
|
||||||
|
[psobject]$State
|
||||||
|
)
|
||||||
|
|
||||||
|
# Determine visibility for download-specific controls based on ISO path
|
||||||
|
$visibility = if (-not [string]::IsNullOrEmpty($isoPath) -and $isoPath.EndsWith('.iso', [System.StringComparison]::OrdinalIgnoreCase)) {
|
||||||
|
'Collapsed'
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
'Visible'
|
||||||
|
}
|
||||||
|
|
||||||
|
# Set visibility for Language and Media Type controls
|
||||||
|
$State.Controls.WindowsLangStackPanel.Visibility = $visibility
|
||||||
|
$State.Controls.cmbWindowsLang.Visibility = $visibility
|
||||||
|
$State.Controls.MediaTypeStackPanel.Visibility = $visibility
|
||||||
|
$State.Controls.cmbMediaType.Visibility = $visibility
|
||||||
|
|
||||||
|
# Update Release combo first
|
||||||
|
Update-WindowsReleaseCombo -isoPath $isoPath -State $State
|
||||||
|
|
||||||
|
# Get the newly selected release value
|
||||||
|
$selectedReleaseValue = 11 # Default to 11 if selection is null
|
||||||
|
if ($null -ne $State.Controls.cmbWindowsRelease.SelectedItem) {
|
||||||
|
$selectedReleaseValue = $State.Controls.cmbWindowsRelease.SelectedItem.Value
|
||||||
|
}
|
||||||
|
|
||||||
|
# Update Version combo based on the selected release
|
||||||
|
Update-WindowsVersionCombo -selectedRelease $selectedReleaseValue -isoPath $isoPath -State $State
|
||||||
|
|
||||||
|
# Update SKU combo based on the selected release (now derives values internally)
|
||||||
|
Update-WindowsSkuCombo -State $State
|
||||||
|
|
||||||
|
# Finally, update the Architecture combo to match the initial state
|
||||||
|
Update-WindowsArchCombo -State $State
|
||||||
|
}
|
||||||
|
|
||||||
|
# Dynamic checkboxes for optional features in Windows Settings tab
|
||||||
|
function UpdateOptionalFeaturesString {
|
||||||
|
param(
|
||||||
|
[psobject]$State
|
||||||
|
)
|
||||||
|
$checkedFeatures = @()
|
||||||
|
foreach ($entry in $State.Controls.featureCheckBoxes.GetEnumerator()) {
|
||||||
|
if ($entry.Value.IsChecked) { $checkedFeatures += $entry.Key }
|
||||||
|
}
|
||||||
|
}
|
||||||
|
function BuildFeaturesGrid {
|
||||||
|
param (
|
||||||
|
[Parameter(Mandatory)]
|
||||||
|
[System.Windows.FrameworkElement]$parent,
|
||||||
|
[Parameter(Mandatory)]
|
||||||
|
[array]$allowedFeatures, # Pass the list of features explicitly
|
||||||
|
[Parameter(Mandatory = $true)]
|
||||||
|
[psobject]$State
|
||||||
|
)
|
||||||
|
$parent.Children.Clear()
|
||||||
|
$State.Controls.featureCheckBoxes.Clear() # Clear the tracking hashtable
|
||||||
|
|
||||||
|
$sortedFeatures = $allowedFeatures | Sort-Object
|
||||||
|
$rows = 10 # Define number of rows for layout
|
||||||
|
$columns = [math]::Ceiling($sortedFeatures.Count / $rows)
|
||||||
|
|
||||||
|
$featuresGrid = New-Object System.Windows.Controls.Grid
|
||||||
|
$featuresGrid.Margin = "0,5,0,5"
|
||||||
|
$featuresGrid.ShowGridLines = $false
|
||||||
|
|
||||||
|
# Define grid rows
|
||||||
|
for ($r = 0; $r -lt $rows; $r++) {
|
||||||
|
$rowDef = New-Object System.Windows.Controls.RowDefinition
|
||||||
|
$rowDef.Height = [System.Windows.GridLength]::Auto
|
||||||
|
$featuresGrid.RowDefinitions.Add($rowDef) | Out-Null
|
||||||
|
}
|
||||||
|
# Define grid columns
|
||||||
|
for ($c = 0; $c -lt $columns; $c++) {
|
||||||
|
$colDef = New-Object System.Windows.Controls.ColumnDefinition
|
||||||
|
$colDef.Width = [System.Windows.GridLength]::Auto
|
||||||
|
$featuresGrid.ColumnDefinitions.Add($colDef) | Out-Null
|
||||||
|
}
|
||||||
|
|
||||||
|
# Populate grid with checkboxes
|
||||||
|
for ($i = 0; $i -lt $sortedFeatures.Count; $i++) {
|
||||||
|
$featureName = $sortedFeatures[$i]
|
||||||
|
$colIndex = [int]([math]::Floor($i / $rows))
|
||||||
|
$rowIndex = $i % $rows
|
||||||
|
|
||||||
|
$chk = New-Object System.Windows.Controls.CheckBox
|
||||||
|
$chk.Content = $featureName
|
||||||
|
$chk.Margin = "5"
|
||||||
|
$chk.Add_Checked({
|
||||||
|
param($eventSource, $e)
|
||||||
|
$window = [System.Windows.Window]::GetWindow($eventSource)
|
||||||
|
if ($null -ne $window) {
|
||||||
|
UpdateOptionalFeaturesString -State $window.Tag
|
||||||
|
}
|
||||||
|
})
|
||||||
|
$chk.Add_Unchecked({
|
||||||
|
param($eventSource, $e)
|
||||||
|
$window = [System.Windows.Window]::GetWindow($eventSource)
|
||||||
|
if ($null -ne $window) {
|
||||||
|
UpdateOptionalFeaturesString -State $window.Tag
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
$State.Controls.featureCheckBoxes[$featureName] = $chk # Track the checkbox
|
||||||
|
|
||||||
|
[System.Windows.Controls.Grid]::SetRow($chk, $rowIndex)
|
||||||
|
[System.Windows.Controls.Grid]::SetColumn($chk, $colIndex)
|
||||||
|
$featuresGrid.Children.Add($chk) | Out-Null
|
||||||
|
}
|
||||||
|
$parent.Children.Add($featuresGrid) | Out-Null
|
||||||
|
}
|
||||||
|
|
||||||
|
# --------------------------------------------------------------------------
|
||||||
|
# SECTION: Module Export
|
||||||
|
# --------------------------------------------------------------------------
|
||||||
|
|
||||||
|
Export-ModuleMember -Function *
|
||||||
@@ -0,0 +1,514 @@
|
|||||||
|
<#
|
||||||
|
.SYNOPSIS
|
||||||
|
Manages all Winget-related functionality for the 'Applications' tab in the FFU Builder UI.
|
||||||
|
.DESCRIPTION
|
||||||
|
This module provides the business logic for interacting with Winget from the FFU Builder UI. It includes functions for searching for packages, importing and exporting application lists, checking for and installing necessary Winget components (CLI and PowerShell module), and managing the parallel download of selected applications. It works in conjunction with FFU.Common.Winget for lower-level operations and FFU.Common.Parallel for managing concurrent downloads.
|
||||||
|
#>
|
||||||
|
|
||||||
|
# Function to search for Winget apps
|
||||||
|
function Search-WingetApps {
|
||||||
|
param(
|
||||||
|
[Parameter(Mandatory = $true)]
|
||||||
|
[psobject]$State
|
||||||
|
)
|
||||||
|
|
||||||
|
$searchQuery = $State.Controls.txtWingetSearch.Text
|
||||||
|
if ([string]::IsNullOrWhiteSpace($searchQuery)) { return }
|
||||||
|
|
||||||
|
$State.Controls.txtStatus.Text = "Searching Winget for apps matching query '$searchQuery'..."
|
||||||
|
$State.Window.Cursor = [System.Windows.Input.Cursors]::Wait
|
||||||
|
$State.Controls.btnWingetSearch.IsEnabled = $false
|
||||||
|
|
||||||
|
try {
|
||||||
|
# Get current items from the ListView
|
||||||
|
$currentItemsInListView = @()
|
||||||
|
if ($null -ne $State.Controls.lstWingetResults.ItemsSource) {
|
||||||
|
$currentItemsInListView = @($State.Controls.lstWingetResults.ItemsSource)
|
||||||
|
}
|
||||||
|
elseif ($State.Controls.lstWingetResults.HasItems) {
|
||||||
|
$currentItemsInListView = @($State.Controls.lstWingetResults.Items)
|
||||||
|
}
|
||||||
|
|
||||||
|
# Store selected apps from the current view
|
||||||
|
$selectedAppsFromView = @($currentItemsInListView | Where-Object { $_.IsSelected })
|
||||||
|
|
||||||
|
# Get default architecture from the UI
|
||||||
|
$defaultArch = $State.Controls.cmbWindowsArch.SelectedItem
|
||||||
|
|
||||||
|
# Search for new apps, which are streamed directly as PSCustomObjects
|
||||||
|
# with the required properties for performance.
|
||||||
|
$searchedAppResults = Search-WingetPackagesPublic -Query $searchQuery -DefaultArchitecture $defaultArch
|
||||||
|
$finalAppList = [System.Collections.Generic.List[object]]::new()
|
||||||
|
$addedAppIds = [System.Collections.Generic.HashSet[string]]::new([System.StringComparer]::OrdinalIgnoreCase)
|
||||||
|
|
||||||
|
# Add previously selected apps first
|
||||||
|
foreach ($app in $selectedAppsFromView) {
|
||||||
|
$finalAppList.Add($app)
|
||||||
|
$addedAppIds.Add($app.Id) | Out-Null
|
||||||
|
}
|
||||||
|
|
||||||
|
# Add new search results, avoiding duplicates of already added (selected) apps
|
||||||
|
$newAppsAddedCount = 0
|
||||||
|
foreach ($result in $searchedAppResults) {
|
||||||
|
# HashSet.Add returns $true if the item was added, $false if it already existed.
|
||||||
|
if ($addedAppIds.Add($result.Id)) {
|
||||||
|
$finalAppList.Add($result)
|
||||||
|
$newAppsAddedCount++
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# Update the ListView's ItemsSource using the passed-in State object
|
||||||
|
$State.Controls.lstWingetResults.ItemsSource = $finalAppList.ToArray()
|
||||||
|
Request-ListViewColumnAutoResize -ListView $State.Controls.lstWingetResults
|
||||||
|
|
||||||
|
# Update status text
|
||||||
|
$statusText = ""
|
||||||
|
if ($newAppsAddedCount -gt 0) {
|
||||||
|
$statusText = "Found $newAppsAddedCount new applications. "
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
$statusText = "No new applications found. "
|
||||||
|
}
|
||||||
|
$statusText += "Displaying $($finalAppList.Count) total applications."
|
||||||
|
$State.Controls.txtStatus.Text = $statusText
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
$errorMessage = "Error searching for apps: $($_.Exception.Message)"
|
||||||
|
$State.Controls.txtStatus.Text = $errorMessage
|
||||||
|
[System.Windows.MessageBox]::Show($errorMessage, "Error", "OK", "Error")
|
||||||
|
}
|
||||||
|
finally {
|
||||||
|
$State.Window.Cursor = $null
|
||||||
|
$State.Controls.btnWingetSearch.IsEnabled = $true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# Function to save selected apps to JSON
|
||||||
|
function Save-WingetList {
|
||||||
|
param(
|
||||||
|
[Parameter(Mandatory = $true)]
|
||||||
|
[psobject]$State
|
||||||
|
)
|
||||||
|
try {
|
||||||
|
$selectedApps = $State.Controls.lstWingetResults.Items | Where-Object { $_.IsSelected }
|
||||||
|
if (-not $selectedApps) {
|
||||||
|
[System.Windows.MessageBox]::Show("No apps selected to save.", "Warning", "OK", "Warning")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
$appList = @{
|
||||||
|
apps = @($selectedApps | ForEach-Object {
|
||||||
|
[ordered]@{
|
||||||
|
name = (ConvertTo-SafeName -Name $_.Name)
|
||||||
|
id = $_.Id
|
||||||
|
source = $_.Source.ToLower()
|
||||||
|
architecture = $_.Architecture
|
||||||
|
AdditionalExitCodes = if ($_.PSObject.Properties['AdditionalExitCodes']) { $_.AdditionalExitCodes } else { "" }
|
||||||
|
IgnoreNonZeroExitCodes = if ($_.PSObject.Properties['IgnoreNonZeroExitCodes']) { [bool]$_.IgnoreNonZeroExitCodes } else { $false }
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
# Default the save dialog to the configured Winget app list path.
|
||||||
|
$currentPath = $State.Controls.txtAppListJsonPath.Text
|
||||||
|
$initialDirectory = if (-not [string]::IsNullOrWhiteSpace($currentPath)) { Split-Path -Path $currentPath -Parent } else { $State.Controls.txtApplicationPath.Text }
|
||||||
|
if ([string]::IsNullOrWhiteSpace($initialDirectory) -or -not (Test-Path -Path $initialDirectory -PathType Container)) {
|
||||||
|
$initialDirectory = $State.Controls.txtApplicationPath.Text
|
||||||
|
}
|
||||||
|
$fileName = if (-not [string]::IsNullOrWhiteSpace($currentPath)) { Split-Path -Path $currentPath -Leaf } else { "AppList.json" }
|
||||||
|
|
||||||
|
$sfd = New-Object System.Windows.Forms.SaveFileDialog
|
||||||
|
$sfd.Filter = "JSON files (*.json)|*.json"
|
||||||
|
$sfd.Title = "Save Winget App List"
|
||||||
|
$sfd.InitialDirectory = $initialDirectory
|
||||||
|
$sfd.FileName = $fileName
|
||||||
|
|
||||||
|
if ($sfd.ShowDialog() -eq [System.Windows.Forms.DialogResult]::OK) {
|
||||||
|
$appList | ConvertTo-Json -Depth 10 | Set-Content $sfd.FileName -Encoding UTF8
|
||||||
|
$State.Controls.txtAppListJsonPath.Text = $sfd.FileName
|
||||||
|
[System.Windows.MessageBox]::Show("Winget app list saved successfully.", "Success", "OK", "Information")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
[System.Windows.MessageBox]::Show("Error saving Winget app list: $_", "Error", "OK", "Error")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# Function to import app list from JSON
|
||||||
|
function Import-WingetList {
|
||||||
|
param(
|
||||||
|
[Parameter(Mandatory = $true)]
|
||||||
|
[psobject]$State
|
||||||
|
)
|
||||||
|
try {
|
||||||
|
# Default the import dialog to the configured Winget app list path.
|
||||||
|
$currentPath = $State.Controls.txtAppListJsonPath.Text
|
||||||
|
$initialDirectory = if (-not [string]::IsNullOrWhiteSpace($currentPath)) { Split-Path -Path $currentPath -Parent } else { $State.Controls.txtApplicationPath.Text }
|
||||||
|
if ([string]::IsNullOrWhiteSpace($initialDirectory) -or -not (Test-Path -Path $initialDirectory -PathType Container)) {
|
||||||
|
$initialDirectory = $State.Controls.txtApplicationPath.Text
|
||||||
|
}
|
||||||
|
|
||||||
|
$ofd = New-Object System.Windows.Forms.OpenFileDialog
|
||||||
|
$ofd.Filter = "JSON files (*.json)|*.json"
|
||||||
|
$ofd.Title = "Import Winget App List"
|
||||||
|
$ofd.InitialDirectory = $initialDirectory
|
||||||
|
|
||||||
|
if ($ofd.ShowDialog() -eq [System.Windows.Forms.DialogResult]::OK) {
|
||||||
|
$importedAppsData = Get-Content $ofd.FileName -Raw | ConvertFrom-Json
|
||||||
|
|
||||||
|
$newAppListForItemsSource = [System.Collections.Generic.List[object]]::new()
|
||||||
|
|
||||||
|
if ($null -ne $importedAppsData.apps) {
|
||||||
|
# Get default architecture from the UI for fallback.
|
||||||
|
$defaultArch = $State.Controls.cmbWindowsArch.SelectedItem
|
||||||
|
|
||||||
|
foreach ($appInfo in $importedAppsData.apps) {
|
||||||
|
$arch = if ($appInfo.source -eq 'msstore') { 'NA' } else { if ($appInfo.PSObject.Properties['architecture']) { $appInfo.architecture } else { $defaultArch } }
|
||||||
|
$newAppListForItemsSource.Add([PSCustomObject]@{
|
||||||
|
IsSelected = $true
|
||||||
|
Name = $appInfo.name
|
||||||
|
Id = $appInfo.id
|
||||||
|
Version = ""
|
||||||
|
Source = $appInfo.source
|
||||||
|
Architecture = $arch
|
||||||
|
AdditionalExitCodes = if ($appInfo.PSObject.Properties['AdditionalExitCodes']) { $appInfo.AdditionalExitCodes } else { "" }
|
||||||
|
IgnoreNonZeroExitCodes = if ($appInfo.PSObject.Properties['IgnoreNonZeroExitCodes']) { [bool]$appInfo.IgnoreNonZeroExitCodes } else { $false }
|
||||||
|
DownloadStatus = ""
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
$State.Controls.lstWingetResults.ItemsSource = $newAppListForItemsSource.ToArray()
|
||||||
|
Request-ListViewColumnAutoResize -ListView $State.Controls.lstWingetResults
|
||||||
|
$State.Controls.txtAppListJsonPath.Text = $ofd.FileName
|
||||||
|
|
||||||
|
[System.Windows.MessageBox]::Show("Winget app list imported successfully.", "Success", "OK", "Information")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
[System.Windows.MessageBox]::Show("Error importing Winget app list: $_", "Error", "OK", "Error")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# --------------------------------------------------------------------------
|
||||||
|
# SECTION: Winget Management Functions (Moved from FFUUI.Core.psm1)
|
||||||
|
# --------------------------------------------------------------------------
|
||||||
|
function Search-WingetPackagesPublic {
|
||||||
|
[CmdletBinding()]
|
||||||
|
param(
|
||||||
|
[Parameter(Mandatory = $true)]
|
||||||
|
[string]$Query,
|
||||||
|
[Parameter(Mandatory = $true)]
|
||||||
|
[string]$DefaultArchitecture
|
||||||
|
)
|
||||||
|
|
||||||
|
WriteLog "Searching Winget packages with query: '$Query'"
|
||||||
|
try {
|
||||||
|
# Using ForEach-Object -Parallel can speed up object creation on multi-core systems
|
||||||
|
# by distributing the work across multiple threads.
|
||||||
|
$results = Find-WinGetPackage -Query $Query -ErrorAction Stop
|
||||||
|
WriteLog "Found $($results.Count) packages matching query '$Query'."
|
||||||
|
WriteLog "Creating output objects for Winget search results, please wait..."
|
||||||
|
$output = $results | ForEach-Object -Parallel {
|
||||||
|
$arch = if ($_.Source -eq 'msstore') { 'NA' } else { $using:DefaultArchitecture }
|
||||||
|
[PSCustomObject]@{
|
||||||
|
IsSelected = [bool]$false
|
||||||
|
Name = [string]$_.Name
|
||||||
|
Id = [string]$_.Id
|
||||||
|
Version = [string]$_.Version
|
||||||
|
Source = [string]$_.Source
|
||||||
|
Architecture = [string]$arch
|
||||||
|
AdditionalExitCodes = [string]::Empty
|
||||||
|
IgnoreNonZeroExitCodes = [bool]$false
|
||||||
|
DownloadStatus = [string]::Empty
|
||||||
|
}
|
||||||
|
} -ThrottleLimit 20
|
||||||
|
WriteLog "Winget search completed. Created $($output.Count) output objects."
|
||||||
|
return $output
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
WriteLog "Error during Winget search: $($_.Exception.Message)"
|
||||||
|
# Return an empty array or throw, depending on desired UI policy
|
||||||
|
return @()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function Test-WingetCLI {
|
||||||
|
[CmdletBinding()]
|
||||||
|
param()
|
||||||
|
|
||||||
|
$minVersion = [version]"1.8.1911"
|
||||||
|
|
||||||
|
# Check Winget CLI
|
||||||
|
$wingetCmd = Get-Command -Name winget -ErrorAction SilentlyContinue
|
||||||
|
if (-not $wingetCmd) {
|
||||||
|
return @{
|
||||||
|
Version = "Not installed"
|
||||||
|
Status = "Not installed - Install from Microsoft Store"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# Get and check version
|
||||||
|
$wingetVersion = & winget.exe --version
|
||||||
|
if ($wingetVersion -match 'v?(\d+\.\d+.\d+)') {
|
||||||
|
$version = [version]$matches[1]
|
||||||
|
if ($version -lt $minVersion) {
|
||||||
|
return @{
|
||||||
|
Version = $version.ToString()
|
||||||
|
Status = "Update required - Install from Microsoft Store"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return @{
|
||||||
|
Version = $version.ToString()
|
||||||
|
Status = $version.ToString()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return @{
|
||||||
|
Version = "Unknown"
|
||||||
|
Status = "Version check failed"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
function Install-WingetComponents {
|
||||||
|
[CmdletBinding()]
|
||||||
|
param(
|
||||||
|
# Add parameter to accept a script block for UI updates
|
||||||
|
[Parameter(Mandatory)]
|
||||||
|
[scriptblock]$UiUpdateCallback
|
||||||
|
)
|
||||||
|
|
||||||
|
$minVersion = [version]"1.8.1911"
|
||||||
|
$module = $null
|
||||||
|
|
||||||
|
try {
|
||||||
|
# Check and update PowerShell Module
|
||||||
|
$module = Get-InstalledModule -Name Microsoft.WinGet.Client -ErrorAction SilentlyContinue
|
||||||
|
if (-not $module -or $module.Version -lt $minVersion) {
|
||||||
|
WriteLog "Winget module needs install/update. Attempting..."
|
||||||
|
# Invoke the callback provided by the UI script to update status
|
||||||
|
# Note: We don't have the CLI version readily available here, pass a placeholder or adjust if needed.
|
||||||
|
& $UiUpdateCallback "Checking..." "Installing..."
|
||||||
|
|
||||||
|
# Store and modify PSGallery trust setting temporarily if needed
|
||||||
|
$PSGalleryTrust = (Get-PSRepository -Name 'PSGallery').InstallationPolicy
|
||||||
|
if ($PSGalleryTrust -eq 'Untrusted') {
|
||||||
|
Set-PSRepository -Name 'PSGallery' -InstallationPolicy Trusted
|
||||||
|
}
|
||||||
|
|
||||||
|
# Install/Update the module
|
||||||
|
Install-Module -Name Microsoft.WinGet.Client -Force -Repository 'PSGallery' -Scope AllUsers
|
||||||
|
|
||||||
|
# Restore original PSGallery trust setting
|
||||||
|
if ($PSGalleryTrust -eq 'Untrusted') {
|
||||||
|
Set-PSRepository -Name 'PSGallery' -InstallationPolicy Untrusted
|
||||||
|
}
|
||||||
|
|
||||||
|
$module = Get-InstalledModule -Name Microsoft.WinGet.Client -ErrorAction Stop
|
||||||
|
}
|
||||||
|
|
||||||
|
return $module
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
Write-Error "Failed to install/update Winget PowerShell module: $_"
|
||||||
|
throw
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# Winget Module Check Function (UI Version)
|
||||||
|
# Performs checks, triggers install if needed, and reports status back to the UI.
|
||||||
|
function Confirm-WingetInstallationUI {
|
||||||
|
[CmdletBinding()]
|
||||||
|
param(
|
||||||
|
# Callback for intermediate UI updates (e.g., "Installing...")
|
||||||
|
[Parameter(Mandatory)]
|
||||||
|
[scriptblock]$UiUpdateCallback
|
||||||
|
)
|
||||||
|
|
||||||
|
$minVersion = [version]"1.8.1911"
|
||||||
|
$result = [PSCustomObject]@{
|
||||||
|
Success = $false
|
||||||
|
Message = ""
|
||||||
|
CliVersion = "Unknown"
|
||||||
|
ModuleVersion = "Unknown"
|
||||||
|
NeedsUpdate = $false
|
||||||
|
UpdateAttempted = $false
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
# Initial Check
|
||||||
|
WriteLog "Confirm-WingetInstallationUI: Starting checks..."
|
||||||
|
$cliStatus = Test-WingetCLI
|
||||||
|
$module = Get-InstalledModule -Name Microsoft.WinGet.Client -ErrorAction SilentlyContinue
|
||||||
|
|
||||||
|
$result.CliVersion = $cliStatus.Version
|
||||||
|
$result.ModuleVersion = if ($null -ne $module) { $module.Version.ToString() } else { "Not installed" }
|
||||||
|
|
||||||
|
# Use callback for initial status display
|
||||||
|
& $UiUpdateCallback $result.CliVersion $result.ModuleVersion
|
||||||
|
|
||||||
|
# Determine if install/update is needed
|
||||||
|
$needsCliUpdate = $cliStatus.Status -notmatch '^\d+\.\d+\.\d+$' -or ([version]$cliStatus.Version -lt $minVersion)
|
||||||
|
$needsModuleUpdate = ($null -eq $module) -or ([version]$module.Version -lt $minVersion)
|
||||||
|
$result.NeedsUpdate = $needsCliUpdate -or $needsModuleUpdate
|
||||||
|
|
||||||
|
if ($result.NeedsUpdate) {
|
||||||
|
WriteLog "Confirm-WingetInstallationUI: Update needed. CLI Needs Update: $needsCliUpdate, Module Needs Update: $needsModuleUpdate"
|
||||||
|
$result.UpdateAttempted = $true
|
||||||
|
|
||||||
|
# Use callback to indicate installation attempt
|
||||||
|
& $UiUpdateCallback $result.CliVersion "Installing/Updating..."
|
||||||
|
|
||||||
|
# Attempt to install/update Winget CLI and module
|
||||||
|
$installedModule = Install-WingetComponents -UiUpdateCallback $UiUpdateCallback
|
||||||
|
|
||||||
|
# Re-check status after attempt
|
||||||
|
WriteLog "Confirm-WingetInstallationUI: Re-checking status after update attempt..."
|
||||||
|
$cliStatus = Test-WingetCLI
|
||||||
|
$result.CliVersion = $cliStatus.Version
|
||||||
|
$result.ModuleVersion = if ($null -ne $installedModule) { $installedModule.Version } else { "Install Failed" }
|
||||||
|
# Use callback for final status display after update attempt
|
||||||
|
& $UiUpdateCallback $result.CliVersion $result.ModuleVersion
|
||||||
|
|
||||||
|
# Check if update was successful
|
||||||
|
$cliOk = $cliStatus.Status -match '^\d+\.\d+\.\d+$' -and ([version]$cliStatus.Version -ge $minVersion)
|
||||||
|
$moduleOk = ($null -ne $installedModule) -and ([version]$installedModule.Version -ge $minVersion)
|
||||||
|
$result.Success = $cliOk -and $moduleOk
|
||||||
|
$result.Message = if ($result.Success) { "Winget components installed/updated successfully." } else { "Winget component installation/update failed or is incomplete." }
|
||||||
|
WriteLog "Confirm-WingetInstallationUI: Update attempt finished. Success: $($result.Success). Message: $($result.Message)"
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
# Already up-to-date
|
||||||
|
$result.Success = $true
|
||||||
|
$result.Message = "Winget components are up-to-date."
|
||||||
|
WriteLog "Confirm-WingetInstallationUI: Components already up-to-date."
|
||||||
|
}
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
$result.Success = $false
|
||||||
|
$result.Message = "Error during Winget check/install: $($_.Exception.Message)"
|
||||||
|
WriteLog "Confirm-WingetInstallationUI: Error - $($result.Message)"
|
||||||
|
# Use callback to show error state
|
||||||
|
& $UiUpdateCallback $result.CliVersion "Error"
|
||||||
|
}
|
||||||
|
|
||||||
|
return $result
|
||||||
|
}
|
||||||
|
|
||||||
|
# Note: Start-WingetAppDownloadTask has been moved to FFU.Common.Winget.psm1
|
||||||
|
# to enable code reuse between UI and CLI builds. It is imported via the FFU.Common module.
|
||||||
|
|
||||||
|
function Invoke-WingetDownload {
|
||||||
|
param(
|
||||||
|
[psobject]$State,
|
||||||
|
[object]$Button
|
||||||
|
)
|
||||||
|
try {
|
||||||
|
$selectedApps = $State.Controls.lstWingetResults.Items | Where-Object { $_.IsSelected }
|
||||||
|
if (-not $selectedApps) {
|
||||||
|
[System.Windows.MessageBox]::Show("No applications selected to download.", "Download Winget Apps", "OK", "Information")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
$Button.IsEnabled = $false
|
||||||
|
$State.Controls.pbOverallProgress.Visibility = 'Visible'
|
||||||
|
$State.Controls.pbOverallProgress.Value = 0
|
||||||
|
$State.Controls.txtStatus.Text = "Starting Winget app downloads..."
|
||||||
|
|
||||||
|
# Define necessary task-specific variables locally
|
||||||
|
$localAppsPath = $State.Controls.txtApplicationPath.Text
|
||||||
|
$localAppListJsonPath = $State.Controls.txtAppListJsonPath.Text
|
||||||
|
$localWindowsArch = $State.Controls.cmbWindowsArch.SelectedItem
|
||||||
|
$localOrchestrationPath = Join-Path -Path $State.Controls.txtApplicationPath.Text -ChildPath "Orchestration"
|
||||||
|
|
||||||
|
# Create hashtable for task-specific arguments to pass to Invoke-ParallelProcessing
|
||||||
|
# UI downloads skip WinGetWin32Apps.json creation - it's generated at build time
|
||||||
|
$taskArguments = @{
|
||||||
|
AppsPath = $localAppsPath
|
||||||
|
AppListJsonPath = $localAppListJsonPath
|
||||||
|
OrchestrationPath = $localOrchestrationPath
|
||||||
|
WindowsArch = $localWindowsArch
|
||||||
|
SkipWin32Json = $true
|
||||||
|
}
|
||||||
|
|
||||||
|
# Select only necessary properties before passing to Invoke-ParallelProcessing
|
||||||
|
$itemsToProcess = $selectedApps | Select-Object Name, Id, Source, Version, Architecture # Include Version and Architecture if needed
|
||||||
|
|
||||||
|
# Before downloading, persist the selected apps to AppList.json including exit-code fields (parity with Save-WingetList)
|
||||||
|
try {
|
||||||
|
# Determine AppList.json path; default if empty
|
||||||
|
if ([string]::IsNullOrWhiteSpace($localAppListJsonPath)) {
|
||||||
|
$localAppListJsonPath = Join-Path -Path $localAppsPath -ChildPath "AppList.json"
|
||||||
|
$taskArguments.AppListJsonPath = $localAppListJsonPath
|
||||||
|
WriteLog "AppListJsonPath was empty. Defaulting to: $localAppListJsonPath"
|
||||||
|
}
|
||||||
|
|
||||||
|
# Build apps payload from current selection, preserving AdditionalExitCodes/IgnoreNonZeroExitCodes
|
||||||
|
$appListToSave = @{
|
||||||
|
apps = @($selectedApps | ForEach-Object {
|
||||||
|
[ordered]@{
|
||||||
|
name = (ConvertTo-SafeName -Name $_.Name)
|
||||||
|
id = $_.Id
|
||||||
|
source = $_.Source.ToLower()
|
||||||
|
architecture = $_.Architecture
|
||||||
|
AdditionalExitCodes = if ($_.PSObject.Properties['AdditionalExitCodes']) { $_.AdditionalExitCodes } else { "" }
|
||||||
|
IgnoreNonZeroExitCodes = if ($_.PSObject.Properties['IgnoreNonZeroExitCodes']) { [bool]$_.IgnoreNonZeroExitCodes } else { $false }
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
# Ensure destination directory exists and write AppList.json
|
||||||
|
$destDir = Split-Path -Parent $localAppListJsonPath
|
||||||
|
if (-not (Test-Path -LiteralPath $destDir)) {
|
||||||
|
[void][System.IO.Directory]::CreateDirectory($destDir)
|
||||||
|
}
|
||||||
|
$appListToSave | ConvertTo-Json -Depth 10 | Set-Content -Path $localAppListJsonPath -Encoding UTF8
|
||||||
|
WriteLog "Persisted AppList.json with selected apps and exit-code fields to: $localAppListJsonPath"
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
WriteLog "Warning: Failed to persist AppList.json prior to download. Error: $($_.Exception.Message)"
|
||||||
|
}
|
||||||
|
|
||||||
|
# Invoke the centralized parallel processing function
|
||||||
|
# Pass task type and task-specific arguments
|
||||||
|
Invoke-ParallelProcessing -ItemsToProcess $itemsToProcess `
|
||||||
|
-ListViewControl $State.Controls.lstWingetResults `
|
||||||
|
-IdentifierProperty 'Id' `
|
||||||
|
-StatusProperty 'DownloadStatus' `
|
||||||
|
-TaskType 'WingetDownload' `
|
||||||
|
-TaskArguments $taskArguments `
|
||||||
|
-CompletedStatusText "Completed" `
|
||||||
|
-ErrorStatusPrefix "Error: " `
|
||||||
|
-WindowObject $State.Window `
|
||||||
|
-MainThreadLogPath $State.LogFilePath `
|
||||||
|
-ThrottleLimit $State.Controls.txtThreads.Text
|
||||||
|
|
||||||
|
# Final status update is handled by Invoke-ParallelProcessing, but we need to re-enable the button
|
||||||
|
$State.Controls.pbOverallProgress.Visibility = 'Collapsed'
|
||||||
|
$Button.IsEnabled = $true
|
||||||
|
}
|
||||||
|
catch {
|
||||||
|
WriteLog "FATAL Error in Invoke-WingetDownload: $($_.Exception.ToString())"
|
||||||
|
[System.Windows.MessageBox]::Show("A critical error occurred while starting the Winget download: $($_.Exception.Message)", "Error", "OK", "Error")
|
||||||
|
# Reset UI state on error
|
||||||
|
if ($Button) { $Button.IsEnabled = $true }
|
||||||
|
if ($State.Controls.pbOverallProgress) { $State.Controls.pbOverallProgress.Visibility = 'Collapsed' }
|
||||||
|
if ($State.Controls.txtStatus) { $State.Controls.txtStatus.Text = "Winget download failed to start." }
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function Update-WingetVersionFields {
|
||||||
|
param(
|
||||||
|
[psobject]$State,
|
||||||
|
[string]$wingetText,
|
||||||
|
[string]$moduleText
|
||||||
|
)
|
||||||
|
$State.Window.Dispatcher.Invoke([System.Windows.Threading.DispatcherPriority]::Normal, [Action] {
|
||||||
|
$State.Controls.txtWingetVersion.Text = $wingetText
|
||||||
|
$State.Controls.txtWingetModuleVersion.Text = $moduleText
|
||||||
|
[System.Windows.Forms.Application]::DoEvents()
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
Export-ModuleMember -Function *
|
||||||
@@ -0,0 +1,143 @@
|
|||||||
|
#
|
||||||
|
# Module manifest for module 'FFUUI.Core'
|
||||||
|
#
|
||||||
|
# Generated by: Richard Balsley
|
||||||
|
#
|
||||||
|
# Generated on: 6/11/2025
|
||||||
|
#
|
||||||
|
|
||||||
|
@{
|
||||||
|
|
||||||
|
# Script module or binary module file associated with this manifest.
|
||||||
|
RootModule = 'FFUUI.Core.psm1'
|
||||||
|
|
||||||
|
# Version number of this module.
|
||||||
|
ModuleVersion = '0.0.1'
|
||||||
|
|
||||||
|
# Supported PSEditions
|
||||||
|
# CompatiblePSEditions = @()
|
||||||
|
|
||||||
|
# ID used to uniquely identify this module
|
||||||
|
GUID = '826c5868-c452-48a9-a3d8-9ff7fea54feb'
|
||||||
|
|
||||||
|
# Author of this module
|
||||||
|
Author = 'Richard Balsley'
|
||||||
|
|
||||||
|
# Company or vendor of this module
|
||||||
|
CompanyName = 'Unknown'
|
||||||
|
|
||||||
|
# Copyright statement for this module
|
||||||
|
Copyright = '(c) Richard Balsley. All rights reserved.'
|
||||||
|
|
||||||
|
# Description of the functionality provided by this module
|
||||||
|
Description = 'Core UI logic for the FFU Builder application.'
|
||||||
|
|
||||||
|
# Minimum version of the PowerShell engine required by this module
|
||||||
|
# PowerShellVersion = ''
|
||||||
|
|
||||||
|
# Name of the PowerShell host required by this module
|
||||||
|
# PowerShellHostName = ''
|
||||||
|
|
||||||
|
# Minimum version of the PowerShell host required by this module
|
||||||
|
# PowerShellHostVersion = ''
|
||||||
|
|
||||||
|
# Minimum version of Microsoft .NET Framework required by this module. This prerequisite is valid for the PowerShell Desktop edition only.
|
||||||
|
# DotNetFrameworkVersion = ''
|
||||||
|
|
||||||
|
# Minimum version of the common language runtime (CLR) required by this module. This prerequisite is valid for the PowerShell Desktop edition only.
|
||||||
|
# ClrVersion = ''
|
||||||
|
|
||||||
|
# Processor architecture (None, X86, Amd64) required by this module
|
||||||
|
# ProcessorArchitecture = ''
|
||||||
|
|
||||||
|
# Modules that must be imported into the global environment prior to importing this module
|
||||||
|
RequiredModules = @('..\FFU.Common\FFU.Common.psd1')
|
||||||
|
|
||||||
|
# Assemblies that must be loaded prior to importing this module
|
||||||
|
# RequiredAssemblies = @()
|
||||||
|
|
||||||
|
# Script files (.ps1) that are run in the caller's environment prior to importing this module.
|
||||||
|
# ScriptsToProcess = @()
|
||||||
|
|
||||||
|
# Type files (.ps1xml) to be loaded when importing this module
|
||||||
|
# TypesToProcess = @()
|
||||||
|
|
||||||
|
# Format files (.ps1xml) to be loaded when importing this module
|
||||||
|
# FormatsToProcess = @()
|
||||||
|
|
||||||
|
# Modules to import as nested modules of the module specified in RootModule/ModuleToProcess
|
||||||
|
NestedModules = @('FFUUI.Core.Applications.psm1',
|
||||||
|
'FFUUI.Core.Config.psm1',
|
||||||
|
'FFUUI.Core.Drivers.psm1',
|
||||||
|
'FFUUI.Core.Drivers.Dell.psm1',
|
||||||
|
'FFUUI.Core.Drivers.HP.psm1',
|
||||||
|
'FFUUI.Core.Drivers.Lenovo.psm1',
|
||||||
|
'FFUUI.Core.Drivers.Microsoft.psm1',
|
||||||
|
'FFUUI.Core.Handlers.psm1',
|
||||||
|
'FFUUI.Core.Initialize.psm1',
|
||||||
|
'FFUUI.Core.Shared.psm1',
|
||||||
|
'FFUUI.Core.WindowsSettings.psm1',
|
||||||
|
'FFUUI.Core.Winget.psm1')
|
||||||
|
|
||||||
|
# Functions to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no functions to export.
|
||||||
|
FunctionsToExport = '*'
|
||||||
|
|
||||||
|
# Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export.
|
||||||
|
CmdletsToExport = '*'
|
||||||
|
|
||||||
|
# Variables to export from this module
|
||||||
|
VariablesToExport = '*'
|
||||||
|
|
||||||
|
# Aliases to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no aliases to export.
|
||||||
|
AliasesToExport = '*'
|
||||||
|
|
||||||
|
# DSC resources to export from this module
|
||||||
|
# DscResourcesToExport = @()
|
||||||
|
|
||||||
|
# List of all modules packaged with this module
|
||||||
|
# ModuleList = @()
|
||||||
|
|
||||||
|
# List of all files packaged with this module
|
||||||
|
# FileList = @()
|
||||||
|
|
||||||
|
# Private data to pass to the module specified in RootModule/ModuleToProcess. This may also contain a PSData hashtable with additional module metadata used by PowerShell.
|
||||||
|
PrivateData = @{
|
||||||
|
|
||||||
|
PSData = @{
|
||||||
|
|
||||||
|
# Tags applied to this module. These help with module discovery in online galleries.
|
||||||
|
# Tags = @()
|
||||||
|
|
||||||
|
# A URL to the license for this module.
|
||||||
|
# LicenseUri = ''
|
||||||
|
|
||||||
|
# A URL to the main website for this project.
|
||||||
|
# ProjectUri = ''
|
||||||
|
|
||||||
|
# A URL to an icon representing this module.
|
||||||
|
# IconUri = ''
|
||||||
|
|
||||||
|
# ReleaseNotes of this module
|
||||||
|
# ReleaseNotes = ''
|
||||||
|
|
||||||
|
# Prerelease string of this module
|
||||||
|
# Prerelease = ''
|
||||||
|
|
||||||
|
# Flag to indicate whether the module requires explicit user acceptance for install/update/save
|
||||||
|
# RequireLicenseAcceptance = $false
|
||||||
|
|
||||||
|
# External dependent modules of this module
|
||||||
|
# ExternalModuleDependencies = @()
|
||||||
|
|
||||||
|
} # End of PSData hashtable
|
||||||
|
|
||||||
|
} # End of PrivateData hashtable
|
||||||
|
|
||||||
|
# HelpInfo URI of this module
|
||||||
|
# HelpInfoURI = ''
|
||||||
|
|
||||||
|
# Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix.
|
||||||
|
# DefaultCommandPrefix = ''
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
@@ -4,22 +4,34 @@ param(
|
|||||||
$DeployISOPath,
|
$DeployISOPath,
|
||||||
[Switch]$DisableAutoPlay
|
[Switch]$DisableAutoPlay
|
||||||
)
|
)
|
||||||
$Host.UI.RawUI.WindowTitle = 'USB Imaging Tool Creator'
|
$Host.UI.RawUI.WindowTitle = 'Imaging Tool USB Creator'
|
||||||
|
|
||||||
if($DeployISOPath){
|
if($DeployISOPath){
|
||||||
$DevelopmentPath = $DeployISOPath | Split-Path
|
$DevelopmentPath = $DeployISOPath | Split-Path
|
||||||
|
$ImagesPath = "$DevelopmentPath\FFU"
|
||||||
function WriteLog($LogText) {
|
function WriteLog($LogText) {
|
||||||
$LogFileName = '\Script.log'
|
$LogFileName = '\Script.log'
|
||||||
$LogFile = $DevelopmentPath + $LogFilename
|
$LogFile = $DevelopmentPath + $LogFilename
|
||||||
Add-Content -path $LogFile -value "$((Get-Date).ToString()) $LogText" -Force -ErrorAction SilentlyContinue
|
Add-Content -path $LogFile -value "$((Get-Date).ToString()) $LogText" -Force -ErrorAction SilentlyContinue
|
||||||
Write-Verbose $LogText
|
Write-Verbose $LogText
|
||||||
}
|
}
|
||||||
Function Get-USBDrive {
|
|
||||||
$USBDrives = (Get-WmiObject -Class Win32_DiskDrive -Filter "MediaType='Removable Media'")
|
function Write-ProgressLog {
|
||||||
If ($USBDrives -and ($null -eq $USBDrives.count)) {
|
param(
|
||||||
$USBDrivesCount = 1
|
[string]$Activity,
|
||||||
|
[string]$Status
|
||||||
|
)
|
||||||
|
Write-Progress -Activity $Activity -Status $Status -PercentComplete (($currentStep / $totalSteps) * 100)
|
||||||
|
WriteLog $Status
|
||||||
|
$script:currentStep++
|
||||||
|
|
||||||
}
|
}
|
||||||
else {
|
Function Get-RemovableDrive {
|
||||||
|
writelog "Get information for all removable drives"
|
||||||
|
$USBDrives = Get-WmiObject Win32_DiskDrive | Where-Object {$_.MediaType -eq "Removable media" -or $_.MediaType -eq "External hard disk media"}
|
||||||
|
If($USBDrives -and ($null -eq $USBDrives.count)) {
|
||||||
|
$USBDrivesCount = 1
|
||||||
|
} else {
|
||||||
$USBDrivesCount = $USBDrives.Count
|
$USBDrivesCount = $USBDrives.Count
|
||||||
}
|
}
|
||||||
WriteLog "Found $USBDrivesCount USB drives"
|
WriteLog "Found $USBDrivesCount USB drives"
|
||||||
@@ -27,26 +39,30 @@ Function Get-USBDrive {
|
|||||||
if ($null -eq $USBDrives) {
|
if ($null -eq $USBDrives) {
|
||||||
WriteLog "No removable USB drive found. Exiting"
|
WriteLog "No removable USB drive found. Exiting"
|
||||||
Write-Error "No removable USB drive found. Exiting"
|
Write-Error "No removable USB drive found. Exiting"
|
||||||
|
Pause
|
||||||
exit 1
|
exit 1
|
||||||
}
|
}
|
||||||
return $USBDrives, $USBDrivesCount
|
return $USBDrives, $USBDrivesCount
|
||||||
}
|
}
|
||||||
|
|
||||||
Function Build-DeploymentUSB{
|
Function Build-DeploymentUSB{
|
||||||
param(
|
param(
|
||||||
[Array]$Drives
|
[Array]$Drives
|
||||||
)
|
)
|
||||||
writelog "Checking if ffu files are present in the ffu folder"
|
writelog "Creating list of FFU image files"
|
||||||
$Images = Get-ChildItem -Path $FFUPath -Filter "*.ffu" -File -Recurse
|
$Images = Get-ChildItem -Path $ImagesPath -Filter "*.ffu" -File -Recurse
|
||||||
writelog "Checking if drivers are present in the drivers folder"
|
writelog "Checking if drivers are present in the drivers folder"
|
||||||
$Drivers = Get-ChildItem -Path $DriversPath -Recurse
|
$Drivers = Get-ChildItem -Path $DriversPath -Recurse
|
||||||
$DrivesCount = $Drives.Count
|
$DrivesCount = $Drives.Count
|
||||||
Writelog "Creating partitions..."
|
Write-ProgressLog "Create Imaging Tool" "Creating partitions..."
|
||||||
|
writelog "Create job to partition each usb drive"
|
||||||
foreach ($USBDrive in $Drives) {
|
foreach ($USBDrive in $Drives) {
|
||||||
$DriveNumber = $USBDrive.DeviceID.Replace("\\.\PHYSICALDRIVE", "")
|
$DriveNumber = $USBDrive.DeviceID.Replace("\\.\PHYSICALDRIVE", "")
|
||||||
$Model = $USBDrive.model
|
$Model = $USBDrive.model
|
||||||
$ScriptBlock = {
|
$ScriptBlock = {
|
||||||
param($DriveNumber)
|
param($DriveNumber)
|
||||||
Clear-Disk -Number $DriveNumber -RemoveData -RemoveOEM -Confirm:$false
|
Clear-Disk -Number $DriveNumber -RemoveData -RemoveOEM -Confirm:$false
|
||||||
|
Initialize-Disk -Number $DriveNumber
|
||||||
$Disk = Get-Disk -Number $DriveNumber
|
$Disk = Get-Disk -Number $DriveNumber
|
||||||
$PartitionStyle = $Disk.PartitionStyle
|
$PartitionStyle = $Disk.PartitionStyle
|
||||||
if($PartitionStyle -ne 'MBR'){
|
if($PartitionStyle -ne 'MBR'){
|
||||||
@@ -65,7 +81,7 @@ Function Build-DeploymentUSB{
|
|||||||
if($DrivesCount -gt 1){
|
if($DrivesCount -gt 1){
|
||||||
writelog "Get file system information for all drives"
|
writelog "Get file system information for all drives"
|
||||||
$Partitions = Get-Partition | Get-Volume
|
$Partitions = Get-Partition | Get-Volume
|
||||||
}else{
|
} else {
|
||||||
writelog "Get file system information for drive number $DiskNumber"
|
writelog "Get file system information for drive number $DiskNumber"
|
||||||
$Partitions = Get-Partition -DiskNumber $DriveNumber | Get-Volume
|
$Partitions = Get-Partition -DiskNumber $DriveNumber | Get-Volume
|
||||||
}
|
}
|
||||||
@@ -97,11 +113,12 @@ $Destination = $Drive + ":\"
|
|||||||
[string]$SFolder,
|
[string]$SFolder,
|
||||||
[string]$DFolder
|
[string]$DFolder
|
||||||
)
|
)
|
||||||
|
New-Item -Path $DFolder -ItemType Directory -Force -Confirm: $false | Out-Null
|
||||||
Robocopy $SFolder $DFolder /E /COPYALL /R:5 /W:5 /J
|
Robocopy $SFolder $DFolder /E /COPYALL /R:5 /W:5 /J
|
||||||
}
|
}
|
||||||
|
|
||||||
WriteLog "Start job to copy all FFU files to $Destination"
|
WriteLog "Start job to copy all FFU files to $Destination"
|
||||||
Start-Job -ScriptBlock $jobScriptBlock -ArgumentList $FFUPath, $Destination | Out-Null
|
Start-Job -ScriptBlock $jobScriptBlock -ArgumentList $ImagesPath, $Destination | Out-Null
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
if($Drivers){
|
if($Drivers){
|
||||||
@@ -128,14 +145,14 @@ if(!($Drivers)){
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
if($DrivesCount -gt 1){
|
if($DrivesCount -gt 1){
|
||||||
Writelog "Building $DrivesCount drives concurrently...Please be patient..."
|
Write-ProgressLog "Create Imaging Tool" "Building $DrivesCount drives concurrently...Please be patient..."
|
||||||
}else{
|
} else {
|
||||||
Writelog "Building the imaging tool on $model...Please be patient..."
|
Write-ProgressLog "Create Imaging Tool" "Building the imaging tool on $model...Please be patient..."
|
||||||
}
|
}
|
||||||
Get-Job | Wait-Job | Out-Null
|
Get-Job | Wait-Job | Out-Null
|
||||||
|
|
||||||
Dismount-DiskImage -ImagePath $DeployISOPath | Out-Null
|
Dismount-DiskImage -ImagePath $DeployISOPath | Out-Null
|
||||||
Writelog "Drive creation jobs completed..."
|
Write-ProgressLog "Create Imaging Tool" "Drive creation jobs completed..."
|
||||||
}
|
}
|
||||||
|
|
||||||
Function New-DeploymentUSB {
|
Function New-DeploymentUSB {
|
||||||
@@ -154,7 +171,7 @@ Function New-DeploymentUSB {
|
|||||||
$DriveSize = [math]::round($Drives[$i].size/1GB, 2)
|
$DriveSize = [math]::round($Drives[$i].size/1GB, 2)
|
||||||
$DiskNumber = $Drives[$i].DeviceID.Replace("\\.\PHYSICALDRIVE", "")
|
$DiskNumber = $Drives[$i].DeviceID.Replace("\\.\PHYSICALDRIVE", "")
|
||||||
$Properties = [ordered]@{Number = $i + 1 ; DriveNumber = $DiskNumber ; DriveModel = $driveModel ; 'Size (GB)' = $DriveSize}
|
$Properties = [ordered]@{Number = $i + 1 ; DriveNumber = $DiskNumber ; DriveModel = $driveModel ; 'Size (GB)' = $DriveSize}
|
||||||
|
|
||||||
$Drivelist += New-Object PSObject -Property $Properties
|
$Drivelist += New-Object PSObject -Property $Properties
|
||||||
}
|
}
|
||||||
if($Count -gt 1){
|
if($Count -gt 1){
|
||||||
@@ -167,20 +184,15 @@ Function New-DeploymentUSB {
|
|||||||
$var = $true
|
$var = $true
|
||||||
$DriveSelected = Read-Host 'Enter the drive number to apply the .iso to'
|
$DriveSelected = Read-Host 'Enter the drive number to apply the .iso to'
|
||||||
$DriveSelected = ($DriveSelected -as [int]) -1
|
$DriveSelected = ($DriveSelected -as [int]) -1
|
||||||
if($Last){
|
writelog "Drive $DriveSelected selected"
|
||||||
writelog "All drives selected"
|
|
||||||
}else{
|
|
||||||
writelog "Drive $DriveSelected selected"}
|
|
||||||
}
|
}
|
||||||
catch {
|
|
||||||
|
catch {
|
||||||
Write-Host 'Input was not in correct format. Please enter a valid FFU number'
|
Write-Host 'Input was not in correct format. Please enter a valid FFU number'
|
||||||
$var = $false
|
$var = $false
|
||||||
}
|
}
|
||||||
} until (($DriveSelected -le $Count -1 -or $last) -and $var)
|
} until (($DriveSelected -le $Count -1 -or $last) -and $var)
|
||||||
|
if($DisableAutoPlay){
|
||||||
$DisableAutoPlayCurrentSetting = (Get-ItemProperty -Path "HKCU:\SOFTWARE\Microsoft\Windows\CurrentVersion\Explorer\AutoplayHandlers" -Name DisableAutoplay).DisableAutoplay
|
|
||||||
if($DisableAutoPlay -and $DisableAutoPlayCurrentSetting -ne 1){
|
|
||||||
writelog "Disable autoPlay current setting is $DisableAutoPlayCurrentSetting"
|
|
||||||
WriteLog "Setting the registry key to disable autoplay for all drives"
|
WriteLog "Setting the registry key to disable autoplay for all drives"
|
||||||
Set-ItemProperty -Path "HKCU:\SOFTWARE\Microsoft\Windows\CurrentVersion\Explorer\AutoplayHandlers" -Name "DisableAutoplay" -Value 1 -Type DWORD
|
Set-ItemProperty -Path "HKCU:\SOFTWARE\Microsoft\Windows\CurrentVersion\Explorer\AutoplayHandlers" -Name "DisableAutoplay" -Value 1 -Type DWORD
|
||||||
}
|
}
|
||||||
@@ -193,16 +205,16 @@ Function New-DeploymentUSB {
|
|||||||
if($Selection -eq $last){
|
if($Selection -eq $last){
|
||||||
Read-Host -Prompt "ALL DRIVES SELECTED! WILL ERASE ALL CURRENTLY CONNECTED USB DRIVES!! Press ENTER to continue"
|
Read-Host -Prompt "ALL DRIVES SELECTED! WILL ERASE ALL CURRENTLY CONNECTED USB DRIVES!! Press ENTER to continue"
|
||||||
Build-DeploymentUSB -Drives $Drives
|
Build-DeploymentUSB -Drives $Drives
|
||||||
}else{
|
} else {
|
||||||
Read-Host -Prompt "Drive number $Selection was selected. Press ENTER to continue"
|
Read-Host -Prompt "Drive number $Selection was selected. Press ENTER to continue"
|
||||||
Build-DeploymentUSB -Drives $Drives[$DriveSelected]
|
Build-DeploymentUSB -Drives $Drives[$DriveSelected]
|
||||||
}
|
}
|
||||||
WriteLog "Setting the registry key to re-enable autoplay for all drives"
|
WriteLog "Setting the registry key to re-enable autoplay for all drives"
|
||||||
if($DisableAutoPlay){
|
if($DisableAutoPlay){
|
||||||
Writelog "Setting disable autoplay setting back to $DisableAutoPlayCurrentSetting"
|
Write-ProgressLog "Create Imaging Tool" "Enabling Autoplay"
|
||||||
Set-ItemProperty -Path "HKCU:\SOFTWARE\Microsoft\Windows\CurrentVersion\Explorer\AutoplayHandlers" -Name "DisableAutoplay" -Value $DisableAutoPlayCurrentSetting -Type DWORD
|
Set-ItemProperty -Path "HKCU:\SOFTWARE\Microsoft\Windows\CurrentVersion\Explorer\AutoplayHandlers" -Name "DisableAutoplay" -Value 0 -Type DWORD
|
||||||
}
|
}
|
||||||
Writelog "Completed!"
|
Write-ProgressLog "Create Imaging Tool" "Completed!"
|
||||||
}
|
}
|
||||||
#Get USB Drive and create log file
|
#Get USB Drive and create log file
|
||||||
if(Test-Path "$DevelopmentPath\Script.log"){
|
if(Test-Path "$DevelopmentPath\Script.log"){
|
||||||
@@ -211,12 +223,15 @@ New-item -Path $DevelopmentPath -Name 'Script.log' -ItemType "file" -Force | Out
|
|||||||
}
|
}
|
||||||
WriteLog 'Begin Logging'
|
WriteLog 'Begin Logging'
|
||||||
WriteLog 'Getting USB drive information and usb drive count'
|
WriteLog 'Getting USB drive information and usb drive count'
|
||||||
$USBDrives,$USBDrivesCount = Get-USBDrive
|
$USBDrives,$USBDrivesCount = Get-RemovableDrive
|
||||||
|
WriteLog 'Setting first step for percentage progress bar'
|
||||||
|
$currentStep = 1
|
||||||
New-DeploymentUSB -Drives $USBDrives -Count $USBDrivesCount
|
New-DeploymentUSB -Drives $USBDrives -Count $USBDrivesCount
|
||||||
|
|
||||||
read-host -Prompt "USB drive creation complete. Press ENTER to exit"
|
read-host -Prompt "USB drive creation complete. Press ENTER to exit"
|
||||||
|
|
||||||
Exit
|
Exit
|
||||||
}else{
|
} else {
|
||||||
Write-Host "No .ISO file selected..."
|
Write-Host "No .ISO file selected..."
|
||||||
read-host "Press ENTER to Exit..."
|
read-host "Press ENTER to Exit..."
|
||||||
Exit
|
Exit
|
||||||
|
|||||||
@@ -1,4 +0,0 @@
|
|||||||
select disk 0
|
|
||||||
select partition 3
|
|
||||||
Assign letter="M"
|
|
||||||
exit
|
|
||||||
@@ -1,69 +0,0 @@
|
|||||||
#Modify the net use W: \\192.168.1.158\FFUCaptureShare /user:ffu_user ddb1f077-3eed-433c-b4d9-7b8cd54ce727
|
|
||||||
net use W: \\192.168.1.158\FFUCaptureShare /user:ffu_user ddb1f077-3eed-433c-b4d9-7b8cd54ce727
|
|
||||||
|
|
||||||
$AssignDriveLetter = 'x:\AssignDriveLetter.txt'
|
|
||||||
Start-Process -FilePath diskpart.exe -ArgumentList "/S $AssignDriveLetter" -Wait -ErrorAction Stop | Out-Null
|
|
||||||
#Load Registry Hive
|
|
||||||
$Software = 'M:\Windows\System32\config\software'
|
|
||||||
reg load "HKLM\FFU" $Software
|
|
||||||
|
|
||||||
#Find Windows version values
|
|
||||||
|
|
||||||
$SKU = Get-ItemPropertyValue -Path 'HKLM:\FFU\Microsoft\Windows NT\CurrentVersion\' -Name 'EditionID'
|
|
||||||
[int]$CurrentBuild = Get-ItemPropertyValue -Path 'HKLM:\FFU\Microsoft\Windows NT\CurrentVersion\' -Name 'CurrentBuild'
|
|
||||||
$DisplayVersion = Get-ItemPropertyValue -Path 'HKLM:\FFU\Microsoft\Windows NT\CurrentVersion\' -Name 'DisplayVersion'
|
|
||||||
$BuildDate = Get-Date -uformat %b%Y
|
|
||||||
|
|
||||||
$SKU = switch ($SKU) {
|
|
||||||
Core { 'Home' }
|
|
||||||
CoreN { 'HomeN'}
|
|
||||||
CoreSingleLanguage { 'HomeSL'}
|
|
||||||
Professional { 'Pro' }
|
|
||||||
ProfessionalN { 'ProN'}
|
|
||||||
ProfessionalEducation { 'Pro_Edu' }
|
|
||||||
ProfessionalEducationN { 'Pro_EduN' }
|
|
||||||
Enterprise { 'Ent' }
|
|
||||||
EnterpriseN { 'EntN'}
|
|
||||||
Education { 'Edu' }
|
|
||||||
EducationN { 'EduN'}
|
|
||||||
ProfessionalWorkstation { 'Pro_Wks' }
|
|
||||||
ProfessionalWorkstationN { 'Pro_WksN' }
|
|
||||||
}
|
|
||||||
|
|
||||||
if($CurrentBuild -ge 22000){
|
|
||||||
$Name = 'Win11'
|
|
||||||
}
|
|
||||||
else{
|
|
||||||
$Name = 'Win10'
|
|
||||||
}
|
|
||||||
|
|
||||||
#If Office is installed, modify the file name of the FFU
|
|
||||||
#$Office = Get-childitem -Path 'M:\Program Files\Microsoft Office' -ErrorAction SilentlyContinue | Out-Null
|
|
||||||
$Office = Get-childitem -Path 'M:\Program Files\Microsoft Office' -ErrorAction SilentlyContinue
|
|
||||||
if($Office){
|
|
||||||
$ffuFilePath = "W:\$Name`_$DisplayVersion`_$SKU`_Office`_$BuildDate.ffu"
|
|
||||||
$dismArgs = "/capture-ffu /imagefile=$ffuFilePath /capturedrive=\\.\PhysicalDrive0 /name:$Name$DisplayVersion$SKU /Compress:Default"
|
|
||||||
|
|
||||||
|
|
||||||
}
|
|
||||||
else{
|
|
||||||
$ffuFilePath = "W:\$Name`_$DisplayVersion`_$SKU`_Apps`_$BuildDate.ffu"
|
|
||||||
$dismArgs = "/capture-ffu /imagefile=$ffuFilePath /capturedrive=\\.\PhysicalDrive0 /name:$Name$DisplayVersion$SKU /Compress:Default"
|
|
||||||
|
|
||||||
}
|
|
||||||
|
|
||||||
#Unload Registry
|
|
||||||
Set-Location X:\
|
|
||||||
Remove-Variable SKU
|
|
||||||
Remove-Variable CurrentBuild
|
|
||||||
Remove-Variable DisplayVersion
|
|
||||||
Remove-Variable Office
|
|
||||||
reg unload "HKLM\FFU"
|
|
||||||
#This prevents Critical Process Died errors you can have during deployment of the FFU - may not happen during capture from WinPE, but adding here to be consistent with VHDX capture
|
|
||||||
Write-Host "Sleeping for 60 seconds to allow registry to unload prior to capture"
|
|
||||||
Start-sleep 60
|
|
||||||
Start-Process -FilePath dism.exe -ArgumentList $dismArgs -Wait -PassThru -ErrorAction Stop | Out-Null
|
|
||||||
#Copy DISM log to Host
|
|
||||||
xcopy X:\Windows\logs\dism\dism.log W:\ /Y | Out-Null
|
|
||||||
|
|
||||||
wpeutil Shutdown
|
|
||||||
@@ -1,5 +0,0 @@
|
|||||||
wpeinit
|
|
||||||
powercfg /s 8c5e7fda-e8bf-4a96-9a85-a6e23a8c635c
|
|
||||||
powershell -Noprofile -ExecutionPolicy Bypass -File x:\CaptureFFU.ps1
|
|
||||||
exit
|
|
||||||
|
|
||||||
@@ -1,5 +1,6 @@
|
|||||||
wpeinit
|
@echo off
|
||||||
powercfg /s 8c5e7fda-e8bf-4a96-9a85-a6e23a8c635c
|
wpeinit > NUL
|
||||||
|
powercfg /s 8c5e7fda-e8bf-4a96-9a85-a6e23a8c635c > NUL
|
||||||
powershell -Noprofile -ExecutionPolicy Bypass -File x:\ApplyFFU.ps1
|
powershell -Noprofile -ExecutionPolicy Bypass -File x:\ApplyFFU.ps1
|
||||||
exit
|
exit
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,4 @@
|
|||||||
|
SerialNumber,ComputerName
|
||||||
|
ABC12345,CORP-001
|
||||||
|
DEF67890,KIOSK-010
|
||||||
|
XYZ24680,STORE-015
|
||||||
|
@@ -0,0 +1,35 @@
|
|||||||
|
<?xml version="1.0" encoding="utf-8"?>
|
||||||
|
<unattend xmlns="urn:schemas-microsoft-com:unattend" xmlns:wcm="http://schemas.microsoft.com/WMIConfig/2002/State">
|
||||||
|
<settings pass="specialize">
|
||||||
|
<!--<ComputerName> must be in the first Component Element "Microsoft-Windows-Shell-Setup" . Do not change the order or remove it -->
|
||||||
|
<component name="Microsoft-Windows-Shell-Setup" processorArchitecture="amd64" publicKeyToken="31bf3856ad364e35" language="neutral" versionScope="nonSxS" xmlns:wcm="http://schemas.microsoft.com/WMIConfig/2002/State" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
|
||||||
|
<ComputerName>*</ComputerName><!--Leave Default will be renamed-->
|
||||||
|
<TimeZone>Eastern Standard Time</TimeZone><!--Add Your Local TimeZone-->
|
||||||
|
</component>
|
||||||
|
<!-- Place additional Components Elements and Settings below here: -->
|
||||||
|
<component name="Microsoft-Windows-Deployment" processorArchitecture="amd64" publicKeyToken="31bf3856ad364e35" language="neutral" versionScope="nonSxS" xmlns:wcm="http://schemas.microsoft.com/WMIConfig/2002/State" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
|
||||||
|
<RunASynchronous>
|
||||||
|
<RunASynchronousCommand wcm:action="add">
|
||||||
|
<Order>1</Order>
|
||||||
|
<Path>cmd.exe /c date 09-07-2024</Path> <!--Set the device clock to the current date. Helpful when BIOS clocks out of sync. -->
|
||||||
|
<Description>Set system date to a specific date</Description>
|
||||||
|
</RunASynchronousCommand>
|
||||||
|
</RunASynchronous>
|
||||||
|
</component>
|
||||||
|
</settings>
|
||||||
|
<settings pass="oobeSystem">
|
||||||
|
<component name="Microsoft-Windows-International-Core" processorArchitecture="amd64" publicKeyToken="31bf3856ad364e35" language="neutral" versionScope="nonSxS">
|
||||||
|
<InputLocale>0409:00000409</InputLocale><!--Set your Keybaord and System Local https://learn.microsoft.com/en-us/previous-versions/windows/it-pro/windows-8.1-and-8/hh825682(v=win.10) -->
|
||||||
|
<SystemLocale>en-US</SystemLocale>
|
||||||
|
<UILanguage>en-US</UILanguage>
|
||||||
|
<UserLocale>en-US</UserLocale>
|
||||||
|
</component>
|
||||||
|
<component name="Microsoft-Windows-Shell-Setup" processorArchitecture="amd64" publicKeyToken="31bf3856ad364e35" language="neutral" versionScope="nonSxS">
|
||||||
|
<OOBE>
|
||||||
|
<ProtectYourPC>3</ProtectYourPC> <!--Disable Diagnostic Data sent to Microsoft-->
|
||||||
|
<HideEULAPage>true</HideEULAPage><!--Hide the End User License agreement -->
|
||||||
|
<HideWirelessSetupInOOBE>false</HideWirelessSetupInOOBE> <!--Show Wifi Setup -->
|
||||||
|
</OOBE>
|
||||||
|
</component>
|
||||||
|
</settings>
|
||||||
|
</unattend>
|
||||||
@@ -1,8 +1,10 @@
|
|||||||
<?xml version="1.0" encoding="utf-8"?>
|
<?xml version="1.0" encoding="utf-8"?>
|
||||||
<unattend xmlns="urn:schemas-microsoft-com:unattend">
|
<unattend xmlns="urn:schemas-microsoft-com:unattend">
|
||||||
<settings pass="specialize">
|
<settings pass="specialize">
|
||||||
|
<!--<ComputerName> must be in the first Component Element "Microsoft-Windows-Shell-Setup" . Do not change the order or remove it -->
|
||||||
<component name="Microsoft-Windows-Shell-Setup" processorArchitecture="arm64" publicKeyToken="31bf3856ad364e35" language="neutral" versionScope="nonSxS" xmlns:wcm="http://schemas.microsoft.com/WMIConfig/2002/State" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
|
<component name="Microsoft-Windows-Shell-Setup" processorArchitecture="arm64" publicKeyToken="31bf3856ad364e35" language="neutral" versionScope="nonSxS" xmlns:wcm="http://schemas.microsoft.com/WMIConfig/2002/State" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
|
||||||
<ComputerName>MyComputer</ComputerName>
|
<ComputerName>*</ComputerName>
|
||||||
</component>
|
</component>
|
||||||
|
<!--Place addtional Components Elements and settings below here. -->
|
||||||
</settings>
|
</settings>
|
||||||
</unattend>
|
</unattend>
|
||||||
|
|||||||
@@ -1,8 +1,10 @@
|
|||||||
<?xml version="1.0" encoding="utf-8"?>
|
<?xml version="1.0" encoding="utf-8"?>
|
||||||
<unattend xmlns="urn:schemas-microsoft-com:unattend">
|
<unattend xmlns="urn:schemas-microsoft-com:unattend">
|
||||||
<settings pass="specialize">
|
<settings pass="specialize">
|
||||||
|
<!--<ComputerName> must be in the first Component Element "Microsoft-Windows-Shell-Setup" . Do not change the order or remove it -->
|
||||||
<component name="Microsoft-Windows-Shell-Setup" processorArchitecture="amd64" publicKeyToken="31bf3856ad364e35" language="neutral" versionScope="nonSxS" xmlns:wcm="http://schemas.microsoft.com/WMIConfig/2002/State" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
|
<component name="Microsoft-Windows-Shell-Setup" processorArchitecture="amd64" publicKeyToken="31bf3856ad364e35" language="neutral" versionScope="nonSxS" xmlns:wcm="http://schemas.microsoft.com/WMIConfig/2002/State" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
|
||||||
<ComputerName>MyComputer</ComputerName>
|
<ComputerName>*</ComputerName>
|
||||||
</component>
|
</component>
|
||||||
|
<!--Place addtional Components Elements and settings below here. -->
|
||||||
</settings>
|
</settings>
|
||||||
</unattend>
|
</unattend>
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
# Using Full Flash Update (FFU) files to speed up Windows deployment
|
# Using Full Flash Update (FFU) files to speed up Windows deployment
|
||||||
|
|
||||||
What if you could have a Windows image that has:
|
What if you could have a Windows image (Windows 10/11/Server/LTSC) that has:
|
||||||
|
|
||||||
- The latest Windows cumulative update
|
- The latest Windows cumulative update
|
||||||
- The latest .NET cumulative update
|
- The latest .NET cumulative update
|
||||||
@@ -14,100 +14,18 @@ What if you could have a Windows image that has:
|
|||||||
- The ability to bring your own drivers and apps if necessary
|
- The ability to bring your own drivers and apps if necessary
|
||||||
- Custom WinRE support
|
- Custom WinRE support
|
||||||
|
|
||||||
And the best part: it takes less than two minutes to apply the image, even with all of these updates added to the media. After setting Windows up and going through Autopilot or a provisioning package, total elapsed time ~10 minutes (depending on what Intune or your device management tool is deploying).
|
And the best part: **it takes less than two minutes** to apply the image, even with all of these updates added to the media. After setting Windows up and going through Autopilot or a provisioning package, total elapsed time ~10 minutes (depending on what Intune or your device management tool is deploying).
|
||||||
|
|
||||||
The Full-Flash update (FFU) process can automatically download the latest release of Windows 11, the updates mentioned above, and creates a USB drive that can be used to quickly reimage a machine.
|
The Full-Flash update (FFU) process can automatically download the latest release of Windows 11, the updates mentioned above, and creates a USB drive that can be used to quickly reimage a machine.
|
||||||
|
|
||||||
# Updates
|
|
||||||
|
|
||||||
2409.1 has been released! Check out the changes in the [Change Log](ChangeLog.md)
|
|
||||||
|
|
||||||
# Getting Started
|
# Getting Started
|
||||||
|
|
||||||
- Download the latest [release](https://github.com/rbalsleyMSFT/FFU/releases)
|
If you're new to FFU Builder or new to the FFU Builder UI version, check out the [Quick Start Guide](https://rbalsleymsft.github.io/FFU/quickstart.html).
|
||||||
- Extract the FFUDevelopment folder from the ZIP file (recommend to C:\FFUDevelopment)
|
|
||||||
- Follow the doc: C:\FFUDevelopment\Docs\BuildDeployFFU.docx
|
|
||||||
|
|
||||||
## YouTube Detailed Walkthrough
|
This will be the fastest way to create your first FFU. There's a new [FFU Builder Quickstart Youtube video](https://youtu.be/kOIK5OmDugc) based on the 2602.1 UI Preview release.
|
||||||
|
|
||||||
The first 15 minutes of the following video includes a quick start demo to get started. Below the video are a list of chapters. This video was taken with the 2407.2 build. Features released after that will not be demonstrated in the video.
|
## Older Youtube Videos
|
||||||
|
|
||||||
[](https://www.youtube.com/watch?v=rqXRbgeeKSQ "Reimage Windows Fast with Full-Flash Update (FFU))")
|
[2507.1 UI Preview Video](https://www.youtube.com/watch?v=oozG1aVcg9M) - First UI Preview release video. This goes deeper than the quick start video, but is missing some features that have been added since 2507.1 was released.
|
||||||
|
|
||||||
Chapters:
|
[2407.2 Video](https://www.youtube.com/watch?v=rqXRbgeeKSQ) - This was the main deep-dive video on FFU Builder (before it had that name). This is a good deep dive into how the BuildFFUVM.ps1 script works, but a lot has changed since that build.
|
||||||
|
|
||||||
[00:00](https://www.youtube.com/watch?v=rqXRbgeeKSQ&t=0s) Begin
|
|
||||||
|
|
||||||
[03:21](https://www.youtube.com/watch?v=rqXRbgeeKSQ&t=201s) Quick Start Prereqs
|
|
||||||
|
|
||||||
[07:19](https://www.youtube.com/watch?v=rqXRbgeeKSQ&t=439s) Quick Start Demo
|
|
||||||
|
|
||||||
[14:12](https://www.youtube.com/watch?v=rqXRbgeeKSQ&t=852s) Script Parameters
|
|
||||||
|
|
||||||
[17:22](https://www.youtube.com/watch?v=rqXRbgeeKSQ&t=1042s) Obtaining Windows Media
|
|
||||||
|
|
||||||
[25:55](https://www.youtube.com/watch?v=rqXRbgeeKSQ&t=1555s) Adding Applications
|
|
||||||
|
|
||||||
[26:59](https://www.youtube.com/watch?v=rqXRbgeeKSQ&t=1619s) Adding M365 Apps/Office
|
|
||||||
|
|
||||||
[29:21](https://www.youtube.com/watch?v=rqXRbgeeKSQ&t=1761s) Adding Applications via Winget
|
|
||||||
|
|
||||||
[34:59](https://www.youtube.com/watch?v=rqXRbgeeKSQ&t=2099s) Bring your own Applications
|
|
||||||
|
|
||||||
[36:01](https://www.youtube.com/watch?v=rqXRbgeeKSQ&t=2161s) Customizing InstallAppsAndSysprep.cmd
|
|
||||||
|
|
||||||
[38:34](https://www.youtube.com/watch?v=rqXRbgeeKSQ&t=2314s) Demo - Application Configuration
|
|
||||||
|
|
||||||
[49:43](https://www.youtube.com/watch?v=rqXRbgeeKSQ&t=2983s) Drivers
|
|
||||||
|
|
||||||
[55:39](https://www.youtube.com/watch?v=rqXRbgeeKSQ&t=3339s) Automatically downloading drivers
|
|
||||||
|
|
||||||
[57:28](https://www.youtube.com/watch?v=rqXRbgeeKSQ&t=3448s) Microsoft Surface drivers
|
|
||||||
|
|
||||||
[58:55](https://www.youtube.com/watch?v=rqXRbgeeKSQ&t=3535s) Dell drivers
|
|
||||||
|
|
||||||
[01:01:45](https://www.youtube.com/watch?v=rqXRbgeeKSQ&t=3705s) Lenovo drivers
|
|
||||||
|
|
||||||
[01:03:16](https://www.youtube.com/watch?v=rqXRbgeeKSQ&t=3796s) HP drivers
|
|
||||||
|
|
||||||
[01:05:25](https://www.youtube.com/watch?v=rqXRbgeeKSQ&t=3925s) Bring your own drivers
|
|
||||||
|
|
||||||
[01:06:24](https://www.youtube.com/watch?v=rqXRbgeeKSQ&t=3984s) Demo - Drivers
|
|
||||||
|
|
||||||
[01:11:55](https://www.youtube.com/watch?v=rqXRbgeeKSQ&t=4315s) Multi-model driver support
|
|
||||||
|
|
||||||
[01:13:21](https://www.youtube.com/watch?v=rqXRbgeeKSQ&t=4401s) Device naming
|
|
||||||
|
|
||||||
[01:18:30](https://www.youtube.com/watch?v=rqXRbgeeKSQ&t=4710s) Device enrollment
|
|
||||||
|
|
||||||
[01:21:43](https://www.youtube.com/watch?v=rqXRbgeeKSQ&t=4903s) Autopilot
|
|
||||||
|
|
||||||
[01:24:57](https://www.youtube.com/watch?v=rqXRbgeeKSQ&t=5097s) Provisioning packages
|
|
||||||
|
|
||||||
[01:26:54](https://www.youtube.com/watch?v=rqXRbgeeKSQ&t=5214s) Custom WinRE
|
|
||||||
|
|
||||||
[01:29:59](https://www.youtube.com/watch?v=rqXRbgeeKSQ&t=5399s) Demo - Putting it all together (Deep dive)
|
|
||||||
|
|
||||||
[01:32:06](https://www.youtube.com/watch?v=rqXRbgeeKSQ&t=5526s) Downloading Lenovo 500w drivers
|
|
||||||
|
|
||||||
[01:33:28](https://www.youtube.com/watch?v=rqXRbgeeKSQ&t=5608s) Downloading apps via Winget
|
|
||||||
|
|
||||||
[01:36:54](https://www.youtube.com/watch?v=rqXRbgeeKSQ&t=5814s) Downloading Office, Defender, Edge, OneDrive
|
|
||||||
|
|
||||||
[01:38:15](https://www.youtube.com/watch?v=rqXRbgeeKSQ&t=5895s) Building the Apps.iso
|
|
||||||
|
|
||||||
[01:39:08](https://www.youtube.com/watch?v=rqXRbgeeKSQ&t=5948s) Applying Windows to the VHDX
|
|
||||||
|
|
||||||
[01:40:16](https://www.youtube.com/watch?v=rqXRbgeeKSQ&t=6016s) Downloading and applying cumulative updates
|
|
||||||
|
|
||||||
[01:41:44](https://www.youtube.com/watch?v=rqXRbgeeKSQ&t=6104s) Building the VM
|
|
||||||
|
|
||||||
[01:48:13](https://www.youtube.com/watch?v=rqXRbgeeKSQ&t=6493s) Capturing the FFU
|
|
||||||
|
|
||||||
[01:53:38](https://www.youtube.com/watch?v=rqXRbgeeKSQ&t=6818s) Creating USB drive
|
|
||||||
|
|
||||||
[01:58:41](https://www.youtube.com/watch?v=rqXRbgeeKSQ&t=7121s) Deploying FFU
|
|
||||||
|
|
||||||
[02:11:48](https://www.youtube.com/watch?v=rqXRbgeeKSQ&t=7908s) Troubleshooting
|
|
||||||
|
|
||||||
[02:14:30](https://www.youtube.com/watch?v=rqXRbgeeKSQ&t=8070s) EDU Endpoint Office Hours
|
|
||||||
|
|||||||
@@ -0,0 +1,69 @@
|
|||||||
|
---
|
||||||
|
title: M365 Apps/Office
|
||||||
|
nav_order: 8
|
||||||
|
prev_url: /appsscriptvariables.html
|
||||||
|
prev_label: Apps Script Variables
|
||||||
|
next_url: /drivers.html
|
||||||
|
next_label: Drivers
|
||||||
|
parent: UI Overview
|
||||||
|
---
|
||||||
|
# M365 Apps/Office
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
FFU Builder uses the Office Deployment Toolkit (ODT) to install Office. In the `.\FFUDevelopment\Apps\Office` folder you'll find two files:
|
||||||
|
|
||||||
|
* `DownloadFFU.xml`
|
||||||
|
* `DeployFFU.xml`
|
||||||
|
|
||||||
|
## DownloadFFU.xml
|
||||||
|
|
||||||
|
`DownloadFFU.xml` is responsible for the download of Office. It's invoked by `setup.exe /download .\DownloadFFU.xml` during the build process. It defaults to downloading the current channel 64-bit version of Office matching the current OS language to `C:\FFUDevelopment\Apps\Office`.
|
||||||
|
|
||||||
|
`DownloadFFU.xml` contents:
|
||||||
|
|
||||||
|
```
|
||||||
|
<Configuration ID="efa6df21-a106-428e-8eaa-d89a5dda6030">
|
||||||
|
<Add SourcePath="C:\FFUDevelopment\Apps\Office" OfficeClientEdition="64" Channel="Current">
|
||||||
|
<Product ID="O365ProPlusRetail">
|
||||||
|
<Language ID="MatchOS" />
|
||||||
|
</Product>
|
||||||
|
</Add>
|
||||||
|
</Configuration>
|
||||||
|
```
|
||||||
|
|
||||||
|
If you want to modify the language, you'll need to change the language ID to the language you wish to download and install.
|
||||||
|
|
||||||
|
For more information about deploying languages see: [Overview of deploying languages for Microsoft 365 Apps - Microsoft 365 Apps Microsoft Learn](https://learn.microsoft.com/en-us/microsoft-365-apps/deploy/overview-deploying-languages-microsoft-365-apps)
|
||||||
|
|
||||||
|
## DeployFFU.xml
|
||||||
|
|
||||||
|
`DeployFFU.xml` is responsible for customizing the installation of Office. If you don't provide a custom XML, it will default to using what's in `DeployFFU.xml`. The default configuration will install the 64-bit current channel version of Office with Word, Excel, Powerpoint. Below is what's currently in `DeployFFU.xml`:
|
||||||
|
|
||||||
|
```
|
||||||
|
<Configuration ID="efa6df21-a106-428e-8eaa-d89a5dda6030">
|
||||||
|
<Add OfficeClientEdition="64" Channel="Current">
|
||||||
|
<Product ID="O365ProPlusRetail">
|
||||||
|
<Language ID="MatchOS" />
|
||||||
|
<ExcludeApp ID="Access" />
|
||||||
|
<ExcludeApp ID="Lync" />
|
||||||
|
<ExcludeApp ID="Publisher" />
|
||||||
|
<ExcludeApp ID="Bing" />
|
||||||
|
<ExcludeApp ID="Teams" />
|
||||||
|
<ExcludeApp ID="Outlook" />
|
||||||
|
</Product>
|
||||||
|
</Add>
|
||||||
|
<Property Name="SharedComputerLicensing" Value="0" />
|
||||||
|
<Property Name="FORCEAPPSHUTDOWN" Value="FALSE" />
|
||||||
|
<Property Name="DeviceBasedLicensing" Value="0" />
|
||||||
|
<Property Name="SCLCacheOverride" Value="0" />
|
||||||
|
<Updates Enabled="TRUE" />
|
||||||
|
<Display Level="None" AcceptEULA="TRUE" />
|
||||||
|
</Configuration>
|
||||||
|
```
|
||||||
|
|
||||||
|
## Copy Office Configuration XML
|
||||||
|
|
||||||
|
If you want to include your own custom XML file for office, check **Copy Office Configuration XML** and browse to the location of your custom XML file. The path to your custom Office configuration XML file is stored in the `OfficeConfigXMLFile` parameter. This file gets added to the `.\FFUDevelopment\Apps\Office` folder and is referenced in the `.\FFUDevelopment\Apps\Orchestration\Install-Office.ps1` file.
|
||||||
|
|
||||||
|
{% include page_nav.html %}
|
||||||
@@ -0,0 +1,25 @@
|
|||||||
|
title: FFU Builder
|
||||||
|
description: Build and deploy Windows FFU images
|
||||||
|
remote_theme: just-the-docs/just-the-docs@v0.10.1
|
||||||
|
plugins:
|
||||||
|
- jekyll-remote-theme
|
||||||
|
- jekyll-seo-tag
|
||||||
|
|
||||||
|
search_enabled: true
|
||||||
|
|
||||||
|
# Canonical host for absolute URLs (sitemap/robots/canonical tags)
|
||||||
|
url: "https://rbalsleymsft.github.io"
|
||||||
|
|
||||||
|
# Because you’ll publish as a project site at /FFU
|
||||||
|
baseurl: "/FFU"
|
||||||
|
|
||||||
|
callouts:
|
||||||
|
note:
|
||||||
|
title: Note
|
||||||
|
color: purple
|
||||||
|
tip:
|
||||||
|
title: Tip
|
||||||
|
color: green
|
||||||
|
warning:
|
||||||
|
title: Warning
|
||||||
|
color: yellow
|
||||||
@@ -0,0 +1,292 @@
|
|||||||
|
{% if page.url == '/' or page.url == '/index.html' %}
|
||||||
|
<meta name="google-site-verification" content="2O8GqDcQF_fvyvZjeTz-YlTaN2p62FfWd9w-xHU4Zbc" />
|
||||||
|
{% endif %}
|
||||||
|
{% if page.url == '/' or page.url == '/index.html' %}
|
||||||
|
<meta name="google-site-verification" content="2O8GqDcQF_fvyvZjeTz-YlTaN2p62FfWd9w-xHU4Zbc" />
|
||||||
|
{% endif %}
|
||||||
|
<!-- docs/_includes/head_custom.html -->
|
||||||
|
<style>
|
||||||
|
/* Layout: remove Just-the-Docs "centered narrow" constraints on wide screens */
|
||||||
|
@media (min-width: 50rem) {
|
||||||
|
.main {
|
||||||
|
max-width: none !important;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@media (min-width: 66.5rem) {
|
||||||
|
.side-bar {
|
||||||
|
width: 16.5rem !important;
|
||||||
|
min-width: 16.5rem !important;
|
||||||
|
}
|
||||||
|
|
||||||
|
.side-bar+.main {
|
||||||
|
margin-left: 16.5rem !important;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Readability: wider column + slightly larger, less-thin text */
|
||||||
|
@media (min-width: 66.5rem) {
|
||||||
|
.main-content {
|
||||||
|
max-width: 1100px;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@media (min-width: 90rem) {
|
||||||
|
.main-content {
|
||||||
|
max-width: 1280px;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Typography: approximate Microsoft Learn (Segoe UI Variable + regular body + semibold headings) */
|
||||||
|
body,
|
||||||
|
.main-content {
|
||||||
|
font-family: "Segoe UI Variable Text", "Segoe UI Variable", "Segoe UI", system-ui, -apple-system, "Helvetica Neue", Arial, sans-serif;
|
||||||
|
-webkit-font-smoothing: antialiased;
|
||||||
|
-moz-osx-font-smoothing: grayscale;
|
||||||
|
text-rendering: optimizeLegibility;
|
||||||
|
}
|
||||||
|
|
||||||
|
.main-content {
|
||||||
|
margin-right: auto;
|
||||||
|
margin-left: auto;
|
||||||
|
font-size: 1rem;
|
||||||
|
/* 16px-ish, closer to Learn */
|
||||||
|
line-height: 1.6;
|
||||||
|
font-weight: 400;
|
||||||
|
|
||||||
|
/* Just-the-Docs defaults body text to a mid-grey; make it closer to Learn */
|
||||||
|
color: #242424;
|
||||||
|
}
|
||||||
|
|
||||||
|
.main-content p,
|
||||||
|
.main-content li {
|
||||||
|
line-height: 1.65;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Lists: increase indentation (Learn-like) */
|
||||||
|
/* Just-the-Docs draws bullets/numbers via ::before with negative offsets */
|
||||||
|
.main-content ul,
|
||||||
|
.main-content ol {
|
||||||
|
padding-left: 2.25em;
|
||||||
|
}
|
||||||
|
|
||||||
|
.main-content h1,
|
||||||
|
.main-content h2,
|
||||||
|
.main-content h3 {
|
||||||
|
font-weight: 600;
|
||||||
|
letter-spacing: -0.01em;
|
||||||
|
}
|
||||||
|
|
||||||
|
.main-content code,
|
||||||
|
.main-content pre code {
|
||||||
|
font-size: 0.95em;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Wrapping: prevent long code/paths from overflowing into the page TOC */
|
||||||
|
.main-content {
|
||||||
|
overflow-wrap: anywhere;
|
||||||
|
word-break: break-word;
|
||||||
|
}
|
||||||
|
|
||||||
|
.main-content :not(pre)>code {
|
||||||
|
white-space: normal;
|
||||||
|
overflow-wrap: anywhere;
|
||||||
|
word-break: break-word;
|
||||||
|
}
|
||||||
|
|
||||||
|
.main-content a {
|
||||||
|
overflow-wrap: anywhere;
|
||||||
|
word-break: break-word;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Images: make it obvious they're zoomable (opt-out via class="no-zoom") */
|
||||||
|
.main-content img:not(.no-zoom) {
|
||||||
|
cursor: zoom-in;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Image zoom: ensure the zoom overlay sits above the right TOC */
|
||||||
|
.medium-zoom-overlay {
|
||||||
|
z-index: 9999 !important;
|
||||||
|
}
|
||||||
|
|
||||||
|
.medium-zoom-image--opened {
|
||||||
|
z-index: 10000 !important;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Right-side page TOC (desktop only) */
|
||||||
|
@media (min-width: 66.5rem) {
|
||||||
|
.main-content-wrap.has-page-toc {
|
||||||
|
display: grid;
|
||||||
|
grid-template-columns: minmax(0, 1fr) 16rem;
|
||||||
|
grid-template-rows: auto 1fr;
|
||||||
|
grid-template-areas:
|
||||||
|
"breadcrumb breadcrumb"
|
||||||
|
"content toc";
|
||||||
|
column-gap: 2rem;
|
||||||
|
align-items: start;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Breadcrumbs (when present) always span full width */
|
||||||
|
.main-content-wrap.has-page-toc .breadcrumb-nav {
|
||||||
|
grid-area: breadcrumb;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Main content always stays in the left column */
|
||||||
|
.main-content-wrap.has-page-toc .main-content {
|
||||||
|
grid-area: content;
|
||||||
|
|
||||||
|
/* Prevent wide tables/code from forcing overlap */
|
||||||
|
min-width: 0;
|
||||||
|
|
||||||
|
/* Force the content to respect the grid column width (no centering/max-width overflow) */
|
||||||
|
width: 100%;
|
||||||
|
max-width: 100%;
|
||||||
|
margin-left: 0;
|
||||||
|
margin-right: 0;
|
||||||
|
justify-self: stretch;
|
||||||
|
|
||||||
|
/* Keep heading permalink icons visible */
|
||||||
|
/* (Just-the-Docs positions .anchor-heading to the left at desktop widths) */
|
||||||
|
overflow-x: visible;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Safety net: prevent long code/tables from overlapping the TOC */
|
||||||
|
.main-content-wrap.has-page-toc .main-content pre,
|
||||||
|
.main-content-wrap.has-page-toc .main-content .highlighter-rouge,
|
||||||
|
.main-content-wrap.has-page-toc .main-content .table-wrapper {
|
||||||
|
overflow-x: auto;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* TOC always stays in the right column */
|
||||||
|
.page-toc {
|
||||||
|
grid-area: toc;
|
||||||
|
position: sticky;
|
||||||
|
top: 5.5rem;
|
||||||
|
max-height: calc(100vh - 6.5rem);
|
||||||
|
overflow: auto;
|
||||||
|
padding-left: 1rem;
|
||||||
|
border-left: 1px solid #eeebee;
|
||||||
|
font-size: 0.875rem;
|
||||||
|
|
||||||
|
/* Ensure the TOC doesn’t visually blend with overflowing content */
|
||||||
|
background-color: #fff;
|
||||||
|
z-index: 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
.page-toc__title {
|
||||||
|
font-weight: 600;
|
||||||
|
color: #27262b;
|
||||||
|
margin-bottom: 0.75rem;
|
||||||
|
}
|
||||||
|
|
||||||
|
.page-toc__list {
|
||||||
|
list-style: none;
|
||||||
|
padding-left: 0;
|
||||||
|
margin: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
.page-toc__item {
|
||||||
|
margin: 0.4rem 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
.page-toc__item--h3 {
|
||||||
|
padding-left: 0.75rem;
|
||||||
|
}
|
||||||
|
|
||||||
|
.page-toc__link {
|
||||||
|
color: inherit;
|
||||||
|
text-decoration: none;
|
||||||
|
display: block;
|
||||||
|
padding: 0.125rem 0 0.125rem 0.75rem;
|
||||||
|
border-left: 3px solid transparent;
|
||||||
|
}
|
||||||
|
|
||||||
|
.page-toc__link:hover {
|
||||||
|
text-decoration: underline;
|
||||||
|
}
|
||||||
|
|
||||||
|
.page-toc__link.is-active {
|
||||||
|
font-weight: 600;
|
||||||
|
color: #1a1a1a;
|
||||||
|
border-left-color: #2563eb;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Inline "In this article" TOC (narrow viewports; Learn-like) */
|
||||||
|
.page-toc.page-toc--inline {
|
||||||
|
margin: 1.5rem 0;
|
||||||
|
padding-left: 1rem;
|
||||||
|
border-left: 1px solid #eeebee;
|
||||||
|
font-size: 0.875rem;
|
||||||
|
}
|
||||||
|
|
||||||
|
.page-toc--inline .page-toc__title {
|
||||||
|
font-weight: 600;
|
||||||
|
color: #27262b;
|
||||||
|
margin-bottom: 0.75rem;
|
||||||
|
}
|
||||||
|
|
||||||
|
.page-toc--inline .page-toc__list {
|
||||||
|
list-style: none !important;
|
||||||
|
padding-left: 0;
|
||||||
|
margin: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
.page-toc--inline .page-toc__item {
|
||||||
|
list-style: none !important;
|
||||||
|
margin: 0.4rem 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
.page-toc--inline .page-toc__item::marker {
|
||||||
|
content: "";
|
||||||
|
}
|
||||||
|
|
||||||
|
.page-toc--inline .page-toc__item--h3 {
|
||||||
|
padding-left: 0.75rem;
|
||||||
|
}
|
||||||
|
|
||||||
|
.page-toc--inline .page-toc__link {
|
||||||
|
color: inherit;
|
||||||
|
text-decoration: none;
|
||||||
|
display: block;
|
||||||
|
padding: 0.125rem 0 0.125rem 0.75rem;
|
||||||
|
border-left: 3px solid transparent;
|
||||||
|
}
|
||||||
|
|
||||||
|
.page-toc--inline .page-toc__link:hover {
|
||||||
|
text-decoration: underline;
|
||||||
|
}
|
||||||
|
|
||||||
|
.page-toc__item.is-hidden {
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Just-the-Docs renders UL bullets via li::before; disable for inline TOC */
|
||||||
|
.page-toc--inline ul > li::before,
|
||||||
|
.page-toc--inline .page-toc__list > li::before,
|
||||||
|
.page-toc--inline .page-toc__item::before {
|
||||||
|
content: "" !important;
|
||||||
|
display: none !important;
|
||||||
|
}
|
||||||
|
|
||||||
|
.page-toc__toggle {
|
||||||
|
background: none;
|
||||||
|
border: 0;
|
||||||
|
padding: 0.25rem 0 0 0.75rem;
|
||||||
|
font: inherit;
|
||||||
|
color: inherit;
|
||||||
|
cursor: pointer;
|
||||||
|
text-decoration: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
.page-toc__toggle:hover {
|
||||||
|
text-decoration: underline;
|
||||||
|
}
|
||||||
|
</style>
|
||||||
|
|
||||||
|
<meta name="ffu-right-toc" content="{% if page.right_toc == false %}false{% else %}true{% endif %}">
|
||||||
|
|
||||||
|
<script src="{{ '/assets/js/vendor/medium-zoom.min.js' | relative_url }}" defer></script>
|
||||||
|
<script src="{{ '/assets/js/image-zoom.js' | relative_url }}" defer></script>
|
||||||
|
<script src="{{ '/assets/js/page-toc.js' | relative_url }}" defer></script>
|
||||||
|
<script src="{{ '/assets/js/external-links.js' | relative_url }}" defer></script>
|
||||||
@@ -0,0 +1,17 @@
|
|||||||
|
<!-- docs/_includes/page_nav.html -->
|
||||||
|
<div class="d-flex flex-justify-between mt-6">
|
||||||
|
{% assign prev_url = include.prev_url | default: page.prev_url %}
|
||||||
|
{% assign prev_label = include.prev_label| default: page.prev_label | default: 'Home' %}
|
||||||
|
{% assign next_url = include.next_url | default: page.next_url %}
|
||||||
|
{% assign next_label = include.next_label| default: page.next_label | default: 'Next' %}
|
||||||
|
|
||||||
|
{% if prev_url %}
|
||||||
|
<a class="btn btn-outline" href="{{ prev_url | relative_url }}">← {{ prev_label }}</a>
|
||||||
|
{% else %}
|
||||||
|
<span></span>
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
|
{% if next_url %}
|
||||||
|
<a class="btn btn-blue" href="{{ next_url | relative_url }}">{{ next_label }} →</a>
|
||||||
|
{% endif %}
|
||||||
|
</div>
|
||||||
@@ -0,0 +1,21 @@
|
|||||||
|
---
|
||||||
|
title: Applications
|
||||||
|
nav_order: 4
|
||||||
|
prev_url: /updates.html
|
||||||
|
prev_label: Updates
|
||||||
|
next_url: /winget.html
|
||||||
|
next_label: Install Winget Applications
|
||||||
|
parent: UI Overview
|
||||||
|
has_toc: false
|
||||||
|
---
|
||||||
|
# Applications
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
Applications can be installed in three different ways:
|
||||||
|
|
||||||
|
* Winget (using an AppList.json file)
|
||||||
|
* Bring Your Own Applications (using files you provide - can also be used to run command lines with or without content)
|
||||||
|
* Apps Script Variables (key/value pairs used in conjunction with a PowerShell script to install custom applications)
|
||||||
|
|
||||||
|
{% include page_nav.html %}
|
||||||
@@ -0,0 +1,131 @@
|
|||||||
|
---
|
||||||
|
title: Apps Script Variables
|
||||||
|
nav_order: 7
|
||||||
|
prev_url: /byoapps.html
|
||||||
|
prev_label: BYO Applications
|
||||||
|
next_url: /M365appsoffice.html
|
||||||
|
next_label: M365 Apps Office
|
||||||
|
parent: Applications
|
||||||
|
grand_parent: UI Overview
|
||||||
|
---
|
||||||
|
# Apps Script Variables
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
Apps Script Variables are key value pairs that are used to create a hashtable that is passed to the `BuildFFUVM.ps1` script (stored in the `$AppScriptVariables` parameter as a hashtable). At build time, `BuildFFUVM.ps1` will export the `$AppsScriptVariables` hashtable to an `AppsScriptVariables.json` file in the `$OrchestrationPath` folder (`$AppsPath\Orchestration`). You can also manually create your own `AppsScriptVariables.json `file and place it in the `$AppsPath\Orchestration` folder.
|
||||||
|
|
||||||
|
In the VM, the `Orchestrator.ps1` file will call `Invoke-AppsScript.ps1` if `AppsScriptVariables.json` exists. `Invoke-AppsScript.ps1` must be modified to handle your variables.
|
||||||
|
|
||||||
|
`Invoke-AppsScript.ps1` has the following commented example of how to modify the file:
|
||||||
|
|
||||||
|
```
|
||||||
|
# Example of how to use the AppsScriptVariables hashtable to control script execution
|
||||||
|
|
||||||
|
# Note: The UI saves the values as strings, so if you type true for a value, it'll save to the config file as a string, not boolean
|
||||||
|
|
||||||
|
# Example: Check if a variable named 'foo' is set to string 'bar' and run a script accordingly
|
||||||
|
# if ($AppsScriptVariables['foo'] -eq 'bar') {
|
||||||
|
# Write-Host "Foo would have installed"
|
||||||
|
# }
|
||||||
|
# else {
|
||||||
|
# Write-Host "Foo would not have installed"
|
||||||
|
# }
|
||||||
|
|
||||||
|
# Example: Check if a variable named 'Teams' is set to string 'true' and run a script accordingly
|
||||||
|
# if ($AppsScriptVariables['Teams'] -eq 'true') {
|
||||||
|
# Write-Host "Teams would have been installed"
|
||||||
|
# }
|
||||||
|
# else {
|
||||||
|
# Write-Host "Teams would not have been installed"
|
||||||
|
# }
|
||||||
|
```
|
||||||
|
|
||||||
|
## Why use Apps Script Variables?
|
||||||
|
|
||||||
|
This allows for you to create a dynamic task sequence via a PowerShell script with simple if statements to run apps, commands, etc. This is all driven by your `FFUConfig.json` file. For example, the following `FFUConfig.json` file contains an AppsScriptVariables hashtable of foo and vmwaretools like the screenshot above. If you build servers that require vmware tools, you may set the value to true. However there may be situations where you don't need vmwaretools installed. If that's the case, you set vmwaretools to false. This allows for your `Invoke-AppsScript.ps1` file to stay the same and all you have to do is adjust the variables.
|
||||||
|
|
||||||
|
```
|
||||||
|
s{
|
||||||
|
"AdditionalFFUFiles": [],
|
||||||
|
"AllowExternalHardDiskMedia": false,
|
||||||
|
"AllowVHDXCaching": false,
|
||||||
|
"AppListPath": "C:\\FFUDevelopment\\Apps\\AppList.json",
|
||||||
|
"AppsPath": "C:\\FFUDevelopment\\Apps",
|
||||||
|
"AppsScriptVariables": {
|
||||||
|
"foo": "bar",
|
||||||
|
"vmwaretools": "true"
|
||||||
|
},
|
||||||
|
"BuildUSBDrive": false,
|
||||||
|
"CleanupAppsISO": true,
|
||||||
|
"CleanupDeployISO": true,
|
||||||
|
"CleanupDrivers": false,
|
||||||
|
"CompactOS": true,
|
||||||
|
"CompressDownloadedDriversToWim": false,
|
||||||
|
"CopyAdditionalFFUFiles": false,
|
||||||
|
"CopyAutopilot": false,
|
||||||
|
"CopyDrivers": false,
|
||||||
|
"CopyOfficeConfigXML": false,
|
||||||
|
"CopyPEDrivers": false,
|
||||||
|
"CopyPPKG": false,
|
||||||
|
"CopyUnattend": false,
|
||||||
|
"CreateDeploymentMedia": true,
|
||||||
|
"CustomFFUNameTemplate": "{WindowsRelease}_{WindowsVersion}_{SKU}_{yyyy}-{MM}-{dd}_{HH}{mm}",
|
||||||
|
"Disksize": 53687091200,
|
||||||
|
"DownloadDrivers": false,
|
||||||
|
"DriversFolder": "C:\\FFUDevelopment\\Drivers",
|
||||||
|
"DriversJsonPath": "C:\\FFUDevelopment\\Drivers\\Drivers.json",
|
||||||
|
"FFUCaptureLocation": "C:\\FFUDevelopment\\FFU",
|
||||||
|
"FFUDevelopmentPath": "C:\\FFUDevelopment",
|
||||||
|
"FFUPrefix": "_FFU",
|
||||||
|
"InjectUnattend": false,
|
||||||
|
"InstallApps": true,
|
||||||
|
"InstallDrivers": false,
|
||||||
|
"InstallOffice": false,
|
||||||
|
"InstallWingetApps": false,
|
||||||
|
"ISOPath": "",
|
||||||
|
"LogicalSectorSizeBytes": 512,
|
||||||
|
"MaxUSBDrives": 5,
|
||||||
|
"MediaType": "Consumer",
|
||||||
|
"Memory": 4294967296,
|
||||||
|
"OfficeConfigXMLFile": "",
|
||||||
|
"OfficePath": "C:\\FFUDevelopment\\Apps\\Office",
|
||||||
|
"Optimize": true,
|
||||||
|
"OptionalFeatures": "",
|
||||||
|
"OrchestrationPath": "C:\\FFUDevelopment\\Apps\\Orchestration",
|
||||||
|
"PEDriversFolder": "C:\\FFUDevelopment\\PEDrivers",
|
||||||
|
"Processors": 4,
|
||||||
|
"ProductKey": "",
|
||||||
|
"PromptExternalHardDiskMedia": true,
|
||||||
|
"RemoveApps": false,
|
||||||
|
"RemoveFFU": false,
|
||||||
|
"RemoveUpdates": false,
|
||||||
|
"Threads": 5,
|
||||||
|
"UpdateADK": true,
|
||||||
|
"UpdateEdge": true,
|
||||||
|
"UpdateLatestCU": true,
|
||||||
|
"UpdateLatestDefender": true,
|
||||||
|
"UpdateLatestMicrocode": false,
|
||||||
|
"UpdateLatestMSRT": true,
|
||||||
|
"UpdateLatestNet": true,
|
||||||
|
"UpdateOneDrive": true,
|
||||||
|
"UpdatePreviewCU": false,
|
||||||
|
"USBDriveList": {},
|
||||||
|
"UseDriversAsPEDrivers": false,
|
||||||
|
"UserAppListPath": "C:\\FFUDevelopment\\Apps\\UserAppList.json",
|
||||||
|
"Verbose": false,
|
||||||
|
"VMLocation": "C:\\FFUDevelopment\\VM",
|
||||||
|
"VMSwitchName": "External",
|
||||||
|
"WindowsArch": "x64",
|
||||||
|
"WindowsLang": "en-us",
|
||||||
|
"WindowsRelease": 11,
|
||||||
|
"WindowsSKU": "Pro",
|
||||||
|
"WindowsVersion": "25H2"
|
||||||
|
}
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
Example command line to run with vmwaretools set to false and foo set to foo. This will create the `AppsScriptVariables.json` file in the Orchestration folder with the updated values of `foo=foo` and `vmwaretools=false` without the need to modify the config file.
|
||||||
|
|
||||||
|
`.\BuildFFUVM.ps1 -configFile 'C:\FFUDevelopment\config\FFUConfig.json' -appsScriptVariables @{foo='foo'; vmwaretools='false'}`
|
||||||
|
|
||||||
|
{% include page_nav.html %}
|
||||||
@@ -0,0 +1,91 @@
|
|||||||
|
(function () {
|
||||||
|
'use strict';
|
||||||
|
|
||||||
|
function HasToken(tokens, token) {
|
||||||
|
for (var i = 0; i < tokens.length; i++) {
|
||||||
|
if (tokens[i] === token) {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
function AddRelToken(anchor, token) {
|
||||||
|
var rel = (anchor.getAttribute('rel') || '').trim();
|
||||||
|
var tokens = rel ? rel.split(/\s+/) : [];
|
||||||
|
|
||||||
|
if (!HasToken(tokens, token)) {
|
||||||
|
tokens.push(token);
|
||||||
|
}
|
||||||
|
|
||||||
|
anchor.setAttribute('rel', tokens.join(' ').trim());
|
||||||
|
}
|
||||||
|
|
||||||
|
function IsExternalHttpLink(url) {
|
||||||
|
if (!url) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (url.protocol !== 'http:' && url.protocol !== 'https:') {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
return url.origin !== window.location.origin;
|
||||||
|
}
|
||||||
|
|
||||||
|
function InitExternalLinksNewTab() {
|
||||||
|
var mainContent = document.querySelector('.main-content');
|
||||||
|
if (!mainContent) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
var anchors = mainContent.querySelectorAll('a[href]');
|
||||||
|
for (var i = 0; i < anchors.length; i++) {
|
||||||
|
var anchor = anchors[i];
|
||||||
|
var href = (anchor.getAttribute('href') || '').trim();
|
||||||
|
|
||||||
|
if (!href) {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (href.charAt(0) === '#') {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (href.indexOf('mailto:') === 0 || href.indexOf('tel:') === 0 || href.indexOf('javascript:') === 0) {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
var url = null;
|
||||||
|
try {
|
||||||
|
url = new URL(href, window.location.href);
|
||||||
|
} catch (e) {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!IsExternalHttpLink(url)) {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
var target = (anchor.getAttribute('target') || '').trim();
|
||||||
|
|
||||||
|
if (!target) {
|
||||||
|
anchor.setAttribute('target', '_blank');
|
||||||
|
target = '_blank';
|
||||||
|
}
|
||||||
|
|
||||||
|
if (target === '_blank') {
|
||||||
|
AddRelToken(anchor, 'noopener');
|
||||||
|
AddRelToken(anchor, 'noreferrer');
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if (document.readyState === 'loading') {
|
||||||
|
document.addEventListener('DOMContentLoaded', InitExternalLinksNewTab);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
InitExternalLinksNewTab();
|
||||||
|
})();
|
||||||
@@ -0,0 +1,22 @@
|
|||||||
|
(function () {
|
||||||
|
'use strict';
|
||||||
|
|
||||||
|
function InitImageZoom() {
|
||||||
|
if (window.mediumZoom === undefined) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
window.mediumZoom('.main-content img:not(.no-zoom):not([src$=".svg"])', {
|
||||||
|
margin: 24,
|
||||||
|
background: 'rgba(0,0,0,0.80)',
|
||||||
|
scrollOffset: 0
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
if (document.readyState === 'loading') {
|
||||||
|
document.addEventListener('DOMContentLoaded', InitImageZoom);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
InitImageZoom();
|
||||||
|
})();
|
||||||
@@ -0,0 +1,403 @@
|
|||||||
|
(function () {
|
||||||
|
'use strict';
|
||||||
|
|
||||||
|
var scrollSpyDispose = null;
|
||||||
|
var resizeReinitTimerId = null;
|
||||||
|
var inlineMaxVisibleItems = 4;
|
||||||
|
|
||||||
|
function IsRightTocEnabled() {
|
||||||
|
var meta = document.querySelector('meta[name="ffu-right-toc"]');
|
||||||
|
if (meta && meta.content && meta.content.toLowerCase() === 'false') {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
function IsDesktopViewport() {
|
||||||
|
try {
|
||||||
|
return window.matchMedia && window.matchMedia('(min-width: 66.5rem)').matches;
|
||||||
|
} catch (e) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function RemoveExistingToc() {
|
||||||
|
if (scrollSpyDispose) {
|
||||||
|
scrollSpyDispose();
|
||||||
|
scrollSpyDispose = null;
|
||||||
|
}
|
||||||
|
|
||||||
|
var existingTocs = document.querySelectorAll('.page-toc');
|
||||||
|
for (var i = 0; i < existingTocs.length; i++) {
|
||||||
|
existingTocs[i].remove();
|
||||||
|
}
|
||||||
|
|
||||||
|
var wrap = document.querySelector('.main-content-wrap');
|
||||||
|
if (wrap) {
|
||||||
|
wrap.classList.remove('has-page-toc');
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function InsertInlineToc(main, toc) {
|
||||||
|
if (!main || !toc) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
var title = main.querySelector('h1');
|
||||||
|
if (title && title.parentNode === main) {
|
||||||
|
if (title.nextSibling) {
|
||||||
|
main.insertBefore(toc, title.nextSibling);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
main.appendChild(toc);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (main.firstChild) {
|
||||||
|
main.insertBefore(toc, main.firstChild);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
main.appendChild(toc);
|
||||||
|
}
|
||||||
|
|
||||||
|
function GetHeadings(container) {
|
||||||
|
var headings = container.querySelectorAll('h2, h3');
|
||||||
|
var results = [];
|
||||||
|
|
||||||
|
for (var i = 0; i < headings.length; i++) {
|
||||||
|
var heading = headings[i];
|
||||||
|
|
||||||
|
if (heading.classList.contains('no_toc')) {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
var id = heading.getAttribute('id');
|
||||||
|
if (!id) {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
var text = (heading.textContent || '').trim();
|
||||||
|
if (!text) {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
results.push({
|
||||||
|
level: heading.tagName.toLowerCase(),
|
||||||
|
id: id,
|
||||||
|
text: text
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
return results;
|
||||||
|
}
|
||||||
|
|
||||||
|
function BuildToc(headings, options) {
|
||||||
|
var variant = (options && options.variant) ? options.variant : 'right';
|
||||||
|
var maxVisible = (options && options.maxVisible) ? options.maxVisible : 0;
|
||||||
|
var isInline = 'inline' === variant;
|
||||||
|
|
||||||
|
var nav = document.createElement('nav');
|
||||||
|
nav.className = 'page-toc' + (isInline ? ' page-toc--inline' : '');
|
||||||
|
nav.setAttribute('aria-label', 'On this page');
|
||||||
|
|
||||||
|
var title = document.createElement('div');
|
||||||
|
title.className = 'page-toc__title';
|
||||||
|
title.textContent = 'In this article';
|
||||||
|
nav.appendChild(title);
|
||||||
|
|
||||||
|
var list = document.createElement('ul');
|
||||||
|
list.className = 'page-toc__list';
|
||||||
|
list.id = 'page-toc-list';
|
||||||
|
|
||||||
|
for (var i = 0; i < headings.length; i++) {
|
||||||
|
var item = headings[i];
|
||||||
|
|
||||||
|
var li = document.createElement('li');
|
||||||
|
li.className = 'page-toc__item page-toc__item--' + item.level;
|
||||||
|
|
||||||
|
var a = document.createElement('a');
|
||||||
|
a.className = 'page-toc__link';
|
||||||
|
a.href = '#' + item.id;
|
||||||
|
a.textContent = item.text;
|
||||||
|
|
||||||
|
li.appendChild(a);
|
||||||
|
list.appendChild(li);
|
||||||
|
|
||||||
|
if (isInline && maxVisible > 0 && i >= maxVisible) {
|
||||||
|
li.classList.add('is-hidden');
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
nav.appendChild(list);
|
||||||
|
|
||||||
|
if (isInline && maxVisible > 0 && headings.length > maxVisible) {
|
||||||
|
var hiddenCount = headings.length - maxVisible;
|
||||||
|
var isExpanded = false;
|
||||||
|
|
||||||
|
var toggle = document.createElement('button');
|
||||||
|
toggle.type = 'button';
|
||||||
|
toggle.className = 'page-toc__toggle';
|
||||||
|
toggle.setAttribute('aria-controls', list.id);
|
||||||
|
toggle.setAttribute('aria-expanded', 'false');
|
||||||
|
|
||||||
|
function SetToggleText() {
|
||||||
|
if (isExpanded) {
|
||||||
|
toggle.textContent = 'Show less';
|
||||||
|
} else {
|
||||||
|
toggle.textContent = 'Show ' + hiddenCount + ' more';
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function SetHiddenState() {
|
||||||
|
var items = list.querySelectorAll('.page-toc__item');
|
||||||
|
for (var j = 0; j < items.length; j++) {
|
||||||
|
if (j >= maxVisible) {
|
||||||
|
if (isExpanded) {
|
||||||
|
items[j].classList.remove('is-hidden');
|
||||||
|
} else {
|
||||||
|
items[j].classList.add('is-hidden');
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
toggle.setAttribute('aria-expanded', isExpanded ? 'true' : 'false');
|
||||||
|
SetToggleText();
|
||||||
|
}
|
||||||
|
|
||||||
|
toggle.addEventListener('click', function () {
|
||||||
|
isExpanded = !isExpanded;
|
||||||
|
SetHiddenState();
|
||||||
|
});
|
||||||
|
|
||||||
|
SetHiddenState();
|
||||||
|
nav.appendChild(toggle);
|
||||||
|
}
|
||||||
|
|
||||||
|
return nav;
|
||||||
|
}
|
||||||
|
|
||||||
|
function SetActiveTocLink(toc, activeId, keepVisibleInPanel) {
|
||||||
|
if (!toc) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
var links = toc.querySelectorAll('.page-toc__link');
|
||||||
|
for (var i = 0; i < links.length; i++) {
|
||||||
|
var link = links[i];
|
||||||
|
var href = link.getAttribute('href') || '';
|
||||||
|
var isActive = ('#' + activeId) === href;
|
||||||
|
|
||||||
|
if (isActive) {
|
||||||
|
link.classList.add('is-active');
|
||||||
|
|
||||||
|
if (keepVisibleInPanel) {
|
||||||
|
/* Keep the active item visible inside the TOC panel (desktop/right TOC only) */
|
||||||
|
try {
|
||||||
|
link.scrollIntoView({ block: 'nearest' });
|
||||||
|
} catch (e) {
|
||||||
|
link.scrollIntoView();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
link.classList.remove('is-active');
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function SetupScrollSpy(main, toc, headings) {
|
||||||
|
if (!main || !toc || !headings || headings.length < 1) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Scrollspy is desktop-only */
|
||||||
|
if (!IsDesktopViewport()) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
var headingElements = [];
|
||||||
|
for (var i = 0; i < headings.length; i++) {
|
||||||
|
var el = document.getElementById(headings[i].id);
|
||||||
|
if (el) {
|
||||||
|
headingElements.push(el);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if (headingElements.length < 1) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
var activeId = null;
|
||||||
|
var ticking = false;
|
||||||
|
var lockActiveUntilMs = 0;
|
||||||
|
|
||||||
|
function IsNearBottomOfPage() {
|
||||||
|
var thresholdPx = 24;
|
||||||
|
var scrollY = window.scrollY || window.pageYOffset || 0;
|
||||||
|
var viewportBottom = scrollY + window.innerHeight;
|
||||||
|
var pageHeight = Math.max(document.documentElement.scrollHeight, document.body.scrollHeight);
|
||||||
|
|
||||||
|
return viewportBottom >= (pageHeight - thresholdPx);
|
||||||
|
}
|
||||||
|
|
||||||
|
function GetCurrentHeadingId() {
|
||||||
|
/* If we're at the bottom, force the last heading active */
|
||||||
|
if (IsNearBottomOfPage()) {
|
||||||
|
return headingElements[headingElements.length - 1].getAttribute('id');
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Choose the heading closest to the top "activation line" */
|
||||||
|
var activationLine = 16;
|
||||||
|
var current = null;
|
||||||
|
|
||||||
|
for (var i = 0; i < headingElements.length; i++) {
|
||||||
|
var rectTop = headingElements[i].getBoundingClientRect().top;
|
||||||
|
|
||||||
|
if (rectTop <= activationLine) {
|
||||||
|
current = headingElements[i];
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (null === current) {
|
||||||
|
current = headingElements[i];
|
||||||
|
}
|
||||||
|
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (null === current) {
|
||||||
|
current = headingElements[0];
|
||||||
|
}
|
||||||
|
|
||||||
|
return current.getAttribute('id');
|
||||||
|
}
|
||||||
|
|
||||||
|
function Update() {
|
||||||
|
ticking = false;
|
||||||
|
|
||||||
|
/* If the viewport becomes narrow after load, avoid scroll fighting */
|
||||||
|
if (!IsDesktopViewport()) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (Date.now() < lockActiveUntilMs) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
var currentId = GetCurrentHeadingId();
|
||||||
|
if (!currentId || currentId === activeId) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
activeId = currentId;
|
||||||
|
SetActiveTocLink(toc, activeId, true);
|
||||||
|
}
|
||||||
|
|
||||||
|
function OnScrollOrResize() {
|
||||||
|
if (ticking) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
ticking = true;
|
||||||
|
window.requestAnimationFrame(Update);
|
||||||
|
}
|
||||||
|
|
||||||
|
function OnTocClick(evt) {
|
||||||
|
var target = evt.target;
|
||||||
|
if (!target || !target.classList || !target.classList.contains('page-toc__link')) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
var href = target.getAttribute('href') || '';
|
||||||
|
if (href.charAt(0) !== '#') {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
var id = href.substring(1);
|
||||||
|
if (!id) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Prevent scrollspy from immediately overriding the clicked section */
|
||||||
|
lockActiveUntilMs = Date.now() + 800;
|
||||||
|
|
||||||
|
activeId = id;
|
||||||
|
SetActiveTocLink(toc, activeId, true);
|
||||||
|
}
|
||||||
|
|
||||||
|
window.addEventListener('scroll', OnScrollOrResize, { passive: true });
|
||||||
|
window.addEventListener('resize', OnScrollOrResize);
|
||||||
|
toc.addEventListener('click', OnTocClick);
|
||||||
|
|
||||||
|
Update();
|
||||||
|
|
||||||
|
return function DisposeScrollSpy() {
|
||||||
|
window.removeEventListener('scroll', OnScrollOrResize);
|
||||||
|
window.removeEventListener('resize', OnScrollOrResize);
|
||||||
|
toc.removeEventListener('click', OnTocClick);
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
function InitRightToc() {
|
||||||
|
if (!IsRightTocEnabled()) {
|
||||||
|
RemoveExistingToc();
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
var main = document.querySelector('.main-content main');
|
||||||
|
if (!main) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
var headings = GetHeadings(main);
|
||||||
|
if (headings.length < 2) {
|
||||||
|
RemoveExistingToc();
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (IsDesktopViewport()) {
|
||||||
|
RemoveExistingToc();
|
||||||
|
|
||||||
|
var wrap = document.querySelector('.main-content-wrap');
|
||||||
|
if (!wrap) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
wrap.classList.add('has-page-toc');
|
||||||
|
|
||||||
|
var toc = BuildToc(headings, { variant: 'right' });
|
||||||
|
wrap.appendChild(toc);
|
||||||
|
|
||||||
|
scrollSpyDispose = SetupScrollSpy(main, toc, headings);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Narrow viewports: place TOC at the top of the article (Learn-like) */
|
||||||
|
RemoveExistingToc();
|
||||||
|
|
||||||
|
var inlineToc = BuildToc(headings, { variant: 'inline', maxVisible: inlineMaxVisibleItems });
|
||||||
|
InsertInlineToc(main, inlineToc);
|
||||||
|
}
|
||||||
|
|
||||||
|
function OnViewportResize() {
|
||||||
|
if (null !== resizeReinitTimerId) {
|
||||||
|
window.clearTimeout(resizeReinitTimerId);
|
||||||
|
}
|
||||||
|
|
||||||
|
resizeReinitTimerId = window.setTimeout(InitRightToc, 150);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (document.readyState === 'loading') {
|
||||||
|
document.addEventListener('DOMContentLoaded', function () {
|
||||||
|
InitRightToc();
|
||||||
|
window.addEventListener('resize', OnViewportResize);
|
||||||
|
});
|
||||||
|
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
InitRightToc();
|
||||||
|
window.addEventListener('resize', OnViewportResize);
|
||||||
|
})();
|
||||||
@@ -0,0 +1,917 @@
|
|||||||
|
---
|
||||||
|
title: Build
|
||||||
|
nav_order: 10
|
||||||
|
prev_url: /drivers.html
|
||||||
|
prev_label: Drivers
|
||||||
|
next_url: /monitor.html
|
||||||
|
next_label: Monitor
|
||||||
|
parent: UI Overview
|
||||||
|
---
|
||||||
|
# Build
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
The Build tab is where the magic happens
|
||||||
|
|
||||||
|
## FFU Development Path
|
||||||
|
|
||||||
|
The FFU Development path (`$FFUDevelopmentPath`) is the root path of where most other paths are derived. The default is `$PSScriptRoot`, which is the location the script is currently running from and can be changed to another location from within the UI.
|
||||||
|
|
||||||
|
If you want to download and test new releases, or want to create a new FFUDevelopment folder without modifying your existing one, you can always download the source files and put them in another location.
|
||||||
|
|
||||||
|
The recommendation is to run from `C:\FFUDevelopment` and in most cases the path shouldn't need to be changed.
|
||||||
|
|
||||||
|
## Custom FFU Name Template
|
||||||
|
|
||||||
|
Controls the `-CustomFFUNameTemplate` parameter. This allows you to define a custom naming convention for the captured FFU file using placeholders that are replaced at build time.
|
||||||
|
|
||||||
|
If left blank, the default FFU naming convention is used.
|
||||||
|
|
||||||
|
### Available Placeholders
|
||||||
|
|
||||||
|
| Placeholder | Description | Example |
|
||||||
|
| -------------------- | ---------------------- | ------------------------------------------------------------------------------ |
|
||||||
|
| `{WindowsRelease}` | Windows release number | `10`, `11`, `2016`, `2019`, `2022`, `2025` |
|
||||||
|
| `{WindowsVersion}` | Windows version | `1607`, `1809`, `21h2`, `22h2`, `23h2`, `24h2` |
|
||||||
|
| `{SKU}` | Windows edition | `Home`, `Pro`, `Enterprise`, `Education`, `Standard`, `Datacenter` |
|
||||||
|
| `{BuildDate}` | Month and year | `Nov2025` |
|
||||||
|
| `{yyyy}` | 4-digit year | `2025` |
|
||||||
|
| `{MM}` | 2-digit month | `11` (for November) |
|
||||||
|
| `{dd}` | 2-digit day | `28` |
|
||||||
|
| `{HH}` | Hour in 24-hour format | `14` (for 2 PM) |
|
||||||
|
| `{hh}` | Hour in 12-hour format | `02` (for 2 PM) |
|
||||||
|
| `{mm}` | 2-digit minute | `09` |
|
||||||
|
| `{tt}` | AM/PM designator | `AM` or `PM` |
|
||||||
|
|
||||||
|
### Examples
|
||||||
|
|
||||||
|
**Basic template with date and time:**
|
||||||
|
|
||||||
|
```
|
||||||
|
{WindowsRelease}_{WindowsVersion}_{SKU}_{yyyy}-{MM}-{dd}_{HH}{mm}
|
||||||
|
```
|
||||||
|
|
||||||
|
Result: `Win11_24h2_Pro_2025-11-28_1425.ffu`
|
||||||
|
|
||||||
|
**Template with static text (e.g., indicating Office is installed):**
|
||||||
|
|
||||||
|
```
|
||||||
|
{WindowsRelease}_{WindowsVersion}_{SKU}_Office_{yyyy}-{MM}-{dd}_{HH}{mm}
|
||||||
|
```
|
||||||
|
|
||||||
|
Result: `Win11_24h2_Pro_Office_2025-11-28_1425.ffu`
|
||||||
|
|
||||||
|
**Simple template with build date:**
|
||||||
|
|
||||||
|
```
|
||||||
|
{WindowsRelease}_{WindowsVersion}_{SKU}_{BuildDate}
|
||||||
|
```
|
||||||
|
|
||||||
|
Result: `Win11_24h2_Pro_Nov2025.ffu`
|
||||||
|
|
||||||
|
{: .note-title}
|
||||||
|
|
||||||
|
> Note
|
||||||
|
>
|
||||||
|
> The `.ffu` extension is automatically appended if not included in the template.
|
||||||
|
|
||||||
|
## FFU Capture Location
|
||||||
|
|
||||||
|
The FFU Capture Location sets the `-FFUCaptureLocation` parameter that determines where completed `.ffu` images are written. By default it points to `$FFUDevelopmentPath\FFU`, and the build script creates the folder automatically if it does not already exist.
|
||||||
|
|
||||||
|
When apps are installed in a VM, the build still uses the VM for application installs and sysprep, but the actual FFU capture now happens on the host after the VHDX is optimized and remounted. That means completed images are written directly to this folder without creating a temporary SMB share, temporary local account, or capture ISO.
|
||||||
|
|
||||||
|
Choose a path on fast storage with plenty of free space—the directory must be local to the host running `BuildFFUVM.ps1`, and large captures can easily exceed 25–30 GB. This location also feeds other options such as **Copy Additional FFU Files**, **Build USB Drive**, and **Remove FFU**, so keeping all finished images here keeps those workflows simple.
|
||||||
|
|
||||||
|
## Threads
|
||||||
|
|
||||||
|
Controls the `-Threads` parameter, which sets the number of parallel threads used for concurrent operations throughout FFU Builder. The default value is **5**.
|
||||||
|
|
||||||
|
### Operations Affected by Threads
|
||||||
|
|
||||||
|
The Threads value applies to the following parallel operations:
|
||||||
|
|
||||||
|
| Operation | Description |
|
||||||
|
| -------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| **Winget Application Downloads** | When downloading multiple Winget applications, each application download runs as a parallel task |
|
||||||
|
| **BYO Application Copy** | When copying multiple Bring Your Own (BYO) applications to the Apps folder, each copy operation runs in parallel |
|
||||||
|
| **Driver Downloads** | When downloading drivers for multiple device models, each driver download and extraction runs as a parallel task |
|
||||||
|
|
||||||
|
### Recommended Values
|
||||||
|
|
||||||
|
| Threads | Use Case |
|
||||||
|
| -------------- | ------------------------------------------------------------------------- |
|
||||||
|
| **1** | Minimal system impact; useful for troubleshooting or low-resource systems |
|
||||||
|
| **5** | Default; balanced performance for most systems |
|
||||||
|
| **8-10** | Higher concurrency for systems with fast storage and network connections |
|
||||||
|
|
||||||
|
{: .note-title}
|
||||||
|
|
||||||
|
> Note
|
||||||
|
>
|
||||||
|
> Setting a higher thread count may improve download times but will increase resource utilization. If you experience stability issues or resource constraints, try reducing the thread count.
|
||||||
|
|
||||||
|
### Validation
|
||||||
|
|
||||||
|
The UI validates that the Threads value is a valid integer greater than or equal to 1. If an invalid value is entered, it automatically resets to **1**.
|
||||||
|
|
||||||
|
## BITS Priority
|
||||||
|
|
||||||
|
Controls the `-BitsPriority` parameter, which determines the priority level for Background Intelligent Transfer Service (BITS) downloads. The default value is **Normal**.
|
||||||
|
|
||||||
|
If you want faster downloads, change the priority to Foreground. Normal priority will significantly slow down downloads since BITS treats non-Foreground downloads as synchronous and queues each download. This means multiple driver or winget application downloads will go much slower than using Foreground. Normal is default as per Microsoft best practice guidance for using BITS.
|
||||||
|
|
||||||
|
## General Build Options Expander
|
||||||
|
|
||||||
|
This expander groups the core build behaviors that affect how the FFU is created, optimized, cached, and prepared for deployment.
|
||||||
|
|
||||||
|
### Compact OS
|
||||||
|
|
||||||
|
Controls the `-CompactOS` parameter. When checked, the Windows image is applied using compressed files. The default is **checked**.
|
||||||
|
|
||||||
|
#### How It Works
|
||||||
|
|
||||||
|
When enabled, the build script uses the `-Compact` switch with `Expand-WindowsImage` when applying the Windows image to the OS partition. This compresses Windows system files using Compact OS compression, which reduces the disk footprint of the operating system. On an x64 image, space savings is ~3.5-4GB.
|
||||||
|
|
||||||
|
#### Benefits
|
||||||
|
|
||||||
|
| Benefit | Description |
|
||||||
|
| ------------------------------- | ---------------------------------------------------------------------------------------------------- |
|
||||||
|
| **Reduced Disk Space** | Windows files are stored in a compressed state, saving several gigabytes of storage |
|
||||||
|
| **Smaller FFU Size** | The captured FFU file is smaller because the OS partition contains compressed files |
|
||||||
|
| **Faster Deployment** | Smaller FFU files transfer more quickly to USB drives and deploy faster to target devices |
|
||||||
|
| **No Performance Impact** | Modern CPUs decompress files faster than they can be read from storage, so performance is maintained |
|
||||||
|
|
||||||
|
#### When to Disable
|
||||||
|
|
||||||
|
You may want to disable Compact OS in the following scenarios:
|
||||||
|
|
||||||
|
- **Windows Server builds**: The script automatically disables Compact OS for Windows Server operating systems because the Windows Overlay Filter (wof.sys) is not included in Server SKUs
|
||||||
|
- **Troubleshooting**: If you experience issues with specific applications that are incompatible with compressed files
|
||||||
|
- **Maximum performance requirements**: In rare cases where every CPU cycle matters
|
||||||
|
|
||||||
|
{: .note-title}
|
||||||
|
|
||||||
|
> Note
|
||||||
|
>
|
||||||
|
> Compact OS is automatically disabled when building Windows Server images, regardless of this setting. The script detects Server operating systems and applies the Windows image without compression.
|
||||||
|
|
||||||
|
### Update ADK
|
||||||
|
|
||||||
|
Controls the `-UpdateADK` parameter. When checked, the script checks for and installs or updates to the latest Windows ADK and WinPE add-on before starting the build. The default is **checked**.
|
||||||
|
|
||||||
|
#### How It Works
|
||||||
|
|
||||||
|
When enabled, the build process performs the following checks before starting:
|
||||||
|
|
||||||
|
1. **Version Check**: Queries the [Microsoft ADK installation page](https://learn.microsoft.com/en-us/windows-hardware/get-started/adk-install) to determine the latest available ADK version
|
||||||
|
2. **Compare Versions**: Compares the installed ADK and WinPE add-on versions (if present) against the latest available version
|
||||||
|
3. **Update if Needed**: If an older version is detected:
|
||||||
|
- Uninstalls the existing Windows ADK
|
||||||
|
- Uninstalls the existing WinPE add-on
|
||||||
|
- Downloads and installs the latest Windows ADK with Deployment Tools feature
|
||||||
|
- Downloads and installs the latest WinPE add-on
|
||||||
|
|
||||||
|
#### Features Installed
|
||||||
|
|
||||||
|
When installing or updating the ADK, the following features are included:
|
||||||
|
|
||||||
|
| Component | Feature ID | Description |
|
||||||
|
| ---------------------------------- | ---------------------------------------------- | --------------------------------------------------------------- |
|
||||||
|
| **Windows Deployment Tools** | `OptionId.DeploymentTools` | Includes DISM, Oscdimg, and other deployment-related tools |
|
||||||
|
| **WinPE Environment** | `OptionId.WindowsPreinstallationEnvironment` | Windows Preinstallation Environment used for capture and deploy |
|
||||||
|
|
||||||
|
#### Installation Location
|
||||||
|
|
||||||
|
The ADK is installed to the default location: `C:\Program Files (x86)\Windows Kits\10`
|
||||||
|
|
||||||
|
#### When to Disable
|
||||||
|
|
||||||
|
You may want to disable Update ADK in the following scenarios:
|
||||||
|
|
||||||
|
- **Offline or air-gapped environments**: When internet access is not available to download the latest ADK
|
||||||
|
- **Controlled ADK versions**: When you need to maintain a specific ADK version for compatibility or compliance reasons
|
||||||
|
- **Faster builds**: When you have already verified you are running the latest ADK version and want to skip the version check
|
||||||
|
|
||||||
|
{: .warning-title}
|
||||||
|
|
||||||
|
> Warning
|
||||||
|
>
|
||||||
|
> If Update ADK is disabled and the Windows ADK or WinPE add-on is not installed, the build will fail. Ensure you have manually installed the required components before disabling this option.
|
||||||
|
|
||||||
|
#### Manual ADK Installation
|
||||||
|
|
||||||
|
If you prefer to manually install the ADK, visit:
|
||||||
|
|
||||||
|
[Download and install the Windows ADK](https://learn.microsoft.com/en-us/windows-hardware/get-started/adk-install)
|
||||||
|
|
||||||
|
You must install both:
|
||||||
|
|
||||||
|
- Windows Assessment and Deployment Kit (with Deployment Tools feature)
|
||||||
|
- Windows PE add-on for the Windows ADK
|
||||||
|
|
||||||
|
### Optimize
|
||||||
|
|
||||||
|
Controls the `-Optimize` parameter. When enabled, FFU Builder runs the Windows ADK version of DISM to optimize the captured `.ffu` file:
|
||||||
|
|
||||||
|
- `DISM /Optimize-FFU /ImageFile:<path-to-ffu>`
|
||||||
|
|
||||||
|
This post-processing step typically takes a few minutes and is intended to make FFU images faster to deploy and easier to deploy to differently-sized disks (by allowing the Windows partition to expand or shrink during apply).
|
||||||
|
|
||||||
|
**Default:** Enabled (`-Optimize $true`)
|
||||||
|
|
||||||
|
#### When to Disable
|
||||||
|
|
||||||
|
You may want to disable Optimize (`-Optimize $false`) if you are troubleshooting, or if you want to skip the extra post-processing time.
|
||||||
|
|
||||||
|
{: .warning-title}
|
||||||
|
|
||||||
|
> Warning
|
||||||
|
>
|
||||||
|
> If you plan to deploy the same FFU to devices with different storage sizes (especially smaller disks), keep `-Optimize` enabled. Non-optimized FFUs are more likely to require additional partition management during deployment.
|
||||||
|
|
||||||
|
{: .note-title}
|
||||||
|
|
||||||
|
> Note
|
||||||
|
>
|
||||||
|
> FFU Builder also performs a separate “optimize VHDX before capture” step. That VHDX optimization is independent of `-Optimize`, so you may still see “Optimizing VHDX before capture…” even when `-Optimize` is disabled.
|
||||||
|
|
||||||
|
### Allow VHDX Caching
|
||||||
|
|
||||||
|
Controls the `-AllowVHDXCaching` parameter. When enabled, FFU Builder caches the base VHDX it creates in `$FFUDevelopmentPath\VHDXCache` and writes a matching `*_config.json` file alongside it. On later builds, if a cached VHDX exists that matches your selected Windows settings and update set, the script reuses it to avoid re-applying the base image and integrating updates again.
|
||||||
|
|
||||||
|
**Default:** Disabled (`-AllowVHDXCaching $false`)
|
||||||
|
|
||||||
|
#### Cache Matching
|
||||||
|
|
||||||
|
A cached VHDX is reused only when the cache metadata matches your current build inputs, including:
|
||||||
|
|
||||||
|
- Windows release, version, and SKU
|
||||||
|
- Logical sector size (512 vs 4096)
|
||||||
|
- Optional features selection
|
||||||
|
- The exact set of update payload file names downloaded for that run (SSU/CU/.NET/etc.)
|
||||||
|
|
||||||
|
#### Disk Usage and Cleanup
|
||||||
|
|
||||||
|
VHDX caching trades disk space for speed. The `VHDXCache` folder can grow over time as you build different combinations. Periodically check the folder and remove old cached vhdx and config json files as necessary.
|
||||||
|
|
||||||
|
{: .note-title}
|
||||||
|
|
||||||
|
> Note
|
||||||
|
>
|
||||||
|
> To force a full rebuild, delete the contents of `$FFUDevelopmentPath\VHDXCache` (or disable **Allow VHDX Caching**) and run the build again.
|
||||||
|
|
||||||
|
### Create Deployment Media
|
||||||
|
|
||||||
|
Controls the `-CreateDeploymentMedia` parameter.
|
||||||
|
|
||||||
|
When enabled, FFU Builder creates WinPE deployment media that is used to deploy an FFU image to a physical device. This media contains the WinPE environment and deployment scripts needed to boot a target machine and apply the FFU image.
|
||||||
|
|
||||||
|
The deployment media is saved as an ISO file at `$FFUDevelopmentPath\WinPE_FFU_Deploy_x64.iso` (or `WinPE_FFU_Deploy_arm64.iso` for ARM64 builds). This ISO can then be used with the **Build USB Drive** option to create bootable USB media for physical deployments.
|
||||||
|
|
||||||
|
**Default:** Enabled (`-CreateDeploymentMedia $true`)
|
||||||
|
|
||||||
|
{: .note-title}
|
||||||
|
|
||||||
|
> Note
|
||||||
|
>
|
||||||
|
> If you only need to capture FFUs from VMs and do not plan to deploy to physical devices, you can disable this option to save time during the build process. However, most scenarios require deployment media for the final step of applying the FFU to target hardware.
|
||||||
|
|
||||||
|
{: .tip-title}
|
||||||
|
|
||||||
|
> Tip
|
||||||
|
>
|
||||||
|
> If you just need to re-create deployment media, you can use the `Create-PEMedia.ps1` script to regenerate the deploy ISO without running a full build.
|
||||||
|
|
||||||
|
### Verbose
|
||||||
|
|
||||||
|
Controls the `-Verbose` common parameter. When checked, enables detailed verbose output during the build process. The default is **unchecked**.
|
||||||
|
|
||||||
|
In prior builds it was necessary to enable `-verbose` output to track in real-time the build process if you didn't have `cmtrace.exe` or some other log-monitoring tool. With the UI, you can now watch the build in real-time using the monitor tab. Enabling verbose shouldn't be necessary but is available for those who wish to use it.
|
||||||
|
|
||||||
|
## Unattend.xml Options Expander
|
||||||
|
|
||||||
|
Use the **Unattend.xml Options** expander to choose how unattend content is staged and which source XML file FFU Builder should use for x64 and arm64 builds.
|
||||||
|
|
||||||
|
### x64 Unattend File Path
|
||||||
|
|
||||||
|
Use **x64 Unattend File Path** to browse to the source XML file for x64 builds. The default path is `.\FFUDevelopment\unattend\unattend_x64.xml`.
|
||||||
|
|
||||||
|
### arm64 Unattend File Path
|
||||||
|
|
||||||
|
Use **arm64 Unattend File Path** to browse to the source XML file for arm64 builds. The default path is `.\FFUDevelopment\unattend\unattend_arm64.xml`.
|
||||||
|
|
||||||
|
### Inject Unattend.xml
|
||||||
|
|
||||||
|
Controls the `-InjectUnattend` parameter. When checked, stages the XML file selected for the current architecture in **Unattend.xml Options** into the Apps ISO so it's baked into the FFU during the VM build process. The default is **unchecked**.
|
||||||
|
|
||||||
|
This option is used only when **Install Apps** is checked.
|
||||||
|
|
||||||
|
`Copy Unattend.xml` and `Inject Unattend.xml` are mutually exclusive. Select only one.
|
||||||
|
|
||||||
|
#### How It Works
|
||||||
|
|
||||||
|
When enabled, the build process:
|
||||||
|
|
||||||
|
1. Uses the x64 or arm64 source file selected in **Unattend.xml Options** for the current build architecture
|
||||||
|
2. Creates an `Unattend` folder inside `.\FFUDevelopment\Apps` if it doesn't exist
|
||||||
|
3. Copies that file to `.\FFUDevelopment\Apps\Unattend\Unattend.xml`
|
||||||
|
4. Includes the unattend file in the Apps ISO, making it available to sysprep during the VM build
|
||||||
|
|
||||||
|
The unattend file is then used by sysprep during the specialize phase and/or other OOBE phases when the FFU is deployed.
|
||||||
|
|
||||||
|
#### Creating Your Unattend Files
|
||||||
|
|
||||||
|
You can keep the default architecture-specific files in the `.\FFUDevelopment\unattend` folder or browse to another XML file in the UI:
|
||||||
|
|
||||||
|
| File | Description |
|
||||||
|
| ---------------------------- | ----------------------------------- |
|
||||||
|
| **unattend_x64.xml** | Unattend file used for x64 builds |
|
||||||
|
| **unattend_arm64.xml** | Unattend file used for arm64 builds |
|
||||||
|
|
||||||
|
{: .warning-title}
|
||||||
|
|
||||||
|
> Important
|
||||||
|
>
|
||||||
|
> The default paths use the architecture suffix file names shown above. FFU Builder still renames the selected file to `Unattend.xml` when it stages it into the Apps folder.
|
||||||
|
|
||||||
|
#### When to Use This Option
|
||||||
|
|
||||||
|
This option is primarily intended for scenarios where:
|
||||||
|
|
||||||
|
* You are **not using the USB drive** to deploy the FFU and use other deployment methods (e.g., network deployment, disk cloning, etc)
|
||||||
|
* You want the unattend configuration **baked directly into the FFU** rather than applied at deployment time
|
||||||
|
|
||||||
|
#### Limitations
|
||||||
|
|
||||||
|
| Limitation | Description |
|
||||||
|
| ----------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| **No prefixes.txt, SerialComputerNames.csv, or %serial% support** | Unlike**Copy Unattend.xml**, this method does not support `prefixes.txt`, `SerialComputerNames.csv`, or the `%serial%` variable for deployment-time device naming |
|
||||||
|
| **Fixed configuration** | The unattend settings are baked into the FFU at build time and cannot be changed at deployment time |
|
||||||
|
| **Requires VM to be built** | This option only works when**Install Apps** is `$true` because the unattend file is included in the Apps ISO |
|
||||||
|
|
||||||
|
{: .note-title}
|
||||||
|
|
||||||
|
> Note
|
||||||
|
>
|
||||||
|
> Most users should continue using the **Copy Unattend** option via the USB drive, which provides more flexibility including support for `prefixes.txt`, `SerialComputerNames.csv`, and `%serial%` device naming. Use **Inject Unattend.xml** only when you won't be using the USB drive for deployment.
|
||||||
|
|
||||||
|
{: .tip-title}
|
||||||
|
|
||||||
|
> Tip
|
||||||
|
>
|
||||||
|
> If you're using this option, you can disable **Build Deploy ISO** to save time during the build process since the deployment ISO is not needed when you're not using the USB drive method.
|
||||||
|
|
||||||
|
### Copy Unattend.xml
|
||||||
|
|
||||||
|
Controls the `-CopyUnattend` parameter. When checked, stages the XML file selected for the current architecture in **Unattend.xml Options** to an `Unattend` folder on the Deployment partition of the USB drive. The default is **unchecked**.
|
||||||
|
|
||||||
|
Use this option when you plan to build deployment USB media.
|
||||||
|
|
||||||
|
When enabled, the build process copies:
|
||||||
|
|
||||||
|
- The selected x64 or arm64 unattend XML file -> renamed to **Unattend.xml** on the USB drive
|
||||||
|
- **prefixes.txt** -> created from the **Device Naming** prefixes list when that mode is selected
|
||||||
|
- **SerialComputerNames.csv** -> created from the **Device Naming** serial mapping list when that mode is selected
|
||||||
|
|
||||||
|
If you keep the default file paths in place, FFU Builder uses `unattend_x64.xml` for x64 builds and `unattend_arm64.xml` for arm64 builds.
|
||||||
|
|
||||||
|
During deployment, `ApplyFFU.ps1` applies `Unattend.xml` whenever it is present. Device naming only happens when the **Device Naming** setting requires it, or when older media still uses the legacy prompt-based workflow.
|
||||||
|
|
||||||
|
See **Device Naming Expander** below for the available computer-name modes and naming-file behavior.
|
||||||
|
|
||||||
|
## Device Naming Expander
|
||||||
|
|
||||||
|
Use the **Device Naming** expander to decide whether `ComputerName` should be set at deployment time when unattend is applied. There are some major benefits to doing this:
|
||||||
|
|
||||||
|
1. Total deployment time is reduced if naming is set at FFU deployment time since there is no additional reboot done during OOBE.
|
||||||
|
2. Reduces the need for multiple provisioning packages or autopilot profiles. This means you can use a single PPKG or autopilot profile.
|
||||||
|
|
||||||
|
### No Device Name
|
||||||
|
|
||||||
|
This is the default radio selection in the UI.
|
||||||
|
|
||||||
|
- If you leave device naming untouched, FFU Builder does not write `DeviceNamingMode` to the generated config. This preserves the script's `Legacy` default, so an existing `FFUDevelopment\Unattend\prefixes.txt` file is still copied to deployment media when present.
|
||||||
|
- If you explicitly select this option, FFU Builder sets `DeviceNamingMode = None`. The unattend file is still applied, but Windows generates a random computer name instead of forcing a prompt or a fixed name.
|
||||||
|
|
||||||
|
The active `unattend_*.xml` files in `FFUDevelopment\Unattend` use `<ComputerName>*</ComputerName>` in the current sample files.
|
||||||
|
|
||||||
|
### Prompt for Device Name
|
||||||
|
|
||||||
|
Use this option when you want the technician to enter the computer name during deployment.
|
||||||
|
|
||||||
|
- FFU Builder sets `DeviceNamingMode = Prompt`.
|
||||||
|
- This option requires **Copy Unattend.xml**.
|
||||||
|
- The source `unattend_*.xml` files can stay at `<ComputerName>*</ComputerName>`.
|
||||||
|
- During the build, FFU Builder rewrites only the staged deployment copy of `Unattend.xml` to the legacy prompt placeholder that `ApplyFFU.ps1` already recognizes.
|
||||||
|
- **Inject Unattend.xml** is not supported with this option.
|
||||||
|
|
||||||
|
### Specify Device Name
|
||||||
|
|
||||||
|
Use this option when you want a static device name or a template such as `Comp-%serial%`.
|
||||||
|
|
||||||
|
- FFU Builder sets `DeviceNamingMode = Template`.
|
||||||
|
- With **Copy Unattend.xml**, `%serial%` is resolved during deployment in PE.
|
||||||
|
- With **Inject Unattend.xml**, only static names are supported.
|
||||||
|
- **Copy Unattend.xml** and **Inject Unattend.xml** are mutually exclusive. Select only one.
|
||||||
|
|
||||||
|
### Specify a list of Prefixes
|
||||||
|
|
||||||
|
This option writes `prefixes.txt` from the list in the UI. Enter one prefix per line in the multiline prefixes box. If there is a single prefix, deployment uses it automatically. If there are multiple prefixes, the technician is prompted to select one. The selected prefix is combined with the device serial number to create the computer name.
|
||||||
|
|
||||||
|
- FFU Builder sets `DeviceNamingMode = Prefixes`.
|
||||||
|
|
||||||
|
For example, with a prefix of `CORP-` and a serial number of `ABC123`, the resulting computer name would be `CORP-ABC123` (truncated to 15 characters if necessary).
|
||||||
|
|
||||||
|
Sample `prefixes.txt` content:
|
||||||
|
|
||||||
|
```plaintext
|
||||||
|
CORP-
|
||||||
|
STORE-
|
||||||
|
KIOSK-
|
||||||
|
```
|
||||||
|
|
||||||
|
{: .note-title}
|
||||||
|
|
||||||
|
> Note
|
||||||
|
>
|
||||||
|
> If the technician skips prefix selection when multiple prefixes are available, `ApplyFFU.ps1` leaves the existing unattend `ComputerName` value unchanged. With the current unattend samples set to `<ComputerName>*</ComputerName>`, Windows falls back to its default random computer-name behavior, typically resulting in a name such as `WIN-*`.
|
||||||
|
|
||||||
|
### Prefixes File Path
|
||||||
|
|
||||||
|
Use **Prefixes File Path** to point the UI at the source text file for the prefixes list. The file can use any name. When you browse to a prefixes file in the UI, or when a saved configuration references a valid prefixes path, the UI loads that file and populates the multiline prefixes box from its contents.
|
||||||
|
|
||||||
|
### Save Prefixes
|
||||||
|
|
||||||
|
Use **Save Prefixes** to write the current multiline prefixes list back to the file specified in **Prefixes File Path**.
|
||||||
|
|
||||||
|
### Specify Serial to Device Name Mapping
|
||||||
|
|
||||||
|
This option writes `SerialComputerNames.csv` from the CSV content in the UI. Use `SerialNumber,ComputerName` as the header row, then add one row per device. During deployment, `ApplyFFU.ps1` compares the current BIOS serial number to the `SerialNumber` column and uses the matching `ComputerName` value.
|
||||||
|
|
||||||
|
- FFU Builder sets `DeviceNamingMode = SerialComputerNames`.
|
||||||
|
|
||||||
|
Sample `SerialComputerNames.csv` content:
|
||||||
|
|
||||||
|
```plaintext
|
||||||
|
SerialNumber,ComputerName
|
||||||
|
ABC12345,CORP-001
|
||||||
|
DEF67890,KIOSK-010
|
||||||
|
XYZ24680,STORE-015
|
||||||
|
```
|
||||||
|
|
||||||
|
- This option requires **Copy Unattend.xml**.
|
||||||
|
- **Inject Unattend.xml** is not supported with this option.
|
||||||
|
- If no matching serial number is found during deployment, `ApplyFFU.ps1` falls back to a random `FFU-*` computer name so setup can finish.
|
||||||
|
|
||||||
|
{: .note-title}
|
||||||
|
|
||||||
|
> Note
|
||||||
|
>
|
||||||
|
> If `prefixes.txt` and `SerialComputerNames.csv` are both staged manually on the same deployment media, `ApplyFFU.ps1` checks `prefixes.txt` first. FFU Builder avoids this conflict by only staging the naming file for the selected device-naming mode.
|
||||||
|
|
||||||
|
### Serial Computer Names CSV Mapping File Path
|
||||||
|
|
||||||
|
Use **Serial Computer Names CSV Mapping File Path** to point the UI at the source CSV file for the serial-to-device-name mapping. The file can use any name. When you browse to a mapping file in the UI, or when a saved configuration references a valid CSV path, the UI loads that file and populates the multiline CSV box from its contents.
|
||||||
|
|
||||||
|
### Save Serial Mapping
|
||||||
|
|
||||||
|
Use **Save Serial Mapping** to write the current CSV content back to the file specified in **Serial Computer Names CSV Mapping File Path**.
|
||||||
|
|
||||||
|
### Deployment Prompt Compatibility
|
||||||
|
|
||||||
|
Older deployment media that already has an unattend file with `ComputerName` set to the legacy placeholder value and no `prefixes.txt` file will still prompt for a device name during deployment.
|
||||||
|
|
||||||
|
{: .warning-title}
|
||||||
|
|
||||||
|
> Warning
|
||||||
|
>
|
||||||
|
> If using a provisioning package or autopilot json file, DO NOT specify a name in either of these. They will overwrite the name you have specified in the unattend.xml.
|
||||||
|
|
||||||
|
### Creating Your Unattend Files
|
||||||
|
|
||||||
|
The `.\FFUDevelopment\Unattend` folder includes sample files you can customize:
|
||||||
|
|
||||||
|
| File | Description |
|
||||||
|
| --------------------------------------- | ------------------------------------------ |
|
||||||
|
| **SampleUnattend_x64.xml** | Example unattend file for x64 systems |
|
||||||
|
| **unattend_x64.xml** | Active unattend file used for x64 builds |
|
||||||
|
| **unattend_arm64.xml** | Active unattend file used for arm64 builds |
|
||||||
|
| **SamplePrefixes.txt** | Example prefixes file for device naming |
|
||||||
|
| **SampleSerialComputerNames.csv** | Example serial-to-device-name CSV file |
|
||||||
|
|
||||||
|
Copy and customize the sample files to create your own `unattend_x64.xml`, `unattend_arm64.xml`, `prefixes.txt`, and `SerialComputerNames.csv` files.
|
||||||
|
|
||||||
|
{: .note-title}
|
||||||
|
|
||||||
|
> Note
|
||||||
|
>
|
||||||
|
> The unattend file must contain a `<ComputerName>` element in the `Microsoft-Windows-Shell-Setup` component for device naming to work. See the sample files for the correct structure.
|
||||||
|
|
||||||
|
## Build USB Drive Options Expander
|
||||||
|
|
||||||
|
This expander groups the settings used to create deployment USB drives after the FFU and deployment media are ready.
|
||||||
|
|
||||||
|
### Build USB Drive
|
||||||
|
|
||||||
|
Controls the `-BuildUSBDrive` parameter. When checked, FFU Builder partitions and formats selected USB drives and copies the captured FFU plus the enabled deployment assets to them. The default is **unchecked**.
|
||||||
|
|
||||||
|
The remaining settings in this expander apply only when **Build USB Drive** is enabled.
|
||||||
|
|
||||||
|
### Allow External Hard Disk Media
|
||||||
|
|
||||||
|
Controls the `-AllowExternalHardDiskMedia` parameter. When checked, allows the use of drives identified as "External hard disk media" via the WMI class `Win32_DiskDrive`. The default is **unchecked**.
|
||||||
|
|
||||||
|
Most USB thumb drives are identified by Windows as "Removable Media" and work with the default settings. However, faster USB drives—such as portable SSDs or high-speed USB 3.x drives—may be identified as "External hard disk media" instead. If you want to use these faster drives for imaging, enable this option.
|
||||||
|
|
||||||
|
{: .warning-title}
|
||||||
|
|
||||||
|
> Warning
|
||||||
|
>
|
||||||
|
> Enabling this option may expose external hard drives attached to your machine to the USB imaging process. To prevent accidental data loss, use the **Prompt for External Hard Disk Media** option (enabled by default when this option is checked) to confirm which drive to use before formatting.
|
||||||
|
|
||||||
|
### Prompt for External Hard Disk Media
|
||||||
|
|
||||||
|
Controls the `-PromptExternalHardDiskMedia` parameter. When checked, prompts for user confirmation before using any drive identified as "External hard disk media". The default is **checked** when **Allow External Hard Disk Media** is enabled.
|
||||||
|
|
||||||
|
This option is only available when **Allow External Hard Disk Media** is checked.
|
||||||
|
|
||||||
|
When enabled, the build process will:
|
||||||
|
|
||||||
|
1. Display a table listing all detected external hard disk media drives, including drive name, serial number, partition style, and status.
|
||||||
|
2. Prompt you to select which drive to use for imaging.
|
||||||
|
3. Only create a USB drive on the selected drive.
|
||||||
|
|
||||||
|
When disabled, the script will not prompt and can use multiple external hard disk drives simultaneously, similar to how removable USB drives function. This is useful for automated or batch imaging scenarios but increases the risk of accidental data loss.
|
||||||
|
|
||||||
|
{: .note-title}
|
||||||
|
|
||||||
|
> Note
|
||||||
|
>
|
||||||
|
> If you do not want to be prompted each time, you can disable this option after verifying that only your intended imaging drives are connected.
|
||||||
|
|
||||||
|
### Select Specific USB Drives
|
||||||
|
|
||||||
|
When checked, enables manual selection of specific USB drives for imaging. The default is **unchecked**.
|
||||||
|
|
||||||
|
This option is only available when **Build USB Drive** is checked.
|
||||||
|
|
||||||
|
When enabled, a **Check USB drives** button and a list view appear. Click **Check USB drives** to scan for connected USB drives. The list displays all detected drives with the following information:
|
||||||
|
|
||||||
|
| Column | Description |
|
||||||
|
| ------------------- | ----------------------------------------------------- |
|
||||||
|
| **Select** | Checkbox to include or exclude the drive from imaging |
|
||||||
|
| **Model** | The model name of the USB drive |
|
||||||
|
| **Unique ID** | A unique identifier for the drive |
|
||||||
|
| **Size (GB)** | The total capacity of the drive in gigabytes |
|
||||||
|
|
||||||
|
Select one or more drives by checking the checkbox in the **Select** column. Only selected drives will be formatted and used for imaging when the build completes.
|
||||||
|
|
||||||
|
Use the **Select All** checkbox in the column header to quickly select or deselect all drives.
|
||||||
|
|
||||||
|
{: .note-title}
|
||||||
|
|
||||||
|
> Note
|
||||||
|
>
|
||||||
|
> If **Select Specific USB Drives** is unchecked, the build process will automatically use all discovered USB drives.
|
||||||
|
|
||||||
|
### Copy Autopilot Profile
|
||||||
|
|
||||||
|
Controls the `-CopyAutopilot` parameter. When checked, copies the contents of `.\FFUDevelopment\Autopilot` to the `Autopilot` folder on the Deployment partition of the USB drive. The default is **unchecked**.
|
||||||
|
|
||||||
|
This option is only available when **Build USB Drive** is checked.
|
||||||
|
|
||||||
|
This leverages the Autopilot for existing devices json file. It's not recommended to use this method any longer as devices enrolled via this method are enrolled as personal instead of corporate.
|
||||||
|
|
||||||
|
### Copy Provisioning Package
|
||||||
|
|
||||||
|
Controls the `-CopyPPKG` parameter. When checked, copies the contents of `.\FFUDevelopment\PPKG` to the `PPKG` folder on the Deployment partition of the USB drive. The default is **unchecked**.
|
||||||
|
|
||||||
|
This option is only available when **Build USB Drive** is checked.
|
||||||
|
|
||||||
|
#### How It Works
|
||||||
|
|
||||||
|
1. **During Build**: The build process copies all `.ppkg` files from `.\FFUDevelopment\PPKG` to the USB drive.
|
||||||
|
2. **During Deployment**: When `ApplyFFU.ps1` runs, it detects the `PPKG` folder and the provisioning packages within it.
|
||||||
|
- If **multiple** `.ppkg` files are found, the technician is prompted to select which package to apply.
|
||||||
|
- If **one** `.ppkg` file is found, it is automatically selected.
|
||||||
|
3. **Application**: The selected provisioning package is copied to the root of the USB drive, where Windows picks it up during OOBE and applies the settings.
|
||||||
|
|
||||||
|
### Copy Additional FFU Files
|
||||||
|
|
||||||
|
Controls the `-CopyAdditionalFFUFiles` parameter. When checked, allows you to select existing FFU files from the FFU Capture Location to copy to the USB drive alongside the newly built FFU. The default is **unchecked**.
|
||||||
|
|
||||||
|
This option is only available when **Build USB Drive** is checked.
|
||||||
|
|
||||||
|
#### How It Works
|
||||||
|
|
||||||
|
When enabled, an **Additional FFU Files** panel appears below the checkbox with the following controls:
|
||||||
|
|
||||||
|
| Control | Description |
|
||||||
|
| ----------------------- | ----------------------------------------------------------------------------------------------- |
|
||||||
|
| **Refresh** | Scans the FFU Capture Location folder for existing `.ffu` files and populates the list |
|
||||||
|
| **FFU Name** | The filename of the FFU file |
|
||||||
|
| **Last Modified** | The date and time the FFU file was last modified, useful for identifying the most recent builds |
|
||||||
|
|
||||||
|
The list displays all `.ffu` files found in the FFU Capture Location (default `.\FFUDevelopment\FFU`). Click on individual rows to select which FFU files you want to include on the USB drive. Selected files are highlighted in the list.
|
||||||
|
|
||||||
|
#### Use Cases
|
||||||
|
|
||||||
|
- **Multiple device configurations**: Copy different FFU files for different windows/application configurations (e.g., different versions of windows, different application stacks) to a single USB drive, allowing technicians to choose during deployment.
|
||||||
|
- **Previous builds**: Include a known-good FFU from a previous build alongside the new build as a fallback option.
|
||||||
|
- **Multi-architecture imaging**: Include both x64 and arm64 FFU files on the same USB drive for mixed-architecture environments.
|
||||||
|
|
||||||
|
#### Command Line Usage
|
||||||
|
|
||||||
|
When running `BuildFFUVM.ps1` from the command line with `-CopyAdditionalFFUFiles $true` and no `-AdditionalFFUFiles` parameter specified, the script displays an interactive prompt listing all available FFU files in the capture folder. You can:
|
||||||
|
|
||||||
|
- Enter numbers separated by commas (e.g., `1,3,5`) to select specific files
|
||||||
|
- Enter `A` to select all available files
|
||||||
|
- Press **Enter** to skip and not include any additional files
|
||||||
|
|
||||||
|
Example command line usage with pre-selected files:
|
||||||
|
|
||||||
|
```powershell
|
||||||
|
.\BuildFFUVM.ps1 -configFile .\config\FFUConfig.json -CopyAdditionalFFUFiles $true -AdditionalFFUFiles @("C:\FFUDevelopment\FFU\Win11_24h2_Pro_Nov2025.ffu", "C:\FFUDevelopment\FFU\Win11_24h2_Enterprise_Nov2025.ffu")
|
||||||
|
```
|
||||||
|
|
||||||
|
{: .note-title}
|
||||||
|
|
||||||
|
> Note
|
||||||
|
>
|
||||||
|
> The newly captured FFU from the current build is always copied to the USB drive. Additional FFU files selected here are copied in addition to the new FFU.
|
||||||
|
|
||||||
|
### Max USB Drives
|
||||||
|
|
||||||
|
Controls the `-MaxUSBDrives` parameter, which sets the maximum number of USB drives to build in parallel. The default value is **5**.
|
||||||
|
|
||||||
|
This option is only available when **Build USB Drive** is checked.
|
||||||
|
|
||||||
|
When building USB drives, the script processes multiple drives concurrently to speed up imaging. This setting controls how many drives are formatted and copied to simultaneously.
|
||||||
|
|
||||||
|
## Post-Build Cleanup Expander
|
||||||
|
|
||||||
|
This expander groups the cleanup settings that run after a successful build completes.
|
||||||
|
|
||||||
|
### Cleanup Apps ISO
|
||||||
|
|
||||||
|
Controls the `-CleanupAppsISO` parameter. When checked, the Apps ISO file is automatically deleted after the FFU has been successfully captured. The default is **checked**.
|
||||||
|
|
||||||
|
During the build process, when apps are being installed, the script creates an `Apps.iso` file in the FFU Development Path (for example, `.\FFUDevelopment\Apps.iso`). This ISO contains the contents of the `.\FFUDevelopment\Apps` folder, including application installers, Office deployment files, and orchestration scripts, and is mounted to the VM during the build to install applications.
|
||||||
|
|
||||||
|
#### When to Disable
|
||||||
|
|
||||||
|
You may want to disable Cleanup Apps ISO in the following scenarios:
|
||||||
|
|
||||||
|
- **Debugging app installations**: When troubleshooting application installation issues and you want to manually inspect the ISO contents
|
||||||
|
- **Multiple builds with same apps**: If you're running consecutive builds with identical app configurations and want to reuse the existing ISO to save time (the script will recreate it if missing)
|
||||||
|
- **Archival purposes**: When you need to retain a copy of the exact Apps ISO used for a specific FFU build
|
||||||
|
|
||||||
|
{: .note-title}
|
||||||
|
|
||||||
|
> Note
|
||||||
|
>
|
||||||
|
> The Apps ISO is only created when applications are configured for installation. If no apps are being installed in the FFU, this option has no effect. Keeping this option enabled helps conserve disk space by removing temporary build artifacts.
|
||||||
|
|
||||||
|
### Cleanup Deploy ISO
|
||||||
|
|
||||||
|
Controls the `-CleanupDeployISO` parameter. When checked, the WinPE deployment ISO file is automatically deleted after the FFU has been successfully captured. The default is **checked**.
|
||||||
|
|
||||||
|
During the build process, when **Build Deploy ISO** is enabled, the script creates a `WinPE_FFU_Deploy.iso` file (for example, `.\FFUDevelopment\WinPE_FFU_Deploy.iso`). This ISO contains a customized Windows PE environment used to deploy captured FFU images to target devices. The deployment ISO is typically copied to a bootable USB drive along with the FFU files for field deployment.
|
||||||
|
|
||||||
|
#### When to Disable
|
||||||
|
|
||||||
|
You may want to disable Cleanup Deploy ISO in the following scenarios:
|
||||||
|
|
||||||
|
- **Creating deployment media separately**: When you want to create USB deployment drives at a later time, see [USB Imaging Tool Creator](/FFU/usb_imaging_tool_creator.html) for a staged workflow using `USBImagingToolCreator.ps1` with a deploy ISO, `FFU`, and `Drivers` folder (local path or network share)
|
||||||
|
- **Testing in Hyper-V**: When deploying FFU images to Hyper-V VMs for testing, you can attach the deploy ISO directly to a VM as a DVD drive
|
||||||
|
|
||||||
|
### Cleanup Drivers
|
||||||
|
|
||||||
|
Controls the `-CleanupDrivers` parameter. When checked, the contents of the Drivers folder are automatically deleted after the FFU has been successfully captured. The default is **unchecked**.
|
||||||
|
|
||||||
|
During the build process, when drivers are configured for installation, the script downloads and extracts driver packages into manufacturer-specific subfolders within the Drivers folder (for example, `.\FFUDevelopment\Drivers\HP`, `.\FFUDevelopment\Drivers\Dell`). These drivers are then injected into the FFU during the build.
|
||||||
|
|
||||||
|
#### When to Enable
|
||||||
|
|
||||||
|
You may want to enable Cleanup Drivers in the following scenarios:
|
||||||
|
|
||||||
|
- **Conserving disk space**: Driver packages can be large (several gigabytes per manufacturer), and removing them after a successful build frees up storage
|
||||||
|
- **Ensuring fresh drivers**: When you want each build to download the latest available drivers rather than reusing previously downloaded versions
|
||||||
|
- **Single-use builds**: When building an FFU for a one-time deployment and you don't need to retain the driver files
|
||||||
|
|
||||||
|
#### When to Disable
|
||||||
|
|
||||||
|
You may want to keep Cleanup Drivers disabled in the following scenarios:
|
||||||
|
|
||||||
|
- **Multiple builds with same drivers**: If you're running consecutive builds targeting the same hardware models, keeping drivers avoids re-downloading them each time
|
||||||
|
- **Debugging driver issues**: When troubleshooting driver injection problems and you want to manually inspect the downloaded driver contents
|
||||||
|
- **Offline builds**: When building in an environment with limited or no internet access, retaining drivers allows reuse across builds
|
||||||
|
- **Bring Your Own Drivers**: When you download and bring your own set of drivers from another source and don't want FFU Builder to remove them
|
||||||
|
|
||||||
|
{: .note-title}
|
||||||
|
|
||||||
|
> Note
|
||||||
|
>
|
||||||
|
> Only the contents within the Drivers folder are removed. The folder itself is preserved. If no drivers were downloaded during the build, this option has no effect.
|
||||||
|
|
||||||
|
### Remove FFU
|
||||||
|
|
||||||
|
Controls the `-RemoveFFU` parameter. When checked, all FFU files in the FFU Capture Location are automatically deleted after the build completes successfully. The default is **unchecked**.
|
||||||
|
|
||||||
|
During the build process, the captured FFU image is written to the FFU Capture Location (for example, `.\FFUDevelopment\FFU`). This option removes all `.ffu` files from that folder after the build finishes, including any previously captured FFU files that may exist in the folder.
|
||||||
|
|
||||||
|
#### When to Enable
|
||||||
|
|
||||||
|
You may want to enable Remove FFU in the following scenarios:
|
||||||
|
|
||||||
|
- **USB-only workflow**: When you're using **Build USB Drive** to copy the FFU directly to a USB drive and don't need to retain the FFU file on the host machine
|
||||||
|
- **Conserving disk space**: FFU files can be very large depending on what you're installing, and removing them after copying to USB frees up storage
|
||||||
|
- **Automated build pipelines**: When running automated builds where the FFU is immediately transferred to another location (such as a network share or deployment server) and no longer needed locally
|
||||||
|
|
||||||
|
#### When to Disable
|
||||||
|
|
||||||
|
You may want to keep Remove FFU disabled in the following scenarios:
|
||||||
|
|
||||||
|
- **Archival purposes**: When you want to retain captured FFU images for future deployments or as a backup
|
||||||
|
- **Multiple USB drives**: When you need to create additional USB deployment drives at a later time
|
||||||
|
- **Testing and validation**: When you want to test the FFU in Hyper-V or other environments before deploying to physical hardware
|
||||||
|
|
||||||
|
{: .warning-title}
|
||||||
|
|
||||||
|
> Warning
|
||||||
|
>
|
||||||
|
> This option removes **all** FFU files in the FFU Capture Location folder, not just the FFU from the current build. If you have previously captured FFU files stored in this folder that you want to keep, do not enable this option or move those files to a different location before building.
|
||||||
|
|
||||||
|
### Remove Apps Folder Content
|
||||||
|
|
||||||
|
Controls the `-RemoveApps` parameter. When checked, application content in the Apps folder is automatically deleted after the FFU has been successfully captured. The default is **unchecked**.
|
||||||
|
|
||||||
|
During the build process, application content accumulates in several subfolders within the Apps folder (for example, `.\FFUDevelopment\Apps`):
|
||||||
|
|
||||||
|
| Folder | Contents |
|
||||||
|
| ----------- | ------------------------------------------------------------------------------------------------------------------------ |
|
||||||
|
| `Win32` | Winget source applications and Bring Your Own Apps content copied using the**Copy Apps** button or manually copied |
|
||||||
|
| `MSStore` | Microsoft Store applications downloaded via Winget |
|
||||||
|
| `Office` | Microsoft 365 Apps installer files downloaded by the Office Deployment Tool |
|
||||||
|
|
||||||
|
Additionally, the `WinGetWin32Apps.json` orchestration file in `.\FFUDevelopment\Apps\Orchestration` is removed. This file is automatically regenerated at build time based on downloaded applications.
|
||||||
|
|
||||||
|
When this option is enabled, the cleanup process removes:
|
||||||
|
|
||||||
|
- The entire `Win32` folder and its contents
|
||||||
|
- The entire `MSStore` folder and its contents
|
||||||
|
- The Office download subfolder (`Office\Office`) and the `setup.exe` file within the `Office` folder
|
||||||
|
|
||||||
|
#### When to Enable
|
||||||
|
|
||||||
|
You may want to keep Remove Apps Folder Content enabled in the following scenarios:
|
||||||
|
|
||||||
|
- **Conserving disk space**: Downloaded application installers can consume significant storage, and removing them after a successful build frees up space
|
||||||
|
- **Ensuring fresh downloads**: When you want each build to download the latest available application versions rather than reusing previously downloaded content
|
||||||
|
- **Single-use builds**: When building an FFU for a one-time deployment and you don't need to retain the application files
|
||||||
|
|
||||||
|
#### When to Disable
|
||||||
|
|
||||||
|
You may want to disable Remove Apps Folder Content in the following scenarios:
|
||||||
|
|
||||||
|
- **Multiple builds with same apps**: If you're running consecutive builds with identical application configurations, keeping the downloaded content avoids re-downloading applications each time
|
||||||
|
- **Debugging app installations**: When troubleshooting application installation issues and you want to manually inspect the downloaded content
|
||||||
|
- **Offline builds**: When building in an environment with limited or no internet access, retaining downloaded applications allows reuse across builds
|
||||||
|
- **Preserving Bring Your Own Apps**: When you've manually copied application content into the `Win32` folder and don't want FFU Builder to remove it
|
||||||
|
|
||||||
|
{: .note-title}
|
||||||
|
|
||||||
|
> Note
|
||||||
|
>
|
||||||
|
> Only the application content subfolders are removed. The `Apps` folder itself and configuration files such as `AppList.json` and `UserAppList.json` are preserved. If no applications were configured for the build, this option has no effect.
|
||||||
|
|
||||||
|
### Remove Downloaded Update Files
|
||||||
|
|
||||||
|
Controls the `-RemoveUpdates` parameter. When checked, downloaded Windows updates and application update payloads are automatically deleted after the FFU has been successfully captured. The default is **unchecked**.
|
||||||
|
|
||||||
|
During the build process, update files are downloaded to specific locations within the `FFUDevelopment` folder:
|
||||||
|
|
||||||
|
| Folder | Contents |
|
||||||
|
| ----------------- | ---------------------------------------------------------- |
|
||||||
|
| `KB` | Windows Cumulative Updates (CU) and .NET Framework updates |
|
||||||
|
| `Apps\Defender` | Microsoft Defender definition updates |
|
||||||
|
| `Apps\Edge` | Microsoft Edge browser installer |
|
||||||
|
| `Apps\MSRT` | Malicious Software Removal Tool updates |
|
||||||
|
| `Apps\OneDrive` | Microsoft OneDrive installer |
|
||||||
|
|
||||||
|
When this option is enabled, the cleanup process removes the entire `KB` folder and the specific update subfolders within the `Apps` directory.
|
||||||
|
|
||||||
|
#### When to Enable
|
||||||
|
|
||||||
|
You may want to keep Remove Downloaded Update Files enabled in the following scenarios:
|
||||||
|
|
||||||
|
- **Conserving disk space**: Windows Cumulative Updates can be several gigabytes in size, and removing them after a successful build frees up significant storage
|
||||||
|
- **Ensuring latest updates**: When you want each build to download the absolute latest available updates rather than potentially reusing older cached versions
|
||||||
|
|
||||||
|
#### When to Disable
|
||||||
|
|
||||||
|
You may want to disable Remove Downloaded Update Files in the following scenarios:
|
||||||
|
|
||||||
|
- **Multiple builds**: If you're running consecutive builds, keeping the downloaded updates avoids re-downloading large Cumulative Update files each time
|
||||||
|
- **Offline builds**: When building in an environment with limited or no internet access, retaining downloaded updates allows reuse across builds
|
||||||
|
- **Testing and validation**: When you want to manually inspect the update files that were included in the build
|
||||||
|
|
||||||
|
{: .note-title}
|
||||||
|
|
||||||
|
> Note
|
||||||
|
>
|
||||||
|
> Only the update-specific subfolders are removed. The `Apps` folder itself and other application content, unless **Remove Apps Folder Content** is also selected, are preserved.
|
||||||
|
|
||||||
|
### Remove Downloaded ESD file(s)
|
||||||
|
|
||||||
|
Controls the `-RemoveDownloadedESD` parameter. When checked, downloaded Windows ESD files are automatically deleted after they have been applied. The default is **checked**.
|
||||||
|
|
||||||
|
This setting applies to builds that use downloaded Windows ESD media instead of a provided ISO. When enabled, the build removes the downloaded `.esd` file after it has been used. When disabled, the downloaded `.esd` is kept for reuse on later builds.
|
||||||
|
|
||||||
|
#### When to Enable
|
||||||
|
|
||||||
|
You may want to keep Remove Downloaded ESD file(s) enabled in the following scenarios:
|
||||||
|
|
||||||
|
- **Conserving disk space**: Downloaded ESD files can be large, and removing them after a successful build frees up storage
|
||||||
|
- **Ensuring fresh media**: When you want each build to download the latest available ESD for the selected release and version
|
||||||
|
- **Single-use builds**: When you do not expect to reuse the same downloaded source media again
|
||||||
|
|
||||||
|
#### When to Disable
|
||||||
|
|
||||||
|
You may want to disable Remove Downloaded ESD file(s) in the following scenarios:
|
||||||
|
|
||||||
|
- **Multiple builds with the same source media**: Keeping the ESD avoids re-downloading it each time
|
||||||
|
- **Offline or bandwidth-constrained environments**: Retaining the ESD allows reuse across builds
|
||||||
|
- **Troubleshooting source-media issues**: When you want to preserve the downloaded ESD for inspection or repeat testing
|
||||||
|
|
||||||
|
{: .note-title}
|
||||||
|
|
||||||
|
> Note
|
||||||
|
>
|
||||||
|
> This option only applies when the build used a downloaded `.esd` file. If you provide a Windows ISO instead, this setting has no effect.
|
||||||
|
|
||||||
|
## Build Page Actions
|
||||||
|
|
||||||
|
These buttons sit below the Build tab expanders and operate on the overall page state rather than a single expander.
|
||||||
|
|
||||||
|
### Restore Defaults
|
||||||
|
|
||||||
|
Use this to restore FFU Builder to its default state. When clicked:
|
||||||
|
|
||||||
|
- A confirmation dialog lists what will be removed before anything is deleted.
|
||||||
|
- Generated JSON files are removed (`config\FFUConfig.json`, `Apps\AppList.json`, `Apps\UserAppList.json`, `Drivers\Drivers.json`).
|
||||||
|
- Capture, Deploy, and Apps ISO files are deleted.
|
||||||
|
- Downloaded artifacts are cleared: Apps payloads (Win32, MSStore, Office downloads), update folders under Apps (Defender, Edge, MSRT, OneDrive), driver downloads, and all `.ffu` files in the FFU capture folder.
|
||||||
|
- UI list views (drivers, apps, Winget search results, AppScript variables) are cleared and all controls are reset to their default values.
|
||||||
|
|
||||||
|
{: .note-title}
|
||||||
|
|
||||||
|
> Note
|
||||||
|
>
|
||||||
|
> VHDX cache and any custom config files in the `FFUDevelopment\config` folder, and `Drivers\DriverMapping.json` will remain. DriverMapping.json is retained because you may have made custom changes to it and we want to retain those.
|
||||||
|
>
|
||||||
|
> If you want to keep any content prior to restoring defaults, copy it out first.
|
||||||
|
|
||||||
|
### Save Config File
|
||||||
|
|
||||||
|
Saves all current UI selections to a JSON file so you can reload the same settings later or run `BuildFFUVM.ps1` from the command line with `-configFile` (e.g. `BuildFFUVM.ps1 -configFile C:\FFUDevelopment\config\FFUConfig.json`)
|
||||||
|
|
||||||
|
### How it works
|
||||||
|
|
||||||
|
- Collects the full UI state (paths, toggles, driver/app selections, build options) into a single JSON.
|
||||||
|
- Defaults the save location to `FFUDevelopmentPath\config` and suggests `FFUConfig.json` as the file name. You can browse and pick a different file name or folder.
|
||||||
|
- Creates the `config` folder if it does not exist and confirms the save when finished.
|
||||||
|
|
||||||
|
### Load Config File
|
||||||
|
|
||||||
|
Loads a previously saved configuration JSON and repopulates the UI.
|
||||||
|
|
||||||
|
### How it works
|
||||||
|
|
||||||
|
- Click **Load Config File** to browse for a JSON file (for example, `FFUDevelopment\config\FFUConfig.json`).
|
||||||
|
- The UI updates with everything from the file: paths, checkboxes, build options, driver/app selections, and USB settings.
|
||||||
|
- Supplemental files referenced in the config (Winget `AppList.json`, BYO `UserAppList.json`, `Drivers.json`) are also imported if they exist. Missing helper files are treated as optional and noted for you.
|
||||||
|
- If the file is empty, unreadable, or invalid JSON, the load is stopped and an error message is shown.
|
||||||
|
|
||||||
|
### Build FFU
|
||||||
|
|
||||||
|
Use **Build FFU** to run `BuildFFUVM.ps1` with the current UI selections.
|
||||||
|
|
||||||
|
### What happens when you click Build FFU
|
||||||
|
|
||||||
|
- The UI gathers all current settings and saves them to `FFUDevelopment\config\FFUConfig.json`, and launches `BuildFFUVM.ps1 -configFile` pointing to that file in a background job. `FFUConfig.json` persists between builds and is read on each opening of `BuildFFUVM_UI.ps1` so you can continue where you left off on each new run.
|
||||||
|
- The window switches to the **Monitor** tab so you can watch progress in real time.
|
||||||
|
- The progress bar shows overall completion
|
||||||
|
- When the job finishes, the button returns to **Build FFU** and the UI is ready for the next run.
|
||||||
|
|
||||||
|
### Cancelling a Build
|
||||||
|
|
||||||
|
The Build FFU button will change to Cancel while a build is running. Cancelling will do the following:
|
||||||
|
|
||||||
|
- The UI stops the background build job and kills any child processes so DISM, downloads, and other tools exit.
|
||||||
|
- The in-progress download is always removed to avoid partial or corrupt content.
|
||||||
|
- You’re prompted to decide whether to remove other items downloaded during this run. Selecting **Yes** removes only this run’s downloads. Any previously downloaded content stays in place.
|
||||||
|
- When cleanup is finished, the Cancel button reverts to Build FFU and a new build can begin
|
||||||
|
|
||||||
|
{% include page_nav.html %}
|
||||||
@@ -0,0 +1,98 @@
|
|||||||
|
---
|
||||||
|
title: Bring Your Own Applications
|
||||||
|
nav_order: 6
|
||||||
|
prev_url: /winget.html
|
||||||
|
prev_label: Install Winget Applications
|
||||||
|
next_url: /appsscriptvariables.html
|
||||||
|
next_label: Apps Script Variables
|
||||||
|
parent: Applications
|
||||||
|
grand_parent: UI Overview
|
||||||
|
---
|
||||||
|
# Bring Your Own Applications
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
Bring Your Own Applications allows you to run any command line you want in the virtual machine to include in your FFU to install an application, run a script, etc. As the name implies, you'll provide the content, command line, arguments, and additional exit codes.
|
||||||
|
|
||||||
|
All applications are stored in the `$AppsPath` parent folder which defaults to `C:\FFUDevelopment\Apps`. Winget source applications and BYO Apps that you select Copy Apps are stored in `$AppsPath\Win32`. MSStore source apps from Winget are stored in `$AppsPath\MSStore`.
|
||||||
|
|
||||||
|
At build time, an `Apps.iso` file is created of the `$AppsPath` folder. This ISO gets mounted to the VM. It shows up in the VM as the `D:\` drive. When creating your command line or arguments, you must make sure to reference `D:\`.
|
||||||
|
|
||||||
|
## Name
|
||||||
|
|
||||||
|
The name of the application. The name is also used when selecting **Copy Apps** to copy apps from a source location to the `$AppsPath\Win32\<Name>` folder (e.g. `C:\FFUDevelopment\Apps\Win32\Google Chrome`)
|
||||||
|
|
||||||
|
## Command Line
|
||||||
|
|
||||||
|
This is the full path to the command line to install the application, script, or to run a command. If the content was included in the `$AppsPath` this should start with `D:\` (e.g. `D:\Win32\Mozilla Firefox\Mozilla Firefox_136.0.3_Machine_X64_exe_en-US.exe`)
|
||||||
|
|
||||||
|
For MSI applications, this should only include msiexec. The rest of the command line will be specified in arguments.
|
||||||
|
|
||||||
|
## Arguments
|
||||||
|
|
||||||
|
These are the command line arguments for the application. Using the Mozilla Firefox example above, the arguments would be `/S /PreventRebootRequired=true`.
|
||||||
|
|
||||||
|
For MSI applications, this will include `/i` and the full-path to the MSI file plus any additional command line parameters (e.g. `/i "D:\Win32\Google Chrome\Google Chrome_134.0.6998.178_Machine_X64_wix_en-US.msi" /quiet /norestart`)
|
||||||
|
|
||||||
|
## Source
|
||||||
|
|
||||||
|
This is an optional parameter. This is the local source to the content. It is used by the Copy Apps button to copy from the source location to the `$AppsPath\Win32\<Name>` folder. If you don't use the **Copy Apps** button, then you must put the conent in the `$AppsPath` folder manually.
|
||||||
|
|
||||||
|
## Additional Exit Codes
|
||||||
|
|
||||||
|
This is an optional parameter. Enter a comma-separated list of additional success exit codes if necessary.
|
||||||
|
|
||||||
|
## Ignore all non-zero exit codes
|
||||||
|
|
||||||
|
If checked, any non-zero exit code will be considered a success.
|
||||||
|
|
||||||
|
## Save UserAppList.json
|
||||||
|
|
||||||
|
When you're done adding your apps, you must save the `UserAppList.json` file to your `$AppsPath` folder. If you click **Copy Apps**, the `UserAppList.json` file is also saved. The `UserAppList.json` is used by the FFU Builder Orchestrator in the VM to know what to install and when based on the priority of the application.
|
||||||
|
|
||||||
|
Below is the `UserAppList.json` of Chrome and Firefox using the example above.
|
||||||
|
|
||||||
|
```json
|
||||||
|
[
|
||||||
|
{
|
||||||
|
"Priority": 1,
|
||||||
|
"Name": "Google Chrome",
|
||||||
|
"CommandLine": "msiexec",
|
||||||
|
"Arguments": "/i \"D:\\Win32\\Google Chrome\\Google Chrome_134.0.6998.178_Machine_X64_wix_en-US.msi\" /quiet /norestart",
|
||||||
|
"Source": "C:\\temp\\source\\Google Chrome",
|
||||||
|
"AdditionalExitCodes": "",
|
||||||
|
"IgnoreNonZeroExitCodes": false
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"Priority": 2,
|
||||||
|
"Name": "Mozilla Firefox",
|
||||||
|
"CommandLine": "D:\\Win32\\Mozilla Firefox\\Mozilla Firefox_136.0.3_Machine_X64_exe_en-US.exe",
|
||||||
|
"Arguments": "/S /PreventRebootRequired=true",
|
||||||
|
"Source": "C:\\temp\\source\\Mozilla Firefox",
|
||||||
|
"AdditionalExitCodes": "",
|
||||||
|
"IgnoreNonZeroExitCodes": false
|
||||||
|
}
|
||||||
|
]
|
||||||
|
```
|
||||||
|
|
||||||
|
## Import UserAppList.json
|
||||||
|
|
||||||
|
You can import a saved `UserAppList.json`
|
||||||
|
|
||||||
|
## Edit Application
|
||||||
|
|
||||||
|
When you select a single application you can select the **Edit Application** button. This allows you to edit the application information and update the application.
|
||||||
|
|
||||||
|
## Copy Apps
|
||||||
|
|
||||||
|
If the application source is provided, click **Copy Apps** to copy the application content to the `$AppsPath\Win32` folder (e.g. `C:\FFUDevelopment\Apps\Win32\<Name>`). Network shares are supported. When clicking **Copy Apps** the `UserAppList.json` file is automatically created.
|
||||||
|
|
||||||
|
## Remove Selected
|
||||||
|
|
||||||
|
Removes the selected applications from the list view. Click **Save UserAppList.json** to save the application list.
|
||||||
|
|
||||||
|
## Clear List
|
||||||
|
|
||||||
|
The **Clear List** button will clear the list view of what’s currently in it. It will not clear the `UserAppList.json` file if it exists.
|
||||||
|
|
||||||
|
{% include page_nav.html %}
|
||||||
@@ -0,0 +1,85 @@
|
|||||||
|
---
|
||||||
|
title: Create PE Media
|
||||||
|
nav_order: 1
|
||||||
|
prev_url: /helper_scripts.html
|
||||||
|
prev_label: Helper Scripts
|
||||||
|
next_url: /usb_imaging_tool_creator.html
|
||||||
|
next_label: USB Imaging Tool Creator
|
||||||
|
parent: Helper Scripts
|
||||||
|
---
|
||||||
|
# Create PE Media
|
||||||
|
|
||||||
|
`Create-PEMedia.ps1` is a standalone helper script that creates WinPE deployment ISO files outside the main build flow.
|
||||||
|
|
||||||
|
This is useful when admins need to quickly generate a deploy ISO for a share (or local staging folder) that technicians will use with `USBImagingToolCreator.ps1`.
|
||||||
|
|
||||||
|
## Common use case
|
||||||
|
|
||||||
|
If your staging location does not already have a deployment ISO, run `Create-PEMedia.ps1` to generate one, then copy that ISO to the staging folder used by your technicians.
|
||||||
|
|
||||||
|
## Prerequisites
|
||||||
|
|
||||||
|
- Run from an elevated PowerShell session.
|
||||||
|
- Windows ADK + WinPE add-on must be installed (default path: `C:\Program Files (x86)\Windows Kits\10\`).
|
||||||
|
- Script should be run from the `FFUDevelopment` folder (or provide explicit paths via parameters).
|
||||||
|
|
||||||
|
## Quick start (deploy ISO)
|
||||||
|
|
||||||
|
From `FFUDevelopment`, this creates a deploy ISO by default:
|
||||||
|
|
||||||
|
```powershell
|
||||||
|
.\Create-PEMedia.ps1
|
||||||
|
```
|
||||||
|
|
||||||
|
Default output file:
|
||||||
|
|
||||||
|
- `.\WinPE_FFU_Deploy_x64.iso`
|
||||||
|
|
||||||
|
## Useful commands
|
||||||
|
|
||||||
|
Create deploy ISO for x64:
|
||||||
|
|
||||||
|
```powershell
|
||||||
|
.\Create-PEMedia.ps1 -WindowsArch 'x64'
|
||||||
|
```
|
||||||
|
|
||||||
|
Create deploy ISO for ARM64:
|
||||||
|
|
||||||
|
```powershell
|
||||||
|
.\Create-PEMedia.ps1 -WindowsArch 'arm64' -DeployISO "$PSScriptRoot\WinPE_FFU_Deploy_arm64.iso"
|
||||||
|
```
|
||||||
|
|
||||||
|
Create deploy ISO and include PE drivers from `.\PEDrivers`:
|
||||||
|
|
||||||
|
```powershell
|
||||||
|
.\Create-PEMedia.ps1 -CopyPEDrivers $true
|
||||||
|
```
|
||||||
|
|
||||||
|
## Stage output for USB imaging
|
||||||
|
|
||||||
|
After creating the deploy ISO, place it in the same staging root used for USB media creation.
|
||||||
|
|
||||||
|
Example:
|
||||||
|
|
||||||
|
```text
|
||||||
|
\\Server\FFUStaging\
|
||||||
|
WinPE_FFU_Deploy_x64.iso
|
||||||
|
FFU\
|
||||||
|
<image files>.ffu
|
||||||
|
Drivers\
|
||||||
|
<optional driver content>
|
||||||
|
```
|
||||||
|
|
||||||
|
Then technicians can run:
|
||||||
|
|
||||||
|
```powershell
|
||||||
|
.\USBImagingToolCreator.ps1 -DeployISOPath "\\Server\FFUStaging\WinPE_FFU_Deploy_x64.iso" -DisableAutoPlay
|
||||||
|
```
|
||||||
|
|
||||||
|
## Logging
|
||||||
|
|
||||||
|
`Create-PEMedia.ps1` writes log output to:
|
||||||
|
|
||||||
|
- `.\Create-PEMedia.log` (or custom path via `-LogFile`)
|
||||||
|
|
||||||
|
{% include page_nav.html %}
|
||||||
@@ -0,0 +1,410 @@
|
|||||||
|
---
|
||||||
|
title: Drivers
|
||||||
|
nav_order: 9
|
||||||
|
prev_url: /M365appsoffice.html
|
||||||
|
prev_label: M365 Apps Office
|
||||||
|
next_url: /build.html
|
||||||
|
next_label: Build
|
||||||
|
parent: UI Overview
|
||||||
|
---
|
||||||
|
# Drivers
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
FFU Builder supports adding drivers directly to the FFU file at build time, or adding them as folders on your USB drive which can be serviced offline after the FFU has been applied to your device.
|
||||||
|
|
||||||
|
The UI allows you to download the drivers prior to build and/or create a `Drivers.json` file which can be used to automatically download the drivers at build time. This allows for flexibility in downloading drivers whenever you need them. It supports downloading multiple driver models at once in parallel.
|
||||||
|
|
||||||
|
## Drivers Folder
|
||||||
|
|
||||||
|
This is the location where drivers are downloaded to, or where you'll manually copy drivers to. The default is `.\FFUDevelopment\Drivers`
|
||||||
|
|
||||||
|
## PE Drivers Folder
|
||||||
|
|
||||||
|
Path to the folder containing drivers to be injected into the WinPE deployment media. Default is `.\FFUDevelopment\PEDrivers`.
|
||||||
|
|
||||||
|
## Drivers.json Path
|
||||||
|
|
||||||
|
Path to a JSON file that specifies which drivers to download. Default is `.\FFUDevelopment\Drivers\Drivers.json`
|
||||||
|
|
||||||
|
## Download Drivers
|
||||||
|
|
||||||
|
FFU Builder can download drivers from the following OEMs:
|
||||||
|
|
||||||
|
* Dell
|
||||||
|
* HP
|
||||||
|
* Lenovo
|
||||||
|
* Microsoft
|
||||||
|
|
||||||
|
Clicking the **Download Drivers** exposes a **Make:** drop down which lists the above four OEMs and a **Get Models** button
|
||||||
|
|
||||||
|
Clicking **Get Models** downloads the list of models from the selected OEM.
|
||||||
|
|
||||||
|
The **Model Filter** box allows you to type in a string to filter on the model. The filter should match on any portion of text in the model name.
|
||||||
|
|
||||||
|
The model column lists the model name and the System ID (for Dell and HP) or the Machine Type (for Lenovo) in parenthesis. The SystemID/Machine Type values are required to know exactly which set of drivers to download for your model. There typically is a lot of overlap, and sometimes the drivers for the various SystemID/MachineTypes for the same model might be exactly the same, it's still best to grab the SystemID/MachineType before downloading drivers.
|
||||||
|
|
||||||
|
To get the System ID:
|
||||||
|
|
||||||
|
**HP**
|
||||||
|
|
||||||
|
* BIOS/UEFI: Either under Main or System Information (it's going to be different depending on the model) you're looking for the **System Board ID** and it should be a four-character code.
|
||||||
|
* PowerShell:`(Get-CimInstance -Namespace 'root\WMI' -Class MS_SystemInformation).BaseboardProduct`
|
||||||
|
|
||||||
|
**Dell**
|
||||||
|
|
||||||
|
* BIOS/UEFI: I'm not sure if it's possible to get the System ID from the BIOS/UEFI. I seem to recall in some BIOS screenshots that System SKU is listed in some BIOS/UEFI implementations, but it may not be consistent.
|
||||||
|
* PowerShell: `(Get-CIMInstance -ClassName "MS_SystemInformation" -NameSpace "root\WMI").SystemSku`
|
||||||
|
|
||||||
|
or
|
||||||
|
|
||||||
|
```
|
||||||
|
[string]$OEMString = Get-WmiObject -Class "Win32_ComputerSystem" | Select-Object -ExpandProperty OEMStringArray
|
||||||
|
$ComputerDetails.FallbackSKU = [regex]::Matches($OEMString, '\[\S*]')[0].Value.TrimStart("[").TrimEnd("]")
|
||||||
|
```
|
||||||
|
|
||||||
|
**Lenovo**
|
||||||
|
|
||||||
|
To find the Machine Type for Lenovo devices, check the bottom/back of the device for the MTM field and capture the first four characters.
|
||||||
|
|
||||||
|
* BIOS/UEFI: Look for MTM and grab the first four characters
|
||||||
|
* PowerShell: `(Get-CIMInstance -ClassName "MS_SystemInformation" -NameSpace "root\WMI").SystemProductName`
|
||||||
|
|
||||||
|
You can multi-select different models within the same make, or mix and match different makes. The screenshot below shows different Dell, HP, Lenovo, and Microsoft models selected
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
## Save Drivers.json
|
||||||
|
|
||||||
|
After selecting the drivers you want to download, clicking **Save Drivers.json** will prompt you for a location to save the `Drivers.json` file to. The `Drivers.json` file is responsible for telling `BuildFFUVM.ps1` what drivers to download during the build process.
|
||||||
|
|
||||||
|
Below is an example of `Drivers.json`:
|
||||||
|
|
||||||
|
```
|
||||||
|
{
|
||||||
|
"HP": {
|
||||||
|
"Models": [
|
||||||
|
{
|
||||||
|
"Name": "HP EliteBook 865 16 inch G11 Notebook PC",
|
||||||
|
"SystemId": "8d03"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"Dell": {
|
||||||
|
"Models": [
|
||||||
|
{
|
||||||
|
"Name": "Dell Pro Max Desktops Dell Pro Max Micro FCM2250,Dell Pro Max Micro XE FCM2250",
|
||||||
|
"CabUrl": "https://downloads.dell.com/FOLDER13898125M/1/Dell_Pro_Max_Desktops_0D14.cab",
|
||||||
|
"SystemId": "0D14"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"Lenovo": {
|
||||||
|
"Models": [
|
||||||
|
{
|
||||||
|
"Name": "Lenovo 300w Yoga Gen 4",
|
||||||
|
"MachineType": "82VN"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"Microsoft": {
|
||||||
|
"Models": [
|
||||||
|
{
|
||||||
|
"Name": "Surface Pro for Business (11th Edition)",
|
||||||
|
"Link": "https://www.microsoft.com/download/details.aspx?id=108013"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Import Drivers.json
|
||||||
|
|
||||||
|
Import Drivers.json allows you to import a previously saved Drivers.json file. The models in the Drivers.json file will show up in the list view pre-selected. This will allow you to select additional models and save an updated version of Drivers.json, or to download the selected models by clicking Download Selected.
|
||||||
|
|
||||||
|
## Download Selected
|
||||||
|
|
||||||
|
Download Selected will download the selected models to the Drivers Folder path (default .\FFUDevelopment\Drivers). Drivers will download the the .\FFUDevelopment\Drivers\Make\Model folder. Download select also interacts with the Compress Driver Model Folder to WIM checkbox which will download and compress the drivers to WIM.
|
||||||
|
|
||||||
|
If you've previously downloaded a driver model and want to compress it to a WIM, you can check he Compress Driver Model Folder to WIM checkbox and click Download Selected again. This will skip the download and compress the driver folder to a WIM file.
|
||||||
|
|
||||||
|
Download Selected leverages BITS and the BITS Priority can be controlled by the BITS Priority drop down on the Build tab. If driver downloads via the UI feel slow, change BITS Priority to Foreground to speed them up.
|
||||||
|
|
||||||
|
## Clear List
|
||||||
|
|
||||||
|
Clears the list view of the previous model list
|
||||||
|
|
||||||
|
## Install Drivers to FFU
|
||||||
|
|
||||||
|
Install Drivers to FFU will recursively add the drivers in the FFUDevelopment\Drivers folder to the FFU file.
|
||||||
|
|
||||||
|
It's recommended to only include a single model's drivers in the FFU. This is because dism will add the drivers to the drivers store in the FFU and any additional models that aren't necessary will bloat the drivers store, using up disk space.
|
||||||
|
|
||||||
|
If you're dealing with multiple models, it's recommended to select Copy Drivers to USB drive instead.
|
||||||
|
|
||||||
|
## Copy Drivers to USB drive
|
||||||
|
|
||||||
|
Copy Drivers to USB drive will copy the drivers to the .\Drivers folder on the deploy partition of the USB drive (e.g. D:\Drivers\Make\Model)
|
||||||
|
|
||||||
|
If you're manually copying drivers to the .\FFUDevelopment\Drivers folder, you must copy them to the FFUDevelopment\Drivers\Make\Model folder (e.g. FFUDevelopment\Drivers\Lenovo\Lenovo 300w). Prior releases referenced using just .\FFUDevelopment\Drivers\Model, however for better organization and consistency, the code has been updated to require the make folder.
|
||||||
|
|
||||||
|
## Compress Driver Model Folder to WIM
|
||||||
|
|
||||||
|
Enabling this checkbox compresses the driver model folder to a WIM file after each model finishes downloading (or when an existing model is detected). Every `Drivers\<Make>\<Model>` directory is captured into a single `<Drivers folder>\<Make>\<Model>.wim` using DISM with `Compress:Max`, which dramatically reduces the space required on your USB drive.
|
||||||
|
|
||||||
|
1. Select the models you need, check **Compress Driver Model Folder to WIM**, then click **Download Selected**. Fresh downloads are extracted as usual and immediately compressed into their companion `.wim`.
|
||||||
|
2. If the model already exists, the download phase is skipped and only the compression runs, so you can rebuild the `.wim` whenever you refresh the folder contents.
|
||||||
|
|
||||||
|
By default the extracted folder is deleted after a successful capture so that the `.wim` becomes the canonical artifact. When **Use Drivers Folder as PE Drivers Source** is also checked, the UI keeps the folder in place, writes a `__PreservedForPEDrivers.txt` marker, and lets WinPE driver harvesting reuse the loose INF set.
|
||||||
|
|
||||||
|
Additional guidance:
|
||||||
|
|
||||||
|
- `DriverMapping.json` is updated to reference the `.wim`, so `Copy Drivers to USB drive`, `BuildFFUVM.ps1 -CopyDrivers`, and the WinPE `ApplyFFU.ps1` flow mount the compressed archive automatically.
|
||||||
|
- Watch the Drivers tab status column or `FFUDevelopment_UI.log` for DISM progress and troubleshooting details per model.
|
||||||
|
- Ensure the volume hosting `FFUDevelopment\Drivers` has enough free space for both the source folder and the resulting `.wim`.
|
||||||
|
- Only applies to drivers from Dell, HP, Lenovo, or Microsoft that are specified in the Drivers.json file. It will not compress models you manually copy to the Drivers folder.
|
||||||
|
|
||||||
|
## Copy PE Drivers
|
||||||
|
|
||||||
|
When **Copy PE Drivers** is enabled, drivers will be injected into the WinPE deployment media. This ensures that WinPE has the necessary drivers to recognize hardware components like storage controllers, network adapters, and input devices during FFU deployment.
|
||||||
|
|
||||||
|
By default, drivers are sourced from the **PE Drivers Folder** (default `.\FFUDevelopment\PEDrivers`). You can manually place drivers in this folder, and they will be injected into the WinPE media during the build process.
|
||||||
|
|
||||||
|
### Use Drivers Folder as PE Drivers Source
|
||||||
|
|
||||||
|
When **Copy PE Drivers** is checked, an additional sub-option becomes visible: **Use Drivers Folder as PE Drivers Source** .
|
||||||
|
|
||||||
|
When this option is enabled, the script bypasses the PE Drivers Folder and instead dynamically builds the WinPE driver set from the main **Drivers Folder**. The script scans all available drivers in the Drivers folder, parses their INF files, and copies only the essential driver types needed for WinPE, including:
|
||||||
|
|
||||||
|
* System devices
|
||||||
|
* SCSI, RAID, and NVMe controllers
|
||||||
|
* Keyboards
|
||||||
|
* Mice and other pointing devices
|
||||||
|
* Human Interface Devices (HID) for touch support
|
||||||
|
|
||||||
|
This eliminates the need to maintain a separate, manually curated `PEDrivers` folder and ensures that WinPE has the necessary drivers based on what you've already downloaded for your target devices.
|
||||||
|
|
||||||
|
{: .note-title}
|
||||||
|
|
||||||
|
> Note
|
||||||
|
>
|
||||||
|
> If the PE Drivers folder already contains content when using this option, it will be cleared before the new driver set is copied in.
|
||||||
|
>
|
||||||
|
> Some drivers may fail to be added during injection, which is expected behavior and can be safely ignored.
|
||||||
|
>
|
||||||
|
> Network adapters are not included when using the drivers folder as PE drivers source, so if you're using WDS or another network-based solution to copy your FFU and you've modified ApplyFFU.ps1, it's best to not use the **Use Drivers Folder as PE Driver Source** option and just copy in your required PE Drivers to the PE Drivers folder.
|
||||||
|
|
||||||
|
## DriverMapping.json
|
||||||
|
|
||||||
|
`DriverMapping.json` is an automatically generated file that maps hardware identifiers (like System IDs or Machine Types) to specific driver packages. This file enables the WinPE deployment script (`ApplyFFU.ps1`) to automatically detect your device hardware and apply the correct drivers without manual intervention.
|
||||||
|
|
||||||
|
### How it gets created
|
||||||
|
|
||||||
|
`DriverMapping.json` is created and updated automatically when you download drivers using the **Download Selected** button on the Drivers tab of the UI, or when drivers are downloaded during the FFU build. Each time you successfully download drivers for a model, the file is updated with the mapping information for that model.
|
||||||
|
|
||||||
|
### Automatic Driver Selection During Deployment
|
||||||
|
|
||||||
|
When you deploy an FFU using the WinPE media, `ApplyFFU.ps1` looks for `DriverMapping.json` on the USB drive at `D:\Drivers\DriverMapping.json` (where D: is your USB deploy partition). If found, the script:
|
||||||
|
|
||||||
|
1. Detects the hardware identifiers of the current device (System ID, Machine Type, etc.)
|
||||||
|
2. Searches `DriverMapping.json` for a matching entry
|
||||||
|
3. Automatically selects and applies the correct driver package
|
||||||
|
4. Falls back to manual driver selection if no match is found
|
||||||
|
|
||||||
|
### Required Fields by Manufacturer
|
||||||
|
|
||||||
|
Each entry in `DriverMapping.json` contains different required fields depending on the manufacturer:
|
||||||
|
|
||||||
|
**All Manufacturers:**
|
||||||
|
|
||||||
|
* **Manufacturer** – The OEM name (e.g., "Dell", "HP", "Lenovo", "Microsoft")
|
||||||
|
* **Model** – The full model name as it appears in the driver download catalog
|
||||||
|
* **DriverPath** – The relative path to the driver folder or WIM file on the USB drive under the Drivers folder (e.g., "Dell\\\Dell Latitude 7490" or "HP\\\HP EliteBook 865 16 inch G11 Notebook PC.wim").
|
||||||
|
|
||||||
|
Relative paths are used since we don't know the drive letter of the USB drive when the `DriverMapping.json` file is created. And since this uses json, the double backslash is intentional since the first slash is an escape character.
|
||||||
|
|
||||||
|
**Dell:**
|
||||||
|
|
||||||
|
* **SystemId** – The System SKU identifier (e.g., "0819", "0D14"). This is the primary matching field used during deployment. To find your Dell System SKU via PowerShell, run: `(Get-CIMInstance -ClassName "MS_SystemInformation" -NameSpace "root\WMI").SystemSku`
|
||||||
|
|
||||||
|
**HP:**
|
||||||
|
|
||||||
|
* **SystemId** – The System Board ID, a four-character code (e.g., "8d03", "83D2"). This is the primary matching field used during deployment. To find your HP System Board ID via PowerShell, run: `(Get-CimInstance -Namespace 'root\WMI' -Class MS_SystemInformation).BaseboardProduct`
|
||||||
|
|
||||||
|
**Lenovo:**
|
||||||
|
|
||||||
|
* **MachineType** – The first four characters of the MTM (Machine Type Model) field (e.g., "82VN", "21JD"). This is the primary matching field used during deployment. To find your Lenovo Machine Type via PowerShell, run: `(Get-CIMInstance -ClassName "MS_SystemInformation" -NameSpace "root\WMI").SystemProductName`
|
||||||
|
|
||||||
|
**Microsoft:**
|
||||||
|
|
||||||
|
* No additional fields required beyond Manufacturer, Model, and DriverPath. Matching is performed based on the normalized model name.
|
||||||
|
|
||||||
|
### Example DriverMapping.json
|
||||||
|
|
||||||
|
Below is an example of `DriverMapping.json` with entries for multiple manufacturers:
|
||||||
|
|
||||||
|
```
|
||||||
|
[
|
||||||
|
{
|
||||||
|
"Manufacturer": "Dell",
|
||||||
|
"Model": "Dell Latitude 7490",
|
||||||
|
"DriverPath": "Dell\\Dell Latitude 7490",
|
||||||
|
"SystemId": "0819"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"Manufacturer": "Dell",
|
||||||
|
"Model": "Dell Pro Max Desktops Dell Pro Max Micro FCM2250,Dell Pro Max Micro XE FCM2250",
|
||||||
|
"DriverPath": "Dell\\Dell Pro Max Desktops Dell Pro Max Micro FCM2250,Dell Pro Max Micro XE FCM2250.wim",
|
||||||
|
"SystemId": "0D14"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"Manufacturer": "HP",
|
||||||
|
"Model": "HP EliteBook 865 16 inch G11 Notebook PC",
|
||||||
|
"DriverPath": "HP\\HP EliteBook 865 16 inch G11 Notebook PC.wim",
|
||||||
|
"SystemId": "8D03"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"Manufacturer": "Lenovo",
|
||||||
|
"Model": "Lenovo 300w Yoga Gen 4",
|
||||||
|
"DriverPath": "Lenovo\\Lenovo 300w Yoga Gen 4",
|
||||||
|
"MachineType": "82VN"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"Manufacturer": "Microsoft",
|
||||||
|
"Model": "Surface Pro for Business (11th Edition)",
|
||||||
|
"DriverPath": "Microsoft\\Surface Pro for Business (11th Edition)"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
```
|
||||||
|
|
||||||
|
## Bring Your Own Drivers
|
||||||
|
|
||||||
|
If you manage models that aren't from Dell, HP, Lenovo or Microsoft, or you want to use different drivers from what FFU Builder downloads, you can copy your own drivers to the `.\FFUDevelopment\Drivers` folder using the `.\FFUDevelopment\Drivers\Make\Model` format, or simply change the Drivers Folder path to the location of your drivers content.
|
||||||
|
|
||||||
|
You can also manually create your own DriverMapping.json file for the following makes/manufacturers
|
||||||
|
|
||||||
|
| Manufacturer | Match Field | WMI Class | Property |
|
||||||
|
| ------------------------------- | ----------- | ------------------------------------------- | ----------------------------------------------- |
|
||||||
|
| **Dell** | SystemId | `MS_SystemInformation` (via `root\WMI`) | `SystemSku` |
|
||||||
|
| **Dell** (fallback) | SystemId | `Win32_ComputerSystem` | `OEMStringArray` (parsed for bracketed value) |
|
||||||
|
| **HP** | SystemId | `MS_SystemInformation` (via `root\WMI`) | `BaseBoardProduct` |
|
||||||
|
| **Lenovo** | MachineType | `Win32_ComputerSystem` | `Model` |
|
||||||
|
| **Microsoft** | Model | `Win32_ComputerSystem` | `Model` |
|
||||||
|
| **Panasonic Corporation** | SystemId | `MS_SystemInformation` (via `root\WMI`) | `BaseBoardProduct` |
|
||||||
|
| **Viglen** | SystemId | `Win32_BaseBoard` | `SKU` |
|
||||||
|
| **AZW** | SystemId | `MS_SystemInformation` (via `root\WMI`) | `BaseBoardProduct` |
|
||||||
|
| **Fujitsu** | SystemId | `Win32_BaseBoard` | `SKU` |
|
||||||
|
| **Getac** | SystemId | `MS_SystemInformation` (via `root\WMI`) | `BaseBoardProduct` |
|
||||||
|
| **Intel** | Model | `Win32_ComputerSystem` | `Model` |
|
||||||
|
| **ByteSpeed** | Model | `Win32_ComputerSystem` | `Model` |
|
||||||
|
| **Other** (default) | Model | `Win32_ComputerSystem` | `Model` |
|
||||||
|
|
||||||
|
**Notes:**
|
||||||
|
|
||||||
|
* Match Field is the name of the field in the `DriverMapping.json` file (e.g. SystemID, MachineType, Model)
|
||||||
|
* SystemId is a catch-all term for a unique identifier, however each manufacturer calls this something different and stores them in different places within WMI
|
||||||
|
* The Dell (fallback) is used for models where the systemSKU isn't available and the OEMStringArray is parsed via Win32_ComputerSystem
|
||||||
|
* The `MS_SystemInformation` class is queried from the `root\WMI` namespace
|
||||||
|
* Unless noted, the other WMI classes use the `root\cimv2` namespace
|
||||||
|
* All identifiers are normalized to uppercase for matching
|
||||||
|
* ByteSpeed systems with "NUC" in the model name are re-mapped to Intel and use `BaseBoardProduct` instead
|
||||||
|
* For manufacturers that aren't listed, the default behavior is to use the `Win32_ComputerSystem` `model` string
|
||||||
|
|
||||||
|
Below is an example `DriverMapping.json` that includes the additional manufacturers. Note that the model and systemID information is made up and is used only as an example to show how to format the file. You'll need to collect the model or system ID from the locations in the table above and include it in your custom `DriverMapping.json` file. Each entry includes both a WIM and drivers folder for each manufacturer. If you want to include driver WIM files for manufacturers other than Dell, HP, Lenovo, or Microsoft, you'll need to manually compress the drivers folder to a WIM file.
|
||||||
|
|
||||||
|
```
|
||||||
|
[
|
||||||
|
{
|
||||||
|
"Manufacturer": "Panasonic",
|
||||||
|
"Model": "Toughbook CF-33",
|
||||||
|
"SystemId": "CF-33LEHAGT1",
|
||||||
|
"DriverPath": "Panasonic\\CF-33.wim"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"Manufacturer": "Panasonic",
|
||||||
|
"Model": "Toughbook FZ-55",
|
||||||
|
"SystemId": "FZ-55DZ0KVM",
|
||||||
|
"DriverPath": "Panasonic\\FZ-55"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"Manufacturer": "Viglen",
|
||||||
|
"Model": "Genie Desktop Pro",
|
||||||
|
"SystemId": "VGN-GDP-2024",
|
||||||
|
"DriverPath": "Viglen\\GeniePro"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"Manufacturer": "Viglen",
|
||||||
|
"Model": "Omnino Mini",
|
||||||
|
"SystemId": "VGN-OMN-M1",
|
||||||
|
"DriverPath": "Viglen\\OmninoMini.wim"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"Manufacturer": "AZW",
|
||||||
|
"Model": "SER5 Pro",
|
||||||
|
"SystemId": "SER5-5800H",
|
||||||
|
"DriverPath": "AZW\\SER5Pro.wim"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"Manufacturer": "AZW",
|
||||||
|
"Model": "U59 Mini PC",
|
||||||
|
"SystemId": "U59-N5095",
|
||||||
|
"DriverPath": "AZW\\U59"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"Manufacturer": "Fujitsu",
|
||||||
|
"Model": "LIFEBOOK U9312",
|
||||||
|
"SystemId": "FPCM52921",
|
||||||
|
"DriverPath": "Fujitsu\\LIFEBOOK-U9312"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"Manufacturer": "Fujitsu",
|
||||||
|
"Model": "ESPRIMO D7010",
|
||||||
|
"SystemId": "D3644-A1",
|
||||||
|
"DriverPath": "Fujitsu\\D7010.wim"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"Manufacturer": "Getac",
|
||||||
|
"Model": "F110 G6",
|
||||||
|
"SystemId": "F110G6",
|
||||||
|
"DriverPath": "Getac\\F110G6.wim"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"Manufacturer": "Getac",
|
||||||
|
"Model": "B360 Pro",
|
||||||
|
"SystemId": "B360PRO",
|
||||||
|
"DriverPath": "Getac\\B360Pro"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"Manufacturer": "Intel",
|
||||||
|
"Model": "NUC13ANHi7",
|
||||||
|
"DriverPath": "Intel\\NUC13"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"Manufacturer": "Intel",
|
||||||
|
"Model": "NUC12WSHi5",
|
||||||
|
"DriverPath": "Intel\\NUC12.wim"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"Manufacturer": "ByteSpeed",
|
||||||
|
"Model": "Tera 2450",
|
||||||
|
"DriverPath": "ByteSpeed\\Tera2450.wim"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"Manufacturer": "ByteSpeed",
|
||||||
|
"Model": "Celeritas X1",
|
||||||
|
"DriverPath": "ByteSpeed\\CeleritasX1"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"Manufacturer": "Acer",
|
||||||
|
"Model": "TravelMate P214-53",
|
||||||
|
"DriverPath": "Acer\\TMP214"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"Manufacturer": "ASUS",
|
||||||
|
"Model": "ExpertBook B5402CVA",
|
||||||
|
"DriverPath": "ASUS\\B5402.wim"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
```
|
||||||
|
|
||||||
|
{% include page_nav.html %}
|
||||||
@@ -0,0 +1,20 @@
|
|||||||
|
---
|
||||||
|
title: Helper Scripts
|
||||||
|
nav_order: 4
|
||||||
|
prev_url: /ui_overview.html
|
||||||
|
prev_label: UI Overview
|
||||||
|
next_url: /create_pemedia.html
|
||||||
|
next_label: Create PE Media
|
||||||
|
has_children: true
|
||||||
|
has_toc: false
|
||||||
|
---
|
||||||
|
# Helper Scripts
|
||||||
|
|
||||||
|
This section documents standalone helper scripts used outside the primary UI-driven build workflow.
|
||||||
|
|
||||||
|
## Available helper scripts
|
||||||
|
|
||||||
|
- [Create PE Media](/create_pemedia.html)
|
||||||
|
- [USB Imaging Tool Creator](/usb_imaging_tool_creator.html)
|
||||||
|
|
||||||
|
{% include page_nav.html %}
|
||||||
@@ -0,0 +1,52 @@
|
|||||||
|
---
|
||||||
|
title: Hyper-V Settings
|
||||||
|
nav_order: 1
|
||||||
|
prev_url: /ui_overview.html
|
||||||
|
prev_label: UI Overview
|
||||||
|
next_url: /windows_settings.html
|
||||||
|
next_label: Windows Settings
|
||||||
|
parent: UI Overview
|
||||||
|
---
|
||||||
|
# Hyper-V Settings
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
## Enable VM Networking (Experimental)
|
||||||
|
|
||||||
|
Controls whether the build VM is connected to a Hyper-V switch during provisioning.
|
||||||
|
|
||||||
|
Leave this off for the default offline build path. Turn it on only if you want to test internet-connected builds and understand there may be Sysprep or capture issues.
|
||||||
|
|
||||||
|
## VM Switch Name
|
||||||
|
|
||||||
|
Drop down of detected VM Switches. There's also an **Other** option which allows you to specify a VM Switch Name. The other option is useful in scenarios where the machine you're running the UI from isn't going to be the machine where you plan to build the FFU from.
|
||||||
|
|
||||||
|
This setting is only used when **Enable VM Networking (Experimental)** is turned on. VM-based builds still capture from the host-side VHDX after the VM shuts down, so you only need a switch when the VM requires network connectivity during provisioning.
|
||||||
|
|
||||||
|
## Disk Size (GB)
|
||||||
|
|
||||||
|
Size of the virtual hard disk for the virtual machine. Default is a 50GB dynamic disk. You may want to increase the size if you're installing many apps.
|
||||||
|
|
||||||
|
## Memory (GB)
|
||||||
|
|
||||||
|
Amount of memory to allocate for the virtual machine. Recommended to use 8GB if possible, especially for Windows 11. Default is 4GB.
|
||||||
|
|
||||||
|
## Processors
|
||||||
|
|
||||||
|
Number of virtual processors for the virtual machine. Recommended to use at least 4. Default is 4.
|
||||||
|
|
||||||
|
## VM Location
|
||||||
|
|
||||||
|
Default is `$FFUDevelopmentPath\VM`. This is the location of the VHDX that gets created where Windows will be installed to.
|
||||||
|
|
||||||
|
## VM Name Prefix
|
||||||
|
|
||||||
|
Prefix for the generated VM. Default is _FFU.
|
||||||
|
|
||||||
|
## Logical Sector Size
|
||||||
|
|
||||||
|
Uint32 value of 512 or 4096. Useful for 4Kn drives or devices shipping with UFS drives. Default is 512.
|
||||||
|
|
||||||
|
There is some error-handling in the script that will call out mismatch issues with logical sector size. Unfortunately you will need to create a new FFU with the correct logical sector size as you can't convert a previously created FFU. Most should be fine with 512, but lower-end devices that used to ship with eMMC drives have now shifted to using UFS.
|
||||||
|
|
||||||
|
{% include page_nav.html %}
|
||||||
|
After Width: | Height: | Size: 166 KiB |
|
After Width: | Height: | Size: 73 KiB |
|
After Width: | Height: | Size: 281 KiB |
|
After Width: | Height: | Size: 150 KiB |
|
After Width: | Height: | Size: 384 KiB |
|
After Width: | Height: | Size: 185 KiB |
|
After Width: | Height: | Size: 51 KiB |
|
After Width: | Height: | Size: 131 KiB |
|
After Width: | Height: | Size: 236 KiB |
|
After Width: | Height: | Size: 200 KiB |
|
After Width: | Height: | Size: 292 KiB |
|
After Width: | Height: | Size: 147 KiB |
|
After Width: | Height: | Size: 283 KiB |
|
After Width: | Height: | Size: 293 KiB |
|
After Width: | Height: | Size: 247 KiB |
|
After Width: | Height: | Size: 249 KiB |
|
After Width: | Height: | Size: 162 KiB |
|
After Width: | Height: | Size: 608 KiB |
|
After Width: | Height: | Size: 374 KiB |
|
After Width: | Height: | Size: 291 KiB |
|
After Width: | Height: | Size: 281 KiB |
|
After Width: | Height: | Size: 282 KiB |
|
After Width: | Height: | Size: 1.3 MiB |
|
After Width: | Height: | Size: 142 KiB |
|
After Width: | Height: | Size: 44 KiB |
|
After Width: | Height: | Size: 24 KiB |
|
After Width: | Height: | Size: 60 KiB |
|
After Width: | Height: | Size: 263 KiB |
|
After Width: | Height: | Size: 197 KiB |
|
After Width: | Height: | Size: 250 KiB |
|
After Width: | Height: | Size: 203 KiB |