/
core.cpp
1566 lines (1304 loc) · 62.7 KB
/
core.cpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
//-------------------------------------------------------------------------------------------------
// <copyright file="core.cpp" company="Outercurve Foundation">
// Copyright (c) 2004, Outercurve Foundation.
// This software is released under Microsoft Reciprocal License (MS-RL).
// The license and further copyright text can be found in the file
// LICENSE.TXT at the root directory of the distribution.
// </copyright>
//
// <summary>
// Module: Core
//
// Setup chainer/bootstrapper core for WiX toolset.
// </summary>
//-------------------------------------------------------------------------------------------------
#include "precomp.h"
// structs
struct BURN_CACHE_THREAD_CONTEXT
{
BURN_ENGINE_STATE* pEngineState;
DWORD* pcOverallProgressTicks;
BOOL* pfRollback;
};
// internal function declarations
static HRESULT ParseCommandLine(
__in_z_opt LPCWSTR wzCommandLine,
__in BOOTSTRAPPER_COMMAND* pCommand,
__in BURN_PIPE_CONNECTION* pCompanionConnection,
__in BURN_PIPE_CONNECTION* pEmbeddedConnection,
__in BURN_VARIABLES* pVariables,
__out BURN_MODE* pMode,
__out BURN_AU_PAUSE_ACTION* pAutomaticUpdates,
__out BOOL* pfDisableSystemRestore,
__out_z LPWSTR* psczOriginalSource,
__out BURN_ELEVATION_STATE* pElevationState,
__out BOOL* pfDisableUnelevate,
__out DWORD *pdwLoggingAttributes,
__out_z LPWSTR* psczLogFile,
__out_z LPWSTR* psczActiveParent,
__out_z LPWSTR* psczIgnoreDependencies,
__out_z LPWSTR* psczAncestors,
__out_z LPWSTR* psczSanitizedCommandLine
);
static HRESULT ParsePipeConnection(
__in LPWSTR* rgArgs,
__in BURN_PIPE_CONNECTION* pConnection
);
static HRESULT DetectPackagePayloadsCached(
__in BURN_PACKAGE* pPackage
);
static DWORD WINAPI CacheThreadProc(
__in LPVOID lpThreadParameter
);
static HRESULT WaitForCacheThread(
__in HANDLE hCacheThread
);
static void LogPackages(
__in_opt const BURN_PACKAGE* pUpgradeBundlePackage,
__in_opt const BURN_PACKAGE* pForwardCompatibleBundlePackage,
__in const BURN_PACKAGES* pPackages,
__in const BURN_RELATED_BUNDLES* pRelatedBundles,
__in const BOOTSTRAPPER_ACTION action
);
// function definitions
extern "C" HRESULT CoreInitialize(
__in_z_opt LPCWSTR wzCommandLine,
__in BURN_ENGINE_STATE* pEngineState
)
{
HRESULT hr = S_OK;
LPWSTR sczSanitizedCommandLine = NULL;
LPWSTR sczStreamName = NULL;
BYTE* pbBuffer = NULL;
SIZE_T cbBuffer = 0;
BURN_CONTAINER_CONTEXT containerContext = { };
LPWSTR sczOriginalSource = NULL;
// Initialize variables.
hr = VariableInitialize(&pEngineState->variables);
ExitOnFailure(hr, "Failed to initialize variables.");
// Open attached UX container.
hr = ContainerOpenUX(&pEngineState->section, &containerContext);
ExitOnFailure(hr, "Failed to open attached UX container.");
// Load manifest.
hr = ContainerNextStream(&containerContext, &sczStreamName);
ExitOnFailure(hr, "Failed to open manifest stream.");
hr = ContainerStreamToBuffer(&containerContext, &pbBuffer, &cbBuffer);
ExitOnFailure(hr, "Failed to get manifest stream from container.");
hr = ManifestLoadXmlFromBuffer(pbBuffer, cbBuffer, pEngineState);
ExitOnFailure(hr, "Failed to load manifest.");
// Parse command line.
hr = ParseCommandLine(wzCommandLine, &pEngineState->command, &pEngineState->companionConnection, &pEngineState->embeddedConnection, &pEngineState->variables, &pEngineState->mode, &pEngineState->automaticUpdates, &pEngineState->fDisableSystemRestore, &sczOriginalSource, &pEngineState->elevationState, &pEngineState->fDisableUnelevate, &pEngineState->log.dwAttributes, &pEngineState->log.sczPath, &pEngineState->registration.sczActiveParent, &pEngineState->sczIgnoreDependencies, &pEngineState->registration.sczAncestors, &sczSanitizedCommandLine);
ExitOnFailure(hr, "Failed to parse command line.");
LogId(REPORT_STANDARD, MSG_BURN_COMMAND_LINE, sczSanitizedCommandLine ? sczSanitizedCommandLine : L"");
// Retain whether bundle was initially run elevated.
hr = VariableSetNumeric(&pEngineState->variables, BURN_BUNDLE_ELEVATED, BURN_ELEVATION_STATE_UNELEVATED != pEngineState->elevationState, TRUE);
ExitOnFailure(hr, "Failed to overwrite the %ls built-in variable.", BURN_BUNDLE_ELEVATED);
// Set BURN_BUNDLE_ORIGINAL_SOURCE, if it was passed in on the command line.
// Needs to be done after ManifestLoadXmlFromBuffer.
if (sczOriginalSource)
{
hr = VariableSetLiteralString(&pEngineState->variables, BURN_BUNDLE_ORIGINAL_SOURCE, sczOriginalSource);
ExitOnFailure(hr, "Failed to set original source variable.");
}
// If we're not elevated then we'll be loading the bootstrapper application, so extract
// the payloads from the BA container.
if (pEngineState->elevationState == BURN_ELEVATION_STATE_UNELEVATED || pEngineState->elevationState == BURN_ELEVATION_STATE_UNELEVATED_EXPLICITLY)
{
// Extract all UX payloads to working folder.
hr = UserExperienceEnsureWorkingFolder(pEngineState->registration.sczId, &pEngineState->userExperience.sczTempDirectory);
ExitOnFailure(hr, "Failed to get unique temporary folder for bootstrapper application.");
hr = PayloadExtractFromContainer(&pEngineState->userExperience.payloads, NULL, &containerContext, pEngineState->userExperience.sczTempDirectory);
ExitOnFailure(hr, "Failed to extract bootstrapper application payloads.");
// Load the catalog files as soon as they are extracted.
hr = CatalogLoadFromPayload(&pEngineState->catalogs, &pEngineState->userExperience.payloads);
ExitOnFailure(hr, "Failed to load catalog files.");
}
LExit:
ReleaseStr(sczOriginalSource);
ContainerClose(&containerContext);
ReleaseStr(sczStreamName);
ReleaseStr(sczSanitizedCommandLine);
ReleaseMem(pbBuffer);
return hr;
}
extern "C" HRESULT CoreSerializeEngineState(
__in BURN_ENGINE_STATE* pEngineState,
__inout BYTE** ppbBuffer,
__inout SIZE_T* piBuffer
)
{
HRESULT hr = S_OK;
hr = VariableSerialize(&pEngineState->variables, TRUE, ppbBuffer, piBuffer);
ExitOnFailure(hr, "Failed to serialize variables.");
LExit:
return hr;
}
extern "C" HRESULT CoreQueryRegistration(
__in BURN_ENGINE_STATE* pEngineState
)
{
HRESULT hr = S_OK;
BYTE* pbBuffer = NULL;
SIZE_T cbBuffer = 0;
SIZE_T iBuffer = 0;
// Detect if bundle is already installed.
RegistrationDetectInstalled(&pEngineState->registration, &pEngineState->registration.fInstalled);
// detect resume type
hr = RegistrationDetectResumeType(&pEngineState->registration, &pEngineState->command.resumeType);
ExitOnFailure(hr, "Failed to detect resume type.");
// If we have a resume mode that suggests the bundle might already be present, try to load any
// previously stored state.
if (BOOTSTRAPPER_RESUME_TYPE_INVALID < pEngineState->command.resumeType)
{
// load resume state
hr = RegistrationLoadState(&pEngineState->registration, &pbBuffer, &cbBuffer);
if (SUCCEEDED(hr))
{
hr = VariableDeserialize(&pEngineState->variables, TRUE, pbBuffer, cbBuffer, &iBuffer);
}
// Log any failures and continue.
if (FAILED(hr))
{
LogId(REPORT_STANDARD, MSG_CANNOT_LOAD_STATE_FILE, hr, pEngineState->registration.sczStateFile);
hr = S_OK;
}
}
LExit:
ReleaseBuffer(pbBuffer);
return hr;
}
extern "C" HRESULT CoreDetect(
__in BURN_ENGINE_STATE* pEngineState,
__in_opt HWND hwndParent
)
{
HRESULT hr = S_OK;
BOOL fActivated = FALSE;
BURN_PACKAGE* pPackage = NULL;
HRESULT hrFirstPackageFailure = S_OK;
LogId(REPORT_STANDARD, MSG_DETECT_BEGIN, pEngineState->packages.cPackages);
hr = UserExperienceActivateEngine(&pEngineState->userExperience, &fActivated);
ExitOnFailure(hr, "Engine cannot start detect because it is busy with another action.");
int nResult = pEngineState->userExperience.pUserExperience->OnDetectBegin(pEngineState->registration.fInstalled, pEngineState->packages.cPackages);
hr = UserExperienceInterpretResult(&pEngineState->userExperience, MB_OKCANCEL, nResult);
ExitOnRootFailure(hr, "UX aborted detect begin.");
pEngineState->userExperience.hwndDetect = hwndParent;
// Always reset the detect state which means the plan should be reset too.
DetectReset(&pEngineState->registration, &pEngineState->packages, &pEngineState->update);
PlanReset(&pEngineState->plan, &pEngineState->packages);
hr = SearchesExecute(&pEngineState->searches, &pEngineState->variables);
ExitOnFailure(hr, "Failed to execute searches.");
// Load all of the related bundles.
hr = RegistrationDetectRelatedBundles(&pEngineState->registration);
ExitOnFailure(hr, "Failed to detect related bundles.");
hr = DependencyDetectProviderKeyBundleId(&pEngineState->registration);
if (SUCCEEDED(hr))
{
hr = DetectForwardCompatibleBundle(&pEngineState->userExperience, &pEngineState->command, &pEngineState->registration);
ExitOnFailure(hr, "Failed to detect forward compatible bundle.");
// If a forward compatible bundle was detected, skip rest of bundle detection
// since we will passthrough.
if (pEngineState->registration.fEnabledForwardCompatibleBundle)
{
ExitFunction();
}
}
else if (E_NOTFOUND == hr)
{
hr = S_OK;
}
ExitOnFailure(hr, "Failed to detect provider key bundle id.");
// Report the related bundles.
hr = DetectReportRelatedBundles(&pEngineState->userExperience, &pEngineState->registration, pEngineState->command.relationType, pEngineState->command.action);
ExitOnFailure(hr, "Failed to report detected related bundles.");
// Do update detection.
hr = DetectUpdate(pEngineState->registration.sczId, &pEngineState->userExperience, &pEngineState->update);
ExitOnFailure(hr, "Failed to detect update.");
// Detecting MSPs requires special initialization before processing each package but
// only do the detection if there are actually patch packages to detect because it
// can be expensive.
if (pEngineState->packages.cPatchInfo)
{
hr = MspEngineDetectInitialize(&pEngineState->packages);
ExitOnFailure(hr, "Failed to initialize MSP engine detection.");
}
for (DWORD i = 0; i < pEngineState->packages.cPackages; ++i)
{
pPackage = pEngineState->packages.rgPackages + i;
nResult = pEngineState->userExperience.pUserExperience->OnDetectPackageBegin(pPackage->sczId);
hr = UserExperienceInterpretResult(&pEngineState->userExperience, MB_OKCANCEL, nResult);
ExitOnRootFailure(hr, "UX aborted detect package begin.");
// Detect the cache state of the package.
hr = DetectPackagePayloadsCached(pPackage);
ExitOnFailure(hr, "Failed to detect if payloads are all cached for package: %ls", pPackage->sczId);
// Use the correct engine to detect the package.
switch (pPackage->type)
{
case BURN_PACKAGE_TYPE_EXE:
hr = ExeEngineDetectPackage(pPackage, &pEngineState->variables);
break;
case BURN_PACKAGE_TYPE_MSI:
hr = MsiEngineDetectPackage(pPackage, &pEngineState->userExperience);
break;
case BURN_PACKAGE_TYPE_MSP:
hr = MspEngineDetectPackage(pPackage, &pEngineState->userExperience);
break;
case BURN_PACKAGE_TYPE_MSU:
hr = MsuEngineDetectPackage(pPackage, &pEngineState->variables);
break;
default:
hr = E_NOTIMPL;
ExitOnRootFailure(hr, "Package type not supported by detect yet.");
}
// If the package detection failed, ensure the package state is set to unknown.
if (FAILED(hr))
{
if (SUCCEEDED(hrFirstPackageFailure))
{
hrFirstPackageFailure = hr;
}
pPackage->currentState = BOOTSTRAPPER_PACKAGE_STATE_UNKNOWN;
LogErrorId(hr, MSG_FAILED_DETECT_PACKAGE, pPackage->sczId, NULL, NULL);
}
// TODO: consider how to notify the UX that a package is cached.
//else if (BOOTSTRAPPER_PACKAGE_STATE_CACHED > pPackage->currentState && pPackage->fCached)
//{
// pPackage->currentState = BOOTSTRAPPER_PACKAGE_STATE_CACHED;
//}
pEngineState->userExperience.pUserExperience->OnDetectPackageComplete(pPackage->sczId, hr, pPackage->currentState);
}
// Log the detected states.
for (DWORD iPackage = 0; iPackage < pEngineState->packages.cPackages; ++iPackage)
{
pPackage = pEngineState->packages.rgPackages + iPackage;
LogId(REPORT_STANDARD, MSG_DETECTED_PACKAGE, pPackage->sczId, LoggingPackageStateToString(pPackage->currentState), LoggingCacheStateToString(pPackage->cache));
if (BURN_PACKAGE_TYPE_MSI == pPackage->type)
{
for (DWORD iFeature = 0; iFeature < pPackage->Msi.cFeatures; ++iFeature)
{
const BURN_MSIFEATURE* pFeature = pPackage->Msi.rgFeatures + iFeature;
LogId(REPORT_STANDARD, MSG_DETECTED_MSI_FEATURE, pPackage->sczId, pFeature->sczId, LoggingMsiFeatureStateToString(pFeature->currentState));
}
}
else if (BURN_PACKAGE_TYPE_MSP == pPackage->type)
{
for (DWORD iTargetProduct = 0; iTargetProduct < pPackage->Msp.cTargetProductCodes; ++iTargetProduct)
{
const BURN_MSPTARGETPRODUCT* pTargetProduct = pPackage->Msp.rgTargetProducts + iTargetProduct;
LogId(REPORT_STANDARD, MSG_DETECTED_MSP_TARGET, pPackage->sczId, pTargetProduct->wzTargetProductCode, LoggingPackageStateToString(pTargetProduct->patchPackageState));
}
}
}
LExit:
if (SUCCEEDED(hr))
{
hr = hrFirstPackageFailure;
}
if (fActivated)
{
UserExperienceDeactivateEngine(&pEngineState->userExperience);
}
pEngineState->userExperience.pUserExperience->OnDetectComplete(hr);
pEngineState->userExperience.hwndDetect = NULL;
LogId(REPORT_STANDARD, MSG_DETECT_COMPLETE, hr);
return hr;
}
extern "C" HRESULT CorePlan(
__in BURN_ENGINE_STATE* pEngineState,
__in BOOTSTRAPPER_ACTION action
)
{
HRESULT hr = S_OK;
BOOL fActivated = FALSE;
LPWSTR sczLayoutDirectory = NULL;
HANDLE hSyncpointEvent = NULL;
BURN_PACKAGE* pUpgradeBundlePackage = NULL;
BURN_PACKAGE* pForwardCompatibleBundlePackage = NULL;
LogId(REPORT_STANDARD, MSG_PLAN_BEGIN, pEngineState->packages.cPackages, LoggingBurnActionToString(action));
hr = UserExperienceActivateEngine(&pEngineState->userExperience, &fActivated);
ExitOnFailure(hr, "Engine cannot start plan because it is busy with another action.");
int nResult = pEngineState->userExperience.pUserExperience->OnPlanBegin(pEngineState->packages.cPackages);
hr = UserExperienceInterpretResult(&pEngineState->userExperience, MB_OKCANCEL, nResult);
ExitOnRootFailure(hr, "UX aborted plan begin.");
// Always reset the plan.
PlanReset(&pEngineState->plan, &pEngineState->packages);
// Remember the overall action state in the plan since it shapes the changes
// we make everywhere.
pEngineState->plan.action = action;
pEngineState->plan.wzBundleId = pEngineState->registration.sczId;
pEngineState->plan.wzBundleProviderKey = pEngineState->registration.sczId;
hr = PlanSetVariables(action, &pEngineState->variables);
ExitOnFailure(hr, "Failed to update action.");
// Set resume commandline
hr = PlanSetResumeCommand(&pEngineState->registration, action, &pEngineState->command, &pEngineState->log);
ExitOnFailure(hr, "Failed to set resume command");
hr = DependencyPlanInitialize(pEngineState, &pEngineState->plan);
ExitOnFailure(hr, "Failed to initialize the dependencies for the plan.");
if (BOOTSTRAPPER_ACTION_LAYOUT == action)
{
Assert(!pEngineState->plan.fPerMachine);
// Plan the bundle's layout.
hr = PlanLayoutBundle(&pEngineState->plan, pEngineState->registration.sczExecutableName, pEngineState->section.qwBundleSize, &pEngineState->variables, &pEngineState->payloads, &sczLayoutDirectory);
ExitOnFailure(hr, "Failed to plan the layout of the bundle.");
// Plan the packages' layout.
hr = PlanPackages(&pEngineState->registration, &pEngineState->userExperience, &pEngineState->packages, &pEngineState->plan, &pEngineState->log, &pEngineState->variables, FALSE, pEngineState->command.display, pEngineState->command.relationType, sczLayoutDirectory, &hSyncpointEvent);
ExitOnFailure(hr, "Failed to plan packages.");
}
else if (BOOTSTRAPPER_ACTION_UPDATE_REPLACE == action || BOOTSTRAPPER_ACTION_UPDATE_REPLACE_EMBEDDED == action)
{
Assert(!pEngineState->plan.fPerMachine);
pUpgradeBundlePackage = &pEngineState->update.package;
hr = PlanUpdateBundle(&pEngineState->userExperience, pUpgradeBundlePackage, &pEngineState->plan, &pEngineState->log, &pEngineState->variables, pEngineState->command.display, pEngineState->command.relationType, &hSyncpointEvent);
ExitOnFailure(hr, "Failed to plan update.");
}
else if (pEngineState->registration.fEnabledForwardCompatibleBundle)
{
Assert(!pEngineState->plan.fPerMachine);
pForwardCompatibleBundlePackage = &pEngineState->registration.forwardCompatibleBundle;
hr = PlanPassThroughBundle(&pEngineState->userExperience, pForwardCompatibleBundlePackage, &pEngineState->plan, &pEngineState->log, &pEngineState->variables, pEngineState->command.display, pEngineState->command.relationType, &hSyncpointEvent);
ExitOnFailure(hr, "Failed to plan passthrough.");
}
else // doing an action that modifies the machine state.
{
BOOL fContinuePlanning = TRUE; // assume we'll be able to keep planning after registration.
pEngineState->plan.fPerMachine = pEngineState->registration.fPerMachine; // default the scope of the plan to the per-machine state of the bundle.
hr = PlanRegistration(&pEngineState->plan, &pEngineState->registration, pEngineState->command.resumeType, pEngineState->command.relationType, pEngineState->sczIgnoreDependencies, &fContinuePlanning);
ExitOnFailure(hr, "Failed to plan registration.");
if (fContinuePlanning)
{
// Remember the early index, because we want to be able to insert some related bundles
// into the plan before other executed packages. This particularly occurs for uninstallation
// of addons and patches, which should be uninstalled before the main product.
DWORD dwExecuteActionEarlyIndex = pEngineState->plan.cExecuteActions;
// Plan the related bundles first to support downgrades with ref-counting.
hr = PlanRelatedBundlesBegin(&pEngineState->userExperience, &pEngineState->registration, pEngineState->command.relationType, &pEngineState->plan, pEngineState->mode);
ExitOnFailure(hr, "Failed to plan related bundles.");
hr = PlanPackages(&pEngineState->registration, &pEngineState->userExperience, &pEngineState->packages, &pEngineState->plan, &pEngineState->log, &pEngineState->variables, pEngineState->registration.fInstalled, pEngineState->command.display, pEngineState->command.relationType, NULL, &hSyncpointEvent);
ExitOnFailure(hr, "Failed to plan packages.");
// Schedule the update of related bundles last.
hr = PlanRelatedBundlesComplete(&pEngineState->registration, &pEngineState->plan, &pEngineState->log, &pEngineState->variables, &hSyncpointEvent, dwExecuteActionEarlyIndex);
ExitOnFailure(hr, "Failed to schedule related bundles.");
}
}
// Remove unnecessary actions.
hr = PlanFinalizeActions(&pEngineState->plan);
ExitOnFailure(hr, "Failed to remove unnecessary actions from plan.");
// Finally, display all packages and related bundles in the log.
LogPackages(pUpgradeBundlePackage, pForwardCompatibleBundlePackage, &pEngineState->packages, &pEngineState->registration.relatedBundles, action);
#ifdef DEBUG
PlanDump(&pEngineState->plan);
#endif
LExit:
if (fActivated)
{
UserExperienceDeactivateEngine(&pEngineState->userExperience);
}
pEngineState->userExperience.pUserExperience->OnPlanComplete(hr);
LogId(REPORT_STANDARD, MSG_PLAN_COMPLETE, hr);
ReleaseStr(sczLayoutDirectory);
return hr;
}
extern "C" HRESULT CoreElevate(
__in BURN_ENGINE_STATE* pEngineState,
__in_opt HWND hwndParent
)
{
HRESULT hr = S_OK;
// If the elevated companion pipe isn't created yet, let's make that happen.
if (INVALID_HANDLE_VALUE == pEngineState->companionConnection.hPipe)
{
if (!pEngineState->sczBundleEngineWorkingPath)
{
hr = CacheBundleToWorkingDirectory(pEngineState->registration.sczId, pEngineState->registration.sczExecutableName, &pEngineState->userExperience.payloads, &pEngineState->section, &pEngineState->sczBundleEngineWorkingPath);
ExitOnFailure(hr, "Failed to cache engine to working directory.");
}
hr = ElevationElevate(pEngineState, hwndParent);
ExitOnFailure(hr, "Failed to actually elevate.");
hr = VariableSetNumeric(&pEngineState->variables, BURN_BUNDLE_ELEVATED, TRUE, TRUE);
ExitOnFailure(hr, "Failed to overwrite the %ls built-in variable.", BURN_BUNDLE_ELEVATED);
}
LExit:
return hr;
}
extern "C" HRESULT CoreApply(
__in BURN_ENGINE_STATE* pEngineState,
__in_opt HWND hwndParent
)
{
HRESULT hr = S_OK;
BOOL fActivated = FALSE;
HANDLE hLock = NULL;
DWORD cOverallProgressTicks = 0;
HANDLE hCacheThread = NULL;
BOOL fElevated = FALSE;
BOOL fRegistered = FALSE;
BOOL fKeepRegistration = pEngineState->plan.fKeepRegistrationDefault;
BOOL fRollback = FALSE;
BOOL fSuspend = FALSE;
BOOTSTRAPPER_APPLY_RESTART restart = BOOTSTRAPPER_APPLY_RESTART_NONE;
BURN_CACHE_THREAD_CONTEXT cacheThreadContext = { };
DWORD dwPhaseCount = 0;
LogId(REPORT_STANDARD, MSG_APPLY_BEGIN);
hr = UserExperienceActivateEngine(&pEngineState->userExperience, &fActivated);
ExitOnFailure(hr, "Engine cannot start apply because it is busy with another action.");
// Ensure any previous attempts to execute are reset.
ApplyReset(&pEngineState->userExperience, &pEngineState->packages);
if (pEngineState->plan.cCacheActions)
{
++dwPhaseCount;
}
if (pEngineState->plan.cExecuteActions)
{
++dwPhaseCount;
}
pEngineState->userExperience.pUserExperience->OnApplyPhaseCount(dwPhaseCount);
int nResult = pEngineState->userExperience.pUserExperience->OnApplyBegin();
hr = UserExperienceInterpretResult(&pEngineState->userExperience, MB_OKCANCEL, nResult);
ExitOnRootFailure(hr, "UX aborted apply begin.");
// Abort if this bundle already requires a restart.
if (BOOTSTRAPPER_RESUME_TYPE_REBOOT_PENDING == pEngineState->command.resumeType)
{
restart = BOOTSTRAPPER_APPLY_RESTART_REQUIRED;
hr = HRESULT_FROM_WIN32(ERROR_FAIL_NOACTION_REBOOT);
UserExperienceSendError(pEngineState->userExperience.pUserExperience, BOOTSTRAPPER_ERROR_TYPE_APPLY, NULL, hr, NULL, MB_ICONERROR | MB_OK, IDNOACTION);
ExitFunction();
}
hr = ApplyLock(FALSE, &hLock);
ExitOnFailure(hr, "Another per-user setup is already executing.");
// Initialize only after getting a lock.
ApplyInitialize();
pEngineState->userExperience.hwndApply = hwndParent;
hr = ApplySetVariables(&pEngineState->variables);
ExitOnFailure(hr, "Failed to set initial apply variables.");
// If the plan is empty of work to do, skip everything.
if (!(pEngineState->plan.cRegistrationActions || pEngineState->plan.cCacheActions || pEngineState->plan.cExecuteActions || pEngineState->plan.cCleanActions))
{
LogId(REPORT_STANDARD, MSG_APPLY_SKIPPED);
ExitFunction();
}
// Ensure the engine is cached to the working path.
if (!pEngineState->sczBundleEngineWorkingPath)
{
hr = CacheBundleToWorkingDirectory(pEngineState->registration.sczId, pEngineState->registration.sczExecutableName, &pEngineState->userExperience.payloads, &pEngineState->section, &pEngineState->sczBundleEngineWorkingPath);
ExitOnFailure(hr, "Failed to cache engine to working directory.");
}
// Elevate.
if (pEngineState->plan.fPerMachine)
{
hr = CoreElevate(pEngineState, pEngineState->userExperience.hwndApply);
ExitOnFailure(hr, "Failed to elevate.");
hr = ElevationApplyInitialize(pEngineState->companionConnection.hPipe, &pEngineState->variables, pEngineState->plan.action, pEngineState->automaticUpdates, !pEngineState->fDisableSystemRestore);
ExitOnFailure(hr, "Another per-machine setup is already executing.");
fElevated = TRUE;
}
// Register.
if (pEngineState->plan.fRegister)
{
hr = ApplyRegister(pEngineState);
ExitOnFailure(hr, "Failed to register bundle.");
fRegistered = TRUE;
}
// Cache.
if (pEngineState->plan.cCacheActions)
{
// Launch the cache thread.
cacheThreadContext.pEngineState = pEngineState;
cacheThreadContext.pcOverallProgressTicks = &cOverallProgressTicks;
cacheThreadContext.pfRollback = &fRollback;
hCacheThread = ::CreateThread(NULL, 0, CacheThreadProc, &cacheThreadContext, 0, NULL);
ExitOnNullWithLastError(hCacheThread, hr, "Failed to create cache thread.");
// If we're not caching in parallel, wait for the cache thread to terminate.
if (!pEngineState->fParallelCacheAndExecute)
{
hr = WaitForCacheThread(hCacheThread);
ExitOnFailure(hr, "Failed while caching, aborting execution.");
ReleaseHandle(hCacheThread);
}
}
// Execute.
if (pEngineState->plan.cExecuteActions)
{
hr = ApplyExecute(pEngineState, hCacheThread, &cOverallProgressTicks, &fKeepRegistration, &fRollback, &fSuspend, &restart);
UserExperienceExecutePhaseComplete(&pEngineState->userExperience, hr); // signal that execute completed.
}
// Wait for cache thread to terminate, this should return immediately unless we're waiting for layout to complete.
if (hCacheThread)
{
HRESULT hrCached = WaitForCacheThread(hCacheThread);
if (SUCCEEDED(hr))
{
hr = hrCached;
}
}
// If something went wrong or force restarted, skip cleaning.
if (FAILED(hr) || fRollback || fSuspend || BOOTSTRAPPER_APPLY_RESTART_INITIATED == restart)
{
ExitFunction();
}
// Clean.
if (pEngineState->plan.cCleanActions)
{
ApplyClean(&pEngineState->userExperience, &pEngineState->plan, pEngineState->companionConnection.hPipe);
}
LExit:
// Unregister.
if (fRegistered)
{
ApplyUnregister(pEngineState, FAILED(hr) || fRollback, fKeepRegistration || pEngineState->plan.fDisallowRemoval, fSuspend, restart);
}
if (fElevated)
{
ElevationApplyUninitialize(pEngineState->companionConnection.hPipe);
}
pEngineState->userExperience.hwndApply = NULL;
ApplyUninitialize();
if (hLock)
{
::ReleaseMutex(hLock);
::CloseHandle(hLock);
}
if (fActivated)
{
UserExperienceDeactivateEngine(&pEngineState->userExperience);
}
ReleaseHandle(hCacheThread);
nResult = pEngineState->userExperience.pUserExperience->OnApplyComplete(hr, restart);
if (IDRESTART == nResult)
{
pEngineState->fRestart = TRUE;
}
LogId(REPORT_STANDARD, MSG_APPLY_COMPLETE, hr, LoggingRestartToString(restart), LoggingBoolToString(pEngineState->fRestart));
return hr;
}
extern "C" HRESULT CoreLaunchApprovedExe(
__in BURN_ENGINE_STATE* pEngineState,
__in BURN_LAUNCH_APPROVED_EXE* pLaunchApprovedExe
)
{
HRESULT hr = S_OK;
BOOL fActivated = FALSE;
DWORD dwProcessId = 0;
LogId(REPORT_STANDARD, MSG_LAUNCH_APPROVED_EXE_BEGIN, pLaunchApprovedExe->sczId);
hr = UserExperienceActivateEngine(&pEngineState->userExperience, &fActivated);
ExitOnFailure(hr, "Engine cannot start LaunchApprovedExe because it is busy with another action.");
int nResult = pEngineState->userExperience.pUserExperience->OnLaunchApprovedExeBegin();
hr = UserExperienceInterpretResult(&pEngineState->userExperience, MB_OKCANCEL, nResult);
ExitOnRootFailure(hr, "UX aborted LaunchApprovedExe begin.");
// Elevate.
hr = CoreElevate(pEngineState, pLaunchApprovedExe->hwndParent);
ExitOnFailure(hr, "Failed to elevate.");
// Launch.
hr = ElevationLaunchApprovedExe(pEngineState->companionConnection.hPipe, pLaunchApprovedExe, &dwProcessId);
LExit:
if (fActivated)
{
UserExperienceDeactivateEngine(&pEngineState->userExperience);
}
pEngineState->userExperience.pUserExperience->OnLaunchApprovedExeComplete(hr, dwProcessId);
LogId(REPORT_STANDARD, MSG_LAUNCH_APPROVED_EXE_COMPLETE, hr, dwProcessId);
ApprovedExesUninitializeLaunch(pLaunchApprovedExe);
return hr;
}
extern "C" HRESULT CoreQuit(
__in BURN_ENGINE_STATE* pEngineState,
__in int nExitCode
)
{
HRESULT hr = S_OK;
// Save engine state if resume mode is unequal to "none".
if (BURN_RESUME_MODE_NONE != pEngineState->resumeMode)
{
hr = CoreSaveEngineState(pEngineState);
if (FAILED(hr))
{
LogErrorId(hr, MSG_STATE_NOT_SAVED, NULL, NULL, NULL);
hr = S_OK;
}
}
LogId(REPORT_STANDARD, MSG_QUIT, nExitCode);
::PostQuitMessage(nExitCode); // go bye-bye.
return hr;
}
extern "C" HRESULT CoreSaveEngineState(
__in BURN_ENGINE_STATE* pEngineState
)
{
HRESULT hr = S_OK;
BYTE* pbBuffer = NULL;
SIZE_T cbBuffer = 0;
// serialize engine state
hr = CoreSerializeEngineState(pEngineState, &pbBuffer, &cbBuffer);
ExitOnFailure(hr, "Failed to serialize engine state.");
// write to registration store
if (pEngineState->registration.fPerMachine)
{
hr = ElevationSaveState(pEngineState->companionConnection.hPipe, pbBuffer, cbBuffer);
ExitOnFailure(hr, "Failed to save engine state in per-machine process.");
}
else
{
hr = RegistrationSaveState(&pEngineState->registration, pbBuffer, cbBuffer);
ExitOnFailure(hr, "Failed to save engine state.");
}
LExit:
ReleaseBuffer(pbBuffer);
return hr;
}
extern "C" LPCWSTR CoreRelationTypeToCommandLineString(
__in BOOTSTRAPPER_RELATION_TYPE relationType
)
{
LPCWSTR wzRelationTypeCommandLine = NULL;
switch (relationType)
{
case BOOTSTRAPPER_RELATION_DETECT:
wzRelationTypeCommandLine = BURN_COMMANDLINE_SWITCH_RELATED_DETECT;
break;
case BOOTSTRAPPER_RELATION_UPGRADE:
wzRelationTypeCommandLine = BURN_COMMANDLINE_SWITCH_RELATED_UPGRADE;
break;
case BOOTSTRAPPER_RELATION_ADDON:
wzRelationTypeCommandLine = BURN_COMMANDLINE_SWITCH_RELATED_ADDON;
break;
case BOOTSTRAPPER_RELATION_PATCH:
wzRelationTypeCommandLine = BURN_COMMANDLINE_SWITCH_RELATED_PATCH;
break;
case BOOTSTRAPPER_RELATION_UPDATE:
wzRelationTypeCommandLine = BURN_COMMANDLINE_SWITCH_RELATED_UPDATE;
break;
case BOOTSTRAPPER_RELATION_DEPENDENT:
break;
case BOOTSTRAPPER_RELATION_NONE: __fallthrough;
default:
wzRelationTypeCommandLine = NULL;
break;
}
return wzRelationTypeCommandLine;
}
extern "C" HRESULT CoreRecreateCommandLine(
__deref_inout_z LPWSTR* psczCommandLine,
__in BOOTSTRAPPER_ACTION action,
__in BOOTSTRAPPER_DISPLAY display,
__in BOOTSTRAPPER_RESTART restart,
__in BOOTSTRAPPER_RELATION_TYPE relationType,
__in BOOL fPassthrough,
__in_z_opt LPCWSTR wzActiveParent,
__in_z_opt LPCWSTR wzAncestors,
__in_z_opt LPCWSTR wzAppendLogPath,
__in_z_opt LPCWSTR wzAdditionalCommandLineArguments
)
{
HRESULT hr = S_OK;
LPWSTR scz = NULL;
LPCWSTR wzRelationTypeCommandLine = CoreRelationTypeToCommandLineString(relationType);
hr = StrAllocString(psczCommandLine, L"", 0);
ExitOnFailure(hr, "Failed to empty command line.");
switch (display)
{
case BOOTSTRAPPER_DISPLAY_NONE:
hr = StrAllocConcat(psczCommandLine, L" /quiet", 0);
break;
case BOOTSTRAPPER_DISPLAY_PASSIVE:
hr = StrAllocConcat(psczCommandLine, L" /passive", 0);
break;
}
ExitOnFailure(hr, "Failed to append display state to command-line");
switch (action)
{
case BOOTSTRAPPER_ACTION_MODIFY:
hr = StrAllocConcat(psczCommandLine, L" /modify", 0);
break;
case BOOTSTRAPPER_ACTION_REPAIR:
hr = StrAllocConcat(psczCommandLine, L" /repair", 0);
break;
case BOOTSTRAPPER_ACTION_UNINSTALL:
hr = StrAllocConcat(psczCommandLine, L" /uninstall", 0);
break;
}
ExitOnFailure(hr, "Failed to append action state to command-line");
switch (restart)
{
case BOOTSTRAPPER_RESTART_ALWAYS:
hr = StrAllocConcat(psczCommandLine, L" /forcerestart", 0);
break;
case BOOTSTRAPPER_RESTART_NEVER:
hr = StrAllocConcat(psczCommandLine, L" /norestart", 0);
break;
}
ExitOnFailure(hr, "Failed to append restart state to command-line");
if (wzActiveParent)
{
if (*wzActiveParent)
{
hr = StrAllocFormatted(&scz, L" /%ls \"%ls\"", BURN_COMMANDLINE_SWITCH_PARENT, wzActiveParent);
ExitOnFailure(hr, "Failed to format active parent command-line for command-line.");
}
else
{
hr = StrAllocFormatted(&scz, L" /%ls", BURN_COMMANDLINE_SWITCH_PARENT_NONE);
ExitOnFailure(hr, "Failed to format parent:none command-line for command-line.");
}
hr = StrAllocConcat(psczCommandLine, scz, 0);
ExitOnFailure(hr, "Failed to append active parent command-line to command-line.");
}
if (wzAncestors)
{
hr = StrAllocFormatted(&scz, L" /%ls=%ls", BURN_COMMANDLINE_SWITCH_ANCESTORS, wzAncestors);
ExitOnFailure(hr, "Failed to format ancestors for command-line.");
hr = StrAllocConcat(psczCommandLine, scz, 0);
ExitOnFailure(hr, "Failed to append ancestors to command-line.");
}
if (wzRelationTypeCommandLine)
{
hr = StrAllocFormatted(&scz, L" /%ls", wzRelationTypeCommandLine);
ExitOnFailure(hr, "Failed to format relation type for command-line.");
hr = StrAllocConcat(psczCommandLine, scz, 0);
ExitOnFailure(hr, "Failed to append relation type to command-line.");
}
if (fPassthrough)
{
hr = StrAllocFormatted(&scz, L" /%ls", BURN_COMMANDLINE_SWITCH_PASSTHROUGH);
ExitOnFailure(hr, "Failed to format passthrough for command-line.");
hr = StrAllocConcat(psczCommandLine, scz, 0);
ExitOnFailure(hr, "Failed to append passthrough to command-line.");
}
if (wzAppendLogPath && *wzAppendLogPath)
{
hr = StrAllocFormatted(&scz, L" /%ls \"%ls\"", BURN_COMMANDLINE_SWITCH_LOG_APPEND, wzAppendLogPath);
ExitOnFailure(hr, "Failed to format append log command-line for command-line.");
hr = StrAllocConcat(psczCommandLine, scz, 0);
ExitOnFailure(hr, "Failed to append log command-line to command-line");
}
if (wzAdditionalCommandLineArguments && *wzAdditionalCommandLineArguments)
{
hr = StrAllocConcat(psczCommandLine, L" ", 0);
ExitOnFailure(hr, "Failed to append space to command-line.");
hr = StrAllocConcat(psczCommandLine, wzAdditionalCommandLineArguments, 0);
ExitOnFailure(hr, "Failed to append command-line to command-line.");
}
LExit:
ReleaseStr(scz);
return hr;
}
// internal helper functions
static HRESULT ParseCommandLine(
__in_z_opt LPCWSTR wzCommandLine,
__in BOOTSTRAPPER_COMMAND* pCommand,
__in BURN_PIPE_CONNECTION* pCompanionConnection,
__in BURN_PIPE_CONNECTION* pEmbeddedConnection,
__in BURN_VARIABLES* pVariables,
__out BURN_MODE* pMode,
__out BURN_AU_PAUSE_ACTION* pAutomaticUpdates,
__out BOOL* pfDisableSystemRestore,
__out_z LPWSTR* psczOriginalSource,
__out BURN_ELEVATION_STATE* pElevationState,
__out BOOL* pfDisableUnelevate,
__out DWORD *pdwLoggingAttributes,
__out_z LPWSTR* psczLogFile,
__out_z LPWSTR* psczActiveParent,
__out_z LPWSTR* psczIgnoreDependencies,
__out_z LPWSTR* psczAncestors,
__out_z LPWSTR* psczSanitizedCommandLine
)
{
HRESULT hr = S_OK;
int argc = 0;
LPWSTR* argv = NULL;
BOOL fUnknownArg = FALSE;
BOOL fHidden = FALSE;
LPWSTR sczCommandLine = NULL;
LPWSTR sczSanitizedArgument = NULL;
LPWSTR sczVariableName = NULL;
if (wzCommandLine && *wzCommandLine)
{
// CommandLineToArgvW tries to treat the first argument as the path to the process,
// which fails pretty miserably if your first argument is something like
// FOO="C:\Program Files\My Company". So give it something harmless to play with.
hr = StrAllocConcat(&sczCommandLine, L"ignored ", 0);
ExitOnFailure(hr, "Failed to initialize command line.");
hr = StrAllocConcat(&sczCommandLine, wzCommandLine, 0);