1 using Microsoft.Extensions.Logging;
3 using System.Collections.Generic;
7 using System.Runtime.InteropServices;
8 using System.Security.Cryptography;
10 using System.Threading.Tasks;
21 const string CodeModificationsSubdirectory =
"CodeModifications";
22 const string EventScriptsSubdirectory =
"EventScripts";
23 const string GameStaticFilesSubdirectory =
"GameStaticFiles";
25 const string CodeModificationsHeadFile =
"HeadInclude.dm";
26 const string CodeModificationsTailFile =
"TailInclude.dm";
28 static readonly IReadOnlyDictionary<EventType, string> EventTypeScriptFileNameMap =
new Dictionary<EventType, string>
31 {
EventType.CompileComplete,
"PostCompile" },
32 {
EventType.RepoPreSynchronize,
"PreSynchronize" }
35 static readonly
string SystemScriptFileExtension = RuntimeInformation.IsOSPlatform(OSPlatform.Windows) ?
"bat" :
"sh";
65 readonly ILogger<Configuration>
logger;
83 this.ioManager = ioManager ??
throw new ArgumentNullException(nameof(ioManager));
84 this.synchronousIOManager = synchronousIOManager ??
throw new ArgumentNullException(nameof(synchronousIOManager));
85 this.symlinkFactory = symlinkFactory ??
throw new ArgumentNullException(nameof(symlinkFactory));
86 this.processExecutor = processExecutor ??
throw new ArgumentNullException(nameof(processExecutor));
87 this.postWriteHandler = postWriteHandler ??
throw new ArgumentNullException(nameof(postWriteHandler));
88 this.logger = logger ??
throw new ArgumentNullException(nameof(logger));
90 semaphore =
new SemaphoreSlim(1);
94 public void Dispose() => semaphore.Dispose();
101 Task EnsureDirectories(CancellationToken cancellationToken) => Task.WhenAll(ioManager.CreateDirectory(CodeModificationsSubdirectory, cancellationToken), ioManager.CreateDirectory(EventScriptsSubdirectory, cancellationToken), ioManager.CreateDirectory(GameStaticFilesSubdirectory, cancellationToken));
104 public async Task<ServerSideModifications>
CopyDMFilesTo(
string dmeFile,
string destination, CancellationToken cancellationToken)
109 await EnsureDirectories(cancellationToken).ConfigureAwait(
false);
112 var dmeExistsTask = ioManager.FileExists(ioManager.ConcatPath(CodeModificationsSubdirectory, dmeFile), cancellationToken);
113 var headFileExistsTask = ioManager.FileExists(ioManager.ConcatPath(CodeModificationsSubdirectory, CodeModificationsHeadFile), cancellationToken);
114 var tailFileExistsTask = ioManager.FileExists(ioManager.ConcatPath(CodeModificationsSubdirectory, CodeModificationsTailFile), cancellationToken);
116 await Task.WhenAll(dmeExistsTask, headFileExistsTask, tailFileExistsTask).ConfigureAwait(
false);
118 if (!dmeExistsTask.Result && !headFileExistsTask.Result && !tailFileExistsTask.Result)
121 var copyTask = ioManager.CopyDirectory(CodeModificationsSubdirectory, destination, null, cancellationToken);
123 if (dmeExistsTask.Result)
125 await copyTask.ConfigureAwait(
false);
129 if (!headFileExistsTask.Result && !tailFileExistsTask.Result)
131 await copyTask.ConfigureAwait(
false);
135 string IncludeLine(
string filePath) => String.Format(CultureInfo.InvariantCulture,
"#include \"{0}\"", filePath);
137 await copyTask.ConfigureAwait(
false);
138 return new ServerSideModifications(headFileExistsTask.Result ? IncludeLine(CodeModificationsHeadFile) : null, tailFileExistsTask.Result ? IncludeLine(CodeModificationsTailFile) : null,
false);
144 var nullOrEmptyCheck = String.IsNullOrEmpty(configurationRelativePath);
145 if (nullOrEmptyCheck)
146 configurationRelativePath =
".";
147 if (configurationRelativePath[0] == Path.DirectorySeparatorChar || configurationRelativePath[0] == Path.AltDirectorySeparatorChar)
148 configurationRelativePath =
'.' + configurationRelativePath;
149 var resolved = ioManager.ResolvePath(configurationRelativePath);
150 var local = !nullOrEmptyCheck ? ioManager.ResolvePath(
".") : null;
151 if (!nullOrEmptyCheck && resolved.Length < local.Length)
152 throw new InvalidOperationException(
"Attempted to access file outside of configuration manager!");
157 public async Task<IReadOnlyList<ConfigurationFile>>
ListDirectory(
string configurationRelativePath,
ISystemIdentity systemIdentity, CancellationToken cancellationToken)
159 await EnsureDirectories(cancellationToken).ConfigureAwait(
false);
160 var path = ValidateConfigRelativePath(configurationRelativePath);
162 List<ConfigurationFile> result =
new List<ConfigurationFile>();
166 var enumerator = synchronousIOManager.GetDirectories(path, cancellationToken);
172 Path = ioManager.ConcatPath(path, x),
175 catch (IOException e)
177 logger.LogDebug(
"IOException while writing {0}: {1}", path, e);
181 enumerator = synchronousIOManager.GetFiles(path, cancellationToken);
185 Path = ioManager.ConcatPath(path, x),
190 if (systemIdentity == null)
193 await systemIdentity.
RunImpersonated(ListImpl, cancellationToken).ConfigureAwait(
false);
199 public async Task<ConfigurationFile>
Read(
string configurationRelativePath,
ISystemIdentity systemIdentity, CancellationToken cancellationToken)
201 await EnsureDirectories(cancellationToken).ConfigureAwait(
false);
202 var path = ValidateConfigRelativePath(configurationRelativePath);
211 var content = synchronousIOManager.ReadFile(path);
213 #pragma warning disable CA5350 // Do not use insecure cryptographic algorithm SHA1. 214 using (var sha1 =
new SHA1Managed())
215 #pragma warning restore CA5350
216 sha1String = String.Join(
"", sha1.ComputeHash(content).Select(b => b.ToString(
"x2", CultureInfo.InvariantCulture)));
221 LastReadHash = sha1String,
222 AccessDenied =
false,
223 Path = configurationRelativePath
226 catch (UnauthorizedAccessException)
232 isDirectory = synchronousIOManager.
IsDirectory(path);
241 Path = configurationRelativePath
251 if (systemIdentity == null)
252 await Task.Factory.StartNew(ReadImpl, cancellationToken, TaskCreationOptions.LongRunning, TaskScheduler.Current).ConfigureAwait(
false);
254 await systemIdentity.
RunImpersonated(ReadImpl, cancellationToken).ConfigureAwait(
false);
262 async Task SymlinkBase(
bool files)
264 Task<IReadOnlyList<string>> task;
266 task = ioManager.GetFiles(GameStaticFilesSubdirectory, cancellationToken);
268 task = ioManager.GetDirectories(GameStaticFilesSubdirectory, cancellationToken);
269 var entries = await task.ConfigureAwait(
false);
271 await Task.WhenAll(task.Result.Select(async x =>
273 var destPath = ioManager.ConcatPath(destination, ioManager.GetFileName(x));
274 logger.LogTrace(
"Symlinking {0} to {1}...", x, destPath);
275 var fileExistsTask = ioManager.FileExists(destPath, cancellationToken);
276 if (await ioManager.DirectoryExists(destPath, cancellationToken).ConfigureAwait(false))
277 await ioManager.DeleteDirectory(destPath, cancellationToken).ConfigureAwait(false);
278 var fileExists = await fileExistsTask.ConfigureAwait(false);
280 await ioManager.DeleteFile(destPath, cancellationToken).ConfigureAwait(false);
281 await symlinkFactory.CreateSymbolicLink(ioManager.ResolvePath(x), ioManager.ResolvePath(destPath), cancellationToken).ConfigureAwait(false);
282 })).ConfigureAwait(
false);
287 await EnsureDirectories(cancellationToken).ConfigureAwait(
false);
288 await Task.WhenAll(SymlinkBase(
true), SymlinkBase(
false)).ConfigureAwait(
false);
293 public async Task<ConfigurationFile>
Write(
string configurationRelativePath,
ISystemIdentity systemIdentity, byte[] data,
string previousHash, CancellationToken cancellationToken)
295 await EnsureDirectories(cancellationToken).ConfigureAwait(
false);
296 var path = ValidateConfigRelativePath(configurationRelativePath);
305 var fileHash = previousHash;
306 var success = synchronousIOManager.WriteFileChecked(path, data, ref fileHash, cancellationToken);
313 LastReadHash = fileHash,
314 AccessDenied =
false,
315 Path = configurationRelativePath
318 catch (UnauthorizedAccessException)
324 isDirectory = synchronousIOManager.
IsDirectory(path);
333 Path = configurationRelativePath
343 if (systemIdentity == null)
344 await Task.Factory.StartNew(WriteImpl, cancellationToken, TaskCreationOptions.LongRunning, TaskScheduler.Current).ConfigureAwait(
false);
346 await systemIdentity.
RunImpersonated(WriteImpl, cancellationToken).ConfigureAwait(
false);
354 await EnsureDirectories(cancellationToken).ConfigureAwait(
false);
355 var path = ValidateConfigRelativePath(configurationRelativePath);
358 void DoCreate() => result = synchronousIOManager.CreateDirectory(path, cancellationToken);
361 if (systemIdentity == null)
362 await Task.Factory.StartNew(DoCreate, cancellationToken, TaskCreationOptions.LongRunning, TaskScheduler.Current).ConfigureAwait(
false);
364 await systemIdentity.
RunImpersonated(DoCreate, cancellationToken).ConfigureAwait(
false);
370 public Task StartAsync(CancellationToken cancellationToken) => EnsureDirectories(cancellationToken);
373 public Task StopAsync(CancellationToken cancellationToken) => EnsureDirectories(cancellationToken);
376 public async Task<bool>
HandleEvent(
EventType eventType, IEnumerable<string> parameters, CancellationToken cancellationToken)
378 await EnsureDirectories(cancellationToken).ConfigureAwait(
false);
380 if (!EventTypeScriptFileNameMap.TryGetValue(eventType, out var scriptName))
386 var files = await ioManager.GetFilesWithExtension(EventScriptsSubdirectory, SystemScriptFileExtension, cancellationToken).ConfigureAwait(
false);
387 var resolvedScriptsDir = ioManager.ResolvePath(EventScriptsSubdirectory);
389 foreach (var I
in files.Select(x => ioManager.GetFileName(x)).Where(x => x.StartsWith(scriptName, StringComparison.Ordinal)))
390 using (var script = processExecutor.LaunchProcess(ioManager.ConcatPath(resolvedScriptsDir, I), resolvedScriptsDir, String.Join(
' ', parameters), noShellExecute:
true))
391 using (cancellationToken.Register(() => script.Terminate()))
393 var exitCode = await script.Lifetime.ConfigureAwait(
false);
394 cancellationToken.ThrowIfCancellationRequested();
405 await EnsureDirectories(cancellationToken).ConfigureAwait(
false);
406 var path = ValidateConfigRelativePath(configurationRelativePath);
411 void CheckDeleteImpl() => result = synchronousIOManager.DeleteDirectory(path);
413 if (systemIdentity != null)
414 await systemIdentity.
RunImpersonated(CheckDeleteImpl, cancellationToken).ConfigureAwait(
false);
readonly ISynchronousIOManager synchronousIOManager
The ISynchronousIOManager for Configuration
+
async Task< bool > DeleteDirectory(string configurationRelativePath, ISystemIdentity systemIdentity, CancellationToken cancellationToken)
Attempt to delete an empty directory at configurationRelativePath
async Task< ServerSideModifications > CopyDMFilesTo(string dmeFile, string destination, CancellationToken cancellationToken)
Copies all files in the CodeModifications directory to destination
-
async Task< bool > CreateDirectory(string configurationRelativePath, ISystemIdentity systemIdentity, CancellationToken cancellationToken)
Create an empty directory at configurationRelativePath
-
async Task< ConfigurationFile > Write(string configurationRelativePath, ISystemIdentity systemIdentity, byte[] data, string previousHash, CancellationToken cancellationToken)
Writes to a given configurationRelativePath
+
async Task< bool > CreateDirectory(string configurationRelativePath, ISystemIdentity systemIdentity, CancellationToken cancellationToken)
Create an empty directory at configurationRelativePath
+
async Task< ConfigurationFile > Write(string configurationRelativePath, ISystemIdentity systemIdentity, byte[] data, string previousHash, CancellationToken cancellationToken)
Writes to a given configurationRelativePath
Represents a user on the current System.Runtime.InteropServices.OSPlatform
For launching IProcess'
-
async Task< IReadOnlyList< ConfigurationFile > > ListDirectory(string configurationRelativePath, ISystemIdentity systemIdentity, CancellationToken cancellationToken)
Get ConfigurationFile for all items in a given configurationRelativePath
+
async Task< IReadOnlyList< ConfigurationFile > > ListDirectory(string configurationRelativePath, ISystemIdentity systemIdentity, CancellationToken cancellationToken)
Get ConfigurationFile for all items in a given configurationRelativePath
For creating filesystem symbolic links
readonly IProcessExecutor processExecutor
The IProcessExecutor for Configuration
bool IsDirectory
If Path represents a directory
readonly ILogger< Configuration > logger
The ILogger for Configuration
-
async Task< bool > HandleEvent(EventType eventType, IEnumerable< string > parameters, CancellationToken cancellationToken)
Handle a given eventType
+
async Task< bool > HandleEvent(EventType eventType, IEnumerable< string > parameters, CancellationToken cancellationToken)
Handle a given eventType
For accessing the disk in a synchronous manner
-
string ValidateConfigRelativePath(string configurationRelativePath)
+
string ValidateConfigRelativePath(string configurationRelativePath)
readonly ISymlinkFactory symlinkFactory
The ISymlinkFactory for Configuration
Task RunImpersonated(Action action, CancellationToken cancellationToken)
Runs a given action in the context of the ISystemIdentity
readonly IIOManager ioManager
The IIOManager for Configuration
-
async Task< ConfigurationFile > Read(string configurationRelativePath, ISystemIdentity systemIdentity, CancellationToken cancellationToken)
Reads a given configurationRelativePath
+
async Task< ConfigurationFile > Read(string configurationRelativePath, ISystemIdentity systemIdentity, CancellationToken cancellationToken)
Reads a given configurationRelativePath
Configuration(IIOManager ioManager, ISynchronousIOManager synchronousIOManager, ISymlinkFactory symlinkFactory, IProcessExecutor processExecutor, IPostWriteHandler postWriteHandler, ILogger< Configuration > logger)
Construct Configuration
readonly SemaphoreSlim semaphore
The SemaphoreSlim for Configuration
Represents a game configuration file. Create and delete actions uncerimonuously overwrite/delete file...
@@ -127,7 +128,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
Interface for using filesystems
-
async Task SymlinkStaticFilesTo(string destination, CancellationToken cancellationToken)
Symlinks all directories in the GameData directory to destination
+
async Task SymlinkStaticFilesTo(string destination, CancellationToken cancellationToken)
Symlinks all directories in the GameData directory to destination
static async Task< SemaphoreSlimContext > Lock(SemaphoreSlim semaphore, CancellationToken cancellationToken)
Asyncronously locks a semaphore
diff --git a/_configuration_client_8cs_source.html b/_configuration_client_8cs_source.html
index a21c1cab5f..8d0f182804 100644
--- a/_configuration_client_8cs_source.html
+++ b/_configuration_client_8cs_source.html
@@ -91,19 +91,19 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
ConfigurationClient.cs
+
+
+ 
+
+
+ 
+
+
+ 
+
+ 
Public Member Functions inherited from 
-
- 
+
+ 
-
- 
+
+ 
+
+ 
+
+ 
-
- 