ContentfulClientBase.cs
12 KB
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
using Contentful.Core.Configuration;
using Contentful.Core.Errors;
using Contentful.Core.Models;
using Newtonsoft.Json;
using Newtonsoft.Json.Linq;
using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Net;
using System.Net.Http;
using System.Net.Security;
using System.Reflection;
using System.Runtime.InteropServices;
using System.Security.Cryptography.X509Certificates;
using System.Text;
using System.Text.RegularExpressions;
using System.Threading;
using System.Threading.Tasks;
using UnityEngine;
namespace Contentful.Core
{
/// <summary>
/// Base class for Contentful clients.
/// </summary>
public abstract class ContentfulClientBase
{
/// <summary>
/// The HttpClient used for API calls.
/// </summary>
protected HttpClient _httpClient;
/// <summary>
/// The <see cref="ContentfulOptions"/> for this ContentfulClient.
/// </summary>
protected ContentfulOptions _options;
internal JsonSerializer Serializer => JsonSerializer.Create(SerializerSettings);
/// <summary>
/// Gets or sets the settings that should be used for deserialization.
/// </summary>
public JsonSerializerSettings SerializerSettings { get; set; } = new JsonSerializerSettings();
/// <summary>
/// Returns the current version of the package.
/// </summary>
public string Version => typeof(ContentfulClientBase).GetTypeInfo().Assembly.GetCustomAttribute<AssemblyInformationalVersionAttribute>()
.InformationalVersion;
private string Os => RuntimeInformation.IsOSPlatform(OSPlatform.Windows) ? "Windows" : RuntimeInformation.IsOSPlatform(OSPlatform.OSX) ? "macOS" : "Linux";
private string Platform => ".net";
/// <summary>
/// Property for sending a custom tracking header.
/// </summary>
public string Application { get; set; } = "sdk contentful.csharp";
/// <summary>
/// Creates an exception for a failed API request.
/// </summary>
/// <param name="res">The HttpResonseMessage.</param>
/// <returns></returns>
protected async Task CreateExceptionForFailedRequest(HttpResponseMessage res)
{
var jsonError = JObject.Parse(await res.Content.ReadAsStringAsync().ConfigureAwait(false));
var sys = jsonError.SelectToken("$.sys").ToObject<SystemProperties>();
var errorDetails = jsonError.SelectToken("$.details")?.ToObject<ErrorDetails>();
var message = jsonError.SelectToken("$.message")?.ToString();
var statusCode = (int)res.StatusCode;
if (string.IsNullOrEmpty(message))
{
message = GetGenericErrorMessageForStatusCode(statusCode, sys.Id);
}
if(errorDetails != null)
{
message += errorDetails.Errors?.ToString();
}
IEnumerable<string> headers = new List<string>();
if(statusCode == 429 && res.Headers.TryGetValues("X-Contentful-RateLimit-Reset", out headers))
{
var rateLimitException = new ContentfulRateLimitException(message)
{
RequestId = jsonError.SelectToken("$.requestId")?.ToString(),
ErrorDetails = errorDetails,
SystemProperties = sys,
SecondsUntilNextRequest = headers.FirstOrDefault() == null ? 0 : int.Parse(headers.FirstOrDefault())
};
throw rateLimitException;
}
var ex = new ContentfulException(statusCode, message)
{
RequestId = jsonError.SelectToken("$.requestId")?.ToString(),
ErrorDetails = errorDetails,
SystemProperties = sys
};
throw ex;
}
private string GetGenericErrorMessageForStatusCode(int statusCode, string id)
{
if(statusCode == 400)
{
if (id == "BadRequestError")
{
return "The request was malformed or missing a required parameter.";
}
return "The request contained invalid or unknown query parameters.";
}
if(statusCode == 401)
{
return "The authorization token was invalid.";
}
if(statusCode == 403)
{
return "The specified token does not have access to the requested resource.";
}
if(statusCode == 404)
{
return "The requested resource or endpoint could not be found.";
}
if (statusCode == 409)
{
return "Version mismatch error. The version you specified was incorrect. This may be due to someone else editing the content.";
}
if (statusCode == 422)
{
if(id == "InvalidEntryError")
{
return "The entered value was invalid.";
}
return "Validation failed. The request references an invalid field.";
}
if(statusCode == 429)
{
return "Rate limit exceeded. Too many requests per second.";
}
if(statusCode == 500)
{
return "Internal server error.";
}
if(statusCode == 502)
{
return "The requested space is hibernated.";
}
return "An error occurred.";
}
/// <summary>
/// Sends an Http request.
/// </summary>
/// <param name="url">The url to send to.</param>
/// <param name="method">The HTTP method to use.</param>
/// <param name="authToken">The authorization token.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <param name="content">The HTTP content.</param>
/// <returns></returns>
protected async Task<HttpResponseMessage> SendHttpRequest(string url, HttpMethod method, string authToken, CancellationToken cancellationToken, HttpContent content = null)
{
var httpRequestMessage = new HttpRequestMessage()
{
RequestUri = new Uri(url),
Method = method
};
httpRequestMessage.Headers.Add("Authorization", $"Bearer {authToken}");
//UnityEngine.Debug.Log("Application : " + Application);
//UnityEngine.Debug.Log("Version : " + "2.0.3");
//UnityEngine.Debug.Log("Platform : " + Platform);
//UnityEngine.Debug.Log("OS : " + Os);
httpRequestMessage.Headers.Add("X-Contentful-User-Agent", $"{Application}/2.0.3; platform {Platform}; os {Os};");
httpRequestMessage.Content = content;
return await SendHttpRequest(httpRequestMessage, cancellationToken).ConfigureAwait(false); ;
}
private async Task<HttpResponseMessage> SendHttpRequest(HttpRequestMessage request, CancellationToken cancellationToken)
{
ServicePointManager.ServerCertificateValidationCallback += MyRemoteCertificateValidationCallback;
System.Net.ServicePointManager.SecurityProtocol = System.Net.SecurityProtocolType.Tls12;
var response = await _httpClient.SendAsync(request, cancellationToken).ConfigureAwait(false);
response = await EnsureSuccessfulResult(response);
return response;
}
/// <summary>
/// Adds a Contentful version header to the request.
/// </summary>
/// <param name="version"></param>
protected void AddVersionHeader(int? version)
{
if (_httpClient.DefaultRequestHeaders.Contains("X-Contentful-Version"))
{
_httpClient.DefaultRequestHeaders.Remove("X-Contentful-Version");
}
if (version.HasValue)
{
_httpClient.DefaultRequestHeaders.Add("X-Contentful-Version", version.ToString());
}
}
/// <summary>
/// Removes a Contentful version header from the request.
/// </summary>
protected void RemoveVersionHeader()
{
_httpClient.DefaultRequestHeaders.Remove("X-Contentful-Version");
}
/// <summary>
/// Ensures an HttpResponse is successful.
/// </summary>
/// <param name="response"></param>
/// <returns></returns>
protected async Task<HttpResponseMessage> EnsureSuccessfulResult(HttpResponseMessage response)
{
if (!response.IsSuccessStatusCode)
{
if((int)response.StatusCode == 429 && _options.MaxNumberOfRateLimitRetries > 0)
{
//Limit retries to 10 regardless of config
for (var i = 0; i < _options.MaxNumberOfRateLimitRetries && i < 10; i++)
{
try
{
await CreateExceptionForFailedRequest(response).ConfigureAwait(false); ;
}
catch (ContentfulRateLimitException ex)
{
await Task.Delay(ex.SecondsUntilNextRequest * 1000).ConfigureAwait(false);
}
var clonedMessage = await CloneHttpRequest(response.RequestMessage);
response = await _httpClient.SendAsync(clonedMessage).ConfigureAwait(false);
if (response.IsSuccessStatusCode)
{
return response;
}
}
}
await CreateExceptionForFailedRequest(response);
}
return response;
}
private async Task<HttpRequestMessage> CloneHttpRequest(HttpRequestMessage message)
{
var clone = new HttpRequestMessage(message.Method, message.RequestUri);
// Copy the request's content (via a MemoryStream) into the cloned object
var ms = new MemoryStream();
if (message.Content != null)
{
await message.Content.CopyToAsync(ms).ConfigureAwait(false);
ms.Position = 0;
clone.Content = new StreamContent(ms);
if (message.Content.Headers != null)
foreach (var h in message.Content.Headers)
clone.Content.Headers.Add(h.Key, h.Value);
}
foreach (var header in message.Headers)
clone.Headers.TryAddWithoutValidation(header.Key, header.Value);
return clone;
}
public bool MyRemoteCertificateValidationCallback(System.Object sender,
X509Certificate certificate, X509Chain chain, SslPolicyErrors sslPolicyErrors)
{
bool isOk = true;
// If there are errors in the certificate chain,
// look at each error to determine the cause.
if (sslPolicyErrors != SslPolicyErrors.None)
{
for (int i = 0; i < chain.ChainStatus.Length; i++)
{
if (chain.ChainStatus[i].Status == X509ChainStatusFlags.RevocationStatusUnknown)
{
continue;
}
chain.ChainPolicy.RevocationFlag = X509RevocationFlag.EntireChain;
chain.ChainPolicy.RevocationMode = X509RevocationMode.Online;
chain.ChainPolicy.UrlRetrievalTimeout = new TimeSpan(0, 1, 0);
chain.ChainPolicy.VerificationFlags = X509VerificationFlags.AllFlags;
bool chainIsValid = chain.Build((X509Certificate2)certificate);
if (!chainIsValid)
{
isOk = false;
break;
}
}
}
return isOk;
}
}
}