@joebigelow / wix
Code Commits Issues Pulls Sessions CI/CD
main
main
cpp 245 lines 5.92 KB
Raw
1 // 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.
2
3 #include "precomp.h"
4
5 typedef enum BALRETRY_TYPE
6 {
7 BALRETRY_TYPE_CACHE_CONTAINER,
8 BALRETRY_TYPE_CACHE_PAYLOAD,
9 BALRETRY_TYPE_EXECUTE,
10 } BALRETRY_TYPE;
11
12 struct BALRETRY_INFO
13 {
14 LPWSTR sczId;
15 DWORD cRetries;
16 DWORD dwLastError;
17 };
18
19 static DWORD vdwMaxRetries = 0;
20 static DWORD vdwTimeout = 0;
21 static BALRETRY_INFO vrgRetryInfo[3];
22
23 // prototypes
24 static BOOL IsActiveRetryEntry(
25 __in BALRETRY_TYPE type,
26 __in_z LPCWSTR sczId
27 );
28
29 static HRESULT StartActiveRetryEntry(
30 __in BALRETRY_TYPE type,
31 __in_z LPCWSTR sczId
32 );
33
34
35 DAPI_(void) BalRetryInitialize(
36 __in DWORD dwMaxRetries,
37 __in DWORD dwTimeout
38 )
39 {
40 BalRetryUninitialize(); // clean everything out.
41
42 vdwMaxRetries = dwMaxRetries;
43 vdwTimeout = dwTimeout;
44 }
45
46
47 DAPI_(void) BalRetryUninitialize()
48 {
49 for (DWORD i = 0; i < countof(vrgRetryInfo); ++i)
50 {
51 ReleaseStr(vrgRetryInfo[i].sczId);
52 memset(vrgRetryInfo + i, 0, sizeof(BALRETRY_INFO));
53 }
54
55 vdwMaxRetries = 0;
56 vdwTimeout = 0;
57 }
58
59
60 DAPI_(void) BalRetryStartContainerOrPayload(
61 __in_z_opt LPCWSTR wzContainerOrPackageId,
62 __in_z_opt LPCWSTR wzPayloadId
63 )
64 {
65 if (!wzContainerOrPackageId && !wzPayloadId)
66 {
67 ReleaseNullStr(vrgRetryInfo[BALRETRY_TYPE_CACHE_CONTAINER].sczId);
68 ReleaseNullStr(vrgRetryInfo[BALRETRY_TYPE_CACHE_PAYLOAD].sczId);
69 }
70 else if (wzPayloadId)
71 {
72 StartActiveRetryEntry(BALRETRY_TYPE_CACHE_PAYLOAD, wzPayloadId);
73 }
74 else
75 {
76 StartActiveRetryEntry(BALRETRY_TYPE_CACHE_CONTAINER, wzContainerOrPackageId);
77 }
78 }
79
80
81 DAPI_(void) BalRetryStartPackage(
82 __in_z LPCWSTR wzPackageId
83 )
84 {
85 StartActiveRetryEntry(BALRETRY_TYPE_EXECUTE, wzPackageId);
86 }
87
88
89 DAPI_(void) BalRetryErrorOccurred(
90 __in_z LPCWSTR wzPackageId,
91 __in DWORD dwError
92 )
93 {
94 if (IsActiveRetryEntry(BALRETRY_TYPE_EXECUTE, wzPackageId))
95 {
96 vrgRetryInfo[BALRETRY_TYPE_EXECUTE].dwLastError = dwError;
97 }
98 }
99
100
101 DAPI_(HRESULT) BalRetryEndContainerOrPayload(
102 __in_z_opt LPCWSTR wzContainerOrPackageId,
103 __in_z_opt LPCWSTR wzPayloadId,
104 __in HRESULT hrError,
105 __inout BOOL* pfRetry
106 )
107 {
108 HRESULT hr = S_OK;
109 BALRETRY_TYPE type = BALRETRY_TYPE_CACHE_PAYLOAD;
110 LPCWSTR wzId = NULL;
111
112 if (!wzContainerOrPackageId && !wzPayloadId)
113 {
114 ReleaseNullStr(vrgRetryInfo[BALRETRY_TYPE_CACHE_CONTAINER].sczId);
115 ReleaseNullStr(vrgRetryInfo[BALRETRY_TYPE_CACHE_PAYLOAD].sczId);
116 ExitFunction();
117 }
118 else if (wzPayloadId)
119 {
120 type = BALRETRY_TYPE_CACHE_PAYLOAD;
121 wzId = wzPayloadId;
122 }
123 else
124 {
125 type = BALRETRY_TYPE_CACHE_CONTAINER;
126 wzId = wzContainerOrPackageId;
127 }
128
129 if (FAILED(hrError) && vrgRetryInfo[type].cRetries < vdwMaxRetries && IsActiveRetryEntry(type, wzId))
130 {
131 // Retry on all errors except the following.
132 if (HRESULT_FROM_WIN32(ERROR_INSTALL_USEREXIT) != hrError &&
133 BG_E_NETWORK_DISCONNECTED != hrError &&
134 HRESULT_FROM_WIN32(ERROR_FILE_NOT_FOUND) != hrError &&
135 HRESULT_FROM_WIN32(ERROR_INTERNET_NAME_NOT_RESOLVED) != hrError)
136 {
137 *pfRetry = TRUE;
138 }
139 }
140
141 LExit:
142 return hr;
143 }
144
145
146 DAPI_(HRESULT) BalRetryEndPackage(
147 __in_z LPCWSTR wzPackageId,
148 __in HRESULT hrError,
149 __inout BOOL* pfRetry
150 )
151 {
152 HRESULT hr = S_OK;
153 BALRETRY_TYPE type = BALRETRY_TYPE_EXECUTE;
154
155 if (!wzPackageId || !*wzPackageId)
156 {
157 ReleaseNullStr(vrgRetryInfo[type].sczId);
158 }
159 else if (FAILED(hrError) && vrgRetryInfo[type].cRetries < vdwMaxRetries && IsActiveRetryEntry(type, wzPackageId))
160 {
161 // If the service is out of whack, just try again.
162 if (HRESULT_FROM_WIN32(ERROR_INSTALL_SERVICE_FAILURE) == hrError)
163 {
164 *pfRetry = TRUE;
165 }
166 else if (HRESULT_FROM_WIN32(ERROR_INSTALL_FAILURE) == hrError)
167 {
168 DWORD dwError = vrgRetryInfo[type].dwLastError;
169
170 // If we failed with one of these specific error codes, then retry since
171 // we've seen these have a high success of succeeding on retry.
172 if (1303 == dwError ||
173 1304 == dwError ||
174 1306 == dwError ||
175 1307 == dwError ||
176 1309 == dwError ||
177 1310 == dwError ||
178 1311 == dwError ||
179 1312 == dwError ||
180 1316 == dwError ||
181 1317 == dwError ||
182 1321 == dwError ||
183 1335 == dwError ||
184 1402 == dwError ||
185 1406 == dwError ||
186 1706 == dwError ||
187 1719 == dwError ||
188 1723 == dwError ||
189 1923 == dwError ||
190 1931 == dwError)
191 {
192 *pfRetry = TRUE;
193 }
194 }
195 else if (HRESULT_FROM_WIN32(ERROR_INSTALL_ALREADY_RUNNING) == hrError)
196 {
197 *pfRetry = TRUE;
198 }
199 }
200
201 return hr;
202 }
203
204
205 // Internal functions.
206
207 static BOOL IsActiveRetryEntry(
208 __in BALRETRY_TYPE type,
209 __in_z LPCWSTR sczId
210 )
211 {
212 BOOL fActive = FALSE;
213
214 fActive = vrgRetryInfo[type].sczId && CSTR_EQUAL == ::CompareStringW(LOCALE_NEUTRAL, 0, sczId, -1, vrgRetryInfo[type].sczId, -1);
215
216 return fActive;
217 }
218
219 static HRESULT StartActiveRetryEntry(
220 __in BALRETRY_TYPE type,
221 __in_z LPCWSTR sczId
222 )
223 {
224 HRESULT hr = S_OK;
225
226 if (!sczId || !*sczId)
227 {
228 ReleaseNullStr(vrgRetryInfo[type].sczId);
229 }
230 else if (IsActiveRetryEntry(type, sczId))
231 {
232 ++vrgRetryInfo[type].cRetries;
233 ::Sleep(vdwTimeout);
234 }
235 else
236 {
237 hr = StrAllocString(&vrgRetryInfo[type].sczId, sczId, 0);
238
239 vrgRetryInfo[type].cRetries = 0;
240 }
241
242 vrgRetryInfo[type].dwLastError = ERROR_SUCCESS;
243
244 return hr;
245 }