-
-
Notifications
You must be signed in to change notification settings - Fork 33
/
RecursiveExecutionEngine.cs
411 lines (368 loc) · 20.5 KB
/
RecursiveExecutionEngine.cs
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
// <copyright file="RecursiveExecutionEngine.cs" company="Fubar Development Junker">
// Copyright (c) Fubar Development Junker. All rights reserved.
// </copyright>
using System;
using System.Collections.Generic;
using System.Collections.Immutable;
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
using FubarDev.WebDavServer.FileSystem;
using FubarDev.WebDavServer.Model.Headers;
using FubarDev.WebDavServer.Props;
using Microsoft.Extensions.Logging;
namespace FubarDev.WebDavServer.Engines
{
/// <summary>
/// The engine that operates recursively on its targets
/// </summary>
/// <typeparam name="TCollection">The interface type for a collection target</typeparam>
/// <typeparam name="TDocument">The interface type for a document target</typeparam>
/// <typeparam name="TMissing">The interface type for a missing target</typeparam>
public class RecursiveExecutionEngine<TCollection, TDocument, TMissing>
where TCollection : class, ICollectionTarget<TCollection, TDocument, TMissing>
where TDocument : class, IDocumentTarget<TCollection, TDocument, TMissing>
where TMissing : class, IMissingTarget<TCollection, TDocument, TMissing>
{
private readonly ITargetActions<TCollection, TDocument, TMissing> _handler;
private readonly bool _allowOverwrite;
private readonly ILogger _logger;
/// <summary>
/// Initializes a new instance of the <see cref="RecursiveExecutionEngine{TCollection,TDocument,TMissing}"/> class.
/// </summary>
/// <param name="handler">The handler that performs the operation on the targets</param>
/// <param name="allowOverwrite">Is overwriting the destination allowed?</param>
/// <param name="logger">The logger</param>
public RecursiveExecutionEngine(ITargetActions<TCollection, TDocument, TMissing> handler, bool allowOverwrite, ILogger logger)
{
_handler = handler;
_allowOverwrite = allowOverwrite;
_logger = logger;
}
/// <summary>
/// Operates on a collection and the given missing target
/// </summary>
/// <param name="sourceUrl">The root-relative source URL</param>
/// <param name="source">The source collection</param>
/// <param name="depth">The recursion depth</param>
/// <param name="target">The target of the operation</param>
/// <param name="cancellationToken">The cancellation token</param>
/// <returns>The result information of the current operation</returns>
public async Task<CollectionActionResult> ExecuteAsync(Uri sourceUrl, ICollection source, DepthHeader depth, TMissing target, CancellationToken cancellationToken)
{
if (_logger.IsEnabled(LogLevel.Trace))
_logger.LogTrace($"Collecting nodes for operation on collection {sourceUrl} with missing target {target.DestinationUrl}.");
var nodes = await source.GetNodeAsync(depth.OrderValue, cancellationToken).ConfigureAwait(false);
return await ExecuteAsync(sourceUrl, nodes, target, cancellationToken).ConfigureAwait(false);
}
/// <summary>
/// Operates on a collection and the given target collection
/// </summary>
/// <param name="sourceUrl">The root-relative source URL</param>
/// <param name="source">The source collection</param>
/// <param name="depth">The recursion depth</param>
/// <param name="target">The target collection</param>
/// <param name="cancellationToken">The cancellation token</param>
/// <returns>The result information of the current operation</returns>
public async Task<CollectionActionResult> ExecuteAsync(Uri sourceUrl, ICollection source, DepthHeader depth, TCollection target, CancellationToken cancellationToken)
{
if (_logger.IsEnabled(LogLevel.Trace))
_logger.LogTrace($"Collecting nodes for operation on collection {sourceUrl} with existing target {target.DestinationUrl}.");
var nodes = await source.GetNodeAsync(depth.OrderValue, cancellationToken).ConfigureAwait(false);
return await ExecuteAsync(sourceUrl, nodes, target, cancellationToken).ConfigureAwait(false);
}
/// <summary>
/// Operates on a documentation and the given missing target
/// </summary>
/// <param name="sourceUrl">The root-relative source URL</param>
/// <param name="source">The source documentation</param>
/// <param name="target">The target of the operation</param>
/// <param name="cancellationToken">The cancellation token</param>
/// <returns>The result information of the current operation</returns>
public async Task<ActionResult> ExecuteAsync(Uri sourceUrl, IDocument source, TMissing target, CancellationToken cancellationToken)
{
if (_logger.IsEnabled(LogLevel.Trace))
_logger.LogTrace($"Perform operation on document {sourceUrl} with missing target {target.DestinationUrl}.");
try
{
var properties = await GetWriteableProperties(source, cancellationToken).ConfigureAwait(false);
var newDoc = await _handler.ExecuteAsync(source, target, cancellationToken).ConfigureAwait(false);
var failedPropertyNames = await newDoc.SetPropertiesAsync(properties, cancellationToken).ConfigureAwait(false);
if (failedPropertyNames.Count != 0)
{
_logger.LogDebug($"{target.DestinationUrl}: Failed setting properties {string.Join(", ", failedPropertyNames.Select(x => x.ToString()))}");
return new ActionResult(ActionStatus.PropSetFailed, target)
{
FailedProperties = failedPropertyNames,
};
}
return new ActionResult(ActionStatus.Created, newDoc);
}
catch (Exception ex)
{
_logger.LogDebug($"{target.DestinationUrl}: Failed with exception {ex.Message}");
return new ActionResult(ActionStatus.CreateFailed, target)
{
Exception = ex,
};
}
}
/// <summary>
/// Operates on a documentation and the given document target
/// </summary>
/// <param name="sourceUrl">The root-relative source URL</param>
/// <param name="source">The source documentation</param>
/// <param name="target">The target document of the operation</param>
/// <param name="cancellationToken">The cancellation token</param>
/// <returns>The result information of the current operation</returns>
public async Task<ActionResult> ExecuteAsync(Uri sourceUrl, IDocument source, TDocument target, CancellationToken cancellationToken)
{
if (_logger.IsEnabled(LogLevel.Trace))
_logger.LogTrace($"Try to perform operation on document {sourceUrl} with existing target {target.DestinationUrl}.");
if (!_allowOverwrite)
{
_logger.LogDebug($"{target.DestinationUrl}: Cannot overwrite because destination exists");
return new ActionResult(ActionStatus.CannotOverwrite, target);
}
if (_handler.ExistingTargetBehaviour == RecursiveTargetBehaviour.DeleteTarget)
{
if (_logger.IsEnabled(LogLevel.Trace))
_logger.LogTrace($"Delete {target.DestinationUrl} before performing operation on document {sourceUrl}.");
TMissing missingTarget;
try
{
missingTarget = await target.DeleteAsync(cancellationToken).ConfigureAwait(false);
}
catch (Exception ex)
{
_logger.LogDebug($"{target.DestinationUrl}: Delete failed with exception {ex.Message}");
return new CollectionActionResult(ActionStatus.TargetDeleteFailed, target)
{
Exception = ex,
};
}
return await ExecuteAsync(sourceUrl, source, missingTarget, cancellationToken).ConfigureAwait(false);
}
if (_logger.IsEnabled(LogLevel.Trace))
_logger.LogTrace($"Perform operation on document {sourceUrl} with existing target {target.DestinationUrl}.");
var properties = await GetWriteableProperties(source, cancellationToken).ConfigureAwait(false);
var docActionResult = await _handler.ExecuteAsync(source, target, cancellationToken).ConfigureAwait(false);
if (docActionResult.IsFailure)
return docActionResult;
var failedPropertyNames = await target.SetPropertiesAsync(properties, cancellationToken).ConfigureAwait(false);
if (failedPropertyNames.Count != 0)
{
_logger.LogDebug($"{target.DestinationUrl}: Failed setting properties {string.Join(", ", failedPropertyNames.Select(x => x.ToString()))}");
return new ActionResult(ActionStatus.PropSetFailed, target)
{
FailedProperties = failedPropertyNames,
};
}
return new ActionResult(ActionStatus.Overwritten, target);
}
private async Task<List<IUntypedWriteableProperty>> GetWriteableProperties(IEntry entry, CancellationToken cancellationToken)
{
var properties = new List<IUntypedWriteableProperty>();
using (var propsEnum = entry.GetProperties(_handler.Dispatcher).GetEnumerator())
{
while (await propsEnum.MoveNext(cancellationToken).ConfigureAwait(false))
{
var prop = propsEnum.Current as IUntypedWriteableProperty;
if (prop != null)
properties.Add(prop);
}
}
return properties;
}
private async Task<CollectionActionResult> ExecuteAsync(
Uri sourceUrl,
ICollectionNode sourceNode,
TMissing target,
CancellationToken cancellationToken)
{
if (_logger.IsEnabled(LogLevel.Trace))
_logger.LogTrace($"Collect properties for operation on collection {sourceUrl} and create target {target.DestinationUrl}.");
var properties = await GetWriteableProperties(sourceNode.Collection, cancellationToken).ConfigureAwait(false);
TCollection newColl;
try
{
newColl = await target.CreateCollectionAsync(cancellationToken).ConfigureAwait(false);
}
catch (Exception ex)
{
_logger.LogDebug($"{target.DestinationUrl}: Create failed with exception {ex.Message}");
return new CollectionActionResult(ActionStatus.CreateFailed, target)
{
Exception = ex,
};
}
return await ExecuteAsync(sourceUrl, sourceNode, newColl, properties, cancellationToken).ConfigureAwait(false);
}
private async Task<CollectionActionResult> ExecuteAsync(
Uri sourceUrl,
ICollectionNode sourceNode,
TCollection target,
CancellationToken cancellationToken)
{
if (_allowOverwrite && _handler.ExistingTargetBehaviour == RecursiveTargetBehaviour.DeleteTarget)
{
if (_logger.IsEnabled(LogLevel.Trace))
_logger.LogTrace($"Delete existing target {target.DestinationUrl} for operation on collection {sourceUrl}.");
// Only delete an existing collection when the client allows an overwrite
TMissing missing;
try
{
missing = await target.DeleteAsync(cancellationToken).ConfigureAwait(false);
}
catch (Exception ex)
{
_logger.LogDebug($"{target.DestinationUrl}: Delete failed with exception {ex.Message}");
return new CollectionActionResult(ActionStatus.TargetDeleteFailed, target)
{
Exception = ex,
};
}
return await ExecuteAsync(sourceUrl, sourceNode, missing, cancellationToken).ConfigureAwait(false);
}
if (_logger.IsEnabled(LogLevel.Trace))
_logger.LogTrace($"Collect properties for operation on collection {sourceUrl} with existing target {target.DestinationUrl}.");
var properties = await GetWriteableProperties(sourceNode.Collection, cancellationToken).ConfigureAwait(false);
return await ExecuteAsync(sourceUrl, sourceNode, target, properties, cancellationToken).ConfigureAwait(false);
}
private async Task<CollectionActionResult> ExecuteAsync(
Uri sourceUrl,
ICollectionNode sourceNode,
TCollection target,
IReadOnlyCollection<IUntypedWriteableProperty> properties,
CancellationToken cancellationToken)
{
if (_logger.IsEnabled(LogLevel.Trace))
_logger.LogTrace($"Perform operation on collection {sourceUrl} with existing target {target.DestinationUrl}.");
var documentActionResults = ImmutableList<ActionResult>.Empty;
var collectionActionResults = ImmutableList<CollectionActionResult>.Empty;
var subNodeProperties = new Dictionary<string, IReadOnlyCollection<IUntypedWriteableProperty>>();
foreach (var childNode in sourceNode.Nodes)
{
var subProperties = await GetWriteableProperties(childNode.Collection, cancellationToken).ConfigureAwait(false);
subNodeProperties.Add(childNode.Name, subProperties);
}
foreach (var document in sourceNode.Documents)
{
var docUrl = sourceUrl.Append(document);
if (target.Created)
{
// Collection was created by us - we just assume that the document doesn't exist
var missingTarget = target.NewMissing(document.Name);
var docResult = await ExecuteAsync(docUrl, document, missingTarget, cancellationToken).ConfigureAwait(false);
documentActionResults = documentActionResults.Add(docResult);
}
else
{
var foundTarget = await target.GetAsync(document.Name, cancellationToken).ConfigureAwait(false);
var docTarget = foundTarget as TDocument;
if (docTarget != null)
{
// We found a document: Business as usual when we're allowed to overwrite it
var docResult = await ExecuteAsync(docUrl, document, docTarget, cancellationToken).ConfigureAwait(false);
documentActionResults = documentActionResults.Add(docResult);
}
else
{
var collTarget = foundTarget as TCollection;
if (collTarget != null)
{
// We found a collection instead of a document
_logger.LogDebug($"{target.DestinationUrl}: Found a collection instead of a document");
var docResult = new ActionResult(ActionStatus.OverwriteFailed, foundTarget);
documentActionResults = documentActionResults.Add(docResult);
}
else
{
// We didn't find anything: Business as usual
var missingTarget = (TMissing)foundTarget;
var docResult = await ExecuteAsync(docUrl, document, missingTarget, cancellationToken).ConfigureAwait(false);
documentActionResults = documentActionResults.Add(docResult);
}
}
}
}
foreach (var childNode in sourceNode.Nodes)
{
var childProperties = subNodeProperties[childNode.Name];
var collection = childNode.Collection;
var docUrl = sourceUrl.Append(childNode.Collection);
if (target.Created)
{
// Collection was created by us - we just assume that the sub collection doesn't exist
var missingTarget = target.NewMissing(childNode.Name);
var newColl = await missingTarget.CreateCollectionAsync(cancellationToken).ConfigureAwait(false);
var collResult = await ExecuteAsync(docUrl, childNode, newColl, childProperties, cancellationToken).ConfigureAwait(false);
collectionActionResults = collectionActionResults.Add(collResult);
}
else
{
// Test if the target node exists
var foundTarget = await target.GetAsync(collection.Name, cancellationToken).ConfigureAwait(false);
var docTarget = foundTarget as TDocument;
if (docTarget != null)
{
// We found a document instead of a collection
_logger.LogDebug($"{target.DestinationUrl}: Found a document instead of a collection");
var collResult = new CollectionActionResult(ActionStatus.OverwriteFailed, foundTarget);
collectionActionResults = collectionActionResults.Add(collResult);
}
else
{
var collTarget = foundTarget as TCollection;
if (collTarget != null)
{
// We found a collection: Business as usual
var collResult = await ExecuteAsync(docUrl, childNode, collTarget, childProperties, cancellationToken).ConfigureAwait(false);
collectionActionResults = collectionActionResults.Add(collResult);
}
else
{
// We didn't find anything: Business as usual
var missingTarget = (TMissing)foundTarget;
var newColl = await missingTarget.CreateCollectionAsync(cancellationToken).ConfigureAwait(false);
var collResult = await ExecuteAsync(docUrl, childNode, newColl, childProperties, cancellationToken).ConfigureAwait(false);
collectionActionResults = collectionActionResults.Add(collResult);
}
}
}
}
try
{
if (_logger.IsEnabled(LogLevel.Trace))
_logger.LogTrace($"Set properties on collection {target.DestinationUrl}.");
var failedPropertyNames = await target.SetPropertiesAsync(properties, cancellationToken).ConfigureAwait(false);
if (failedPropertyNames.Count != 0)
{
_logger.LogDebug($"{target.DestinationUrl}: Failed setting properties {string.Join(", ", failedPropertyNames.Select(x => x.ToString()))}");
return new CollectionActionResult(ActionStatus.PropSetFailed, target)
{
FailedProperties = failedPropertyNames,
CollectionActionResults = collectionActionResults,
DocumentActionResults = documentActionResults,
};
}
await _handler.ExecuteAsync(sourceNode.Collection, target, cancellationToken).ConfigureAwait(false);
}
catch (Exception ex)
{
_logger.LogDebug($"{sourceNode.Collection.Path}: Cleanup failed with exception {ex.Message}");
return new CollectionActionResult(ActionStatus.CleanupFailed, target)
{
Exception = ex,
CollectionActionResults = collectionActionResults,
DocumentActionResults = documentActionResults,
};
}
return new CollectionActionResult(ActionStatus.Created, target)
{
CollectionActionResults = collectionActionResults,
DocumentActionResults = documentActionResults,
};
}
}
}