From be8fe6d26e0b968f0c40ef0c6606d1218403c4bd Mon Sep 17 00:00:00 2001
From: Cyberboss <Cyberboss@users.noreply.github.com>
Date: Mon, 2 Apr 2018 12:11:42 -0400
Subject: [PATCH] Byond client

---
 .../Models/ByondStatus.cs                     | 35 ++++++++++++++++
 .../Components/IByondClient.cs                | 33 +++++++++++++++
 .../Components/IInstanceClient.cs             |  7 +++-
 .../Rights/ByondRights.cs                     | 40 +++++++++++++++++++
 .../Rights/InstanceRights.cs                  | 10 ++++-
 .../Rights/ServerRights.cs                    |  2 +-
 6 files changed, 124 insertions(+), 3 deletions(-)
 create mode 100644 src/Tgstation.Server.Api/Models/ByondStatus.cs
 create mode 100644 src/Tgstation.Server.Client/Components/IByondClient.cs
 create mode 100644 src/Tgstation.Server.Client/Rights/ByondRights.cs

diff --git a/src/Tgstation.Server.Api/Models/ByondStatus.cs b/src/Tgstation.Server.Api/Models/ByondStatus.cs
new file mode 100644
index 0000000000..d722f1c4e7
--- /dev/null
+++ b/src/Tgstation.Server.Api/Models/ByondStatus.cs
@@ -0,0 +1,35 @@
+namespace Tgstation.Server.Api.Models
+{
+	/// <summary>
+	/// The status of a BYOND update job
+	/// </summary>
+#pragma warning disable CA1717 // Only FlagsAttribute enums should have plural names
+	public enum ByondStatus
+#pragma warning restore CA1717 // Only FlagsAttribute enums should have plural names
+	{
+		/// <summary>
+		/// No update in progress
+		/// </summary>
+		Idle,
+		/// <summary>
+		/// Preparing to update
+		/// </summary>
+		Starting,
+		/// <summary>
+		/// Revision is downloading
+		/// </summary>
+		Downloading,
+		/// <summary>
+		/// Revision is deflating
+		/// </summary>
+		Staging,
+		/// <summary>
+		/// Revision is ready and waiting for DreamDaemon reboot
+		/// </summary>
+		Staged,
+		/// <summary>
+		/// Revision is being applied
+		/// </summary>
+		Updating,
+	}
+}
diff --git a/src/Tgstation.Server.Client/Components/IByondClient.cs b/src/Tgstation.Server.Client/Components/IByondClient.cs
new file mode 100644
index 0000000000..76291f4347
--- /dev/null
+++ b/src/Tgstation.Server.Client/Components/IByondClient.cs
@@ -0,0 +1,33 @@
+using System;
+using System.Threading.Tasks;
+using Tgstation.Server.Api.Models;
+using Tgstation.Server.Client.Rights;
+
+namespace Tgstation.Server.Client.Components
+{
+	/// <summary>
+	/// For managing the BYOND installation
+	/// </summary>
+	public interface IByondClient : IClient<ByondRights>
+	{
+		/// <summary>
+		/// Gets the current status of any BYOND updates
+		/// </summary>
+		/// <returns>A <see cref="Task{TResult}"/> resulting in the <see cref="ByondStatus"/> updater</returns>
+		Task<ByondStatus> CurrentStatus();
+
+		/// <summary>
+		/// Updates the installed BYOND <see cref="Version"/>
+		/// </summary>
+		/// <param name="version">The <see cref="Version"/> to update to. Only considers the <see cref="Version.Major"/> and <see cref="Version.Minor"/> numbers</param>
+		/// <returns>A <see cref="Task"/> representing the running operation</returns>
+		Task UpdateToVersion(Version version);
+
+		/// <summary>
+		/// Get the currently installed BYOND <see cref="Version"/>
+		/// </summary>
+		/// <param name="staged">Read the staged <see cref="Version"/> instead if applicable</param>
+		/// <returns>A <see cref="Task{TResult}"/> resulting in the installed BYOND version or <see langword="null"/> if none is installed</returns>
+		Task<Version> GetVersion(bool staged);
+	}
+}
diff --git a/src/Tgstation.Server.Client/Components/IInstanceClient.cs b/src/Tgstation.Server.Client/Components/IInstanceClient.cs
index 29d6d50a1c..6dd435c045 100644
--- a/src/Tgstation.Server.Client/Components/IInstanceClient.cs
+++ b/src/Tgstation.Server.Client/Components/IInstanceClient.cs
@@ -1,7 +1,7 @@
 using Tgstation.Server.Api.Models;
 using Tgstation.Server.Client.Rights;
 
