Merge branch 'staging' into session-mgr-cmp

Author: Equinox-

CONTRIBUTING.md

@@ -1,9 +1,9 @@
 # Making a Pull Request
-* Fork this repository and make sure your local **master** branch is up to date with the main repository.
-* Create a new branch for your addition with an appropriate name, e.g. **add-restart-command**
+* Fork this repository and make sure your local **staging** branch is up to date with the main repository.
+* Create a new branch from the **staging** branch for your addition with an appropriate name, e.g. **add-restart-command**
   * PRs work by submitting the *entire* branch, so this allows you to continue work without locking up your whole repository.
 * Commit your changes to that branch, making sure that you **follow the code guidelines below**.
-* Submit your branch as a PR to be reviewed.
+* Submit your branch as a PR to be reviewed, with Torch's **staging** branch as the base.
 
 ## Naming Conventions
 * Types: **PascalCase**

Jenkins/release.ps1

@@ -0,0 +1,52 @@
+param([string] $ApiBase, [string]$tagName, [string]$authinfo, [string[]] $assetPaths)
+Add-Type -AssemblyName "System.Web"
+
+$headers = @{
+    Authorization = "Basic " + [System.Convert]::ToBase64String([System.Text.Encoding]::ASCII.GetBytes($authinfo))
+    Accept = "application/vnd.github.v3+json"
+}
+try
+{
+	Write-Output("Checking if release with tag " + $tagName + " already exists...")
+	$release = Invoke-RestMethod -Uri ($ApiBase+"releases/tags/$tagName") -Method "GET" -Headers $headers
+	Write-Output("    Using existing release " + $release.id + " at " + $release.html_url)
+} catch {
+	Write-Output("    Doesn't exist")
+	$rel_arg = @{
+	    tag_name=$tagName
+	    name="Generated $tagName"
+	    body=""
+	    draft=$TRUE
+		prerelease=$tagName.Contains("alpha") -or $tagName.Contains("beta")
+	}
+	Write-Output("Creating new release " + $tagName + "...")
+	$release = Invoke-RestMethod -Uri ($ApiBase+"releases") -Method "POST" -Headers $headers -Body (ConvertTo-Json($rel_arg))
+	Write-Output("    Created new release " + $tagName + " at " + $release.html_url)
+}
+
+$assetsApiBase = $release.assets_url
+Write-Output("Checking for existing assets...")
+$existingAssets = Invoke-RestMethod -Uri ($assetsApiBase) -Method "GET" -Headers $headers
+$assetLabels = ($assetPaths | ForEach-Object {[System.IO.Path]::GetFileName($_)})
+foreach ($asset in $existingAssets) {
+	if ($assetLabels -contains $asset.name) {
+		$uri = $asset.url
+		Write-Output("    Deleting old asset " + $asset.name + " (id " + $asset.id + "); URI=" + $uri)
+		$result = Invoke-RestMethod -Uri $uri -Method "DELETE" -Headers $headers
+	}
+}
+Write-Output("Uploading assets...")
+$uploadUrl = $release.upload_url.Substring(0, $release.upload_url.LastIndexOf('{'))
+foreach ($asset in $assetPaths) {
+	$assetName = [System.IO.Path]::GetFileName($asset)
+	$assetType = [System.Web.MimeMapping]::GetMimeMapping($asset)
+	$assetData = [System.IO.File]::ReadAllBytes($asset)
+	$headerExtra = $headers + @{
+		"Content-Type" = $assetType
+		Name = $assetName
+	}
+	$uri = $uploadUrl + "?name=" + $assetName
+	Write-Output("    Uploading " + $asset + " as " + $assetType + "; URI=" + $uri)
+	$result = Invoke-RestMethod -Uri $uri -Method "POST" -Headers $headerExtra -Body $assetData
+	Write-Output("        ID=" + $result.id + ", found at=" + $result.browser_download_url)
+}

Jenkinsfile

@@ -54,4 +54,14 @@ node {
 
 		archiveArtifacts artifacts: 'bin/x64/Release/Torch*', caseSensitive: false, fingerprint: true, onlyIfSuccessful: true
 	}
+
+	gitVersion = bat(returnStdout: true, script: "@git describe --tags").trim()
+	gitSimpleVersion = bat(returnStdout: true, script: "@git describe --tags --abbrev=0").trim()
+	if (gitVersion == gitSimpleVersion) {
+		stage('Release') {
+			withCredentials([usernamePassword(credentialsId: 'torch-github', usernameVariable: 'USERNAME', passwordVariable: 'PASSWORD')]) {
+				powershell "& ./Jenkins/release.ps1 \"https://api.github.com/repos/TorchAPI/Torch/\" \"$gitSimpleVersion\" \"$USERNAME:$PASSWORD\" @(\"bin/torch-server.zip\", \"bin/torch-client.zip\")"
+			}
+		}
+	}
 }

Torch.API/IChatMessage.cs

@@ -3,6 +3,8 @@
 using System.Linq;
 using System.Text;
 using System.Threading.Tasks;
+using Sandbox.Engine.Multiplayer;
+using Sandbox.Game.Multiplayer;
 using VRage.Network;
 
 namespace Torch.API.Managers
