aboutsummaryrefslogtreecommitdiff
path: root/src/burn/engine/externalengine.cpp
blob: 352d184cc7c2fe785ae9b6a30dde2cf31b2cbb12 (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
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
// 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 "precomp.h"


static HRESULT CopyStringToExternal(
    __in_z LPWSTR wzValue,
    __in_z_opt LPWSTR wzBuffer,
    __inout SIZE_T* pcchBuffer
    );
static HRESULT ProcessUnknownEmbeddedMessages(
    __in PIPE_MESSAGE* /*pMsg*/,
    __in_opt LPVOID /*pvContext*/,
    __out DWORD* pdwResult
    );
static HRESULT EnqueueAction(
    __in BAENGINE_CONTEXT* pEngineContext,
    __inout BAENGINE_ACTION** ppAction
    );

// function definitions

void ExternalEngineGetPackageCount(
    __in BURN_ENGINE_STATE* pEngineState,
    __out DWORD* pcPackages
    )
{
    *pcPackages = pEngineState->packages.cPackages;
}

HRESULT ExternalEngineGetVariableNumeric(
    __in BURN_ENGINE_STATE* pEngineState,
    __in_z LPCWSTR wzVariable,
    __out LONGLONG* pllValue
    )
{
    HRESULT hr = S_OK;

    if (wzVariable && *wzVariable)
    {
        hr = VariableGetNumeric(&pEngineState->variables, wzVariable, pllValue);
    }
    else
    {
        *pllValue = 0;
        hr = E_INVALIDARG;
    }

    return hr;
}

HRESULT ExternalEngineGetVariableString(
    __in BURN_ENGINE_STATE* pEngineState,
    __in_z LPCWSTR wzVariable,
    __out_ecount_opt(*pcchValue) LPWSTR wzValue,
    __inout SIZE_T* pcchValue
    )
{
    HRESULT hr = S_OK;
    LPWSTR sczValue = NULL;

    if (wzVariable && *wzVariable)
    {
        hr = VariableGetString(&pEngineState->variables, wzVariable, &sczValue);
        if (SUCCEEDED(hr))
        {
            hr = CopyStringToExternal(sczValue, wzValue, pcchValue);
        }
    }
    else
    {
        hr = E_INVALIDARG;
    }

    StrSecureZeroFreeString(sczValue);

    return hr;
}

HRESULT ExternalEngineGetVariableVersion(
    __in BURN_ENGINE_STATE* pEngineState,
    __in_z LPCWSTR wzVariable,
    __out_ecount_opt(*pcchValue) LPWSTR wzValue,
    __inout SIZE_T* pcchValue
    )
{
    HRESULT hr = S_OK;
    VERUTIL_VERSION* pVersion = NULL;

    if (wzVariable && *wzVariable)
    {
        hr = VariableGetVersion(&pEngineState->variables, wzVariable, &pVersion);
        if (SUCCEEDED(hr))
        {
            hr = CopyStringToExternal(pVersion->sczVersion, wzValue, pcchValue);
        }
    }
    else
    {
        hr = E_INVALIDARG;
    }

    ReleaseVerutilVersion(pVersion);

    return hr;
}

HRESULT ExternalEngineFormatString(
    __in BURN_ENGINE_STATE* pEngineState,
    __in_z LPCWSTR wzIn,
    __out_ecount_opt(*pcchOut) LPWSTR wzOut,
    __inout SIZE_T* pcchOut
    )
{
    HRESULT hr = S_OK;
    LPWSTR sczValue = NULL;

    if (wzIn && *wzIn)
    {
        hr = VariableFormatString(&pEngineState->variables, wzIn, &sczValue, NULL);
        if (SUCCEEDED(hr))
        {
            hr = CopyStringToExternal(sczValue, wzOut, pcchOut);
        }
    }
    else
    {
        hr = E_INVALIDARG;
    }

    StrSecureZeroFreeString(sczValue);

    return hr;
}

HRESULT ExternalEngineEscapeString(
    __in_z LPCWSTR wzIn,
    __out_ecount_opt(*pcchOut) LPWSTR wzOut,
    __inout SIZE_T* pcchOut
    )
{
    HRESULT hr = S_OK;
    LPWSTR sczValue = NULL;

    if (wzIn && *wzIn)
    {
        hr = VariableEscapeString(wzIn, &sczValue);
        if (SUCCEEDED(hr))
        {
            hr = CopyStringToExternal(sczValue, wzOut, pcchOut);
        }
    }
    else
    {
        hr = E_INVALIDARG;
    }

    StrSecureZeroFreeString(sczValue);

    return hr;
}

HRESULT ExternalEngineEvaluateCondition(
    __in BURN_ENGINE_STATE* pEngineState,
    __in_z LPCWSTR wzCondition,
    __out BOOL* pf
    )
{
    HRESULT hr = S_OK;

    if (wzCondition && *wzCondition)
    {
        hr = ConditionEvaluate(&pEngineState->variables, wzCondition, pf);
    }
    else
    {
        *pf = FALSE;
        hr = E_INVALIDARG;
    }

    return hr;
}

HRESULT ExternalEngineLog(
    __in REPORT_LEVEL rl,
    __in_z LPCWSTR wzMessage
    )
{
    HRESULT hr = S_OK;

    hr = LogStringLine(rl, "%ls", wzMessage);

    return hr;
}

HRESULT ExternalEngineSendEmbeddedError(
    __in BURN_ENGINE_STATE* pEngineState,
    __in const DWORD dwErrorCode,
    __in_z LPCWSTR wzMessage,
    __in const DWORD dwUIHint,
    __out int* pnResult
    )
{
    HRESULT hr = S_OK;
    BYTE* pbData = NULL;
    SIZE_T cbData = 0;
    DWORD dwResult = *pnResult = 0;

    if (BURN_MODE_EMBEDDED != pEngineState->internalCommand.mode)
    {
        hr = HRESULT_FROM_WIN32(ERROR_INVALID_STATE);
        ExitOnRootFailure(hr, "BA requested to send embedded message when not in embedded mode.");
    }

    hr = BuffWriteNumber(&pbData, &cbData, dwErrorCode);
    ExitOnFailure(hr, "Failed to write error code to message buffer.");

    hr = BuffWriteString(&pbData, &cbData, wzMessage ? wzMessage : L"");
    ExitOnFailure(hr, "Failed to write message string to message buffer.");

    hr = BuffWriteNumber(&pbData, &cbData, dwUIHint);
    ExitOnFailure(hr, "Failed to write UI hint to message buffer.");

    hr = BurnPipeSendMessage(pEngineState->embeddedConnection.hPipe, BURN_EMBEDDED_MESSAGE_TYPE_ERROR, pbData, cbData, ProcessUnknownEmbeddedMessages, NULL, &dwResult);
    ExitOnFailure(hr, "Failed to send embedded message over pipe.");

    *pnResult = static_cast<int>(dwResult);

LExit:
    ReleaseMem(pbData);

    return hr;
}

HRESULT ExternalEngineSendEmbeddedProgress(
    __in BURN_ENGINE_STATE* pEngineState,
    __in const DWORD dwProgressPercentage,
    __in const DWORD dwOverallProgressPercentage,
    __out int* pnResult
    )
{
    HRESULT hr = S_OK;
    BYTE* pbData = NULL;
    SIZE_T cbData = 0;
    DWORD dwResult = *pnResult = 0;

    if (BURN_MODE_EMBEDDED != pEngineState->internalCommand.mode)
    {
        hr = HRESULT_FROM_WIN32(ERROR_INVALID_STATE);
        ExitOnRootFailure(hr, "BA requested to send embedded progress message when not in embedded mode.");
    }

    hr = BuffWriteNumber(&pbData, &cbData, dwProgressPercentage);
    ExitOnFailure(hr, "Failed to write progress percentage to message buffer.");

    hr = BuffWriteNumber(&pbData, &cbData, dwOverallProgressPercentage);
    ExitOnFailure(hr, "Failed to write overall progress percentage to message buffer.");

    hr = BurnPipeSendMessage(pEngineState->embeddedConnection.hPipe, BURN_EMBEDDED_MESSAGE_TYPE_PROGRESS, pbData, cbData, ProcessUnknownEmbeddedMessages, NULL, &dwResult);
    ExitOnFailure(hr, "Failed to send embedded progress message over pipe.");

    *pnResult = static_cast<int>(dwResult);

LExit:
    ReleaseMem(pbData);

    return hr;
}

HRESULT ExternalEngineSetUpdate(
    __in BURN_ENGINE_STATE* pEngineState,
    __in_z_opt LPCWSTR wzLocalSource,
    __in_z_opt LPCWSTR wzDownloadSource,
    __in const DWORD64 qwSize,
    __in const BOOTSTRAPPER_UPDATE_HASH_TYPE hashType,
    __in_opt LPCWSTR wzHash,
    __in_z_opt LPCWSTR wzUpdatePackageId
    )
{
    HRESULT hr = S_OK;
    BOOL fLeaveCriticalSection = FALSE;
    LPWSTR sczFileRelativePath = NULL;
    LPWSTR sczCommandline = NULL;
    UUID guid = { };
    WCHAR wzCacheId[39];
    RPC_STATUS rs = RPC_S_OK;
    BOOL fRemove = (!wzLocalSource || !*wzLocalSource) && (!wzDownloadSource || !*wzDownloadSource);

    // Consider allowing the BA to pass this name in, like the UpdatePackageId can be passed in.
    LPCWSTR wzFileName = NULL;

    ::EnterCriticalSection(&pEngineState->userExperience.csEngineActive);
    fLeaveCriticalSection = TRUE;
    hr = BootstrapperApplicationEnsureEngineInactive(&pEngineState->userExperience);
    ExitOnFailure(hr, "Engine is active, cannot change engine state.");

    if (!fRemove)
    {
        if (BOOTSTRAPPER_UPDATE_HASH_TYPE_NONE == hashType && wzHash && *wzHash)
        {
            ExitFunction1(hr = E_INVALIDARG);
        }
        else if (BOOTSTRAPPER_UPDATE_HASH_TYPE_SHA512 == hashType && (!wzHash || !*wzHash || SHA512_HASH_LEN * 2 != lstrlenW(wzHash)))
        {
            ExitFunction1(hr = E_INVALIDARG);
        }
    }

    UpdateUninitialize(&pEngineState->update);

    if (fRemove)
    {
        ExitFunction();
    }

    hr = CoreCreateUpdateBundleCommandLine(&sczCommandline, &pEngineState->internalCommand, &pEngineState->command);
    ExitOnFailure(hr, "Failed to create command-line for update bundle.");

    // Always generate a new CacheId for a location to where we can download then cache the update bundle. This running
    // bundle will clean that cached location when it is done while the update bundle caches itself in its official cache
    // location during its execution.
    rs = ::UuidCreate(&guid);
    hr = HRESULT_FROM_RPC(rs);
    ExitOnFailure(hr, "Failed to create bundle update guid.");

    if (!::StringFromGUID2(guid, wzCacheId, countof(wzCacheId)))
    {
        hr = E_INSUFFICIENT_BUFFER;
        ExitOnRootFailure(hr, "Failed to convert bundle update guid into string.");
    }

    // If the update package id is not provided, use the cache id.
    if (!wzUpdatePackageId || !*wzUpdatePackageId)
    {
        wzUpdatePackageId = wzCacheId;
    }

    // If the file name is not provided, use the current bundle's name. Not a great option but it is the best we have.
    if (!wzFileName || !*wzFileName)
    {
        wzFileName = pEngineState->registration.sczExecutableName;
    }

    // Download the update bundle into a relative folder using the update package id. Ths is important because this running bundle is
    // in the root of one of search paths used in source resolution. Thus, if when wzFileName is the same as the running bundle, the
    // running bundle will be found first and the updated bundle will not actually be downloaded.
    hr = StrAllocFormatted(&sczFileRelativePath, L"%ls\\%ls", wzUpdatePackageId, wzFileName);
    ExitOnFailure(hr, "Failed to build bundle update file path.");

    if (!wzLocalSource || !*wzLocalSource)
    {
        wzLocalSource = sczFileRelativePath;
    }

    hr = PseudoBundleInitializeUpdateBundle(&pEngineState->update.package, wzUpdatePackageId, wzCacheId, sczFileRelativePath, wzLocalSource, wzDownloadSource, qwSize, sczCommandline, wzHash);
    ExitOnFailure(hr, "Failed to set update bundle.");

    pEngineState->update.fUpdateAvailable = TRUE;

LExit:
    if (fLeaveCriticalSection)
    {
        ::LeaveCriticalSection(&pEngineState->userExperience.csEngineActive);
    }

    ReleaseStr(sczCommandline);
    ReleaseStr(sczFileRelativePath);

    return hr;
}

HRESULT ExternalEngineSetLocalSource(
    __in BURN_ENGINE_STATE* pEngineState,
    __in_z_opt LPCWSTR wzPackageOrContainerId,
    __in_z_opt LPCWSTR wzPayloadId,
    __in_z LPCWSTR wzPath
    )
{
    HRESULT hr = S_OK;
    BURN_CONTAINER* pContainer = NULL;
    BURN_PAYLOAD* pPayload = NULL;

    ::EnterCriticalSection(&pEngineState->userExperience.csEngineActive);
    hr = BootstrapperApplicationEnsureEngineInactive(&pEngineState->userExperience);
    ExitOnFailure(hr, "Engine is active, cannot change engine state.");

    if (!wzPath || !*wzPath)
    {
        hr = E_INVALIDARG;
    }
    else if (wzPayloadId && *wzPayloadId)
    {
        hr = PayloadFindById(&pEngineState->payloads, wzPayloadId, &pPayload);
        ExitOnFailure(hr, "BA requested unknown payload with id: %ls", wzPayloadId);

        hr = StrAllocString(&pPayload->sczSourcePath, wzPath, 0);
        ExitOnFailure(hr, "Failed to set source path for payload.");
    }
    else if (wzPackageOrContainerId && *wzPackageOrContainerId)
    {
        hr = ContainerFindById(&pEngineState->containers, wzPackageOrContainerId, &pContainer);
        ExitOnFailure(hr, "BA requested unknown container with id: %ls", wzPackageOrContainerId);

        hr = StrAllocString(&pContainer->sczSourcePath, wzPath, 0);
        ExitOnFailure(hr, "Failed to set source path for container.");
    }
    else
    {
        hr = E_INVALIDARG;
    }

LExit:
    ::LeaveCriticalSection(&pEngineState->userExperience.csEngineActive);

    return hr;
}

HRESULT ExternalEngineSetDownloadSource(
    __in BURN_ENGINE_STATE* pEngineState,
    __in_z_opt LPCWSTR wzPackageOrContainerId,
    __in_z_opt LPCWSTR wzPayloadId,
    __in_z_opt LPCWSTR wzUrl,
    __in_z_opt LPCWSTR wzUser,
    __in_z_opt LPCWSTR wzPassword,
    __in_z_opt LPCWSTR wzAuthorizationHeader
    )
{
    HRESULT hr = S_OK;
    BURN_CONTAINER* pContainer = NULL;
    BURN_PAYLOAD* pPayload = NULL;
    DOWNLOAD_SOURCE* pDownloadSource = NULL;

    ::EnterCriticalSection(&pEngineState->userExperience.csEngineActive);
    hr = BootstrapperApplicationEnsureEngineInactive(&pEngineState->userExperience);
    ExitOnFailure(hr, "Engine is active, cannot change engine state.");

    if (wzPayloadId && *wzPayloadId)
    {
        hr = PayloadFindById(&pEngineState->payloads, wzPayloadId, &pPayload);
        ExitOnFailure(hr, "BA requested unknown payload with id: %ls", wzPayloadId);

        pDownloadSource = &pPayload->downloadSource;
    }
    else if (wzPackageOrContainerId && *wzPackageOrContainerId)
    {
        hr = ContainerFindById(&pEngineState->containers, wzPackageOrContainerId, &pContainer);
        ExitOnFailure(hr, "BA requested unknown container with id: %ls", wzPackageOrContainerId);

        pDownloadSource = &pContainer->downloadSource;
    }
    else
    {
        hr = E_INVALIDARG;
        ExitOnFailure(hr, "BA did not provide container or payload id.");
    }

    if (wzAuthorizationHeader && *wzAuthorizationHeader)
    {
        hr = StrAllocString(&pDownloadSource->sczAuthorizationHeader, wzAuthorizationHeader, 0);
        ExitOnFailure(hr, "Failed to set download authorization header.");

        // Authorization header means no user.
        ReleaseNullStr(pDownloadSource->sczUser);
        ReleaseNullStr(pDownloadSource->sczPassword);
    }
    else if (wzUrl && *wzUrl)
    {
        hr = StrAllocString(&pDownloadSource->sczUrl, wzUrl, 0);
        ExitOnFailure(hr, "Failed to set download URL.");

        if (wzUser && *wzUser)
        {
            hr = StrAllocString(&pDownloadSource->sczUser, wzUser, 0);
            ExitOnFailure(hr, "Failed to set download user.");

            if (wzPassword && *wzPassword)
            {
                hr = StrAllocString(&pDownloadSource->sczPassword, wzPassword, 0);
                ExitOnFailure(hr, "Failed to set download password.");
            }
            else // no password.
            {
                ReleaseNullStr(pDownloadSource->sczPassword);
            }

            // User means no authorization header.
            ReleaseNullStr(pDownloadSource->sczAuthorizationHeader);
        }
        else // no user means no password either.
        {
            ReleaseNullStr(pDownloadSource->sczUser);
            ReleaseNullStr(pDownloadSource->sczPassword);
        }
    }
    else // no URL provided means clear out the whole download source.
    {
        ReleaseNullStr(pDownloadSource->sczUrl);
        ReleaseNullStr(pDownloadSource->sczUser);
        ReleaseNullStr(pDownloadSource->sczPassword);
    }

LExit:
    ::LeaveCriticalSection(&pEngineState->userExperience.csEngineActive);

    return hr;
}

HRESULT ExternalEngineSetVariableNumeric(
    __in BURN_ENGINE_STATE* pEngineState,
    __in_z LPCWSTR wzVariable,
    __in const LONGLONG llValue
    )
{
    HRESULT hr = S_OK;

    if (wzVariable && *wzVariable)
    {
        hr = VariableSetNumeric(&pEngineState->variables, wzVariable, llValue, FALSE);
        ExitOnFailure(hr, "Failed to set numeric variable.");
    }
    else
    {
        hr = E_INVALIDARG;
        ExitOnFailure(hr, "SetVariableNumeric did not provide variable name.");
    }

LExit:
    return hr;
}

HRESULT ExternalEngineSetVariableString(
    __in BURN_ENGINE_STATE* pEngineState,
    __in_z LPCWSTR wzVariable,
    __in_z_opt LPCWSTR wzValue,
    __in const BOOL fFormatted
    )
{
    HRESULT hr = S_OK;

    if (wzVariable && *wzVariable)
    {
        hr = VariableSetString(&pEngineState->variables, wzVariable, wzValue, FALSE, fFormatted);
        ExitOnFailure(hr, "Failed to set string variable.");
    }
    else
    {
        hr = E_INVALIDARG;
        ExitOnFailure(hr, "SetVariableString did not provide variable name.");
    }

LExit:
    return hr;
}

HRESULT ExternalEngineSetVariableVersion(
    __in BURN_ENGINE_STATE* pEngineState,
    __in_z LPCWSTR wzVariable,
    __in_z_opt LPCWSTR wzValue
    )
{
    HRESULT hr = S_OK;
    VERUTIL_VERSION* pVersion = NULL;

    if (wzVariable && *wzVariable)
    {
        if (wzValue)
        {
            hr = VerParseVersion(wzValue, 0, FALSE, &pVersion);
            ExitOnFailure(hr, "Failed to parse new version value.");
        }

        hr = VariableSetVersion(&pEngineState->variables, wzVariable, pVersion, FALSE);
        ExitOnFailure(hr, "Failed to set version variable.");
    }
    else
    {
        hr = E_INVALIDARG;
        ExitOnFailure(hr, "SetVariableVersion did not provide variable name.");
    }

LExit:
    ReleaseVerutilVersion(pVersion);

    return hr;
}

void ExternalEngineCloseSplashScreen(
    __in BURN_ENGINE_STATE* pEngineState
    )
{
    // If the splash screen is still around, close it.
    if (::IsWindow(pEngineState->command.hwndSplashScreen))
    {
        ::PostMessageW(pEngineState->command.hwndSplashScreen, WM_CLOSE, 0, 0);
    }
}

HRESULT ExternalEngineCompareVersions(
    __in_z LPCWSTR wzVersion1,
    __in_z LPCWSTR wzVersion2,
    __out int* pnResult
    )
{
    HRESULT hr = S_OK;

    hr = VerCompareStringVersions(wzVersion1, wzVersion2, FALSE, pnResult);

    return hr;
}

HRESULT ExternalEngineDetect(
    __in BAENGINE_CONTEXT* pEngineContext,
    __in_opt const HWND hwndParent
    )
{
    HRESULT hr = S_OK;
    BAENGINE_ACTION* pAction = NULL;

    pAction = (BAENGINE_ACTION*)MemAlloc(sizeof(BAENGINE_ACTION), TRUE);
    ExitOnNull(pAction, hr, E_OUTOFMEMORY, "Failed to alloc BAENGINE_ACTION");

    pAction->dwMessage = WM_BURN_DETECT;
    pAction->detect.hwndParent = hwndParent;

    hr = EnqueueAction(pEngineContext, &pAction);
    ExitOnFailure(hr, "Failed to enqueue detect action.");

LExit:
    ReleaseMem(pAction);

    return hr;
}

HRESULT ExternalEnginePlan(
    __in BAENGINE_CONTEXT* pEngineContext,
    __in const BOOTSTRAPPER_ACTION action
    )
{
    HRESULT hr = S_OK;
    BAENGINE_ACTION* pAction = NULL;

    if (BOOTSTRAPPER_ACTION_LAYOUT > action || BOOTSTRAPPER_ACTION_UPDATE_REPLACE_EMBEDDED < action)
    {
        ExitOnRootFailure(hr = E_INVALIDARG, "BA passed invalid action to Plan: %u.", action);
    }

    pAction = (BAENGINE_ACTION*)MemAlloc(sizeof(BAENGINE_ACTION), TRUE);
    ExitOnNull(pAction, hr, E_OUTOFMEMORY, "Failed to alloc BAENGINE_ACTION");

    pAction->dwMessage = WM_BURN_PLAN;
    pAction->plan.action = action;

    hr = EnqueueAction(pEngineContext, &pAction);
    ExitOnFailure(hr, "Failed to enqueue plan action.");

LExit:
    ReleaseMem(pAction);

    return hr;
}

HRESULT ExternalEngineElevate(
    __in BAENGINE_CONTEXT* pEngineContext,
    __in_opt const HWND hwndParent
    )
{
    HRESULT hr = S_OK;
    BAENGINE_ACTION* pAction = NULL;

    if (INVALID_HANDLE_VALUE != pEngineContext->pEngineState->companionConnection.hPipe)
    {
        ExitFunction1(hr = HRESULT_FROM_WIN32(ERROR_ALREADY_INITIALIZED));
    }

    pAction = (BAENGINE_ACTION*)MemAlloc(sizeof(BAENGINE_ACTION), TRUE);
    ExitOnNull(pAction, hr, E_OUTOFMEMORY, "Failed to alloc BAENGINE_ACTION");

    pAction->dwMessage = WM_BURN_ELEVATE;
    pAction->elevate.hwndParent = hwndParent;

    hr = EnqueueAction(pEngineContext, &pAction);
    ExitOnFailure(hr, "Failed to enqueue elevate action.");

LExit:
    ReleaseMem(pAction);

    return hr;
}

HRESULT ExternalEngineApply(
    __in BAENGINE_CONTEXT* pEngineContext,
    __in_opt const HWND hwndParent
    )
{
    HRESULT hr = S_OK;
    BAENGINE_ACTION* pAction = NULL;

    ExitOnNull(hwndParent, hr, E_INVALIDARG, "BA passed NULL hwndParent to Apply.");
    if (!::IsWindow(hwndParent))
    {
        ExitOnRootFailure(hr = E_INVALIDARG, "BA passed invalid hwndParent to Apply.");
    }

    pAction = (BAENGINE_ACTION*)MemAlloc(sizeof(BAENGINE_ACTION), TRUE);
    ExitOnNull(pAction, hr, E_OUTOFMEMORY, "Failed to alloc BAENGINE_ACTION");

    pAction->dwMessage = WM_BURN_APPLY;
    pAction->apply.hwndParent = hwndParent;

    hr = EnqueueAction(pEngineContext, &pAction);
    ExitOnFailure(hr, "Failed to enqueue apply action.");

LExit:
    ReleaseMem(pAction);

    return hr;
}

HRESULT ExternalEngineQuit(
    __in BAENGINE_CONTEXT* pEngineContext,
    __in const DWORD dwExitCode
    )
{
    HRESULT hr = S_OK;
    BAENGINE_ACTION* pAction = NULL;

    pAction = (BAENGINE_ACTION*)MemAlloc(sizeof(BAENGINE_ACTION), TRUE);
    ExitOnNull(pAction, hr, E_OUTOFMEMORY, "Failed to alloc BAENGINE_ACTION");

    pAction->dwMessage = WM_BURN_QUIT;
    pAction->quit.dwExitCode = dwExitCode;

    hr = EnqueueAction(pEngineContext, &pAction);
    ExitOnFailure(hr, "Failed to enqueue shutdown action.");

LExit:
    ReleaseMem(pAction);

    return hr;
}

HRESULT ExternalEngineLaunchApprovedExe(
    __in BAENGINE_CONTEXT* pEngineContext,
    __in_opt const HWND hwndParent,
    __in_z LPCWSTR wzApprovedExeForElevationId,
    __in_z_opt LPCWSTR wzArguments,
    __in const DWORD dwWaitForInputIdleTimeout
    )
{
    HRESULT hr = S_OK;
    BURN_APPROVED_EXE* pApprovedExe = NULL;
    BURN_LAUNCH_APPROVED_EXE* pLaunchApprovedExe = NULL;
    BAENGINE_ACTION* pAction = NULL;

    if (!wzApprovedExeForElevationId || !*wzApprovedExeForElevationId)
    {
        ExitFunction1(hr = E_INVALIDARG);
    }

    hr = ApprovedExesFindById(&pEngineContext->pEngineState->approvedExes, wzApprovedExeForElevationId, &pApprovedExe);
    ExitOnFailure(hr, "BA requested unknown approved exe with id: %ls", wzApprovedExeForElevationId);

    pAction = (BAENGINE_ACTION*)MemAlloc(sizeof(BAENGINE_ACTION), TRUE);
    ExitOnNull(pAction, hr, E_OUTOFMEMORY, "Failed to alloc BAENGINE_ACTION");

    pAction->dwMessage = WM_BURN_LAUNCH_APPROVED_EXE;
    pLaunchApprovedExe = &pAction->launchApprovedExe;

    hr = StrAllocString(&pLaunchApprovedExe->sczId, wzApprovedExeForElevationId, NULL);
    ExitOnFailure(hr, "Failed to copy the id.");

    if (wzArguments)
    {
        hr = StrAllocString(&pLaunchApprovedExe->sczArguments, wzArguments, NULL);
        ExitOnFailure(hr, "Failed to copy the arguments.");
    }

    pLaunchApprovedExe->dwWaitForInputIdleTimeout = dwWaitForInputIdleTimeout;

    pLaunchApprovedExe->hwndParent = hwndParent;

    hr = EnqueueAction(pEngineContext, &pAction);
    ExitOnFailure(hr, "Failed to enqueue launch approved exe action.");

LExit:
    if (pAction)
    {
        BAEngineFreeAction(pAction);
    }

    return hr;
}

HRESULT ExternalEngineSetUpdateSource(
    __in BURN_ENGINE_STATE* pEngineState,
    __in_z LPCWSTR wzUrl,
    __in_z_opt LPCWSTR wzAuthorizationHeader
    )
{
    HRESULT hr = S_OK;
    BOOL fLeaveCriticalSection = FALSE;

    ::EnterCriticalSection(&pEngineState->userExperience.csEngineActive);
    fLeaveCriticalSection = TRUE;
    hr = BootstrapperApplicationEnsureEngineInactive(&pEngineState->userExperience);
    ExitOnFailure(hr, "Engine is active, cannot change engine state.");

    if (wzUrl && *wzUrl)
    {
        hr = StrAllocString(&pEngineState->update.sczUpdateSource, wzUrl, 0);
        ExitOnFailure(hr, "Failed to set feed download URL.");

        if (wzAuthorizationHeader && *wzAuthorizationHeader)
        {
            hr = StrAllocString(&pEngineState->update.sczAuthorizationHeader, wzAuthorizationHeader, 0);
            ExitOnFailure(hr, "Failed to set feed authorization header.");
        }
        else
        {
            ReleaseNullStr(pEngineState->update.sczAuthorizationHeader);
        }
    }
    else // no URL provided means clear out the whole download source.
    {
        ReleaseNullStr(pEngineState->update.sczAuthorizationHeader);
        ReleaseNullStr(pEngineState->update.sczUpdateSource);
    }

LExit:
    if (fLeaveCriticalSection)
    {
        ::LeaveCriticalSection(&pEngineState->userExperience.csEngineActive);
    }

    return hr;
}

HRESULT ExternalEngineGetRelatedBundleVariable(
    __in BURN_ENGINE_STATE* /*pEngineState*/,
    __in_z LPCWSTR wzBundleCode,
    __in_z LPCWSTR wzVariable,
    __out_ecount_opt(*pcchValue) LPWSTR wzValue,
    __inout SIZE_T* pcchValue
    )
{
    HRESULT hr = S_OK;
    LPWSTR sczValue = NULL;

    if (wzVariable && *wzVariable && pcchValue)
    {
        hr = BundleGetBundleVariable(wzBundleCode, wzVariable, &sczValue);
        if (SUCCEEDED(hr))
        {
            hr = CopyStringToExternal(sczValue, wzValue, pcchValue);
        }
    }
    else
    {
        hr = E_INVALIDARG;
    }

    StrSecureZeroFreeString(sczValue);

    return hr;
}

// TODO: callers need to provide the original size (at the time of first public release) of the struct instead of the current size.
HRESULT WINAPI ExternalEngineValidateMessageParameter(
    __in_opt const LPVOID pv,
    __in SIZE_T cbSizeOffset,
    __in DWORD dwMinimumSize
    )
{
    HRESULT hr = S_OK;

    if (!pv)
    {
        ExitFunction1(hr = E_INVALIDARG);
    }

    DWORD cbSize = *(DWORD*)((BYTE*)pv + cbSizeOffset);
    if (dwMinimumSize < cbSize)
    {
        ExitFunction1(hr = E_INVALIDARG);
    }

LExit:
    return hr;
}

static HRESULT CopyStringToExternal(
    __in_z LPWSTR wzValue,
    __in_z_opt LPWSTR wzBuffer,
    __inout SIZE_T* pcchBuffer
    )
{
    HRESULT hr = S_OK;
    BOOL fTooSmall = !wzBuffer;

    if (!fTooSmall)
    {
        hr = ::StringCchCopyExW(wzBuffer, *pcchBuffer, wzValue, NULL, NULL, STRSAFE_FILL_BEHIND_NULL);
        if (STRSAFE_E_INSUFFICIENT_BUFFER == hr)
        {
            fTooSmall = TRUE;
        }
    }

    if (fTooSmall)
    {
        hr = ::StringCchLengthW(wzValue, STRSAFE_MAX_LENGTH, reinterpret_cast<size_t*>(pcchBuffer));
        if (SUCCEEDED(hr))
        {
            hr = E_MOREDATA;
            *pcchBuffer += 1; // null terminator.
        }
    }

    return hr;
}

static HRESULT ProcessUnknownEmbeddedMessages(
    __in PIPE_MESSAGE* /*pMsg*/,
    __in_opt LPVOID /*pvContext*/,
    __out DWORD* pdwResult
    )
{
    *pdwResult = (DWORD)E_NOTIMPL;

    return S_OK;
}

static HRESULT EnqueueAction(
    __in BAENGINE_CONTEXT* pEngineContext,
    __inout BAENGINE_ACTION** ppAction
    )
{
    HRESULT hr = S_OK;

    ::EnterCriticalSection(&pEngineContext->csQueue);

    if (pEngineContext->pEngineState->fQuit)
    {
        LogId(REPORT_WARNING, MSG_IGNORE_OPERATION_AFTER_QUIT, LoggingBurnMessageToString((*ppAction)->dwMessage));
        hr = E_INVALIDSTATE;
    }
    else
    {
        hr = QueEnqueue(pEngineContext->hQueue, *ppAction);
    }

    ::LeaveCriticalSection(&pEngineContext->csQueue);

    ExitOnFailure(hr, "Failed to enqueue action.");

    *ppAction = NULL;

    if (!::ReleaseSemaphore(pEngineContext->hQueueSemaphore, 1, NULL))
    {
        ExitWithLastError(hr, "Failed to signal queue semaphore.");
    }

LExit:
    return hr;
}