aboutsummaryrefslogtreecommitdiff
path: root/src/api/burn/balutil/inc/IBootstrapperApplication.h
blob: 3f57f09568b719f024c63af6dfebb3d8bb44f154 (plain)
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
#pragma once
// Copyright (c) .NET Foundation and contributors. All rights reserved. Licensed under the Microsoft Reciprocal License. See LICENSE.TXT file in the project root for full license information.

#include <BootstrapperApplication.h>
#include <IBootstrapperEngine.h>

DECLARE_INTERFACE_IID_(IBootstrapperApplication, IUnknown, "53C31D56-49C0-426B-AB06-099D717C67FE")
{
    // BAProc - The PFN_BOOTSTRAPPER_APPLICATION_PROC can call this method to give the BA raw access to the callback from the engine.
    //          This might be used to help the BA support more than one version of the engine.
    STDMETHOD(BAProc)(
        __in BOOTSTRAPPER_APPLICATION_MESSAGE message,
        __in const LPVOID pvArgs,
        __inout LPVOID pvResults
        ) = 0;

    // BAProcFallback - The PFN_BOOTSTRAPPER_APPLICATION_PROC can call this method
    //                  to give the BA the ability to use default behavior
    //                  and then forward the message to extensions.
    STDMETHOD_(void, BAProcFallback)(
        __in BOOTSTRAPPER_APPLICATION_MESSAGE message,
        __in const LPVOID pvArgs,
        __inout LPVOID pvResults,
        __inout HRESULT* phr
        ) = 0;

    // OnCreate - called when the bootstrapper application is created.
    //
    virtual STDMETHODIMP OnCreate(
        __in IBootstrapperEngine* pEngine,
        __in BOOTSTRAPPER_COMMAND* pCommand
        ) = 0;

    // OnDestroy - called before the bootstrapper application stops.
    //
    STDMETHOD(OnDestroy)(
        __in BOOL fReload
    ) = 0;

    // OnStartup - called when the engine is ready for the bootstrapper application to start.
    //
    STDMETHOD(OnStartup)() = 0;

    // OnShutdown - called after the bootstrapper application quits the engine.
    STDMETHOD(OnShutdown)(
        __inout BOOTSTRAPPER_SHUTDOWN_ACTION* pAction
        ) = 0;

    // OnDetectBegin - called when the engine begins detection.
    STDMETHOD(OnDetectBegin)(
        __in BOOL fCached,
        __in BOOTSTRAPPER_REGISTRATION_TYPE registrationType,
        __in DWORD cPackages,
        __inout BOOL* pfCancel
        ) = 0;

    // OnDetectForwardCompatibleBundle - called when the engine detects a forward compatible bundle.
    STDMETHOD(OnDetectForwardCompatibleBundle)(
        __in_z LPCWSTR wzBundleId,
        __in BOOTSTRAPPER_RELATION_TYPE relationType,
        __in_z LPCWSTR wzBundleTag,
        __in BOOL fPerMachine,
        __in_z LPCWSTR wzVersion,
        __in BOOL fMissingFromCache,
        __inout BOOL* pfCancel
        ) = 0;

    // OnDetectUpdateBegin - called when the engine begins detection for bundle update.
    STDMETHOD(OnDetectUpdateBegin)(
        __in_z LPCWSTR wzUpdateLocation,
        __inout BOOL* pfCancel,
        __inout BOOL* pfSkip
        ) = 0;

    // OnDetectUpdate - called when the engine has an update candidate for bundle update.
    STDMETHOD(OnDetectUpdate)(
        __in_z_opt LPCWSTR wzUpdateLocation,
        __in DWORD64 dw64Size,
        __in_z_opt LPCWSTR wzHash,
        __in BOOTSTRAPPER_UPDATE_HASH_TYPE hashAlgorithm,
        __in_z LPCWSTR wzVersion,
        __in_z_opt LPCWSTR wzTitle,
        __in_z_opt LPCWSTR wzSummary,
        __in_z_opt LPCWSTR wzContentType,
        __in_z_opt LPCWSTR wzContent,
        __inout BOOL* pfCancel,
        __inout BOOL* pfStopProcessingUpdates
        ) = 0;

    // OnDetectUpdateComplete - called when the engine completes detection for bundle update.
    STDMETHOD(OnDetectUpdateComplete)(
        __in HRESULT hrStatus,
        __inout BOOL* pfIgnoreError
        ) = 0;

    // OnDetectRelatedBundle - called when the engine detects a related bundle.
    STDMETHOD(OnDetectRelatedBundle)(
        __in_z LPCWSTR wzBundleId,
        __in BOOTSTRAPPER_RELATION_TYPE relationType,
        __in_z LPCWSTR wzBundleTag,
        __in BOOL fPerMachine,
        __in_z LPCWSTR wzVersion,
        __in BOOL fMissingFromCache,
        __inout BOOL* pfCancel
        ) = 0;

    // OnDetectPackageBegin - called when the engine begins detecting a package.
    STDMETHOD(OnDetectPackageBegin)(
        __in_z LPCWSTR wzPackageId,
        __inout BOOL* pfCancel
        ) = 0;

    // OnDetectCompatibleMsiPackage - called when the engine detects that a package is not installed but a newer package using the same provider key is.
    STDMETHOD(OnDetectCompatibleMsiPackage)(
        __in_z LPCWSTR wzPackageId,
        __in_z LPCWSTR wzCompatiblePackageId,
        __in_z LPCWSTR wzCompatiblePackageVersion,
        __inout BOOL* pfCancel
        ) = 0;

    // OnDetectRelatedMsiPackage - called when the engine begins detects a related package.
    STDMETHOD(OnDetectRelatedMsiPackage)(
        __in_z LPCWSTR wzPackageId,
        __in_z LPCWSTR wzUpgradeCode,
        __in_z LPCWSTR wzProductCode,
        __in BOOL fPerMachine,
        __in_z LPCWSTR wzVersion,
        __in BOOTSTRAPPER_RELATED_OPERATION operation,
        __inout BOOL* pfCancel
        ) = 0;

    // OnDetectPatchTarget - called when the engine detects a target product
    //                       for an MSP package.
    STDMETHOD(OnDetectPatchTarget)(
        __in_z LPCWSTR wzPackageId,
        __in_z LPCWSTR wzProductCode,
        __in BOOTSTRAPPER_PACKAGE_STATE patchState,
        __inout BOOL* pfCancel
        ) = 0;

    // OnDetectMsiFeature - called when the engine detects a feature in an MSI package.
    STDMETHOD(OnDetectMsiFeature)(
        __in_z LPCWSTR wzPackageId,
        __in_z LPCWSTR wzFeatureId,
        __in BOOTSTRAPPER_FEATURE_STATE state,
        __inout BOOL* pfCancel
        ) = 0;

    // OnDetectPackageComplete - called after the engine detects a package.
    //
    STDMETHOD(OnDetectPackageComplete)(
        __in_z LPCWSTR wzPackageId,
        __in HRESULT hrStatus,
        __in BOOTSTRAPPER_PACKAGE_STATE state,
        __in BOOL fCached
        ) = 0;

    // OnDetectPackageComplete - called after the engine completes detection.
    //
    STDMETHOD(OnDetectComplete)(
        __in HRESULT hrStatus,
        __in BOOL fEligibleForCleanup
        ) = 0;

    // OnPlanBegin - called when the engine begins planning.
    STDMETHOD(OnPlanBegin)(
        __in DWORD cPackages,
        __inout BOOL* pfCancel
        ) = 0;

    // OnPlanRelatedBundle - called when the engine begins planning a related bundle.
    STDMETHOD(OnPlanRelatedBundle)(
        __in_z LPCWSTR wzBundleId,
        __in BOOTSTRAPPER_REQUEST_STATE recommendedState,
        __inout BOOTSTRAPPER_REQUEST_STATE* pRequestedState,
        __inout BOOL* pfCancel
        ) = 0;

    // OnPlanRollbackBoundary - called when the engine is planning a rollback boundary.
    STDMETHOD(OnPlanRollbackBoundary)(
        __in_z LPCWSTR wzRollbackBoundaryId,
        __in BOOL fRecommendedTransaction,
        __inout BOOL* pfTransaction,
        __inout BOOL* pfCancel
        ) = 0;

    // OnPlanPackageBegin - called when the engine has begun getting the BA's input
    //                      for planning a package.
    STDMETHOD(OnPlanPackageBegin)(
        __in_z LPCWSTR wzPackageId,
        __in BOOTSTRAPPER_PACKAGE_STATE state,
        __in BOOL fCached,
        __in BOOTSTRAPPER_PACKAGE_CONDITION_RESULT installCondition,
        __in BOOTSTRAPPER_PACKAGE_CONDITION_RESULT repairCondition,
        __in BOOTSTRAPPER_REQUEST_STATE recommendedState,
        __in BOOTSTRAPPER_CACHE_TYPE recommendedCacheType,
        __inout BOOTSTRAPPER_REQUEST_STATE* pRequestedState,
        __inout BOOTSTRAPPER_CACHE_TYPE* pRequestedCacheType,
        __inout BOOL* pfCancel
        ) = 0;

    // OnPlanCompatibleMsiPackageBegin - called when the engine plans a newer, compatible package using the same provider key.
    STDMETHOD(OnPlanCompatibleMsiPackageBegin)(
        __in_z LPCWSTR wzPackageId,
        __in_z LPCWSTR wzCompatiblePackageId,
        __in_z LPCWSTR wzCompatiblePackageVersion,
        __in BOOL fRecommendedRemove,
        __inout BOOL* pfRequestRemove,
        __inout BOOL* pfCancel
        ) = 0;

    // OnPlanCompatibleMsiPackageComplete - called after the engine plans the package.
    //
    STDMETHOD(OnPlanCompatibleMsiPackageComplete)(
        __in_z LPCWSTR wzPackageId,
        __in_z LPCWSTR wzCompatiblePackageId,
        __in HRESULT hrStatus,
        __in BOOL fRequestedRemove
        ) = 0;

    // OnPlanPatchTarget - called when the engine is about to plan a target
    //                     of an MSP package.
    STDMETHOD(OnPlanPatchTarget)(
        __in_z LPCWSTR wzPackageId,
        __in_z LPCWSTR wzProductCode,
        __in BOOTSTRAPPER_REQUEST_STATE recommendedState,
        __inout BOOTSTRAPPER_REQUEST_STATE* pRequestedState,
        __inout BOOL* pfCancel
        ) = 0;

    // OnPlanMsiFeature - called when the engine plans a feature in an
    //                    MSI package.
    STDMETHOD(OnPlanMsiFeature)(
        __in_z LPCWSTR wzPackageId,
        __in_z LPCWSTR wzFeatureId,
        __in BOOTSTRAPPER_FEATURE_STATE recommendedState,
        __inout BOOTSTRAPPER_FEATURE_STATE* pRequestedState,
        __inout BOOL* pfCancel
        ) = 0;

    // OnPlanMsiPackage - called when the engine plans an MSI or MSP package.
    //
    STDMETHOD(OnPlanMsiPackage)(
        __in_z LPCWSTR wzPackageId,
        __in BOOL fExecute, // false means rollback.
        __in BOOTSTRAPPER_ACTION_STATE action,
        __in BOOTSTRAPPER_MSI_FILE_VERSIONING recommendedFileVersioning,
        __inout BOOL* pfCancel,
        __inout BURN_MSI_PROPERTY* pActionMsiProperty,
        __inout INSTALLUILEVEL* pUiLevel,
        __inout BOOL* pfDisableExternalUiHandler,
        __inout BOOTSTRAPPER_MSI_FILE_VERSIONING* pFileVersioning
        ) = 0;

    // OnPlanPackageComplete - called after the engine has completed getting the BA's input
    //                         for planning a package.
    STDMETHOD(OnPlanPackageComplete)(
        __in_z LPCWSTR wzPackageId,
        __in HRESULT hrStatus,
        __in BOOTSTRAPPER_REQUEST_STATE requested
        ) = 0;

    // OnPlannedCompatiblePackage - called after the engine has completed planning a compatible package.
    STDMETHOD(OnPlannedCompatiblePackage)(
        __in_z LPCWSTR wzPackageId,
        __in_z LPCWSTR wzCompatiblePackageId,
        __in BOOL fRemove
        ) = 0;

    // OnPlannedPackage - called after the engine has completed planning a package.
    STDMETHOD(OnPlannedPackage)(
        __in_z LPCWSTR wzPackageId,
        __in BOOTSTRAPPER_ACTION_STATE execute,
        __in BOOTSTRAPPER_ACTION_STATE rollback,
        __in BOOL fPlannedCache,
        __in BOOL fPlannedUncache
        ) = 0;

    // OnPlanComplete - called when the engine completes planning.
    //
    STDMETHOD(OnPlanComplete)(
        __in HRESULT hrStatus
        ) = 0;

    // OnApplyBegin - called when the engine begins applying the plan.
    //
    STDMETHOD(OnApplyBegin)(
        __in DWORD dwPhaseCount,
        __inout BOOL* pfCancel
        ) = 0;

    // OnElevateBegin - called before the engine displays an elevation prompt.
    //                  Will only happen once per execution of the engine,
    //                  assuming the elevation was successful.
    STDMETHOD(OnElevateBegin)(
        __inout BOOL* pfCancel
        ) = 0;

    // OnElevateComplete - called after the engine attempted to elevate.
    //
    STDMETHOD(OnElevateComplete)(
        __in HRESULT hrStatus
        ) = 0;

    // OnProgress - called when the engine makes progress.
    //
    STDMETHOD(OnProgress)(
        __in DWORD dwProgressPercentage,
        __in DWORD dwOverallPercentage,
        __inout BOOL* pfCancel
        ) = 0;

    // OnError - called when the engine encounters an error.
    //
    // nResult:
    //  uiFlags is a combination of valid ID* return values appropriate for
    //          the error.
    //
    //  IDNOACTION instructs the engine to pass the error through to default
    //             handling which usually results in the apply failing.
    STDMETHOD(OnError)(
        __in BOOTSTRAPPER_ERROR_TYPE errorType,
        __in_z_opt LPCWSTR wzPackageId,
        __in DWORD dwCode,
        __in_z_opt LPCWSTR wzError,
        __in DWORD dwUIHint,
        __in DWORD cData,
        __in_ecount_z_opt(cData) LPCWSTR* rgwzData,
        __in int nRecommendation,
        __inout int* pResult
        ) = 0;

    // OnRegisterBegin - called when the engine registers the bundle.
    //
    STDMETHOD(OnRegisterBegin)(
        __in BOOTSTRAPPER_REGISTRATION_TYPE recommendedRegistrationType,
        __inout BOOL* pfCancel,
        __inout BOOTSTRAPPER_REGISTRATION_TYPE* pRegistrationType
        ) = 0;

    // OnRegisterComplete - called when the engine registration is
    //                      complete.
    //
    STDMETHOD(OnRegisterComplete)(
        __in HRESULT hrStatus
        ) = 0;

    // OnCacheBegin - called when the engine begins caching.
    //
    STDMETHOD(OnCacheBegin)(
        __inout BOOL* pfCancel
        ) = 0;

    // OnCachePackageBegin - called when the engine begins caching
    //                       a package.
    //
    STDMETHOD(OnCachePackageBegin)(
        __in_z LPCWSTR wzPackageId,
        __in DWORD cCachePayloads,
        __in DWORD64 dw64PackageCacheSize,
        __in BOOL fVital,
        __inout BOOL* pfCancel
        )  = 0;

    // OnCacheAcquireBegin - called when the engine begins acquiring a payload or container.
    //
    // Notes:
    //  It is expected the BA may call IBootstrapperEngine::SetLocalSource() or IBootstrapperEngine::SetDownloadSource()
    //  to update the source location before returning.
    //
    STDMETHOD(OnCacheAcquireBegin)(
        __in_z_opt LPCWSTR wzPackageOrContainerId,
        __in_z_opt LPCWSTR wzPayloadId,
        __in_z LPCWSTR wzSource,
        __in_z_opt LPCWSTR wzDownloadUrl,
        __in_z_opt LPCWSTR wzPayloadContainerId,
        __in BOOTSTRAPPER_CACHE_OPERATION recommendation,
        __inout BOOTSTRAPPER_CACHE_OPERATION* pAction,
        __inout BOOL* pfCancel
        ) = 0;

    // OnCacheAcquireProgress - called when the engine makes progress acquiring the payload or container.
    //
    STDMETHOD(OnCacheAcquireProgress)(
        __in_z_opt LPCWSTR wzPackageOrContainerId,
        __in_z_opt LPCWSTR wzPayloadId,
        __in DWORD64 dw64Progress,
        __in DWORD64 dw64Total,
        __in DWORD dwOverallPercentage,
        __inout BOOL* pfCancel
        ) = 0;

    // OnCacheAcquireResolving - called to allow the BA to override the acquisition action for the payload or container.
    //
    // Parameters:
    //  wzPackageOrContainerId will be NULL when resolving a layout-only payload.
    //  wzPayloadId will be NULL when resolving a container.
    //  wzDownloadUrl will be NULL if the container or payload does not provide a DownloadURL.
    //  wzPayloadContainerId will not be NULL if acquiring a payload that is in a container.
    //
    //  rgSearchPaths are the search paths used for source resolution.
    //  fFoundLocal is TRUE when dwRecommendedSearchPath indicates that the file was found.
    //  dwRecommendedSearchPath is the index into rgSearchPaths for the recommended local file.
    //
    STDMETHOD(OnCacheAcquireResolving)(
        __in_z_opt LPCWSTR wzPackageOrContainerId,
        __in_z_opt LPCWSTR wzPayloadId,
        __in_z LPCWSTR* rgSearchPaths,
        __in DWORD cSearchPaths,
        __in BOOL fFoundLocal,
        __in DWORD dwRecommendedSearchPath,
        __in_z_opt LPCWSTR wzDownloadUrl,
        __in_z_opt LPCWSTR wzPayloadContainerId,
        __in BOOTSTRAPPER_CACHE_RESOLVE_OPERATION recommendation,
        __inout DWORD* pdwChosenSearchPath,
        __inout BOOTSTRAPPER_CACHE_RESOLVE_OPERATION* pAction,
        __inout BOOL* pfCancel
        ) = 0;

    // OnCacheAcquireComplete - called after the engine acquired the payload or container.
    //
    // Notes:
    //  It is expected the BA may call IBootstrapperEngine::SetLocalSource() or IBootstrapperEngine::SetDownloadSource()
    //  to update the source location before returning BOOTSTRAPPER_CACHEACQUIRECOMPLETE_ACTION_RETRY.
    //
    STDMETHOD(OnCacheAcquireComplete)(
        __in_z_opt LPCWSTR wzPackageOrContainerId,
        __in_z_opt LPCWSTR wzPayloadId,
        __in HRESULT hrStatus,
        __in BOOTSTRAPPER_CACHEACQUIRECOMPLETE_ACTION recommendation,
        __inout BOOTSTRAPPER_CACHEACQUIRECOMPLETE_ACTION* pAction
        ) = 0;

    // OnCacheVerifyBegin - called when the engine begins to verify then copy
    //                      a payload or container to the package cache folder.
    //
    STDMETHOD(OnCacheVerifyBegin)(
        __in_z_opt LPCWSTR wzPackageOrContainerId,
        __in_z_opt LPCWSTR wzPayloadId,
        __inout BOOL* pfCancel
        ) = 0;

    STDMETHOD(OnCacheVerifyProgress)(
        __in_z_opt LPCWSTR wzPackageOrContainerId,
        __in_z_opt LPCWSTR wzPayloadId,
        __in DWORD64 dw64Progress,
        __in DWORD64 dw64Total,
        __in DWORD dwOverallPercentage,
        __in BOOTSTRAPPER_CACHE_VERIFY_STEP verifyStep,
        __inout BOOL* pfCancel
        ) = 0;

    // OnCacheVerifyComplete - called after the engine verifies and copies
    //                         a payload or container to the package cache folder.
    //
    STDMETHOD(OnCacheVerifyComplete)(
        __in_z_opt LPCWSTR wzPackageOrContainerId,
        __in_z_opt LPCWSTR wzPayloadId,
        __in HRESULT hrStatus,
        __in BOOTSTRAPPER_CACHEVERIFYCOMPLETE_ACTION recommendation,
        __inout BOOTSTRAPPER_CACHEVERIFYCOMPLETE_ACTION* pAction
        ) = 0;

    // OnCachePackageComplete - called after the engine attempts to copy or download all
    //                          payloads of a package into the package cache folder.
    //
    STDMETHOD(OnCachePackageComplete)(
        __in_z LPCWSTR wzPackageId,
        __in HRESULT hrStatus,
        __in BOOTSTRAPPER_CACHEPACKAGECOMPLETE_ACTION recommendation,
        __inout BOOTSTRAPPER_CACHEPACKAGECOMPLETE_ACTION* pAction
        )  = 0;

    // OnCacheComplete - called when the engine caching is complete.
    //
    STDMETHOD(OnCacheComplete)(
        __in HRESULT hrStatus
        ) = 0;

    // OnExecuteBegin - called when the engine begins executing the plan.
    //
    STDMETHOD(OnExecuteBegin)(
        __in DWORD cExecutingPackages,
        __inout BOOL* pfCancel
        ) = 0;

    // OnExecutePackageBegin - called when the engine begins executing a package.
    //
    STDMETHOD(OnExecutePackageBegin)(
        __in_z LPCWSTR wzPackageId,
        __in BOOL fExecute, // false means rollback.
        __in BOOTSTRAPPER_ACTION_STATE action,
        __in INSTALLUILEVEL uiLevel,
        __in BOOL fDisableExternalUiHandler,
        __inout BOOL* pfCancel
        ) = 0;

    // OnExecutePatchTarget - called for each patch in an MspPackage targeting the product
    //                        when the engine begins executing the MspPackage.
    //
    STDMETHOD(OnExecutePatchTarget)(
        __in_z LPCWSTR wzPackageId,
        __in_z LPCWSTR wzTargetProductCode,
        __inout BOOL* pfCancel
        ) = 0;

    // OnExecuteProgress - called when the engine makes progress executing a package.
    //
    STDMETHOD(OnExecuteProgress)(
        __in_z LPCWSTR wzPackageId,
        __in DWORD dwProgressPercentage,
        __in DWORD dwOverallPercentage,
        __inout BOOL* pfCancel
        ) = 0;

    // OnExecuteMsiMessage - called when the engine receives an MSI package message.
    //
    // Return:
    //  uiFlags is a combination of valid ID* return values appropriate for
    //          the message.
    //
    //  IDNOACTION instructs the engine to pass the message through to default
    //             handling which usually results in the execution continuing.
    STDMETHOD(OnExecuteMsiMessage)(
        __in_z LPCWSTR wzPackageId,
        __in INSTALLMESSAGE messageType,
        __in DWORD dwUIHint,
        __in_z LPCWSTR wzMessage,
        __in DWORD cData,
        __in_ecount_z_opt(cData) LPCWSTR* rgwzData,
        __in int nRecommendation,
        __inout int* pResult
        ) = 0;

    // OnExecuteFilesInUse - called when the engine receives a files in use message
    //                       while executing a package.
    //
    // Return value depends on the source:
    //  BOOTSTRAPPER_FILES_IN_USE_TYPE_MSI: https://docs.microsoft.com/en-us/windows/win32/msi/installvalidate-action
    //  BOOTSTRAPPER_FILES_IN_USE_TYPE_MSI_RM: https://docs.microsoft.com/en-us/windows/win32/msi/using-restart-manager-with-an-external-ui-
    //  BOOTSTRAPPER_FILES_IN_USE_TYPE_NETFX: https://docs.microsoft.com/en-us/dotnet/framework/deployment/how-to-get-progress-from-the-dotnet-installer
    STDMETHOD(OnExecuteFilesInUse)(
        __in_z LPCWSTR wzPackageId,
        __in DWORD cFiles,
        __in_ecount_z(cFiles) LPCWSTR* rgwzFiles,
        __in int nRecommendation,
        __in BOOTSTRAPPER_FILES_IN_USE_TYPE source,
        __inout int* pResult
        ) = 0;

    // OnExecutePackageComplete - called when a package execution is complete.
    //
    STDMETHOD(OnExecutePackageComplete)(
        __in_z LPCWSTR wzPackageId,
        __in HRESULT hrStatus,
        __in BOOTSTRAPPER_APPLY_RESTART restart,
        __in BOOTSTRAPPER_EXECUTEPACKAGECOMPLETE_ACTION recommendation,
        __inout BOOTSTRAPPER_EXECUTEPACKAGECOMPLETE_ACTION* pAction
        ) = 0;

    // OnExecuteComplete - called when the engine execution is complete.
    //
    STDMETHOD(OnExecuteComplete)(
        __in HRESULT hrStatus
        ) = 0;

    // OnUnregisterBegin - called when the engine unregisters the bundle.
    //
    STDMETHOD(OnUnregisterBegin)(
        __in BOOTSTRAPPER_REGISTRATION_TYPE recommendedRegistrationType,
        __inout BOOTSTRAPPER_REGISTRATION_TYPE* pRegistrationType
        ) = 0;

    // OnUnregisterComplete - called when the engine unregistration is complete.
    //
    STDMETHOD(OnUnregisterComplete)(
        __in HRESULT hrStatus
        ) = 0;

    // OnApplyComplete - called after the plan has been applied.
    //
    STDMETHOD(OnApplyComplete)(
        __in HRESULT hrStatus,
        __in BOOTSTRAPPER_APPLY_RESTART restart,
        __in BOOTSTRAPPER_APPLYCOMPLETE_ACTION recommendation,
        __inout BOOTSTRAPPER_APPLYCOMPLETE_ACTION* pAction
        ) = 0;

    // OnLaunchApprovedExeBegin - called before trying to launch the preapproved executable.
    //
    STDMETHOD(OnLaunchApprovedExeBegin)(
        __inout BOOL* pfCancel
        ) = 0;

    // OnLaunchApprovedExeComplete - called after trying to launch the preapproved executable.
    //
    STDMETHOD(OnLaunchApprovedExeComplete)(
        __in HRESULT hrStatus,
        __in DWORD dwProcessId
        ) = 0;

    STDMETHOD(OnBeginMsiTransactionBegin)(
        __in_z LPCWSTR wzTransactionId,
        __inout BOOL* pfCancel
        ) = 0;

    STDMETHOD(OnBeginMsiTransactionComplete)(
        __in_z LPCWSTR wzTransactionId,
        __in HRESULT hrStatus
        ) = 0;

    STDMETHOD(OnCommitMsiTransactionBegin)(
        __in_z LPCWSTR wzTransactionId,
        __inout BOOL* pfCancel
        ) = 0;

    STDMETHOD(OnCommitMsiTransactionComplete)(
        __in_z LPCWSTR wzTransactionId,
        __in HRESULT hrStatus,
        __in BOOTSTRAPPER_APPLY_RESTART restart,
        __in BOOTSTRAPPER_EXECUTEMSITRANSACTIONCOMPLETE_ACTION recommendation,
        __inout BOOTSTRAPPER_EXECUTEMSITRANSACTIONCOMPLETE_ACTION* pAction
        ) = 0;

    STDMETHOD(OnRollbackMsiTransactionBegin)(
        __in_z LPCWSTR wzTransactionId
        ) = 0;

    STDMETHOD(OnRollbackMsiTransactionComplete)(
        __in_z LPCWSTR wzTransactionId,
        __in HRESULT hrStatus,
        __in BOOTSTRAPPER_APPLY_RESTART restart,
        __in BOOTSTRAPPER_EXECUTEMSITRANSACTIONCOMPLETE_ACTION recommendation,
        __inout BOOTSTRAPPER_EXECUTEMSITRANSACTIONCOMPLETE_ACTION* pAction
        ) = 0;

    STDMETHOD(OnPauseAutomaticUpdatesBegin)(
        ) = 0;

    STDMETHOD(OnPauseAutomaticUpdatesComplete)(
        __in HRESULT hrStatus
        ) = 0;

    STDMETHOD(OnSystemRestorePointBegin)(
        ) = 0;

    STDMETHOD(OnSystemRestorePointComplete)(
        __in HRESULT hrStatus
        ) = 0;

    STDMETHOD(OnPlanForwardCompatibleBundle)(
        __in_z LPCWSTR wzBundleId,
        __in BOOTSTRAPPER_RELATION_TYPE relationType,
        __in_z LPCWSTR wzBundleTag,
        __in BOOL fPerMachine,
        __in_z LPCWSTR wzVersion,
        __in BOOL fRecommendedIgnoreBundle,
        __inout BOOL* pfCancel,
        __inout BOOL* pfIgnoreBundle
        ) = 0;

    STDMETHOD(OnCacheContainerOrPayloadVerifyBegin)(
        __in_z_opt LPCWSTR wzPackageOrContainerId,
        __in_z_opt LPCWSTR wzPayloadId,
        __inout BOOL* pfCancel
        ) = 0;

    STDMETHOD(OnCacheContainerOrPayloadVerifyProgress)(
        __in_z_opt LPCWSTR wzPackageOrContainerId,
        __in_z_opt LPCWSTR wzPayloadId,
        __in DWORD64 dw64Progress,
        __in DWORD64 dw64Total,
        __in DWORD dwOverallPercentage,
        __inout BOOL* pfCancel
        ) = 0;

    STDMETHOD(OnCacheContainerOrPayloadVerifyComplete)(
        __in_z_opt LPCWSTR wzPackageOrContainerId,
        __in_z_opt LPCWSTR wzPayloadId,
        __in HRESULT hrStatus
        ) = 0;

    STDMETHOD(OnCachePayloadExtractBegin)(
        __in_z_opt LPCWSTR wzContainerId,
        __in_z_opt LPCWSTR wzPayloadId,
        __inout BOOL* pfCancel
        ) = 0;

    STDMETHOD(OnCachePayloadExtractProgress)(
        __in_z_opt LPCWSTR wzContainerId,
        __in_z_opt LPCWSTR wzPayloadId,
        __in DWORD64 dw64Progress,
        __in DWORD64 dw64Total,
        __in DWORD dwOverallPercentage,
        __inout BOOL* pfCancel
        ) = 0;

    STDMETHOD(OnCachePayloadExtractComplete)(
        __in_z_opt LPCWSTR wzContainerId,
        __in_z_opt LPCWSTR wzPayloadId,
        __in HRESULT hrStatus
        ) = 0;

    // OnPlanRestoreRelatedBundle - called when the engine begins planning an upgrade related bundle for restoring in case of failure.
    STDMETHOD(OnPlanRestoreRelatedBundle)(
        __in_z LPCWSTR wzBundleId,
        __in BOOTSTRAPPER_REQUEST_STATE recommendedState,
        __inout BOOTSTRAPPER_REQUEST_STATE* pRequestedState,
        __inout BOOL* pfCancel
        ) = 0;

    // OnPlanRelatedBundleType - called when the engine begins planning the related bundle relation type.
    STDMETHOD(OnPlanRelatedBundleType)(
        __in_z LPCWSTR wzBundleId,
        __in BOOTSTRAPPER_RELATED_BUNDLE_PLAN_TYPE recommendedType,
        __inout BOOTSTRAPPER_RELATED_BUNDLE_PLAN_TYPE* pRequestedType,
        __inout BOOL* pfCancel
        ) = 0;

    // OnApplyDowngrade - called when the plan determined that nothing should happen to prevent downgrading.
    //
    STDMETHOD(OnApplyDowngrade)(
        __in HRESULT hrRecommended,
        __inout HRESULT* phrStatus
        ) = 0;

    // OnExecuteProcessCancel - called when a package that spawned a process is cancelled.
    //
    STDMETHOD(OnExecuteProcessCancel)(
        __in_z LPCWSTR wzPackageId,
        __in DWORD dwProcessId,
        __in BOOTSTRAPPER_EXECUTEPROCESSCANCEL_ACTION recommendation,
        __inout BOOTSTRAPPER_EXECUTEPROCESSCANCEL_ACTION* pAction
        ) = 0;

    // OnDetectRelatedBundlePackage - called when the engine detects a related bundle for a BundlePackage.
    STDMETHOD(OnDetectRelatedBundlePackage)(
        __in_z LPCWSTR wzPackageId,
        __in_z LPCWSTR wzBundleId,
        __in BOOTSTRAPPER_RELATION_TYPE relationType,
        __in BOOL fPerMachine,
        __in_z LPCWSTR wzVersion,
        __inout BOOL* pfCancel
        ) = 0;

    // OnCachePackageNonVitalValidationFailure - called when the engine failed validating a package in the package cache that is non-vital to execution.
    STDMETHOD(OnCachePackageNonVitalValidationFailure)(
        __in_z LPCWSTR wzPackageId,
        __in HRESULT hrStatus,
        __in BOOTSTRAPPER_CACHEPACKAGENONVITALVALIDATIONFAILURE_ACTION recommendation,
        __inout BOOTSTRAPPER_CACHEPACKAGENONVITALVALIDATIONFAILURE_ACTION* pAction
        ) = 0;
};