@@ -12,6 +14,38 @@ namespace Torch.API.Managers
     /// </summary>
     public struct TorchChatMessage
     {
+        /// <summary>
+        /// Creates a new torch chat message with the given author and message.
+        /// </summary>
+        /// <param name="author">Author's name</param>
+        /// <param name="message">Message</param>
+        public TorchChatMessage(string author, string message)
+        {
+            Timestamp = DateTime.Now;
+            AuthorSteamId = null;
+            Author = author;
+            Message = message;
+            Font = "Blue";
+        }
+
+        /// <summary>
+        /// Creates a new torch chat message with the given author and message.
+        /// </summary>
+        /// <param name="authorSteamId">Author's steam ID</param>
+        /// <param name="message">Message</param>
+        public TorchChatMessage(ulong authorSteamId, string message)
+        {
+            Timestamp = DateTime.Now;
+            AuthorSteamId = authorSteamId;
+            Author = MyMultiplayer.Static?.GetMemberName(authorSteamId) ?? "Player";
+            Message = message;
+            Font = "Blue";
+        }
+
+        /// <summary>
+        /// This message's timestamp.
+        /// </summary>
+        public DateTime Timestamp;
         /// <summary>
         /// The author's steam ID, if available.  Else, null.
         /// </summary>

Torch.API/Managers/IChatManagerClient.cs

@@ -7,14 +7,7 @@
 namespace Torch.API.Managers
 {
     /// <summary>
-    /// Delegate for received messages.
-    /// </summary>
-    /// <param name="message">Message data.</param>
-    /// <param name="sendToOthers">Flag to broadcast message to other players.</param>
-    public delegate void MessageReceivedDel(IChatMessage message, ref bool sendToOthers);
-
-    /// <summary>
-    /// API for multiplayer related functions.
+    /// API for multiplayer related functions common to servers and clients.
     /// </summary>
     public interface IMultiplayerManagerBase : IManager
     {

Torch.API/Managers/IMultiplayerManagerBase.cs

@@ -6,6 +6,9 @@
 
 namespace Torch.API.Managers
 {
+    /// <summary>
+    /// API for multiplayer functions that exist on servers and lobbies
+    /// </summary>
     public interface IMultiplayerManagerServer : IMultiplayerManagerBase
     {
         /// <summary>

Torch.API/Managers/IMultiplayerManagerServer.cs

@@ -25,5 +25,15 @@ public interface ITorchSession
 
         /// <inheritdoc cref="IDependencyManager"/>
         IDependencyManager Managers { get; }
+
+        /// <summary>
+        /// The current state of the session
+        /// </summary>
+        TorchSessionState State { get; }
+
+        /// <summary>
+        /// Event raised when the <see cref="State"/> changes.
+        /// </summary>
+        event TorchSessionStateChangedDel StateChanged;
     }
 }

Torch.API/Session/ITorchSession.cs

@@ -17,31 +17,20 @@ namespace Torch.API.Session
     /// <returns>The manager that will live in the session, or null if none.</returns>
     public delegate IManager SessionManagerFactoryDel(ITorchSession session);
 
-    /// <summary>
-    /// Fired when the given session has been completely loaded or is unloading.
-    /// </summary>
-    /// <param name="session">The session</param>
-    public delegate void TorchSessionLoadDel(ITorchSession session);
-
     /// <summary>
     /// Manages the creation and destruction of <see cref="ITorchSession"/> instances for each <see cref="Sandbox.Game.World.MySession"/> created by Space Engineers.
     /// </summary>
     public interface ITorchSessionManager : IManager
     {
         /// <summary>
-        /// Fired when a <see cref="ITorchSession"/> has finished loading.
-        /// </summary>
-        event TorchSessionLoadDel SessionLoaded;
-
-        /// <summary>
-        /// Fired when a <see cref="ITorchSession"/> has begun unloading.
+        /// The currently running session
         /// </summary>
-        event TorchSessionLoadDel SessionUnloading;
+        ITorchSession CurrentSession { get; }
 
         /// <summary>
-        /// The currently running session
+        /// Raised when any <see cref="ITorchSession"/> <see cref="ITorchSession.State"/> changes.
         /// </summary>
-        ITorchSession CurrentSession { get; }
+        event TorchSessionStateChangedDel SessionStateChanged;
 
         /// <summary>
         /// Adds the given factory as a supplier for session based managers

Torch.API/Session/ITorchSessionManager.cs

@@ -0,0 +1,38 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace Torch.API.Session
+{
+    /// <summary>
+    /// Represents the state of a <see cref="ITorchSession"/>
+    /// </summary>
+    public enum TorchSessionState
+    {
+        /// <summary>
+        /// The session has been created, and is now loading.
+        /// </summary>
+        Loading,
+        /// <summary>
+        /// The session has loaded, and is now running.
+        /// </summary>
+        Loaded,
+        /// <summary>
+        /// The session was running, and is now unloading.
+        /// </summary>
+        Unloading,
+        /// <summary>
+        /// The session was unloading, and is now unloaded and stopped.
+        /// </summary>
+        Unloaded
+    }
+
+    /// <summary>
+    /// Callback raised when a session's state changes
+    /// </summary>
+    /// <param name="session">The session who had a state change</param>
+    /// <param name="newState">The session's new state</param>
+    public delegate void TorchSessionStateChangedDel(ITorchSession session, TorchSessionState newState);
+}