From a3531de91f259ee3b63fc4512a84b6a2023846d5 Mon Sep 17 00:00:00 2001
From: Cyberboss <Cyberboss@users.noreply.github.com>
Date: Wed, 4 Apr 2018 16:29:04 -0400
Subject: [PATCH] IConfigurationClient

---
 .../Models/Configuration.cs                   |  2 +-
 src/Tgstation.Server.Api/RouteHelper.cs       | 13 +++++
 .../Components/IConfigurationClient.cs        | 55 +++++++++++++++++++
 .../Components/IInstanceClient.cs             |  5 ++
 4 files changed, 74 insertions(+), 1 deletion(-)
 create mode 100644 src/Tgstation.Server.Client/Components/IConfigurationClient.cs

diff --git a/src/Tgstation.Server.Api/Models/Configuration.cs b/src/Tgstation.Server.Api/Models/Configuration.cs
index 198956a00d..8497408366 100644
--- a/src/Tgstation.Server.Api/Models/Configuration.cs
+++ b/src/Tgstation.Server.Api/Models/Configuration.cs
@@ -33,7 +33,7 @@ namespace Tgstation.Server.Api.Models
 #pragma warning restore CA1819 // Properties should not return arrays
 
 		/// <summary>
-		/// The MD5 hash of the file when last read by the user. Will be <see langword="null"/> if <see cref="ReadDenied"/> is <see langword="true"/>. If this doesn't match during update actions, the write will be denied
+		/// The MD5 hash of the file when last read by the user. Will be <see langword="null"/> if <see cref="ReadDenied"/> is <see langword="true"/>. If this doesn't match during update actions, the write will be denied with error code 409
 		/// </summary>
 		public string LastReadHash { get; set; }
 	}
diff --git a/src/Tgstation.Server.Api/RouteHelper.cs b/src/Tgstation.Server.Api/RouteHelper.cs
index b833a3f630..82592c0654 100644
--- a/src/Tgstation.Server.Api/RouteHelper.cs
+++ b/src/Tgstation.Server.Api/RouteHelper.cs
@@ -121,6 +121,19 @@ namespace Tgstation.Server.Api
 		/// <returns>A <see cref="Route"/> to the read action</returns>
 		public static Route ReadFile(Instance instance, string path) => new Route { Path = String.Concat("/Configuration/", instance?.Id ?? throw new ArgumentNullException(nameof(instance)), '/', path?.TrimStart('/') ?? throw new ArgumentNullException(nameof(path))), Method = HttpMethod.Get };
 
+		/// <summary>
+		/// Get the <see cref="Route"/> to list <see cref="Configuration"/> files for a <paramref name="directory"/>
+		/// </summary>
+		/// <param name="instance">The <see cref="Instance"/> the <see cref="Configuration"/> file resides in</param>
+		/// <param name="directory">The <see cref="Configuration"/> directory to list</param>
+		/// <returns>A <see cref="Route"/> to the read action</returns>
+		public static Route ListFiles(Instance instance, string directory)
+		{
+			var result = ReadFile(instance, directory);
+			result.Path = String.Concat("/ConfigurationList", result.Path.Substring(result.Path.IndexOf('/', 1)));
+			return result;
+		}
+
 		/// <summary>
 		/// Get the <see cref="Route"/> to create a <see cref="Configuration"/> file
 		/// </summary>
diff --git a/src/Tgstation.Server.Client/Components/IConfigurationClient.cs b/src/Tgstation.Server.Client/Components/IConfigurationClient.cs
new file mode 100644
index 0000000000..7f7d05a477
--- /dev/null
+++ b/src/Tgstation.Server.Client/Components/IConfigurationClient.cs
@@ -0,0 +1,55 @@
+using System;
+using System.Collections.Generic;
+using System.Threading;
+using System.Threading.Tasks;
+using Tgstation.Server.Api.Models;
+using Tgstation.Server.Api.Rights;
+
+namespace Tgstation.Server.Client.Components
+{
+	/// <summary>
+	/// For managing <see cref="Configuration"/> files
+	/// </summary>
+	public interface IConfigurationClient : IRightsClient<ConfigurationRights>
+	{
+		/// <summary>
+		/// List configuration files
+		/// </summary>
+		/// <param name="directory">The path to the directory to list files in</param>
+		/// <param name="cancellationToken">The <see cref="CancellationToken"/> for the operation</param>
+		/// <returns>A <see cref="IReadOnlyList{T}"/> of <see cref="Configuration"/>s in the <paramref name="directory"/></returns>
+		Task<IReadOnlyList<Configuration>> List(string directory, CancellationToken cancellationToken);
+
+		/// <summary>
+		/// Read a <see cref="Configuration"/> file
+		/// </summary>
+		/// <param name="file">The <see cref="Configuration"/> file to read</param>
+		/// <param name="cancellationToken">The <see cref="CancellationToken"/> for the operation</param>
+		/// <returns>A <see cref="Task"/> representing the running operation</returns>
+		Task Read(Configuration file, CancellationToken cancellationToken);
+
+		/// <summary>
+		/// Overwrite a <see cref="Configuration"/> file with integrity checks
+		/// </summary>
+		/// <param name="file">The <see cref="Configuration"/> file to write</param>
+		/// <param name="cancellationToken">The <see cref="CancellationToken"/> for the operation</param>
+		/// <returns>A <see cref="Task"/> representing the running operation</returns>
+		Task Write(Configuration file, CancellationToken cancellationToken);
+
+		/// <summary>
+		/// Create/overwrite a <see cref="Configuration"/> file
+		/// </summary>
+		/// <param name="file">The <see cref="Configuration"/> file to write</param>
+		/// <param name="cancellationToken">The <see cref="CancellationToken"/> for the operation</param>
+		/// <returns>A <see cref="Task"/> representing the running operation</returns>
+		Task Create(Configuration file, CancellationToken cancellationToken);
+
+		/// <summary>
+		/// Delete a <see cref="Configuration"/> file
+		/// </summary>
+		/// <param name="file">The <see cref="Configuration"/> file to delete</param>
+		/// <param name="cancellationToken">The <see cref="CancellationToken"/> for the operation</param>
+		/// <returns>A <see cref="Task"/> representing the running operation</returns>
+		Task Delete(Configuration file, CancellationToken cancellationToken);
+	}
+}
diff --git a/src/Tgstation.Server.Client/Components/IInstanceClient.cs b/src/Tgstation.Server.Client/Components/IInstanceClient.cs
index 0e891f674f..12f2eda8c1 100644
--- a/src/Tgstation.Server.Client/Components/IInstanceClient.cs
+++ b/src/Tgstation.Server.Client/Components/IInstanceClient.cs
@@ -24,6 +24,11 @@ namespace Tgstation.Server.Client.Components
         /// </summary>
         IDreamDaemonClient DreamDaemon { get; }
 
+		/// <summary>
+		/// Access the <see cref="IConfigurationClient"/>
+		/// </summary>
+		IConfigurationClient Configuration { get; }
+
         /// <summary>
         /// Access the <see cref="IInstanceUserClient"/>
         /// </summary>