ContentfulClient.cs
33 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
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
using System;
using System.Collections.Generic;
using System.Linq;
using System.Net.Http;
using System.Threading.Tasks;
using Contentful.Core.Configuration;
using Contentful.Core.Models;
using Microsoft.Extensions.Options;
using Newtonsoft.Json.Linq;
using System.Reflection;
using System.Text;
using Contentful.Core.Search;
using System.Threading;
using Contentful.Core.Errors;
using Newtonsoft.Json;
using System.Collections;
using System.Net;
namespace Contentful.Core
{
/// <summary>
/// Main class for interaction with the contentful delivery and preview APIs
/// </summary>
public class ContentfulClient : ContentfulClientBase, IContentfulClient
{
private readonly string _baseUrl = "http://cdn.contentful.com/spaces/";
/// <summary>
/// Initializes a new instance of the <see cref="ContentfulClient"/> class.
/// The main class for interaction with the contentful deliver and preview APIs.
/// </summary>
/// <param name="httpClient">The HttpClient of your application.</param>
/// <param name="options">The options object used to retrieve the <see cref="ContentfulOptions"/> for this client.</param>
/// <exception cref="ArgumentException">The <see name="options">options</see> parameter was null or empty</exception>
public ContentfulClient(HttpClient httpClient, IOptions<ContentfulOptions> options)
{
ServicePointManager.ServerCertificateValidationCallback += (p1, p2, p3, p4) => true;
System.Net.ServicePointManager.SecurityProtocol = System.Net.SecurityProtocolType.Tls12;
_httpClient = httpClient;
_options = options.Value;
if (options == null)
{
throw new ArgumentException("The ContentfulOptions cannot be null.", nameof(options));
}
if (_options.UsePreviewApi)
{
_baseUrl = _baseUrl.Replace("cdn", "preview");
}
ResolveEntriesSelectively = _options.ResolveEntriesSelectively;
SerializerSettings.Converters.Add(new AssetJsonConverter());
SerializerSettings.TypeNameHandling = TypeNameHandling.All;
}
/// <summary>
/// Initializes a new instance of the <see cref="ContentfulClient"/> class.
/// </summary>
/// <param name="httpClient">The HttpClient of your application.</param>
/// <param name="options">The <see cref="ContentfulOptions"/> used for this client.</param>
public ContentfulClient(HttpClient httpClient, ContentfulOptions options):
this(httpClient, new OptionsWrapper<ContentfulOptions>(options))
{
}
/// <summary>
/// Initializes a new instance of the <see cref="ContentfulClient"/> class.
/// </summary>
/// <param name="httpClient">The HttpClient of your application.</param>
/// <param name="deliveryApiKey">The delivery API key used when communicating with the Contentful API.</param>
/// <param name="previewApiKey">The preview API key used when communicating with the Contentful Preview API.</param>
/// <param name="spaceId">The ID of the space to fetch content from.</param>
/// <param name="usePreviewApi">Whether or not to use the Preview API for requests.
/// If this is set to true the preview API key needs to be used for <paramref name="deliveryApiKey"/>
/// </param>
public ContentfulClient(HttpClient httpClient, string deliveryApiKey, string previewApiKey, string spaceId, bool usePreviewApi = false):
this(httpClient, new OptionsWrapper<ContentfulOptions>(new ContentfulOptions()
{
DeliveryApiKey = deliveryApiKey,
SpaceId = spaceId,
PreviewApiKey = previewApiKey,
UsePreviewApi = usePreviewApi
}))
{
}
/// <summary>
/// Returns whether or not the client is using the preview API.
/// </summary>
public bool IsPreviewClient => _options?.UsePreviewApi ?? false;
/// <summary>
/// Gets or sets the resolver used when resolving entries to typed objects.
/// </summary>
public IContentTypeResolver ContentTypeResolver { get; set; }
/// <summary>
/// If set the GetEntries methods will evaluate the class to serialize into and only serialize the parts that are part of the class structure.
/// </summary>
public bool ResolveEntriesSelectively { get; set; }
/// <summary>
/// Get a single entry by the specified ID.
/// </summary>
/// <typeparam name="T">The type to serialize this entry into. If you want the metadata to
/// be included in the serialized response use the <see cref="Entry{T}"/> class as a type parameter.</typeparam>
/// <param name="entryId">The ID of the entry.</param>
/// <param name="queryBuilder">The optional <see cref="QueryBuilder{T}"/> to add additional filtering to the query.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>The response from the API serialized into <typeparamref name="T"/></returns>
/// <exception cref="ContentfulException">There was an error when communicating with the Contentful API.</exception>
/// <exception cref="ArgumentException">The entryId parameter was null or empty.</exception>
public async Task<T> GetEntry<T>(string entryId, QueryBuilder<T> queryBuilder, CancellationToken cancellationToken = default(CancellationToken))
{
return await GetEntry<T>(entryId, queryBuilder?.Build(), cancellationToken).ConfigureAwait(false);
}
/// <summary>
/// Get a single entry by the specified ID.
/// </summary>
/// <typeparam name="T">The type to serialize this entry into. If you want the metadata to
/// be included in the serialized response use the <see cref="Entry{T}"/> class as a type parameter.</typeparam>
/// <param name="entryId">The ID of the entry.</param>
/// <param name="queryString">The optional querystring to add additional filtering to the query.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>The response from the API serialized into <typeparamref name="T"/></returns>
/// <exception cref="ContentfulException">There was an error when communicating with the Contentful API.</exception>
/// <exception cref="ArgumentException">The entryId parameter was null or empty.</exception>
public async Task<T> GetEntry<T>(string entryId, string queryString = null, CancellationToken cancellationToken = default(CancellationToken))
{
if (string.IsNullOrEmpty(entryId))
{
throw new ArgumentException(nameof(entryId));
}
var res = await Get($"{_baseUrl}{_options.SpaceId}/entries/{entryId}{queryString}", cancellationToken).ConfigureAwait(false);
var ob = default(T);
var json = JObject.Parse(await res.Content.ReadAsStringAsync().ConfigureAwait(false));
//move the sys object beneath the fields to make serialization more logical for the end user.
var sys = json.SelectToken("$.sys");
var fields = json.SelectToken("$.fields");
fields["sys"] = sys;
ob = fields.ToObject<T>(Serializer);
return ob;
}
/// <summary>
/// Gets all the entries with the specified content type.
/// </summary>
/// <typeparam name="T">The class to serialize the response into. If you want the metadata to
/// be included in the serialized response use the <see cref="Entry{T}"/> class as a type parameter.</typeparam>
/// <param name="contentTypeId">The ID of the content type to get entries for.</param>
/// <param name="queryBuilder">The optional <see cref="QueryBuilder{T}"/> to add additional filtering to the query.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>A <see cref="ContentfulCollection{T}"/> of items.</returns>
/// <exception cref="ContentfulException">There was an error when communicating with the Contentful API.</exception>
public async Task<ContentfulCollection<T>> GetEntriesByType<T>(string contentTypeId, QueryBuilder<T> queryBuilder = null, CancellationToken cancellationToken = default(CancellationToken))
{
var builder = queryBuilder ?? new QueryBuilder<T>();
builder.ContentTypeIs(contentTypeId);
return await GetEntries<T>(builder, cancellationToken).ConfigureAwait(false);
}
/// <summary>
/// Gets all the entries of a space, filtered by an optional <see cref="QueryBuilder{T}"/>.
/// </summary>
/// <typeparam name="T">The class to serialize the response into. If you want the metadata to
/// be included in the serialized response use the <see cref="Entry{T}"/> class as a type parameter.</typeparam>
/// <param name="queryBuilder">The optional <see cref="QueryBuilder{T}"/> to add additional filtering to the query.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>A <see cref="ContentfulCollection{T}"/> of items.</returns>
/// <exception cref="ContentfulException">There was an error when communicating with the Contentful API.</exception>
public async Task<ContentfulCollection<T>> GetEntries<T>(QueryBuilder<T> queryBuilder, CancellationToken cancellationToken = default(CancellationToken))
{
return await GetEntries<T>(queryBuilder?.Build(), cancellationToken).ConfigureAwait(false);
}
/// <summary>
/// Gets all the entries of a space, filtered by an optional querystring. A simpler approach than
/// to construct a query manually is to use the <see cref="QueryBuilder{T}"/> class.
/// </summary>
/// <typeparam name="T">The class to serialize the response into. If you want the metadata to
/// be included in the serialized response use the <see cref="Entry{T}"/> class as a type parameter.</typeparam>
/// <param name="queryString">The optional querystring to add additional filtering to the query.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>A <see cref="ContentfulCollection{T}"/> of items.</returns>
/// <exception cref="ContentfulException">There was an error when communicating with the Contentful API.</exception>
public async Task<ContentfulCollection<T>> GetEntries<T>(string queryString = null, CancellationToken cancellationToken = default(CancellationToken))
{
var res = await Get($"{_baseUrl}{_options.SpaceId}/entries{queryString}", cancellationToken).ConfigureAwait(false);
IEnumerable<T> entries;
var json = JObject.Parse(await res.Content.ReadAsStringAsync().ConfigureAwait(false));
var processedIds = new HashSet<string>();
foreach (var item in json.SelectTokens("$.items[*]").OfType<JObject>())
{
ResolveLinks(json, item, processedIds, typeof(T));
}
var entryTokens = json.SelectTokens("$.items[*]..fields").ToList();
for (var i = entryTokens.Count - 1; i >= 0; i--)
{
var token = entryTokens[i];
var grandParent = token.Parent.Parent;
if(grandParent["sys"]?["type"] != null && grandParent["sys"]["type"]?.ToString() != "Entry")
{
continue;
}
ResolveContentTypes(grandParent);
//Remove the fields property and let the fields be direct descendants of the node to make deserialization logical.
token.Parent.Remove();
grandParent.Add(token.Children());
}
entries = json.SelectToken("$.items").ToObject<IEnumerable<T>>(Serializer);
var collection = json.ToObject<ContentfulCollection<T>>(Serializer);
collection.Items = entries;
collection.IncludedAssets = json.SelectTokens("$.includes.Asset[*]")?.Select(t => t.ToObject<Asset>(Serializer));
collection.IncludedEntries = json.SelectTokens("$.includes.Entry[*]")?.Select(t => t.ToObject<Entry<dynamic>>(Serializer));
return collection;
}
private void ResolveContentTypes(JContainer container)
{
if(ContentTypeResolver == null || container["$type"] != null)
{
return;
}
var contentType = container["sys"]?["contentType"]?["sys"]?["id"]?.ToString();
if(contentType == null)
{
return;
}
var type = ContentTypeResolver.Resolve(contentType);
if (type != null)
{
container.AddFirst(new JProperty("$type", type.AssemblyQualifiedName));
}
}
private void ResolveLinks(JObject json, JObject entryToken, ISet<string> processedIds, Type type)
{
var id = ((JValue) entryToken.SelectToken("$.sys.id"))?.Value?.ToString();
if(id == null)
{
//No id token present, not possible to resolve links. Probably because the sys property has been excluded with a select statement.
return;
}
ResolveContentTypes(entryToken);
if(entryToken["$type"] != null)
{
type = Type.GetType(entryToken["$type"].Value<string>());
}
if (!processedIds.Contains(id))
{
entryToken.AddFirst(new JProperty("$id", new JValue(id)));
processedIds.Add(id);
}
var links = entryToken.SelectTokens("$.fields..sys").ToList();
//Walk through and add any included entries as direct links.
foreach (var linkToken in links)
{
var propName = (linkToken.Parent.Parent.Ancestors().FirstOrDefault(a => a is JProperty) as JProperty)?.Name;
var linkId = ((JValue)linkToken["id"]).Value.ToString();
JToken replacementToken = null;
if (processedIds.Contains(linkId))
{
replacementToken = new JObject
{
["$ref"] = linkId
};
}
else if (!string.IsNullOrEmpty(linkToken["linkType"]?.ToString()))
{
replacementToken = json.SelectTokens($"$.includes.{linkToken["linkType"]}[?(@.sys.id=='{linkId}')]").FirstOrDefault();
if (replacementToken == null)
{
//This could be due to the referenced entry being part of the original request (circular reference), so scan through that as well.
replacementToken = json.SelectTokens($"$.items.[?(@.sys.id=='{linkId}')]").FirstOrDefault();
}
}
var grandParent = (JObject)linkToken.Parent.Parent;
if (replacementToken != null)
{
grandParent.RemoveAll();
grandParent.Add(replacementToken.Children());
PropertyInfo prop = null;
if (ResolveEntriesSelectively)
{
prop = type?.GetRuntimeProperties().FirstOrDefault(p => (p.Name.Equals(propName, StringComparison.OrdinalIgnoreCase) ||
p.GetCustomAttribute<JsonPropertyAttribute>()?.PropertyName == propName));
if (prop == null)
{
//the property does not exist in the entry. Skip it in resolving references.
continue;
}
}
if (!processedIds.Contains(linkId))
{
Type propType = null;
if (ResolveEntriesSelectively)
{
propType = prop?.PropertyType;
if (propType != null && propType.IsArray)
{
propType = propType.GetElementType();
}
else if (propType != null && typeof(IEnumerable).GetTypeInfo().IsAssignableFrom(propType.GetTypeInfo()) && propType.IsConstructedGenericType)
{
propType = propType.GetTypeInfo().GenericTypeArguments[0];
}
}
ResolveLinks(json, grandParent, processedIds, propType);
}
}
else
{
var errorToken = json.SelectTokens($"$.errors.[?(@.details.id=='{linkId}')]").FirstOrDefault();
// The include is missing and present in the errors (possibly it was removed in contentful), we skip it to make sure it deserializes to null
if (errorToken != null)
{
var itemToSkip = grandParent.Parent is JProperty ? grandParent.Parent : grandParent;
itemToSkip.Remove();
}
}
}
}
/// <summary>
/// Gets a single <see cref="Asset"/> by the specified ID.
/// </summary>
/// <param name="assetId">The ID of the asset.</param>
/// <param name="queryBuilder">The optional <see cref="QueryBuilder{T}"/> to add additional filtering to the query.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>The response from the API serialized into an <see cref="Asset"/></returns>
/// <exception cref="ContentfulException">There was an error when communicating with the Contentful API.</exception>
/// <exception cref="ArgumentException">The <see name="assetId">assetId</see> parameter was null or emtpy.</exception>
public async Task<Asset> GetAsset(string assetId, QueryBuilder<Asset> queryBuilder, CancellationToken cancellationToken = default(CancellationToken))
{
return await GetAsset(assetId, queryBuilder?.Build(), cancellationToken);
}
/// <summary>
/// Gets a single <see cref="Asset"/> by the specified ID.
/// </summary>
/// <param name="assetId">The ID of the asset.</param>
/// <param name="queryString">The optional querystring to add additional filtering to the query.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>The response from the API serialized into an <see cref="Asset"/></returns>
/// <exception cref="ContentfulException">There was an error when communicating with the Contentful API.</exception>
/// <exception cref="ArgumentException">The <see name="assetId">assetId</see> parameter was null or emtpy.</exception>
public async Task<Asset> GetAsset(string assetId, string queryString = null, CancellationToken cancellationToken = default(CancellationToken))
{
if (string.IsNullOrEmpty(assetId))
{
throw new ArgumentException(nameof(assetId));
}
var res = await Get($"{_baseUrl}{_options.SpaceId}/assets/{assetId}{queryString}", cancellationToken).ConfigureAwait(false);
var jsonObject = JObject.Parse(await res.Content.ReadAsStringAsync().ConfigureAwait(false));
var asset = jsonObject.ToObject<Asset>(Serializer);
return asset;
}
/// <summary>
/// Gets all assets of a space, filtered by an optional <see cref="QueryBuilder{T}"/>.
/// </summary>
/// <param name="queryBuilder">The optional <see cref="QueryBuilder{T}"/> to add additional filtering to the query.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>A <see cref="ContentfulCollection{T}"/> of <see cref="Asset"/>.</returns>
/// <exception cref="ContentfulException">There was an error when communicating with the Contentful API.</exception>
public async Task<ContentfulCollection<Asset>> GetAssets(QueryBuilder<Asset> queryBuilder, CancellationToken cancellationToken = default(CancellationToken))
{
return await GetAssets(queryBuilder?.Build(), cancellationToken).ConfigureAwait(false);
}
/// <summary>
/// Gets all assets of a space, filtered by an optional queryString. A simpler approach than
/// to construct a query manually is to use the <see cref="QueryBuilder{T}"/> class.
/// </summary>
/// <param name="queryString">The optional querystring to add additional filtering to the query.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>A <see cref="ContentfulCollection{T}"/> of <see cref="Asset"/>.</returns>
/// <exception cref="ContentfulException">There was an error when communicating with the Contentful API.</exception>
public async Task<ContentfulCollection<Asset>> GetAssets(string queryString = null, CancellationToken cancellationToken = default(CancellationToken))
{
var res = await Get($"{_baseUrl}{_options.SpaceId}/assets/{queryString}", cancellationToken).ConfigureAwait(false);
var jsonObject = JObject.Parse(await res.Content.ReadAsStringAsync().ConfigureAwait(false));
var collection = jsonObject.ToObject<ContentfulCollection<Asset>>(Serializer);
var assets = jsonObject.SelectTokens("$.items[*]").Select(c => c.ToObject<Asset>(Serializer)); ;
collection.Items = assets;
return collection;
}
/// <summary>
/// Gets the <see cref="Space"/> for this client.
/// </summary>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>The <see cref="Space"/>.</returns>
/// <exception cref="ContentfulException">There was an error when communicating with the Contentful API.</exception>
public async Task<Space> GetSpace(CancellationToken cancellationToken = default(CancellationToken))
{
var res = await Get($"{_baseUrl}{_options.SpaceId}", cancellationToken).ConfigureAwait(false);
var jsonObject = JObject.Parse(await res.Content.ReadAsStringAsync().ConfigureAwait(false));
var space = jsonObject.ToObject<Space>(Serializer);
return space;
}
/// <summary>
/// Gets a <see cref="ContentType"/> by the specified ID.
/// </summary>
/// <param name="contentTypeId">The ID of the content type.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>The response from the API serialized into a <see cref="ContentType"/>.</returns>
/// <exception cref="ContentfulException">There was an error when communicating with the Contentful API.</exception>
/// <exception cref="ArgumentException">The <see name="contentTypeId">contentTypeId</see> parameter was null or empty</exception>
public async Task<ContentType> GetContentType(string contentTypeId, CancellationToken cancellationToken = default(CancellationToken))
{
if (string.IsNullOrEmpty(contentTypeId))
{
throw new ArgumentException(nameof(contentTypeId));
}
var res = await Get($"{_baseUrl}{_options.SpaceId}/content_types/{contentTypeId}", cancellationToken).ConfigureAwait(false);
var jsonObject = JObject.Parse(await res.Content.ReadAsStringAsync().ConfigureAwait(false));
var contentType = jsonObject.ToObject<ContentType>(Serializer);
return contentType;
}
/// <summary>
/// Get all content types of a space.
/// </summary>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>An <see cref="IEnumerable{T}"/> of <see cref="ContentType"/>.</returns>
public async Task<IEnumerable<ContentType>> GetContentTypes(CancellationToken cancellationToken = default(CancellationToken))
{
var res = await Get($"{_baseUrl}{_options.SpaceId}/content_types/", cancellationToken).ConfigureAwait(false);
var jsonObject = JObject.Parse(await res.Content.ReadAsStringAsync().ConfigureAwait(false));
var contentTypes = jsonObject.SelectTokens("$..items[*]").Select(t => t.ToObject<ContentType>(Serializer));
return contentTypes;
}
/// <summary>
/// Fetches an initial sync result of content. Note that this sync might not contain the entire result.
/// If the <see cref="SyncResult"/> returned contains a <see cref="SyncResult.NextPageUrl"/> that means
/// there are more resources to fetch. See also the <see cref="SyncInitialRecursive"/> method.
/// </summary>
/// <param name="syncType">The optional type of items that should be synced.</param>
/// <param name="contentTypeId">The content type ID to filter entries by. Only applicable when the syncType is <see cref="SyncType.Entry"/>.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>A <see cref="SyncResult"/> containing all synced resources.</returns>
/// <exception cref="ContentfulException">There was an error when communicating with the Contentful API.</exception>
public async Task<SyncResult> SyncInitial(SyncType syncType = SyncType.All, string contentTypeId = "", CancellationToken cancellationToken = default(CancellationToken))
{
var query = BuildSyncQuery(syncType, contentTypeId, true);
var res = await Get($"{_baseUrl}{_options.SpaceId}/sync{query}", cancellationToken).ConfigureAwait(false);
var syncResult = ParseSyncResult(await res.Content.ReadAsStringAsync().ConfigureAwait(false));
return syncResult;
}
/// <summary>
/// Syncs the delta changes since the last sync or the next page of an incomplete sync.
/// </summary>
/// <param name="nextSyncOrPageUrl">The next page or next sync url from another <see cref="SyncResult"/>,
/// you can either pass the entire URL or only the syncToken query string parameter.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>A <see cref="SyncResult"/> containing all synced resources.</returns>
/// <exception cref="ArgumentException">The <see name="nextSyncOrPageUrl">nextSyncOrPageUrl</see> parameter was null or empty</exception>
/// <exception cref="ContentfulException">There was an error when communicating with the Contentful API.</exception>
public async Task<SyncResult> SyncNextResult(string nextSyncOrPageUrl, CancellationToken cancellationToken = default(CancellationToken))
{
if (string.IsNullOrEmpty(nextSyncOrPageUrl))
{
throw new ArgumentException("nextPageUrl must be specified.", nameof(nextSyncOrPageUrl));
}
var syncToken = nextSyncOrPageUrl.Substring(nextSyncOrPageUrl.LastIndexOf('=') + 1);
var query = BuildSyncQuery(syncToken:syncToken);
var res = await Get($"{_baseUrl}{_options.SpaceId}/sync{query}", cancellationToken).ConfigureAwait(false);
var syncResult = ParseSyncResult(await res.Content.ReadAsStringAsync().ConfigureAwait(false));
return syncResult;
}
/// <summary>
/// Fetches an inital sync result of content and then recursively calls the api for any further
/// content available using the <see cref="SyncResult.NextPageUrl"/>. Note that this might result in
/// multiple outgoing calls to the Contentful API. If you have a large amount of entries to sync consider using
/// the <see cref="SyncInitial"/> method in conjunction with the <see cref="SyncNextResult"/> method and
/// handling each response separately.
/// </summary>
/// <param name="syncType">The optional type of items that should be synced.</param>
/// <param name="contentTypeId">The content type ID to filter entries by. Only applicable when the syncType is <see cref="SyncType.Entry"/>.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>A <see cref="SyncResult"/> containing all synced resources.</returns>
/// <exception cref="ContentfulException">There was an error when communicating with the Contentful API.</exception>
public async Task<SyncResult> SyncInitialRecursive(SyncType syncType = SyncType.All, string contentTypeId = "", CancellationToken cancellationToken = default(CancellationToken))
{
var syncResult = await SyncInitial(syncType, contentTypeId).ConfigureAwait(false);
while (!string.IsNullOrEmpty(syncResult.NextPageUrl))
{
var nextResult = await SyncNextResult(syncResult.NextPageUrl, cancellationToken).ConfigureAwait(false);
syncResult.Entries = syncResult.Entries.Concat(nextResult.Entries);
syncResult.Assets = syncResult.Assets.Concat(nextResult.Assets);
syncResult.DeletedAssets = syncResult.DeletedAssets.Concat(nextResult.DeletedAssets);
syncResult.DeletedEntries = syncResult.DeletedEntries.Concat(nextResult.DeletedEntries);
syncResult.SystemProperties = nextResult.SystemProperties;
syncResult.NextPageUrl = nextResult.NextPageUrl;
syncResult.NextSyncUrl = nextResult.NextSyncUrl;
}
return syncResult;
}
private SyncResult ParseSyncResult(string content)
{
var jsonObject = JObject.Parse(content);
var syncResult = jsonObject.ToObject<SyncResult>(Serializer);
var entries =
jsonObject.SelectTokens("$.items[?(@.sys.type=='Entry')]").Select(c => c.ToObject<Entry<dynamic>>(Serializer));
var assets =
jsonObject.SelectTokens("$.items[?(@.sys.type=='Asset')]").Select(c => c.ToObject<SyncedAsset>(Serializer));
var deletedEntries = jsonObject.SelectTokens("$.items[?(@.sys.type=='DeletedEntry')].sys").Select(c => c.ToObject<SystemProperties>(Serializer));
var deletedAssets = jsonObject.SelectTokens("$.items[?(@.sys.type=='DeletedAsset')].sys").Select(c => c.ToObject<SystemProperties>(Serializer));
syncResult.Assets = assets;
syncResult.DeletedAssets = deletedAssets;
syncResult.DeletedEntries = deletedEntries;
syncResult.Entries = entries;
return syncResult;
}
private string BuildSyncQuery(SyncType syncType = SyncType.All, string contentTypeId = null, bool initial = false, string syncToken = null)
{
var querystringValues = new List<KeyValuePair<string, string>>();
if (syncType != SyncType.All)
{
querystringValues.Add(new KeyValuePair<string, string>("type", syncType.ToString()));
}
if (syncType == SyncType.Entry && !string.IsNullOrEmpty(contentTypeId))
{
querystringValues.Add(new KeyValuePair<string, string>("content_type", contentTypeId));
}
if (initial)
{
querystringValues.Add(new KeyValuePair<string, string>("initial", "true"));
}
if (!string.IsNullOrEmpty(syncToken))
{
querystringValues.Add(new KeyValuePair<string, string>("sync_token", syncToken));
}
var query = new StringBuilder();
var hasQuery = false;
foreach (var parameter in querystringValues)
{
query.Append(hasQuery ? '&' : '?');
query.Append(parameter.Key);
query.Append('=');
query.Append(parameter.Value);
hasQuery = true;
}
return query.ToString();
}
private async Task<HttpResponseMessage> Get(string url, CancellationToken cancellationToken)
{
UnityEngine.Debug.Log(url + " " + cancellationToken.IsCancellationRequested);
return await SendHttpRequest(url, HttpMethod.Get, _options.UsePreviewApi ? _options.PreviewApiKey : _options.DeliveryApiKey, cancellationToken).ConfigureAwait(false);
}
}
}