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
|
#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.
#define BURN_CACHE_MAX_SEARCH_PATHS 7
#ifdef __cplusplus
extern "C" {
#endif
enum BURN_CACHE_MESSAGE_TYPE
{
BURN_CACHE_MESSAGE_BEGIN,
BURN_CACHE_MESSAGE_SUCCESS,
BURN_CACHE_MESSAGE_COMPLETE,
BURN_CACHE_MESSAGE_FAILURE,
};
enum BURN_CACHE_STEP
{
BURN_CACHE_STEP_HASH_TO_SKIP_ACQUIRE,
BURN_CACHE_STEP_HASH_TO_SKIP_VERIFY,
BURN_CACHE_STEP_STAGE,
BURN_CACHE_STEP_HASH,
BURN_CACHE_STEP_FINALIZE,
};
typedef struct _BURN_CACHE
{
BOOL fInitializedCache;
BOOL fPerMachineCacheRootVerified;
BOOL fOriginalPerMachineCacheRootVerified;
BOOL fUnverifiedCacheFolderCreated;
BOOL fCustomMachinePackageCache;
LPWSTR sczDefaultUserPackageCache;
LPWSTR sczDefaultMachinePackageCache;
LPWSTR sczCurrentMachinePackageCache;
WCHAR wzGuid[GUID_STRING_LENGTH + 1];
LPWSTR* rgsczPotentialBaseWorkingFolders;
DWORD cPotentialBaseWorkingFolders;
// Only valid after CacheInitializeSources
BOOL fInitializedCacheSources;
BOOL fRunningFromCache;
LPWSTR sczSourceProcessFolder;
LPWSTR sczAcquisitionFolder;
// Only valid after CacheEnsureBaseWorkingFolder
BOOL fInitializedBaseWorkingFolder;
LPWSTR sczBaseWorkingFolder;
} BURN_CACHE;
typedef struct _BURN_CACHE_MESSAGE
{
BURN_CACHE_MESSAGE_TYPE type;
union
{
struct
{
BURN_CACHE_STEP cacheStep;
} begin;
struct
{
DWORD64 qwFileSize;
} success;
struct
{
HRESULT hrStatus;
} complete;
struct
{
BURN_CACHE_STEP cacheStep;
} failure;
};
} BURN_CACHE_MESSAGE;
typedef HRESULT(CALLBACK* PFN_BURNCACHEMESSAGEHANDLER)(
__in BURN_CACHE_MESSAGE* pMessage,
__in LPVOID pvContext
);
// functions
HRESULT CacheInitialize(
__in BURN_CACHE* pCache,
__in BURN_ENGINE_COMMAND* pInternalCommand
);
HRESULT CacheInitializeSources(
__in BURN_CACHE* pCache,
__in BURN_REGISTRATION* pRegistration,
__in BURN_VARIABLES* pVariables,
__in BURN_ENGINE_COMMAND* pInternalCommand
);
HRESULT CacheEnsureAcquisitionFolder(
__in BURN_CACHE* pCache
);
HRESULT CacheEnsureBaseWorkingFolder(
__in BURN_CACHE* pCache,
__deref_out_z_opt LPWSTR* psczBaseWorkingFolder
);
HRESULT CacheCalculateBundleWorkingPath(
__in BURN_CACHE* pCache,
__in LPCWSTR wzExecutableName,
__deref_out_z LPWSTR* psczWorkingPath
);
HRESULT CacheCalculateBundleLayoutWorkingPath(
__in BURN_CACHE* pCache,
__in_z LPCWSTR wzBundleId,
__deref_out_z LPWSTR* psczWorkingPath
);
HRESULT CacheCalculatePayloadWorkingPath(
__in BURN_CACHE* pCache,
__in BURN_PAYLOAD* pPayload,
__deref_out_z LPWSTR* psczWorkingPath
);
HRESULT CacheCalculateContainerWorkingPath(
__in BURN_CACHE* pCache,
__in BURN_CONTAINER* pContainer,
__deref_out_z LPWSTR* psczWorkingPath
);
HRESULT CacheGetPerMachineRootCompletedPath(
__in BURN_CACHE* pCache,
__out_z LPWSTR* psczCurrentRootCompletedPath,
__out_z LPWSTR* psczDefaultRootCompletedPath
);
HRESULT CacheGetCompletedPath(
__in BURN_CACHE* pCache,
__in BOOL fPerMachine,
__in_z LPCWSTR wzCacheId,
__deref_out_z LPWSTR* psczCompletedPath
);
HRESULT CacheGetResumePath(
__in_z LPCWSTR wzPayloadWorkingPath,
__deref_out_z LPWSTR* psczResumePath
);
HRESULT CacheGetLocalSourcePaths(
__in_z LPCWSTR wzRelativePath,
__in_z LPCWSTR wzSourcePath,
__in_z LPCWSTR wzDestinationPath,
__in_z_opt LPCWSTR wzLayoutDirectory,
__in BURN_CACHE* pCache,
__in BURN_VARIABLES* pVariables,
__inout LPWSTR** prgSearchPaths,
__out DWORD* pcSearchPaths,
__out DWORD* pdwLikelySearchPath,
__out DWORD* pdwDestinationSearchPath
);
HRESULT CacheSetLastUsedSource(
__in BURN_VARIABLES* pVariables,
__in_z LPCWSTR wzSourcePath,
__in_z LPCWSTR wzRelativePath
);
HRESULT CacheSendProgressCallback(
__in DOWNLOAD_CACHE_CALLBACK* pCallback,
__in DWORD64 dw64Progress,
__in DWORD64 dw64Total,
__in HANDLE hDestinationFile
);
void CacheSendErrorCallback(
__in DOWNLOAD_CACHE_CALLBACK* pCallback,
__in HRESULT hrError,
__in_z_opt LPCWSTR wzError,
__out_opt BOOL* pfRetry
);
BOOL CacheBundleRunningFromCache(
__in BURN_CACHE* pCache
);
HRESULT CachePreparePackage(
__in BURN_CACHE* pCache,
__in BURN_PACKAGE* pPackage
);
HRESULT CacheBundleToCleanRoom(
__in BURN_CACHE* pCache,
__in BURN_SECTION* pSection,
__deref_out_z_opt LPWSTR* psczCleanRoomBundlePath
);
HRESULT CacheBundleToWorkingDirectory(
__in BURN_CACHE* pCache,
__in_z LPCWSTR wzExecutableName,
__in BURN_SECTION* pSection,
__deref_out_z_opt LPWSTR* psczEngineWorkingPath
);
HRESULT CacheLayoutBundle(
__in_z LPCWSTR wzExecutableName,
__in_z LPCWSTR wzLayoutDirectory,
__in_z LPCWSTR wzSourceBundlePath,
__in DWORD64 qwBundleSize,
__in PFN_BURNCACHEMESSAGEHANDLER pfnCacheMessageHandler,
__in LPPROGRESS_ROUTINE pfnProgress,
__in LPVOID pContext
);
HRESULT CacheCompleteBundle(
__in BURN_CACHE* pCache,
__in BOOL fPerMachine,
__in_z LPCWSTR wzExecutableName,
__in_z LPCWSTR wzBundleId,
__in_z LPCWSTR wzSourceBundlePath
#ifdef DEBUG
, __in_z LPCWSTR wzExecutablePath
#endif
);
HRESULT CacheLayoutContainer(
__in BURN_CONTAINER* pContainer,
__in_z_opt LPCWSTR wzLayoutDirectory,
__in_z LPCWSTR wzUnverifiedContainerPath,
__in BOOL fMove,
__in PFN_BURNCACHEMESSAGEHANDLER pfnCacheMessageHandler,
__in LPPROGRESS_ROUTINE pfnProgress,
__in LPVOID pContext
);
HRESULT CacheLayoutPayload(
__in BURN_PAYLOAD* pPayload,
__in_z_opt LPCWSTR wzLayoutDirectory,
__in_z LPCWSTR wzUnverifiedPayloadPath,
__in BOOL fMove,
__in PFN_BURNCACHEMESSAGEHANDLER pfnCacheMessageHandler,
__in LPPROGRESS_ROUTINE pfnProgress,
__in LPVOID pContext
);
HRESULT CacheCompletePayload(
__in BURN_CACHE* pCache,
__in BOOL fPerMachine,
__in BURN_PAYLOAD* pPayload,
__in_z LPCWSTR wzCacheId,
__in_z LPCWSTR wzUnverifiedPayloadPath,
__in BOOL fMove,
__in PFN_BURNCACHEMESSAGEHANDLER pfnCacheMessageHandler,
__in LPPROGRESS_ROUTINE pfnProgress,
__in LPVOID pContext
);
HRESULT CacheVerifyContainer(
__in BURN_CONTAINER* pContainer,
__in_z LPCWSTR wzCachedDirectory,
__in PFN_BURNCACHEMESSAGEHANDLER pfnCacheMessageHandler,
__in LPPROGRESS_ROUTINE pfnProgress,
__in LPVOID pContext
);
HRESULT CacheVerifyPayload(
__in BURN_PAYLOAD* pPayload,
__in_z LPCWSTR wzCachedDirectory,
__in PFN_BURNCACHEMESSAGEHANDLER pfnCacheMessageHandler,
__in LPPROGRESS_ROUTINE pfnProgress,
__in LPVOID pContext
);
HRESULT CacheRemoveBaseWorkingFolder(
__in BURN_CACHE* pCache
);
HRESULT CacheRemoveBundle(
__in BURN_CACHE* pCache,
__in BOOL fPerMachine,
__in_z LPCWSTR wzPackageId
);
HRESULT CacheRemovePackage(
__in BURN_CACHE* pCache,
__in BOOL fPerMachine,
__in_z LPCWSTR wzPackageId,
__in_z LPCWSTR wzCacheId
);
void CacheCleanup(
__in BOOL fPerMachine,
__in BURN_CACHE* pCache
);
void CacheUninitialize(
__in BURN_CACHE* pCache
);
#ifdef __cplusplus
}
#endif
|