-namespace Tgstation.Server.Client
+namespace Tgstation.Server.Client.Components
 {
 	/// <summary>
 	/// <see cref="IClient{TRights}"/> for server instances
@@ -12,5 +12,10 @@ namespace Tgstation.Server.Client
 		/// The <see cref="Instance"/> of the <see cref="IInstanceClient"/>
 		/// </summary>
 		Instance Metadata { get; }
+
+		/// <summary>
+		/// Access the <see cref="IByondClient"/>
+		/// </summary>
+		IByondClient Byond { get; }
 	}
 }
\ No newline at end of file
diff --git a/src/Tgstation.Server.Client/Rights/ByondRights.cs b/src/Tgstation.Server.Client/Rights/ByondRights.cs
new file mode 100644
index 0000000000..3c17bc4439
--- /dev/null
+++ b/src/Tgstation.Server.Client/Rights/ByondRights.cs
@@ -0,0 +1,40 @@
+using System;
+
+namespace Tgstation.Server.Client.Rights
+{
+	/// <summary>
+	/// Rights for <see cref="Components.IByondClient"/>
+	/// </summary>
+	[Flags]
+	public enum ByondRights
+	{
+		/// <summary>
+		/// User has no rights
+		/// </summary>
+		None = 0,
+		/// <summary>
+		/// User may check the installed BYOND version
+		/// </summary>
+		ReadInstalled = 1,
+		/// <summary>
+		/// User may check the staged BYOND version
+		/// </summary>
+		ReadStaged = 2,
+		/// <summary>
+		/// User may install any BYOND version if none is installed
+		/// </summary>
+		Install = 4,
+		/// <summary>
+		/// User may upgrade the installed BYOND version
+		/// </summary>
+		Upgrade = 8,
+		/// <summary>
+		/// User may downgrade the installed BYOND version
+		/// </summary>
+		Downgrade = 16,
+		/// <summary>
+		/// User may cancel any pending installation job
+		/// </summary>
+		Cancel = 32
+	}
+}
diff --git a/src/Tgstation.Server.Client/Rights/InstanceRights.cs b/src/Tgstation.Server.Client/Rights/InstanceRights.cs
index 20b2998f72..0613badfc2 100644
--- a/src/Tgstation.Server.Client/Rights/InstanceRights.cs
+++ b/src/Tgstation.Server.Client/Rights/InstanceRights.cs
@@ -3,10 +3,18 @@
 namespace Tgstation.Server.Client.Rights
 {
 	/// <summary>
-	/// Rights for an <see cref="IInstanceClient"/>
+	/// Rights for an <see cref="Components.IInstanceClient"/>
 	/// </summary>
 	[Flags]
 	public enum InstanceRights
 	{
+		/// <summary>
+		/// User has no rights
+		/// </summary>
+		None = 0,
+		/// <summary>
+		/// Allow access to <see cref="Components.IByondClient"/>
+		/// </summary>
+		Byond = 1,
 	}
 }
diff --git a/src/Tgstation.Server.Client/Rights/ServerRights.cs b/src/Tgstation.Server.Client/Rights/ServerRights.cs
index d875941010..640f44dc3f 100644
--- a/src/Tgstation.Server.Client/Rights/ServerRights.cs
+++ b/src/Tgstation.Server.Client/Rights/ServerRights.cs
@@ -9,7 +9,7 @@ namespace Tgstation.Server.Client.Rights
 	public enum ServerRights
 	{
 		/// <summary>
-		/// Client has no rights
+		/// User has no rights
 		/// </summary>
 		None = 0,
 		/// <summary>