1
0
mirror of https://github.com/chylex/Minecraft-Phantom-Panel.git synced 2025-09-15 15:32:10 +02:00

15 Commits

64 changed files with 959 additions and 494 deletions

View File

@@ -1,28 +1,25 @@
using System.Diagnostics; using Phantom.Utils.Collections;
using Phantom.Utils.Collections;
using Phantom.Utils.Runtime; using Phantom.Utils.Runtime;
namespace Phantom.Agent.Minecraft.Instance; namespace Phantom.Agent.Minecraft.Instance;
public sealed class InstanceSession : IDisposable { public sealed class InstanceProcess : IDisposable {
public InstanceProperties InstanceProperties { get; } public InstanceProperties InstanceProperties { get; }
public CancellableSemaphore BackupSemaphore { get; } = new (1, 1); public CancellableSemaphore BackupSemaphore { get; } = new (1, 1);
private readonly RingBuffer<string> outputBuffer = new (10000); private readonly RingBuffer<string> outputBuffer = new (10000);
private event EventHandler<string>? OutputEvent; private event EventHandler<string>? OutputEvent;
public event EventHandler? SessionEnded; public event EventHandler? Ended;
public bool HasEnded { get; private set; } public bool HasEnded { get; private set; }
private readonly Process process; private readonly Process process;
internal InstanceSession(InstanceProperties instanceProperties, Process process) { internal InstanceProcess(InstanceProperties instanceProperties, Process process) {
this.InstanceProperties = instanceProperties; this.InstanceProperties = instanceProperties;
this.process = process; this.process = process;
this.process.EnableRaisingEvents = true;
this.process.Exited += ProcessOnExited; this.process.Exited += ProcessOnExited;
this.process.OutputDataReceived += HandleOutputLine; this.process.OutputReceived += ProcessOutputReceived;
this.process.ErrorDataReceived += HandleOutputLine;
} }
public async Task SendCommand(string command, CancellationToken cancellationToken) { public async Task SendCommand(string command, CancellationToken cancellationToken) {
@@ -41,17 +38,15 @@ public sealed class InstanceSession : IDisposable {
OutputEvent -= listener; OutputEvent -= listener;
} }
private void HandleOutputLine(object sender, DataReceivedEventArgs args) { private void ProcessOutputReceived(object? sender, Process.Output output) {
if (args.Data is {} line) { outputBuffer.Add(output.Line);
outputBuffer.Add(line); OutputEvent?.Invoke(this, output.Line);
OutputEvent?.Invoke(this, line);
}
} }
private void ProcessOnExited(object? sender, EventArgs e) { private void ProcessOnExited(object? sender, EventArgs e) {
OutputEvent = null; OutputEvent = null;
HasEnded = true; HasEnded = true;
SessionEnded?.Invoke(this, EventArgs.Empty); Ended?.Invoke(this, EventArgs.Empty);
} }
public void Kill() { public void Kill() {
@@ -68,6 +63,6 @@ public sealed class InstanceSession : IDisposable {
process.Dispose(); process.Dispose();
BackupSemaphore.Dispose(); BackupSemaphore.Dispose();
OutputEvent = null; OutputEvent = null;
SessionEnded = null; Ended = null;
} }
} }

View File

@@ -1,6 +1,7 @@
using System.Collections.Immutable; using System.Collections.Immutable;
using Phantom.Agent.Minecraft.Java; using Phantom.Agent.Minecraft.Java;
using Phantom.Agent.Minecraft.Properties; using Phantom.Agent.Minecraft.Properties;
using Phantom.Common.Data.Instance;
namespace Phantom.Agent.Minecraft.Instance; namespace Phantom.Agent.Minecraft.Instance;
@@ -11,5 +12,6 @@ public sealed record InstanceProperties(
ImmutableArray<string> JvmArguments, ImmutableArray<string> JvmArguments,
string InstanceFolder, string InstanceFolder,
string ServerVersion, string ServerVersion,
ServerProperties ServerProperties ServerProperties ServerProperties,
InstanceLaunchProperties LaunchProperties
); );

View File

@@ -1,17 +1,19 @@
using System.Diagnostics; using System.Text;
using System.Text;
using Kajabity.Tools.Java; using Kajabity.Tools.Java;
using Phantom.Agent.Minecraft.Instance; using Phantom.Agent.Minecraft.Instance;
using Phantom.Agent.Minecraft.Java; using Phantom.Agent.Minecraft.Java;
using Phantom.Agent.Minecraft.Server; using Phantom.Agent.Minecraft.Server;
using Phantom.Common.Minecraft; using Phantom.Common.Minecraft;
using Phantom.Utils.Runtime;
using Serilog; using Serilog;
namespace Phantom.Agent.Minecraft.Launcher; namespace Phantom.Agent.Minecraft.Launcher;
public abstract class BaseLauncher { public abstract class BaseLauncher : IServerLauncher {
private readonly InstanceProperties instanceProperties; private readonly InstanceProperties instanceProperties;
protected string MinecraftVersion => instanceProperties.ServerVersion;
private protected BaseLauncher(InstanceProperties instanceProperties) { private protected BaseLauncher(InstanceProperties instanceProperties) {
this.instanceProperties = instanceProperties; this.instanceProperties = instanceProperties;
} }
@@ -25,33 +27,25 @@ public abstract class BaseLauncher {
return new LaunchResult.InvalidJvmArguments(); return new LaunchResult.InvalidJvmArguments();
} }
var vanillaServerJarPath = await services.ServerExecutables.DownloadAndGetPath(instanceProperties.ServerVersion, downloadProgressEventHandler, cancellationToken); var vanillaServerJarPath = await services.ServerExecutables.DownloadAndGetPath(instanceProperties.LaunchProperties.ServerDownloadInfo, MinecraftVersion, downloadProgressEventHandler, cancellationToken);
if (vanillaServerJarPath == null) { if (vanillaServerJarPath == null) {
return new LaunchResult.CouldNotDownloadMinecraftServer(); return new LaunchResult.CouldNotDownloadMinecraftServer();
} }
var startInfo = new ProcessStartInfo { ServerJarInfo? serverJar;
FileName = javaRuntimeExecutable.ExecutablePath, try {
WorkingDirectory = instanceProperties.InstanceFolder, serverJar = await PrepareServerJar(logger, vanillaServerJarPath, cancellationToken);
RedirectStandardInput = true, } catch (OperationCanceledException) {
RedirectStandardOutput = true, throw;
RedirectStandardError = true, } catch (Exception e) {
UseShellExecute = false, logger.Error(e, "Caught exception while preparing the server jar.");
CreateNoWindow = false return new LaunchResult.CouldNotPrepareMinecraftServerLauncher();
}; }
var jvmArguments = new JvmArgumentBuilder(instanceProperties.JvmProperties, instanceProperties.JvmArguments); if (!File.Exists(serverJar.FilePath)) {
CustomizeJvmArguments(jvmArguments); logger.Error("Missing prepared server or launcher jar: {FilePath}", serverJar.FilePath);
return new LaunchResult.CouldNotPrepareMinecraftServerLauncher();
var serverJarPath = await PrepareServerJar(vanillaServerJarPath, instanceProperties.InstanceFolder, cancellationToken); }
var processArguments = startInfo.ArgumentList;
jvmArguments.Build(processArguments);
processArguments.Add("-jar");
processArguments.Add(serverJarPath);
processArguments.Add("nogui");
var process = new Process { StartInfo = startInfo };
var session = new InstanceSession(instanceProperties, process);
try { try {
await AcceptEula(instanceProperties); await AcceptEula(instanceProperties);
@@ -61,10 +55,32 @@ public abstract class BaseLauncher {
return new LaunchResult.CouldNotConfigureMinecraftServer(); return new LaunchResult.CouldNotConfigureMinecraftServer();
} }
var processConfigurator = new ProcessConfigurator {
FileName = javaRuntimeExecutable.ExecutablePath,
WorkingDirectory = instanceProperties.InstanceFolder,
RedirectInput = true,
UseShellExecute = false
};
var jvmArguments = new JvmArgumentBuilder(instanceProperties.JvmProperties, instanceProperties.JvmArguments);
CustomizeJvmArguments(jvmArguments);
var processArguments = processConfigurator.ArgumentList;
jvmArguments.Build(processArguments);
foreach (var extraArgument in serverJar.ExtraArgs) {
processArguments.Add(extraArgument);
}
processArguments.Add("-jar");
processArguments.Add(serverJar.FilePath);
processArguments.Add("nogui");
var process = processConfigurator.CreateProcess();
var instanceProcess = new InstanceProcess(instanceProperties, process);
try { try {
process.Start(); process.Start();
process.BeginOutputReadLine();
process.BeginErrorReadLine();
} catch (Exception launchException) { } catch (Exception launchException) {
logger.Error(launchException, "Caught exception launching the server process."); logger.Error(launchException, "Caught exception launching the server process.");
@@ -77,13 +93,13 @@ public abstract class BaseLauncher {
return new LaunchResult.CouldNotStartMinecraftServer(); return new LaunchResult.CouldNotStartMinecraftServer();
} }
return new LaunchResult.Success(session); return new LaunchResult.Success(instanceProcess);
} }
private protected virtual void CustomizeJvmArguments(JvmArgumentBuilder arguments) {} private protected virtual void CustomizeJvmArguments(JvmArgumentBuilder arguments) {}
private protected virtual Task<string> PrepareServerJar(string serverJarPath, string instanceFolderPath, CancellationToken cancellationToken) { private protected virtual Task<ServerJarInfo> PrepareServerJar(ILogger logger, string serverJarPath, CancellationToken cancellationToken) {
return Task.FromResult(serverJarPath); return Task.FromResult(new ServerJarInfo(serverJarPath));
} }
private static async Task AcceptEula(InstanceProperties instanceProperties) { private static async Task AcceptEula(InstanceProperties instanceProperties) {

View File

@@ -0,0 +1,8 @@
using Phantom.Agent.Minecraft.Server;
using Serilog;
namespace Phantom.Agent.Minecraft.Launcher;
public interface IServerLauncher {
Task<LaunchResult> Launch(ILogger logger, LaunchServices services, EventHandler<DownloadProgressEventArgs> downloadProgressEventHandler, CancellationToken cancellationToken);
}

View File

@@ -5,7 +5,7 @@ namespace Phantom.Agent.Minecraft.Launcher;
public abstract record LaunchResult { public abstract record LaunchResult {
private LaunchResult() {} private LaunchResult() {}
public sealed record Success(InstanceSession Session) : LaunchResult; public sealed record Success(InstanceProcess Process) : LaunchResult;
public sealed record InvalidJavaRuntime : LaunchResult; public sealed record InvalidJavaRuntime : LaunchResult;
@@ -13,6 +13,8 @@ public abstract record LaunchResult {
public sealed record CouldNotDownloadMinecraftServer : LaunchResult; public sealed record CouldNotDownloadMinecraftServer : LaunchResult;
public sealed record CouldNotPrepareMinecraftServerLauncher : LaunchResult;
public sealed record CouldNotConfigureMinecraftServer : LaunchResult; public sealed record CouldNotConfigureMinecraftServer : LaunchResult;
public sealed record CouldNotStartMinecraftServer : LaunchResult; public sealed record CouldNotStartMinecraftServer : LaunchResult;

View File

@@ -0,0 +1,7 @@
using System.Collections.Immutable;
namespace Phantom.Agent.Minecraft.Launcher;
sealed record ServerJarInfo(string FilePath, ImmutableArray<string> ExtraArgs) {
public ServerJarInfo(string filePath) : this(filePath, ImmutableArray<string>.Empty) {}
}

View File

@@ -0,0 +1,55 @@
using System.Collections.Immutable;
using Phantom.Agent.Minecraft.Instance;
using Phantom.Utils.IO;
using Serilog;
namespace Phantom.Agent.Minecraft.Launcher.Types;
public sealed class FabricLauncher : BaseLauncher {
public FabricLauncher(InstanceProperties instanceProperties) : base(instanceProperties) {}
private protected override async Task<ServerJarInfo> PrepareServerJar(ILogger logger, string serverJarPath, CancellationToken cancellationToken) {
var serverJarParentFolderPath = Directory.GetParent(serverJarPath);
if (serverJarParentFolderPath == null) {
throw new ArgumentException("Could not get parent folder from: " + serverJarPath, nameof(serverJarPath));
}
var launcherJarPath = Path.Combine(serverJarParentFolderPath.FullName, "fabric.jar");
if (!File.Exists(launcherJarPath)) {
await DownloadLauncher(logger, launcherJarPath, cancellationToken);
}
return new ServerJarInfo(launcherJarPath, ImmutableArray.Create("-Dfabric.installer.server.gameJar=" + Paths.NormalizeSlashes(serverJarPath)));
}
private async Task DownloadLauncher(ILogger logger, string targetFilePath, CancellationToken cancellationToken) {
// TODO customizable loader version, probably with a dedicated temporary folder
string installerUrl = $"https://meta.fabricmc.net/v2/versions/loader/{MinecraftVersion}/stable/stable/server/jar";
logger.Information("Downloading Fabric launcher from: {Url}", installerUrl);
using var http = new HttpClient();
var response = await http.GetAsync(installerUrl, HttpCompletionOption.ResponseHeadersRead, cancellationToken);
response.EnsureSuccessStatusCode();
try {
await using var fileStream = new FileStream(targetFilePath, FileMode.CreateNew, FileAccess.Write, FileShare.Read);
await using var responseStream = await response.Content.ReadAsStreamAsync(cancellationToken);
await responseStream.CopyToAsync(fileStream, cancellationToken);
} catch (Exception) {
TryDeleteLauncherAfterFailure(logger, targetFilePath);
throw;
}
}
private static void TryDeleteLauncherAfterFailure(ILogger logger, string filePath) {
if (File.Exists(filePath)) {
try {
File.Delete(filePath);
} catch (Exception e) {
logger.Warning(e, "Could not clean up partially downloaded Fabric launcher: {FilePath}", filePath);
}
}
}
}

View File

@@ -0,0 +1,12 @@
using Phantom.Agent.Minecraft.Instance;
using Phantom.Agent.Minecraft.Java;
namespace Phantom.Agent.Minecraft.Launcher.Types;
public class ForgeLauncher : BaseLauncher {
public ForgeLauncher(InstanceProperties instanceProperties) : base(instanceProperties) {}
private protected override void CustomizeJvmArguments(JvmArgumentBuilder arguments) {
arguments.AddProperty("terminal.ansi", "true"); // TODO
}
}

View File

@@ -0,0 +1,14 @@
using Phantom.Agent.Minecraft.Server;
using Serilog;
namespace Phantom.Agent.Minecraft.Launcher.Types;
public sealed class InvalidLauncher : IServerLauncher {
public static InvalidLauncher Instance { get; } = new ();
private InvalidLauncher() {}
public Task<LaunchResult> Launch(ILogger logger, LaunchServices services, EventHandler<DownloadProgressEventArgs> downloadProgressEventHandler, CancellationToken cancellationToken) {
return Task.FromResult<LaunchResult>(new LaunchResult.CouldNotPrepareMinecraftServerLauncher());
}
}

View File

@@ -17,6 +17,7 @@
<ProjectReference Include="..\..\Utils\Phantom.Utils.Collections\Phantom.Utils.Collections.csproj" /> <ProjectReference Include="..\..\Utils\Phantom.Utils.Collections\Phantom.Utils.Collections.csproj" />
<ProjectReference Include="..\..\Utils\Phantom.Utils.Cryptography\Phantom.Utils.Cryptography.csproj" /> <ProjectReference Include="..\..\Utils\Phantom.Utils.Cryptography\Phantom.Utils.Cryptography.csproj" />
<ProjectReference Include="..\..\Utils\Phantom.Utils.IO\Phantom.Utils.IO.csproj" /> <ProjectReference Include="..\..\Utils\Phantom.Utils.IO\Phantom.Utils.IO.csproj" />
<ProjectReference Include="..\..\Utils\Phantom.Utils.Runtime\Phantom.Utils.Runtime.csproj" />
</ItemGroup> </ItemGroup>
</Project> </Project>

View File

@@ -1,6 +1,6 @@
using System.Security.Cryptography; using System.Security.Cryptography;
using Phantom.Common.Data.Minecraft;
using Phantom.Common.Logging; using Phantom.Common.Logging;
using Phantom.Common.Minecraft;
using Phantom.Utils.Cryptography; using Phantom.Utils.Cryptography;
using Phantom.Utils.IO; using Phantom.Utils.IO;
using Phantom.Utils.Runtime; using Phantom.Utils.Runtime;
@@ -11,8 +11,6 @@ namespace Phantom.Agent.Minecraft.Server;
sealed class MinecraftServerExecutableDownloader { sealed class MinecraftServerExecutableDownloader {
private static readonly ILogger Logger = PhantomLogger.Create<MinecraftServerExecutableDownloader>(); private static readonly ILogger Logger = PhantomLogger.Create<MinecraftServerExecutableDownloader>();
private readonly MinecraftVersions minecraftVersions;
public Task<string?> Task { get; } public Task<string?> Task { get; }
public event EventHandler<DownloadProgressEventArgs>? DownloadProgress; public event EventHandler<DownloadProgressEventArgs>? DownloadProgress;
public event EventHandler? Completed; public event EventHandler? Completed;
@@ -20,17 +18,15 @@ sealed class MinecraftServerExecutableDownloader {
private readonly CancellationTokenSource cancellationTokenSource = new (); private readonly CancellationTokenSource cancellationTokenSource = new ();
private int listeners = 0; private int listeners = 0;
public MinecraftServerExecutableDownloader(MinecraftVersions minecraftVersions, string version, string filePath, MinecraftServerExecutableDownloadListener listener) { public MinecraftServerExecutableDownloader(FileDownloadInfo fileDownloadInfo, string minecraftVersion, string filePath, MinecraftServerExecutableDownloadListener listener) {
this.minecraftVersions = minecraftVersions;
Register(listener); Register(listener);
Task = DownloadAndGetPath(version, filePath); Task = DownloadAndGetPath(fileDownloadInfo, minecraftVersion, filePath);
Task.ContinueWith(OnCompleted, TaskScheduler.Default); Task.ContinueWith(OnCompleted, TaskScheduler.Default);
} }
public void Register(MinecraftServerExecutableDownloadListener listener) { public void Register(MinecraftServerExecutableDownloadListener listener) {
++listeners; ++listeners;
Logger.Verbose("Registered download listener, current listener count: {Listeners}", listeners); Logger.Debug("Registered download listener, current listener count: {Listeners}", listeners);
DownloadProgress += listener.DownloadProgressEventHandler; DownloadProgress += listener.DownloadProgressEventHandler;
listener.CancellationToken.Register(Unregister, listener); listener.CancellationToken.Register(Unregister, listener);
@@ -41,11 +37,11 @@ sealed class MinecraftServerExecutableDownloader {
DownloadProgress -= listener.DownloadProgressEventHandler; DownloadProgress -= listener.DownloadProgressEventHandler;
if (--listeners <= 0) { if (--listeners <= 0) {
Logger.Verbose("Unregistered last download listener, cancelling download."); Logger.Debug("Unregistered last download listener, cancelling download.");
cancellationTokenSource.Cancel(); cancellationTokenSource.Cancel();
} }
else { else {
Logger.Verbose("Unregistered download listener, current listener count: {Listeners}", listeners); Logger.Debug("Unregistered download listener, current listener count: {Listeners}", listeners);
} }
} }
@@ -54,7 +50,7 @@ sealed class MinecraftServerExecutableDownloader {
} }
private void OnCompleted(Task task) { private void OnCompleted(Task task) {
Logger.Verbose("Download task completed."); Logger.Debug("Download task completed.");
Completed?.Invoke(this, EventArgs.Empty); Completed?.Invoke(this, EventArgs.Empty);
Completed = null; Completed = null;
DownloadProgress = null; DownloadProgress = null;
@@ -72,33 +68,26 @@ sealed class MinecraftServerExecutableDownloader {
} }
} }
private async Task<string?> DownloadAndGetPath(string version, string filePath) { private async Task<string?> DownloadAndGetPath(FileDownloadInfo fileDownloadInfo, string minecraftVersion, string filePath) {
Logger.Information("Downloading server version {Version}...", version);
string tmpFilePath = filePath + ".tmp"; string tmpFilePath = filePath + ".tmp";
var cancellationToken = cancellationTokenSource.Token; var cancellationToken = cancellationTokenSource.Token;
try { try {
var serverExecutableInfo = await minecraftVersions.GetServerExecutableInfo(version, cancellationToken); Logger.Information("Downloading server version {Version} from: {Url} ({Size})", minecraftVersion, fileDownloadInfo.DownloadUrl, fileDownloadInfo.Size.ToHumanReadable(decimalPlaces: 1));
if (serverExecutableInfo == null) {
return null;
}
Logger.Information("Downloading server executable from: {Url} ({Size})", serverExecutableInfo.DownloadUrl, serverExecutableInfo.Size.ToHumanReadable(decimalPlaces: 1));
try { try {
using var http = new HttpClient(); using var http = new HttpClient();
await FetchServerExecutableFile(http, new DownloadProgressCallback(this), serverExecutableInfo, tmpFilePath, cancellationToken); await FetchServerExecutableFile(http, new DownloadProgressCallback(this), fileDownloadInfo, tmpFilePath, cancellationToken);
} catch (Exception) { } catch (Exception) {
TryDeleteExecutableAfterFailure(tmpFilePath); TryDeleteExecutableAfterFailure(tmpFilePath);
throw; throw;
} }
File.Move(tmpFilePath, filePath, true); File.Move(tmpFilePath, filePath, true);
Logger.Information("Server version {Version} downloaded.", version); Logger.Information("Server version {Version} downloaded.", minecraftVersion);
return filePath; return filePath;
} catch (OperationCanceledException) { } catch (OperationCanceledException) {
Logger.Information("Download for server version {Version} was cancelled.", version); Logger.Information("Download for server version {Version} was cancelled.", minecraftVersion);
throw; throw;
} catch (StopProcedureException) { } catch (StopProcedureException) {
return null; return null;
@@ -110,17 +99,17 @@ sealed class MinecraftServerExecutableDownloader {
} }
} }
private static async Task FetchServerExecutableFile(HttpClient http, DownloadProgressCallback progressCallback, MinecraftServerExecutableInfo info, string filePath, CancellationToken cancellationToken) { private static async Task FetchServerExecutableFile(HttpClient http, DownloadProgressCallback progressCallback, FileDownloadInfo fileDownloadInfo, string filePath, CancellationToken cancellationToken) {
Sha1String downloadedFileHash; Sha1String downloadedFileHash;
try { try {
var response = await http.GetAsync(info.DownloadUrl, HttpCompletionOption.ResponseHeadersRead, cancellationToken); var response = await http.GetAsync(fileDownloadInfo.DownloadUrl, HttpCompletionOption.ResponseHeadersRead, cancellationToken);
response.EnsureSuccessStatusCode(); response.EnsureSuccessStatusCode();
await using var fileStream = new FileStream(filePath, FileMode.CreateNew, FileAccess.Write, FileShare.Read); await using var fileStream = new FileStream(filePath, FileMode.CreateNew, FileAccess.Write, FileShare.Read);
await using var responseStream = await response.Content.ReadAsStreamAsync(cancellationToken); await using var responseStream = await response.Content.ReadAsStreamAsync(cancellationToken);
using var streamCopier = new MinecraftServerDownloadStreamCopier(progressCallback, info.Size.Bytes); using var streamCopier = new MinecraftServerDownloadStreamCopier(progressCallback, fileDownloadInfo.Size.Bytes);
downloadedFileHash = await streamCopier.Copy(responseStream, fileStream, cancellationToken); downloadedFileHash = await streamCopier.Copy(responseStream, fileStream, cancellationToken);
} catch (OperationCanceledException) { } catch (OperationCanceledException) {
throw; throw;
@@ -129,8 +118,8 @@ sealed class MinecraftServerExecutableDownloader {
throw StopProcedureException.Instance; throw StopProcedureException.Instance;
} }
if (!downloadedFileHash.Equals(info.Hash)) { if (!downloadedFileHash.Equals(fileDownloadInfo.Hash)) {
Logger.Error("Downloaded server executable has mismatched SHA1 hash. Expected {Expected}, got {Actual}.", info.Hash, downloadedFileHash); Logger.Error("Downloaded server executable has mismatched SHA1 hash. Expected {Expected}, got {Actual}.", fileDownloadInfo.Hash, downloadedFileHash);
throw StopProcedureException.Instance; throw StopProcedureException.Instance;
} }
} }

View File

@@ -1,33 +1,37 @@
using System.Text.RegularExpressions; using System.Text.RegularExpressions;
using Phantom.Common.Data.Minecraft;
using Phantom.Common.Logging; using Phantom.Common.Logging;
using Phantom.Common.Minecraft;
using Phantom.Utils.IO; using Phantom.Utils.IO;
using Serilog; using Serilog;
namespace Phantom.Agent.Minecraft.Server; namespace Phantom.Agent.Minecraft.Server;
public sealed partial class MinecraftServerExecutables : IDisposable { public sealed partial class MinecraftServerExecutables {
private static readonly ILogger Logger = PhantomLogger.Create<MinecraftServerExecutables>(); private static readonly ILogger Logger = PhantomLogger.Create<MinecraftServerExecutables>();
[GeneratedRegex(@"[^a-zA-Z0-9_\-\.]", RegexOptions.Compiled)] [GeneratedRegex(@"[^a-zA-Z0-9_\-\.]", RegexOptions.Compiled)]
private static partial Regex VersionFolderSanitizeRegex(); private static partial Regex VersionFolderSanitizeRegex();
private readonly string basePath; private readonly string basePath;
private readonly MinecraftVersions minecraftVersions = new ();
private readonly Dictionary<string, MinecraftServerExecutableDownloader> runningDownloadersByVersion = new (); private readonly Dictionary<string, MinecraftServerExecutableDownloader> runningDownloadersByVersion = new ();
public MinecraftServerExecutables(string basePath) { public MinecraftServerExecutables(string basePath) {
this.basePath = basePath; this.basePath = basePath;
} }
internal async Task<string?> DownloadAndGetPath(string version, EventHandler<DownloadProgressEventArgs> progressEventHandler, CancellationToken cancellationToken) { internal async Task<string?> DownloadAndGetPath(FileDownloadInfo? fileDownloadInfo, string minecraftVersion, EventHandler<DownloadProgressEventArgs> progressEventHandler, CancellationToken cancellationToken) {
string serverExecutableFolderPath = Path.Combine(basePath, VersionFolderSanitizeRegex().Replace(version, "_")); string serverExecutableFolderPath = Path.Combine(basePath, VersionFolderSanitizeRegex().Replace(minecraftVersion, "_"));
string serverExecutableFilePath = Path.Combine(serverExecutableFolderPath, "server.jar"); string serverExecutableFilePath = Path.Combine(serverExecutableFolderPath, "server.jar");
if (File.Exists(serverExecutableFilePath)) { if (File.Exists(serverExecutableFilePath)) {
return serverExecutableFilePath; return serverExecutableFilePath;
} }
if (fileDownloadInfo == null) {
Logger.Error("Unable to download server executable for version {Version} because no download info was provided.", minecraftVersion);
return null;
}
try { try {
Directories.Create(serverExecutableFolderPath, Chmod.URWX_GRX); Directories.Create(serverExecutableFolderPath, Chmod.URWX_GRX);
} catch (Exception e) { } catch (Exception e) {
@@ -39,26 +43,22 @@ public sealed partial class MinecraftServerExecutables : IDisposable {
MinecraftServerExecutableDownloadListener listener = new (progressEventHandler, cancellationToken); MinecraftServerExecutableDownloadListener listener = new (progressEventHandler, cancellationToken);
lock (this) { lock (this) {
if (runningDownloadersByVersion.TryGetValue(version, out downloader)) { if (runningDownloadersByVersion.TryGetValue(minecraftVersion, out downloader)) {
Logger.Information("A download for server version {Version} is already running, waiting for it to finish...", version); Logger.Information("A download for server version {Version} is already running, waiting for it to finish...", minecraftVersion);
downloader.Register(listener); downloader.Register(listener);
} }
else { else {
downloader = new MinecraftServerExecutableDownloader(minecraftVersions, version, serverExecutableFilePath, listener); downloader = new MinecraftServerExecutableDownloader(fileDownloadInfo, minecraftVersion, serverExecutableFilePath, listener);
downloader.Completed += (_, _) => { downloader.Completed += (_, _) => {
lock (this) { lock (this) {
runningDownloadersByVersion.Remove(version); runningDownloadersByVersion.Remove(minecraftVersion);
} }
}; };
runningDownloadersByVersion[version] = downloader; runningDownloadersByVersion[minecraftVersion] = downloader;
} }
} }
return await downloader.Task.WaitAsync(cancellationToken); return await downloader.Task.WaitAsync(cancellationToken);
} }
public void Dispose() {
minecraftVersions.Dispose();
}
} }

View File

@@ -84,7 +84,7 @@ public sealed class ServerStatusProtocol {
return null; return null;
} }
logger.Verbose("Detected {OnlinePlayerCount} online player(s).", onlinePlayerCount); logger.Debug("Detected {OnlinePlayerCount} online player(s).", onlinePlayerCount);
return onlinePlayerCount; return onlinePlayerCount;
} finally { } finally {
ArrayPool<byte>.Shared.Return(messageBuffer); ArrayPool<byte>.Shared.Return(messageBuffer);

View File

@@ -69,7 +69,7 @@ public sealed class RpcLauncher : RpcRuntime<ClientSocket> {
} catch (OperationCanceledException) { } catch (OperationCanceledException) {
// Ignore. // Ignore.
} finally { } finally {
logger.Verbose("ZeroMQ client stopped receiving messages."); logger.Debug("ZeroMQ client stopped receiving messages.");
disconnectSemaphore.Wait(CancellationToken.None); disconnectSemaphore.Wait(CancellationToken.None);
keepAliveLoop.Cancel(); keepAliveLoop.Cancel();

View File

@@ -44,7 +44,7 @@ sealed class BackupArchiver {
return false; return false;
} }
public async Task ArchiveWorld(BackupCreationResult.Builder resultBuilder) { public async Task<string?> ArchiveWorld(BackupCreationResult.Builder resultBuilder) {
string guid = instanceProperties.InstanceGuid.ToString(); string guid = instanceProperties.InstanceGuid.ToString();
string currentDateTime = DateTime.Now.ToString("yyyyMMdd-HHmmss"); string currentDateTime = DateTime.Now.ToString("yyyyMMdd-HHmmss");
string backupFolderPath = Path.Combine(destinationBasePath, guid); string backupFolderPath = Path.Combine(destinationBasePath, guid);
@@ -53,7 +53,7 @@ sealed class BackupArchiver {
if (File.Exists(backupFilePath)) { if (File.Exists(backupFilePath)) {
resultBuilder.Kind = BackupCreationResultKind.BackupFileAlreadyExists; resultBuilder.Kind = BackupCreationResultKind.BackupFileAlreadyExists;
logger.Warning("Skipping backup, file already exists: {File}", backupFilePath); logger.Warning("Skipping backup, file already exists: {File}", backupFilePath);
return; return null;
} }
try { try {
@@ -61,18 +61,16 @@ sealed class BackupArchiver {
} catch (Exception e) { } catch (Exception e) {
resultBuilder.Kind = BackupCreationResultKind.CouldNotCreateBackupFolder; resultBuilder.Kind = BackupCreationResultKind.CouldNotCreateBackupFolder;
logger.Error(e, "Could not create backup folder: {Folder}", backupFolderPath); logger.Error(e, "Could not create backup folder: {Folder}", backupFolderPath);
return; return null;
} }
string temporaryFolderPath = Path.Combine(temporaryBasePath, guid + "_" + currentDateTime); string temporaryFolderPath = Path.Combine(temporaryBasePath, guid + "_" + currentDateTime);
if (!await CopyWorldAndCreateTarArchive(temporaryFolderPath, backupFilePath, resultBuilder)) { if (!await CopyWorldAndCreateTarArchive(temporaryFolderPath, backupFilePath, resultBuilder)) {
return; return null;
} }
var compressedFilePath = await BackupCompressor.Compress(backupFilePath, cancellationToken); logger.Debug("Created world backup: {FilePath}", backupFilePath);
if (compressedFilePath == null) { return backupFilePath;
resultBuilder.Warnings |= BackupCreationWarnings.CouldNotCompressWorldArchive;
}
} }
private async Task<bool> CopyWorldAndCreateTarArchive(string temporaryFolderPath, string backupFilePath, BackupCreationResult.Builder resultBuilder) { private async Task<bool> CopyWorldAndCreateTarArchive(string temporaryFolderPath, string backupFilePath, BackupCreationResult.Builder resultBuilder) {
@@ -137,7 +135,7 @@ sealed class BackupArchiver {
foreach (FileInfo file in sourceFolder.EnumerateFiles()) { foreach (FileInfo file in sourceFolder.EnumerateFiles()) {
var filePath = relativePath.Add(file.Name); var filePath = relativePath.Add(file.Name);
if (IsFileSkipped(filePath)) { if (IsFileSkipped(filePath)) {
logger.Verbose("Skipping file: {File}", string.Join('/', filePath)); logger.Debug("Skipping file: {File}", string.Join('/', filePath));
continue; continue;
} }
@@ -152,7 +150,7 @@ sealed class BackupArchiver {
foreach (DirectoryInfo directory in sourceFolder.EnumerateDirectories()) { foreach (DirectoryInfo directory in sourceFolder.EnumerateDirectories()) {
var folderPath = relativePath.Add(directory.Name); var folderPath = relativePath.Add(directory.Name);
if (IsFolderSkipped(folderPath)) { if (IsFolderSkipped(folderPath)) {
logger.Verbose("Skipping folder: {Folder}", string.Join('/', folderPath)); logger.Debug("Skipping folder: {Folder}", string.Join('/', folderPath));
continue; continue;
} }

View File

@@ -1,15 +1,16 @@
using System.Diagnostics; using Phantom.Common.Logging;
using Phantom.Common.Logging; using Phantom.Utils.Runtime;
using Serilog; using Serilog;
namespace Phantom.Agent.Services.Backups; namespace Phantom.Agent.Services.Backups;
static class BackupCompressor { static class BackupCompressor {
private static ILogger Logger { get; } = PhantomLogger.Create(nameof(BackupCompressor)); private static ILogger Logger { get; } = PhantomLogger.Create(nameof(BackupCompressor));
private static ILogger ZstdLogger { get; } = PhantomLogger.Create(nameof(BackupCompressor), "Zstd");
private const int Quality = 10; private const string Quality = "-10";
private const int Memory = 26; private const string Memory = "--long=26";
private const int Threads = 3; private const string Threads = "-T3";
public static async Task<string?> Compress(string sourceFilePath, CancellationToken cancellationToken) { public static async Task<string?> Compress(string sourceFilePath, CancellationToken cancellationToken) {
if (sourceFilePath.Contains('"')) { if (sourceFilePath.Contains('"')) {
@@ -39,65 +40,30 @@ static class BackupCompressor {
return false; return false;
} }
var startInfo = new ProcessStartInfo { var launcher = new ProcessConfigurator {
FileName = "zstd", FileName = "zstd",
WorkingDirectory = workingDirectory, WorkingDirectory = workingDirectory,
Arguments = $"-{Quality} --long={Memory} -T{Threads} -c --rm --no-progress -c -o \"{destinationFilePath}\" -- \"{sourceFilePath}\"", ArgumentList = {
RedirectStandardOutput = true, Quality,
RedirectStandardError = true Memory,
Threads,
"-c",
"--rm",
"--no-progress",
"-c",
"-o", destinationFilePath,
"--", sourceFilePath
}
}; };
using var process = new Process { StartInfo = startInfo }; static void OnZstdOutput(object? sender, Process.Output output) {
process.OutputDataReceived += OnZstdProcessOutput; if (!string.IsNullOrWhiteSpace(output.Line)) {
process.ErrorDataReceived += OnZstdProcessOutput; ZstdLogger.Debug("[Output] {Line}", output.Line);
}
try {
process.Start();
process.BeginOutputReadLine();
process.BeginErrorReadLine();
} catch (Exception e) {
Logger.Error(e, "Caught exception launching zstd process.");
} }
try { var process = new OneShotProcess(ZstdLogger, launcher);
await process.WaitForExitAsync(cancellationToken); process.OutputReceived += OnZstdOutput;
} catch (OperationCanceledException) { return await process.Run(cancellationToken);
await TryKillProcess(process);
return false;
} catch (Exception e) {
Logger.Error(e, "Caught exception waiting for zstd process to exit.");
return false;
}
if (!process.HasExited) {
await TryKillProcess(process);
return false;
}
if (process.ExitCode != 0) {
Logger.Error("Zstd process exited with code {ExitCode}.", process.ExitCode);
return false;
}
return true;
}
private static void OnZstdProcessOutput(object sender, DataReceivedEventArgs e) {
if (!string.IsNullOrWhiteSpace(e.Data)) {
Logger.Verbose("[Zstd] {Line}", e.Data);
}
}
private static async Task TryKillProcess(Process process) {
CancellationTokenSource timeout = new CancellationTokenSource(TimeSpan.FromSeconds(1));
try {
process.Kill();
await process.WaitForExitAsync(timeout.Token);
} catch (OperationCanceledException) {
Logger.Error("Timed out waiting for killed zstd process to exit.");
} catch (Exception e) {
Logger.Error(e, "Caught exception killing zstd process.");
}
} }
} }

View File

@@ -1,13 +1,11 @@
using System.Text.RegularExpressions; using Phantom.Agent.Minecraft.Instance;
using Phantom.Agent.Minecraft.Command;
using Phantom.Agent.Minecraft.Instance;
using Phantom.Common.Data.Backups; using Phantom.Common.Data.Backups;
using Phantom.Common.Logging; using Phantom.Common.Logging;
using Serilog; using Serilog;
namespace Phantom.Agent.Services.Backups; namespace Phantom.Agent.Services.Backups;
sealed partial class BackupManager { sealed class BackupManager {
private readonly string destinationBasePath; private readonly string destinationBasePath;
private readonly string temporaryBasePath; private readonly string temporaryBasePath;
@@ -16,9 +14,9 @@ sealed partial class BackupManager {
this.temporaryBasePath = Path.Combine(agentFolders.TemporaryFolderPath, "backups"); this.temporaryBasePath = Path.Combine(agentFolders.TemporaryFolderPath, "backups");
} }
public async Task<BackupCreationResult> CreateBackup(string loggerName, InstanceSession session, CancellationToken cancellationToken) { public async Task<BackupCreationResult> CreateBackup(string loggerName, InstanceProcess process, CancellationToken cancellationToken) {
try { try {
if (!await session.BackupSemaphore.Wait(TimeSpan.FromSeconds(1), cancellationToken)) { if (!await process.BackupSemaphore.Wait(TimeSpan.FromSeconds(1), cancellationToken)) {
return new BackupCreationResult(BackupCreationResultKind.BackupAlreadyRunning); return new BackupCreationResult(BackupCreationResultKind.BackupAlreadyRunning);
} }
} catch (ObjectDisposedException) { } catch (ObjectDisposedException) {
@@ -28,9 +26,9 @@ sealed partial class BackupManager {
} }
try { try {
return await new BackupCreator(destinationBasePath, temporaryBasePath, loggerName, session, cancellationToken).CreateBackup(); return await new BackupCreator(destinationBasePath, temporaryBasePath, loggerName, process, cancellationToken).CreateBackup();
} finally { } finally {
session.BackupSemaphore.Release(); process.BackupSemaphore.Release();
} }
} }
@@ -39,62 +37,53 @@ sealed partial class BackupManager {
private readonly string temporaryBasePath; private readonly string temporaryBasePath;
private readonly string loggerName; private readonly string loggerName;
private readonly ILogger logger; private readonly ILogger logger;
private readonly InstanceSession session; private readonly InstanceProcess process;
private readonly BackupCommandListener listener;
private readonly CancellationToken cancellationToken; private readonly CancellationToken cancellationToken;
public BackupCreator(string destinationBasePath, string temporaryBasePath, string loggerName, InstanceSession session, CancellationToken cancellationToken) { public BackupCreator(string destinationBasePath, string temporaryBasePath, string loggerName, InstanceProcess process, CancellationToken cancellationToken) {
this.destinationBasePath = destinationBasePath; this.destinationBasePath = destinationBasePath;
this.temporaryBasePath = temporaryBasePath; this.temporaryBasePath = temporaryBasePath;
this.loggerName = loggerName; this.loggerName = loggerName;
this.logger = PhantomLogger.Create<BackupManager>(loggerName); this.logger = PhantomLogger.Create<BackupManager>(loggerName);
this.session = session; this.process = process;
this.listener = new BackupCommandListener(logger);
this.cancellationToken = cancellationToken; this.cancellationToken = cancellationToken;
} }
public async Task<BackupCreationResult> CreateBackup() { public async Task<BackupCreationResult> CreateBackup() {
logger.Information("Backup started."); logger.Information("Backup started.");
session.AddOutputListener(listener.OnOutput, maxLinesToReadFromHistory: 0);
try {
var resultBuilder = new BackupCreationResult.Builder();
await RunBackupProcedure(resultBuilder); var resultBuilder = new BackupCreationResult.Builder();
string? backupFilePath;
var result = resultBuilder.Build(); using (var dispatcher = new BackupServerCommandDispatcher(logger, process, cancellationToken)) {
if (result.Kind == BackupCreationResultKind.Success) { backupFilePath = await CreateWorldArchive(dispatcher, resultBuilder);
var warningCount = result.Warnings.Count();
if (warningCount == 0) {
logger.Information("Backup finished successfully.");
}
else {
logger.Warning("Backup finished with {Warnings} warning(s).", warningCount);
}
}
else {
logger.Warning("Backup failed: {Reason}", result.Kind.ToSentence());
}
return result;
} finally {
session.RemoveOutputListener(listener.OnOutput);
} }
if (backupFilePath != null) {
await CompressWorldArchive(backupFilePath, resultBuilder);
}
var result = resultBuilder.Build();
LogBackupResult(result);
return result;
} }
private async Task RunBackupProcedure(BackupCreationResult.Builder resultBuilder) { private async Task<string?> CreateWorldArchive(BackupServerCommandDispatcher dispatcher, BackupCreationResult.Builder resultBuilder) {
try { try {
await DisableAutomaticSaving(); await dispatcher.DisableAutomaticSaving();
await SaveAllChunks(); await dispatcher.SaveAllChunks();
await new BackupArchiver(destinationBasePath, temporaryBasePath, loggerName, session.InstanceProperties, cancellationToken).ArchiveWorld(resultBuilder); return await new BackupArchiver(destinationBasePath, temporaryBasePath, loggerName, process.InstanceProperties, cancellationToken).ArchiveWorld(resultBuilder);
} catch (OperationCanceledException) { } catch (OperationCanceledException) {
resultBuilder.Kind = BackupCreationResultKind.BackupCancelled; resultBuilder.Kind = BackupCreationResultKind.BackupCancelled;
logger.Warning("Backup creation was cancelled."); logger.Warning("Backup creation was cancelled.");
return null;
} catch (Exception e) { } catch (Exception e) {
resultBuilder.Kind = BackupCreationResultKind.UnknownError; resultBuilder.Kind = BackupCreationResultKind.UnknownError;
logger.Error(e, "Caught exception while creating an instance backup."); logger.Error(e, "Caught exception while creating an instance backup.");
return null;
} finally { } finally {
try { try {
await EnableAutomaticSaving(); await dispatcher.EnableAutomaticSaving();
} catch (OperationCanceledException) { } catch (OperationCanceledException) {
// ignore // ignore
} catch (Exception e) { } catch (Exception e) {
@@ -104,66 +93,25 @@ sealed partial class BackupManager {
} }
} }
private async Task DisableAutomaticSaving() { private async Task CompressWorldArchive(string filePath, BackupCreationResult.Builder resultBuilder) {
await session.SendCommand(MinecraftCommand.SaveOff, cancellationToken); var compressedFilePath = await BackupCompressor.Compress(filePath, cancellationToken);
await listener.AutomaticSavingDisabled.Task.WaitAsync(cancellationToken); if (compressedFilePath == null) {
resultBuilder.Warnings |= BackupCreationWarnings.CouldNotCompressWorldArchive;
}
} }
private async Task SaveAllChunks() { private void LogBackupResult(BackupCreationResult result) {
// TODO Try if not flushing and waiting a few seconds before flushing reduces lag. if (result.Kind != BackupCreationResultKind.Success) {
await session.SendCommand(MinecraftCommand.SaveAll(flush: true), cancellationToken); logger.Warning("Backup failed: {Reason}", result.Kind.ToSentence());
await listener.SavedTheGame.Task.WaitAsync(cancellationToken);
}
private async Task EnableAutomaticSaving() {
await session.SendCommand(MinecraftCommand.SaveOn, cancellationToken);
await listener.AutomaticSavingEnabled.Task.WaitAsync(cancellationToken);
}
}
private sealed partial class BackupCommandListener {
[GeneratedRegex(@"^\[(?:.*?)\] \[Server thread/INFO\]: (.*?)$", RegexOptions.NonBacktracking)]
private static partial Regex ServerThreadInfoRegex();
private readonly ILogger logger;
public BackupCommandListener(ILogger logger) {
this.logger = logger;
}
public TaskCompletionSource AutomaticSavingDisabled { get; } = new ();
public TaskCompletionSource SavedTheGame { get; } = new ();
public TaskCompletionSource AutomaticSavingEnabled { get; } = new ();
public void OnOutput(object? sender, string? line) {
if (line == null) {
return; return;
} }
var match = ServerThreadInfoRegex().Match(line); var warningCount = result.Warnings.Count();
if (!match.Success) { if (warningCount > 0) {
return; logger.Warning("Backup finished with {Warnings} warning(s).", warningCount);
} }
else {
string info = match.Groups[1].Value; logger.Information("Backup finished successfully.");
if (!AutomaticSavingDisabled.Task.IsCompleted) {
if (info == "Automatic saving is now disabled") {
logger.Verbose("Detected that automatic saving is disabled.");
AutomaticSavingDisabled.SetResult();
}
}
else if (!SavedTheGame.Task.IsCompleted) {
if (info == "Saved the game") {
logger.Verbose("Detected that the game is saved.");
SavedTheGame.SetResult();
}
}
else if (!AutomaticSavingEnabled.Task.IsCompleted) {
if (info == "Automatic saving is now enabled") {
logger.Verbose("Detected that automatic saving is enabled.");
AutomaticSavingEnabled.SetResult();
}
} }
} }
} }

View File

@@ -14,17 +14,17 @@ sealed class BackupScheduler : CancellableBackgroundTask {
private readonly string loggerName; private readonly string loggerName;
private readonly BackupManager backupManager; private readonly BackupManager backupManager;
private readonly InstanceSession session; private readonly InstanceProcess process;
private readonly int serverPort; private readonly int serverPort;
private readonly ServerStatusProtocol serverStatusProtocol; private readonly ServerStatusProtocol serverStatusProtocol;
private readonly ManualResetEventSlim serverOutputWhileWaitingForOnlinePlayers = new (); private readonly ManualResetEventSlim serverOutputWhileWaitingForOnlinePlayers = new ();
public event EventHandler<BackupCreationResult>? BackupCompleted; public event EventHandler<BackupCreationResult>? BackupCompleted;
public BackupScheduler(TaskManager taskManager, BackupManager backupManager, InstanceSession session, int serverPort, string loggerName) : base(PhantomLogger.Create<BackupScheduler>(loggerName), taskManager, "Backup scheduler for " + loggerName) { public BackupScheduler(TaskManager taskManager, BackupManager backupManager, InstanceProcess process, int serverPort, string loggerName) : base(PhantomLogger.Create<BackupScheduler>(loggerName), taskManager, "Backup scheduler for " + loggerName) {
this.loggerName = loggerName; this.loggerName = loggerName;
this.backupManager = backupManager; this.backupManager = backupManager;
this.session = session; this.process = process;
this.serverPort = serverPort; this.serverPort = serverPort;
this.serverStatusProtocol = new ServerStatusProtocol(loggerName); this.serverStatusProtocol = new ServerStatusProtocol(loggerName);
} }
@@ -50,13 +50,13 @@ sealed class BackupScheduler : CancellableBackgroundTask {
} }
private async Task<BackupCreationResult> CreateBackup() { private async Task<BackupCreationResult> CreateBackup() {
return await backupManager.CreateBackup(loggerName, session, CancellationToken.None); return await backupManager.CreateBackup(loggerName, process, CancellationToken.None);
} }
private async Task WaitForOnlinePlayers() { private async Task WaitForOnlinePlayers() {
bool needsToLogOfflinePlayersMessage = true; bool needsToLogOfflinePlayersMessage = true;
session.AddOutputListener(ServerOutputListener, maxLinesToReadFromHistory: 0); process.AddOutputListener(ServerOutputListener, maxLinesToReadFromHistory: 0);
try { try {
while (!CancellationToken.IsCancellationRequested) { while (!CancellationToken.IsCancellationRequested) {
serverOutputWhileWaitingForOnlinePlayers.Reset(); serverOutputWhileWaitingForOnlinePlayers.Reset();
@@ -79,18 +79,18 @@ sealed class BackupScheduler : CancellableBackgroundTask {
await Task.Delay(TimeSpan.FromSeconds(10), CancellationToken); await Task.Delay(TimeSpan.FromSeconds(10), CancellationToken);
Logger.Verbose("Waiting for server output before checking for online players again..."); Logger.Debug("Waiting for server output before checking for online players again...");
await serverOutputWhileWaitingForOnlinePlayers.WaitHandle.WaitOneAsync(CancellationToken); await serverOutputWhileWaitingForOnlinePlayers.WaitHandle.WaitOneAsync(CancellationToken);
} }
} finally { } finally {
session.RemoveOutputListener(ServerOutputListener); process.RemoveOutputListener(ServerOutputListener);
} }
} }
private void ServerOutputListener(object? sender, string line) { private void ServerOutputListener(object? sender, string line) {
if (!serverOutputWhileWaitingForOnlinePlayers.IsSet) { if (!serverOutputWhileWaitingForOnlinePlayers.IsSet) {
serverOutputWhileWaitingForOnlinePlayers.Set(); serverOutputWhileWaitingForOnlinePlayers.Set();
Logger.Verbose("Detected server output, signalling to check for online players again."); Logger.Debug("Detected server output, signalling to check for online players again.");
} }
} }
} }

View File

@@ -0,0 +1,80 @@
using System.Text.RegularExpressions;
using Phantom.Agent.Minecraft.Command;
using Phantom.Agent.Minecraft.Instance;
using Phantom.Utils.Runtime;
using Serilog;
namespace Phantom.Agent.Services.Backups;
sealed partial class BackupServerCommandDispatcher : IDisposable {
[GeneratedRegex(@"^\[(?:.*?)\] \[Server thread/INFO\]: (.*?)$", RegexOptions.NonBacktracking)]
private static partial Regex ServerThreadInfoRegex();
private readonly ILogger logger;
private readonly InstanceProcess process;
private readonly CancellationToken cancellationToken;
private readonly TaskCompletionSource automaticSavingDisabled = Tasks.CreateCompletionSource();
private readonly TaskCompletionSource savedTheGame = Tasks.CreateCompletionSource();
private readonly TaskCompletionSource automaticSavingEnabled = Tasks.CreateCompletionSource();
public BackupServerCommandDispatcher(ILogger logger, InstanceProcess process, CancellationToken cancellationToken) {
this.logger = logger;
this.process = process;
this.cancellationToken = cancellationToken;
this.process.AddOutputListener(OnOutput, maxLinesToReadFromHistory: 0);
}
void IDisposable.Dispose() {
process.RemoveOutputListener(OnOutput);
}
public async Task DisableAutomaticSaving() {
await process.SendCommand(MinecraftCommand.SaveOff, cancellationToken);
await automaticSavingDisabled.Task.WaitAsync(cancellationToken);
}
public async Task SaveAllChunks() {
// TODO Try if not flushing and waiting a few seconds before flushing reduces lag.
await process.SendCommand(MinecraftCommand.SaveAll(flush: true), cancellationToken);
await savedTheGame.Task.WaitAsync(cancellationToken);
}
public async Task EnableAutomaticSaving() {
await process.SendCommand(MinecraftCommand.SaveOn, cancellationToken);
await automaticSavingEnabled.Task.WaitAsync(cancellationToken);
}
private void OnOutput(object? sender, string? line) {
if (line == null) {
return;
}
var match = ServerThreadInfoRegex().Match(line);
if (!match.Success) {
return;
}
string info = match.Groups[1].Value;
if (!automaticSavingDisabled.Task.IsCompleted) {
if (info == "Automatic saving is now disabled") {
logger.Debug("Detected that automatic saving is disabled.");
automaticSavingDisabled.SetResult();
}
}
else if (!savedTheGame.Task.IsCompleted) {
if (info == "Saved the game") {
logger.Debug("Detected that the game is saved.");
savedTheGame.SetResult();
}
}
else if (!automaticSavingEnabled.Task.IsCompleted) {
if (info == "Automatic saving is now enabled") {
logger.Debug("Detected that automatic saving is enabled.");
automaticSavingEnabled.SetResult();
}
}
}
}

View File

@@ -18,15 +18,10 @@ sealed class Instance : IDisposable {
return prefix[..prefix.IndexOf('-')] + "/" + Interlocked.Increment(ref loggerSequenceId); return prefix[..prefix.IndexOf('-')] + "/" + Interlocked.Increment(ref loggerSequenceId);
} }
public static Instance Create(InstanceConfiguration configuration, InstanceServices services, BaseLauncher launcher) { private InstanceServices Services { get; }
var instance = new Instance(configuration, services, launcher);
instance.SetStatus(instance.currentStatus);
return instance;
}
public InstanceConfiguration Configuration { get; private set; } public InstanceConfiguration Configuration { get; private set; }
private InstanceServices Services { get; } private IServerLauncher Launcher { get; set; }
private BaseLauncher Launcher { get; set; }
private readonly string shortName; private readonly string shortName;
private readonly ILogger logger; private readonly ILogger logger;
@@ -41,29 +36,41 @@ sealed class Instance : IDisposable {
public event EventHandler? IsRunningChanged; public event EventHandler? IsRunningChanged;
private Instance(InstanceConfiguration configuration, InstanceServices services, BaseLauncher launcher) { public Instance(InstanceServices services, InstanceConfiguration configuration, IServerLauncher launcher) {
this.shortName = GetLoggerName(configuration.InstanceGuid); this.shortName = GetLoggerName(configuration.InstanceGuid);
this.logger = PhantomLogger.Create<Instance>(shortName); this.logger = PhantomLogger.Create<Instance>(shortName);
this.Configuration = configuration;
this.Services = services; this.Services = services;
this.Configuration = configuration;
this.Launcher = launcher; this.Launcher = launcher;
this.currentState = new InstanceNotRunningState(); this.currentState = new InstanceNotRunningState();
this.currentStatus = InstanceStatus.NotRunning; this.currentStatus = InstanceStatus.NotRunning;
} }
private void SetStatus(IInstanceStatus status) { private void TryUpdateStatus(string taskName, Func<Task> getUpdateTask) {
int myStatusUpdateCounter = Interlocked.Increment(ref statusUpdateCounter); int myStatusUpdateCounter = Interlocked.Increment(ref statusUpdateCounter);
Services.TaskManager.Run("Report status of instance " + shortName + " as " + status.GetType().Name, async () => { Services.TaskManager.Run(taskName, async () => {
if (myStatusUpdateCounter == statusUpdateCounter) { if (myStatusUpdateCounter == statusUpdateCounter) {
currentStatus = status; await getUpdateTask();
await ServerMessaging.Send(new ReportInstanceStatusMessage(Configuration.InstanceGuid, status));
} }
}); });
} }
public void ReportLastStatus() {
TryUpdateStatus("Report last status of instance " + shortName, async () => {
await ServerMessaging.Send(new ReportInstanceStatusMessage(Configuration.InstanceGuid, currentStatus));
});
}
private void ReportAndSetStatus(IInstanceStatus status) {
TryUpdateStatus("Report status of instance " + shortName + " as " + status.GetType().Name, async () => {
currentStatus = status;
await ServerMessaging.Send(new ReportInstanceStatusMessage(Configuration.InstanceGuid, status));
});
}
private void ReportEvent(IInstanceEvent instanceEvent) { private void ReportEvent(IInstanceEvent instanceEvent) {
var message = new ReportInstanceEventMessage(Guid.NewGuid(), DateTime.UtcNow, Configuration.InstanceGuid, instanceEvent); var message = new ReportInstanceEventMessage(Guid.NewGuid(), DateTime.UtcNow, Configuration.InstanceGuid, instanceEvent);
Services.TaskManager.Run("Report event for instance " + shortName, async () => await ServerMessaging.Send(message)); Services.TaskManager.Run("Report event for instance " + shortName, async () => await ServerMessaging.Send(message));
@@ -78,7 +85,7 @@ sealed class Instance : IDisposable {
disposable.Dispose(); disposable.Dispose();
} }
logger.Verbose("Transitioning instance state to: {NewState}", newState.GetType().Name); logger.Debug("Transitioning instance state to: {NewState}", newState.GetType().Name);
var wasRunning = IsRunning; var wasRunning = IsRunning;
currentState = newState; currentState = newState;
@@ -94,7 +101,7 @@ sealed class Instance : IDisposable {
return newStateAndResult.Result; return newStateAndResult.Result;
} }
public async Task Reconfigure(InstanceConfiguration configuration, BaseLauncher launcher, CancellationToken cancellationToken) { public async Task Reconfigure(InstanceConfiguration configuration, IServerLauncher launcher, CancellationToken cancellationToken) {
await stateTransitioningActionSemaphore.WaitAsync(cancellationToken); await stateTransitioningActionSemaphore.WaitAsync(cancellationToken);
try { try {
Configuration = configuration; Configuration = configuration;
@@ -147,7 +154,7 @@ sealed class Instance : IDisposable {
private readonly Instance instance; private readonly Instance instance;
private readonly CancellationToken shutdownCancellationToken; private readonly CancellationToken shutdownCancellationToken;
public InstanceContextImpl(Instance instance, CancellationToken shutdownCancellationToken) : base(instance.Configuration, instance.Launcher, instance.Services) { public InstanceContextImpl(Instance instance, CancellationToken shutdownCancellationToken) : base(instance.Services, instance.Configuration, instance.Launcher) {
this.instance = instance; this.instance = instance;
this.shutdownCancellationToken = shutdownCancellationToken; this.shutdownCancellationToken = shutdownCancellationToken;
} }
@@ -156,7 +163,7 @@ sealed class Instance : IDisposable {
public override string ShortName => instance.shortName; public override string ShortName => instance.shortName;
public override void SetStatus(IInstanceStatus newStatus) { public override void SetStatus(IInstanceStatus newStatus) {
instance.SetStatus(newStatus); instance.ReportAndSetStatus(newStatus);
} }
public override void ReportEvent(IInstanceEvent instanceEvent) { public override void ReportEvent(IInstanceEvent instanceEvent) {
@@ -170,12 +177,12 @@ sealed class Instance : IDisposable {
if (!instance.IsRunning) { if (!instance.IsRunning) {
// Only InstanceSessionManager is allowed to transition an instance out of a non-running state. // Only InstanceSessionManager is allowed to transition an instance out of a non-running state.
instance.logger.Verbose("Cancelled state transition to {State} because instance is not running.", state.GetType().Name); instance.logger.Debug("Cancelled state transition to {State} because instance is not running.", state.GetType().Name);
return; return;
} }
if (state is not InstanceNotRunningState && shutdownCancellationToken.IsCancellationRequested) { if (state is not InstanceNotRunningState && shutdownCancellationToken.IsCancellationRequested) {
instance.logger.Verbose("Cancelled state transition to {State} due to Agent shutdown.", state.GetType().Name); instance.logger.Debug("Cancelled state transition to {State} due to Agent shutdown.", state.GetType().Name);
return; return;
} }

View File

@@ -6,17 +6,17 @@ using Serilog;
namespace Phantom.Agent.Services.Instances; namespace Phantom.Agent.Services.Instances;
abstract class InstanceContext { abstract class InstanceContext {
public InstanceConfiguration Configuration { get; }
public BaseLauncher Launcher { get; }
public InstanceServices Services { get; } public InstanceServices Services { get; }
public InstanceConfiguration Configuration { get; }
public IServerLauncher Launcher { get; }
public abstract ILogger Logger { get; } public abstract ILogger Logger { get; }
public abstract string ShortName { get; } public abstract string ShortName { get; }
protected InstanceContext(InstanceConfiguration configuration, BaseLauncher launcher, InstanceServices services) { protected InstanceContext(InstanceServices services, InstanceConfiguration configuration, IServerLauncher launcher) {
Services = services;
Configuration = configuration; Configuration = configuration;
Launcher = launcher; Launcher = launcher;
Services = services;
} }
public abstract void SetStatus(IInstanceStatus newStatus); public abstract void SetStatus(IInstanceStatus newStatus);

View File

@@ -27,7 +27,6 @@ sealed class InstanceSessionManager : IDisposable {
private readonly AgentInfo agentInfo; private readonly AgentInfo agentInfo;
private readonly string basePath; private readonly string basePath;
private readonly MinecraftServerExecutables minecraftServerExecutables;
private readonly InstanceServices instanceServices; private readonly InstanceServices instanceServices;
private readonly Dictionary<Guid, Instance> instances = new (); private readonly Dictionary<Guid, Instance> instances = new ();
@@ -38,11 +37,12 @@ sealed class InstanceSessionManager : IDisposable {
public InstanceSessionManager(AgentInfo agentInfo, AgentFolders agentFolders, JavaRuntimeRepository javaRuntimeRepository, TaskManager taskManager, BackupManager backupManager) { public InstanceSessionManager(AgentInfo agentInfo, AgentFolders agentFolders, JavaRuntimeRepository javaRuntimeRepository, TaskManager taskManager, BackupManager backupManager) {
this.agentInfo = agentInfo; this.agentInfo = agentInfo;
this.basePath = agentFolders.InstancesFolderPath; this.basePath = agentFolders.InstancesFolderPath;
this.minecraftServerExecutables = new MinecraftServerExecutables(agentFolders.ServerExecutableFolderPath);
this.shutdownCancellationToken = shutdownCancellationTokenSource.Token; this.shutdownCancellationToken = shutdownCancellationTokenSource.Token;
var minecraftServerExecutables = new MinecraftServerExecutables(agentFolders.ServerExecutableFolderPath);
var launchServices = new LaunchServices(minecraftServerExecutables, javaRuntimeRepository); var launchServices = new LaunchServices(minecraftServerExecutables, javaRuntimeRepository);
var portManager = new PortManager(agentInfo.AllowedServerPorts, agentInfo.AllowedRconPorts); var portManager = new PortManager(agentInfo.AllowedServerPorts, agentInfo.AllowedRconPorts);
this.instanceServices = new InstanceServices(taskManager, portManager, backupManager, launchServices); this.instanceServices = new InstanceServices(taskManager, portManager, backupManager, launchServices);
} }
@@ -71,7 +71,7 @@ sealed class InstanceSessionManager : IDisposable {
}); });
} }
public async Task<InstanceActionResult<ConfigureInstanceResult>> Configure(InstanceConfiguration configuration) { public async Task<InstanceActionResult<ConfigureInstanceResult>> Configure(InstanceConfiguration configuration, InstanceLaunchProperties launchProperties, bool launchNow, bool alwaysReportStatus) {
return await AcquireSemaphoreAndRun(async () => { return await AcquireSemaphoreAndRun(async () => {
var instanceGuid = configuration.InstanceGuid; var instanceGuid = configuration.InstanceGuid;
var instanceFolder = Path.Combine(basePath, instanceGuid.ToString()); var instanceFolder = Path.Combine(basePath, instanceGuid.ToString());
@@ -90,22 +90,33 @@ sealed class InstanceSessionManager : IDisposable {
configuration.JvmArguments, configuration.JvmArguments,
instanceFolder, instanceFolder,
configuration.MinecraftVersion, configuration.MinecraftVersion,
new ServerProperties(configuration.ServerPort, configuration.RconPort) new ServerProperties(configuration.ServerPort, configuration.RconPort),
launchProperties
); );
BaseLauncher launcher = new VanillaLauncher(properties); IServerLauncher launcher = configuration.MinecraftServerKind switch {
MinecraftServerKind.Vanilla => new VanillaLauncher(properties),
MinecraftServerKind.Fabric => new FabricLauncher(properties),
_ => InvalidLauncher.Instance
};
if (instances.TryGetValue(instanceGuid, out var instance)) { if (instances.TryGetValue(instanceGuid, out var instance)) {
await instance.Reconfigure(configuration, launcher, shutdownCancellationToken); await instance.Reconfigure(configuration, launcher, shutdownCancellationToken);
Logger.Information("Reconfigured instance \"{Name}\" (GUID {Guid}).", configuration.InstanceName, configuration.InstanceGuid); Logger.Information("Reconfigured instance \"{Name}\" (GUID {Guid}).", configuration.InstanceName, configuration.InstanceGuid);
if (alwaysReportStatus) {
instance.ReportLastStatus();
}
} }
else { else {
instances[instanceGuid] = instance = Instance.Create(configuration, instanceServices, launcher); instances[instanceGuid] = instance = new Instance(instanceServices, configuration, launcher);
instance.IsRunningChanged += OnInstanceIsRunningChanged;
Logger.Information("Created instance \"{Name}\" (GUID {Guid}).", configuration.InstanceName, configuration.InstanceGuid); Logger.Information("Created instance \"{Name}\" (GUID {Guid}).", configuration.InstanceName, configuration.InstanceGuid);
instance.ReportLastStatus();
instance.IsRunningChanged += OnInstanceIsRunningChanged;
} }
if (configuration.LaunchAutomatically) { if (launchNow) {
await LaunchInternal(instance); await LaunchInternal(instance);
} }
@@ -179,7 +190,6 @@ sealed class InstanceSessionManager : IDisposable {
public void Dispose() { public void Dispose() {
DisposeAllInstances(); DisposeAllInstances();
minecraftServerExecutables.Dispose();
shutdownCancellationTokenSource.Dispose(); shutdownCancellationTokenSource.Dispose();
semaphore.Dispose(); semaphore.Dispose();
} }

View File

@@ -0,0 +1,28 @@
using Phantom.Agent.Minecraft.Instance;
namespace Phantom.Agent.Services.Instances.Sessions;
sealed class InstanceSession : IDisposable {
private readonly InstanceProcess process;
private readonly InstanceContext context;
private readonly InstanceLogSender logSender;
public InstanceSession(InstanceProcess process, InstanceContext context) {
this.process = process;
this.context = context;
this.logSender = new InstanceLogSender(context.Services.TaskManager, context.Configuration.InstanceGuid, context.ShortName);
this.process.AddOutputListener(SessionOutput);
}
private void SessionOutput(object? sender, string line) {
context.Logger.Debug("[Server] {Line}", line);
logSender.Enqueue(line);
}
public void Dispose() {
logSender.Stop();
process.Dispose();
context.Services.PortManager.Release(context.Configuration);
}
}

View File

@@ -1,6 +1,7 @@
using Phantom.Agent.Minecraft.Instance; using Phantom.Agent.Minecraft.Instance;
using Phantom.Agent.Minecraft.Launcher; using Phantom.Agent.Minecraft.Launcher;
using Phantom.Agent.Minecraft.Server; using Phantom.Agent.Minecraft.Server;
using Phantom.Agent.Services.Instances.Sessions;
using Phantom.Common.Data.Instance; using Phantom.Common.Data.Instance;
using Phantom.Common.Data.Minecraft; using Phantom.Common.Data.Minecraft;
using Phantom.Common.Data.Replies; using Phantom.Common.Data.Replies;
@@ -24,7 +25,7 @@ sealed class InstanceLaunchingState : IInstanceState, IDisposable {
launchTask.ContinueWith(OnLaunchFailure, CancellationToken.None, TaskContinuationOptions.NotOnRanToCompletion, TaskScheduler.Default); launchTask.ContinueWith(OnLaunchFailure, CancellationToken.None, TaskContinuationOptions.NotOnRanToCompletion, TaskScheduler.Default);
} }
private async Task<InstanceSession> DoLaunch() { private async Task<InstanceProcess> DoLaunch() {
var cancellationToken = cancellationTokenSource.Token; var cancellationToken = cancellationTokenSource.Token;
cancellationToken.ThrowIfCancellationRequested(); cancellationToken.ThrowIfCancellationRequested();
@@ -47,6 +48,9 @@ sealed class InstanceLaunchingState : IInstanceState, IDisposable {
else if (launchResult is LaunchResult.CouldNotDownloadMinecraftServer) { else if (launchResult is LaunchResult.CouldNotDownloadMinecraftServer) {
throw new LaunchFailureException(InstanceLaunchFailReason.CouldNotDownloadMinecraftServer, "Session failed to launch, could not download Minecraft server."); throw new LaunchFailureException(InstanceLaunchFailReason.CouldNotDownloadMinecraftServer, "Session failed to launch, could not download Minecraft server.");
} }
else if (launchResult is LaunchResult.CouldNotPrepareMinecraftServerLauncher) {
throw new LaunchFailureException(InstanceLaunchFailReason.CouldNotPrepareMinecraftServerLauncher, "Session failed to launch, could not prepare Minecraft server launcher.");
}
else if (launchResult is LaunchResult.CouldNotConfigureMinecraftServer) { else if (launchResult is LaunchResult.CouldNotConfigureMinecraftServer) {
throw new LaunchFailureException(InstanceLaunchFailReason.CouldNotConfigureMinecraftServer, "Session failed to launch, could not configure Minecraft server."); throw new LaunchFailureException(InstanceLaunchFailReason.CouldNotConfigureMinecraftServer, "Session failed to launch, could not configure Minecraft server.");
} }
@@ -59,29 +63,35 @@ sealed class InstanceLaunchingState : IInstanceState, IDisposable {
} }
context.SetStatus(InstanceStatus.Launching); context.SetStatus(InstanceStatus.Launching);
return launchSuccess.Session; return launchSuccess.Process;
} }
private void OnLaunchSuccess(Task<InstanceSession> task) { private void OnLaunchSuccess(Task<InstanceProcess> task) {
context.TransitionState(() => { context.TransitionState(() => {
context.ReportEvent(InstanceEvent.LaunchSucceded);
var process = task.Result;
var session = new InstanceSession(process, context);
if (cancellationTokenSource.IsCancellationRequested) { if (cancellationTokenSource.IsCancellationRequested) {
context.Services.PortManager.Release(context.Configuration); return (new InstanceStoppingState(context, process, session), InstanceStatus.Stopping);
return (new InstanceNotRunningState(), InstanceStatus.NotRunning);
} }
else { else {
context.ReportEvent(InstanceEvent.LaunchSucceded); return (new InstanceRunningState(context, process, session), null);
return (new InstanceRunningState(context, task.Result), null);
} }
}); });
} }
private void OnLaunchFailure(Task task) { private void OnLaunchFailure(Task task) {
if (task.Exception is { InnerException: LaunchFailureException e }) { if (task.IsFaulted) {
context.Logger.Error(e.LogMessage); if (task.Exception is { InnerException: LaunchFailureException e }) {
context.SetLaunchFailedStatusAndReportEvent(e.Reason); context.Logger.Error(e.LogMessage);
} context.SetLaunchFailedStatusAndReportEvent(e.Reason);
else { }
context.SetLaunchFailedStatusAndReportEvent(InstanceLaunchFailReason.UnknownError); else {
context.Logger.Error(task.Exception, "Caught exception while launching instance.");
context.SetLaunchFailedStatusAndReportEvent(InstanceLaunchFailReason.UnknownError);
}
} }
context.Services.PortManager.Release(context.Configuration); context.Services.PortManager.Release(context.Configuration);

View File

@@ -1,6 +1,7 @@
using Phantom.Agent.Minecraft.Command; using Phantom.Agent.Minecraft.Command;
using Phantom.Agent.Minecraft.Instance; using Phantom.Agent.Minecraft.Instance;
using Phantom.Agent.Services.Backups; using Phantom.Agent.Services.Backups;
using Phantom.Agent.Services.Instances.Sessions;
using Phantom.Common.Data.Backups; using Phantom.Common.Data.Backups;
using Phantom.Common.Data.Instance; using Phantom.Common.Data.Instance;
using Phantom.Common.Data.Minecraft; using Phantom.Common.Data.Minecraft;
@@ -10,30 +11,27 @@ namespace Phantom.Agent.Services.Instances.States;
sealed class InstanceRunningState : IInstanceState { sealed class InstanceRunningState : IInstanceState {
private readonly InstanceContext context; private readonly InstanceContext context;
private readonly InstanceSession session; private readonly InstanceProcess process;
private readonly InstanceLogSender logSender;
private readonly BackupScheduler backupScheduler; private readonly BackupScheduler backupScheduler;
private readonly SessionObjects sessionObjects; private readonly RunningSessionDisposer runningSessionDisposer;
private readonly CancellationTokenSource delayedStopCancellationTokenSource = new (); private readonly CancellationTokenSource delayedStopCancellationTokenSource = new ();
private bool stateOwnsDelayedStopCancellationTokenSource = true; private bool stateOwnsDelayedStopCancellationTokenSource = true;
private bool isStopping; private bool isStopping;
public InstanceRunningState(InstanceContext context, InstanceSession session) { public InstanceRunningState(InstanceContext context, InstanceProcess process, InstanceSession session) {
this.context = context; this.context = context;
this.session = session; this.process = process;
this.logSender = new InstanceLogSender(context.Services.TaskManager, context.Configuration.InstanceGuid, context.ShortName); this.backupScheduler = new BackupScheduler(context.Services.TaskManager, context.Services.BackupManager, process, context.Configuration.ServerPort, context.ShortName);
this.backupScheduler = new BackupScheduler(context.Services.TaskManager, context.Services.BackupManager, session, context.Configuration.ServerPort, context.ShortName);
this.backupScheduler.BackupCompleted += OnScheduledBackupCompleted; this.backupScheduler.BackupCompleted += OnScheduledBackupCompleted;
this.sessionObjects = new SessionObjects(this); this.runningSessionDisposer = new RunningSessionDisposer(this, session);
} }
public void Initialize() { public void Initialize() {
session.AddOutputListener(SessionOutput); process.Ended += ProcessEnded;
session.SessionEnded += SessionEnded;
if (session.HasEnded) { if (process.HasEnded) {
if (sessionObjects.Dispose()) { if (runningSessionDisposer.Dispose()) {
context.Logger.Warning("Session ended immediately after it was started."); context.Logger.Warning("Session ended immediately after it was started.");
context.ReportEvent(InstanceEvent.Stopped); context.ReportEvent(InstanceEvent.Stopped);
context.Services.TaskManager.Run("Transition state of instance " + context.ShortName + " to not running", () => context.TransitionState(new InstanceNotRunningState(), InstanceStatus.Failed(InstanceLaunchFailReason.UnknownError))); context.Services.TaskManager.Run("Transition state of instance " + context.ShortName + " to not running", () => context.TransitionState(new InstanceNotRunningState(), InstanceStatus.Failed(InstanceLaunchFailReason.UnknownError)));
@@ -45,13 +43,8 @@ sealed class InstanceRunningState : IInstanceState {
} }
} }
private void SessionOutput(object? sender, string line) { private void ProcessEnded(object? sender, EventArgs e) {
context.Logger.Verbose("[Server] {Line}", line); if (!runningSessionDisposer.Dispose()) {
logSender.Enqueue(line);
}
private void SessionEnded(object? sender, EventArgs e) {
if (!sessionObjects.Dispose()) {
return; return;
} }
@@ -88,9 +81,9 @@ sealed class InstanceRunningState : IInstanceState {
} }
private IInstanceState PrepareStoppedState() { private IInstanceState PrepareStoppedState() {
session.SessionEnded -= SessionEnded; process.Ended -= ProcessEnded;
backupScheduler.Stop(); backupScheduler.Stop();
return new InstanceStoppingState(context, session, sessionObjects); return new InstanceStoppingState(context, process, runningSessionDisposer);
} }
private void CancelDelayedStop() { private void CancelDelayedStop() {
@@ -117,7 +110,7 @@ sealed class InstanceRunningState : IInstanceState {
} }
} }
} catch (OperationCanceledException) { } catch (OperationCanceledException) {
context.Logger.Verbose("Cancelled delayed stop."); context.Logger.Debug("Cancelled delayed stop.");
return; return;
} catch (ObjectDisposedException) { } catch (ObjectDisposedException) {
return; return;
@@ -134,7 +127,7 @@ sealed class InstanceRunningState : IInstanceState {
public async Task<bool> SendCommand(string command, CancellationToken cancellationToken) { public async Task<bool> SendCommand(string command, CancellationToken cancellationToken) {
try { try {
context.Logger.Information("Sending command: {Command}", command); context.Logger.Information("Sending command: {Command}", command);
await session.SendCommand(command, cancellationToken); await process.SendCommand(command, cancellationToken);
return true; return true;
} catch (OperationCanceledException) { } catch (OperationCanceledException) {
return false; return false;
@@ -148,12 +141,14 @@ sealed class InstanceRunningState : IInstanceState {
context.ReportEvent(new InstanceBackupCompletedEvent(e.Kind, e.Warnings)); context.ReportEvent(new InstanceBackupCompletedEvent(e.Kind, e.Warnings));
} }
public sealed class SessionObjects { private sealed class RunningSessionDisposer : IDisposable {
private readonly InstanceRunningState state; private readonly InstanceRunningState state;
private readonly InstanceSession session;
private bool isDisposed; private bool isDisposed;
public SessionObjects(InstanceRunningState state) { public RunningSessionDisposer(InstanceRunningState state, InstanceSession session) {
this.state = state; this.state = state;
this.session = session;
} }
public bool Dispose() { public bool Dispose() {
@@ -172,10 +167,12 @@ sealed class InstanceRunningState : IInstanceState {
state.CancelDelayedStop(); state.CancelDelayedStop();
} }
state.logSender.Stop(); session.Dispose();
state.session.Dispose();
state.context.Services.PortManager.Release(state.context.Configuration);
return true; return true;
} }
void IDisposable.Dispose() {
Dispose();
}
} }
} }

View File

@@ -9,13 +9,13 @@ namespace Phantom.Agent.Services.Instances.States;
sealed class InstanceStoppingState : IInstanceState, IDisposable { sealed class InstanceStoppingState : IInstanceState, IDisposable {
private readonly InstanceContext context; private readonly InstanceContext context;
private readonly InstanceSession session; private readonly InstanceProcess process;
private readonly InstanceRunningState.SessionObjects sessionObjects; private readonly IDisposable sessionDisposer;
public InstanceStoppingState(InstanceContext context, InstanceSession session, InstanceRunningState.SessionObjects sessionObjects) { public InstanceStoppingState(InstanceContext context, InstanceProcess process, IDisposable sessionDisposer) {
this.sessionObjects = sessionObjects;
this.session = session;
this.context = context; this.context = context;
this.process = process;
this.sessionDisposer = sessionDisposer;
} }
public void Initialize() { public void Initialize() {
@@ -27,9 +27,9 @@ sealed class InstanceStoppingState : IInstanceState, IDisposable {
private async Task DoStop() { private async Task DoStop() {
try { try {
// Do not release the semaphore after this point. // Do not release the semaphore after this point.
if (!await session.BackupSemaphore.CancelAndWait(TimeSpan.FromSeconds(1))) { if (!await process.BackupSemaphore.CancelAndWait(TimeSpan.FromSeconds(1))) {
context.Logger.Information("Waiting for backup to finish..."); context.Logger.Information("Waiting for backup to finish...");
await session.BackupSemaphore.CancelAndWait(Timeout.InfiniteTimeSpan); await process.BackupSemaphore.CancelAndWait(Timeout.InfiniteTimeSpan);
} }
context.Logger.Information("Sending stop command..."); context.Logger.Information("Sending stop command...");
@@ -47,10 +47,10 @@ sealed class InstanceStoppingState : IInstanceState, IDisposable {
private async Task DoSendStopCommand() { private async Task DoSendStopCommand() {
using var timeout = new CancellationTokenSource(TimeSpan.FromSeconds(5)); using var timeout = new CancellationTokenSource(TimeSpan.FromSeconds(5));
try { try {
await session.SendCommand(MinecraftCommand.Stop, timeout.Token); await process.SendCommand(MinecraftCommand.Stop, timeout.Token);
} catch (OperationCanceledException) { } catch (OperationCanceledException) {
// ignore // ignore
} catch (ObjectDisposedException e) when (e.ObjectName == typeof(Process).FullName && session.HasEnded) { } catch (ObjectDisposedException e) when (e.ObjectName == typeof(Process).FullName && process.HasEnded) {
// ignore // ignore
} catch (Exception e) { } catch (Exception e) {
context.Logger.Warning(e, "Caught exception while sending stop command."); context.Logger.Warning(e, "Caught exception while sending stop command.");
@@ -60,11 +60,11 @@ sealed class InstanceStoppingState : IInstanceState, IDisposable {
private async Task DoWaitForSessionToEnd() { private async Task DoWaitForSessionToEnd() {
using var timeout = new CancellationTokenSource(TimeSpan.FromSeconds(55)); using var timeout = new CancellationTokenSource(TimeSpan.FromSeconds(55));
try { try {
await session.WaitForExit(timeout.Token); await process.WaitForExit(timeout.Token);
} catch (OperationCanceledException) { } catch (OperationCanceledException) {
try { try {
context.Logger.Warning("Waiting timed out, killing session..."); context.Logger.Warning("Waiting timed out, killing session...");
session.Kill(); process.Kill();
} catch (Exception e) { } catch (Exception e) {
context.Logger.Error(e, "Caught exception while killing session."); context.Logger.Error(e, "Caught exception while killing session.");
} }
@@ -84,6 +84,6 @@ sealed class InstanceStoppingState : IInstanceState, IDisposable {
} }
public void Dispose() { public void Dispose() {
sessionObjects.Dispose(); sessionDisposer.Dispose();
} }
} }

View File

@@ -1,4 +1,5 @@
using Phantom.Agent.Rpc; using Phantom.Agent.Rpc;
using Phantom.Common.Data.Instance;
using Phantom.Common.Data.Replies; using Phantom.Common.Data.Replies;
using Phantom.Common.Logging; using Phantom.Common.Logging;
using Phantom.Common.Messages; using Phantom.Common.Messages;
@@ -26,12 +27,15 @@ public sealed class MessageListener : IMessageToAgentListener {
public async Task<NoReply> HandleRegisterAgentSuccess(RegisterAgentSuccessMessage message) { public async Task<NoReply> HandleRegisterAgentSuccess(RegisterAgentSuccessMessage message) {
Logger.Information("Agent authentication successful."); Logger.Information("Agent authentication successful.");
foreach (var instanceInfo in message.InitialInstances) { void ShutdownAfterConfigurationFailed(InstanceConfiguration configuration) {
var result = await agent.InstanceSessionManager.Configure(instanceInfo); Logger.Fatal("Unable to configure instance \"{Name}\" (GUID {Guid}), shutting down.", configuration.InstanceName, configuration.InstanceGuid);
if (!result.Is(ConfigureInstanceResult.Success)) { shutdownTokenSource.Cancel();
Logger.Fatal("Unable to configure instance \"{Name}\" (GUID {Guid}), shutting down.", instanceInfo.InstanceName, instanceInfo.InstanceGuid); }
shutdownTokenSource.Cancel(); foreach (var configureInstanceMessage in message.InitialInstanceConfigurations) {
var result = await HandleConfigureInstance(configureInstanceMessage, alwaysReportStatus: true);
if (!result.Is(ConfigureInstanceResult.Success)) {
ShutdownAfterConfigurationFailed(configureInstanceMessage.Configuration);
return NoReply.Instance; return NoReply.Instance;
} }
} }
@@ -55,8 +59,12 @@ public sealed class MessageListener : IMessageToAgentListener {
return Task.FromResult(NoReply.Instance); return Task.FromResult(NoReply.Instance);
} }
private Task<InstanceActionResult<ConfigureInstanceResult>> HandleConfigureInstance(ConfigureInstanceMessage message, bool alwaysReportStatus) {
return agent.InstanceSessionManager.Configure(message.Configuration, message.LaunchProperties, message.LaunchNow, alwaysReportStatus);
}
public async Task<InstanceActionResult<ConfigureInstanceResult>> HandleConfigureInstance(ConfigureInstanceMessage message) { public async Task<InstanceActionResult<ConfigureInstanceResult>> HandleConfigureInstance(ConfigureInstanceMessage message) {
return await agent.InstanceSessionManager.Configure(message.Configuration); return await HandleConfigureInstance(message, alwaysReportStatus: false);
} }
public async Task<InstanceActionResult<LaunchInstanceResult>> HandleLaunchInstance(LaunchInstanceMessage message) { public async Task<InstanceActionResult<LaunchInstanceResult>> HandleLaunchInstance(LaunchInstanceMessage message) {

View File

@@ -15,6 +15,5 @@ public sealed partial record InstanceConfiguration(
[property: MemoryPackOrder(6)] MinecraftServerKind MinecraftServerKind, [property: MemoryPackOrder(6)] MinecraftServerKind MinecraftServerKind,
[property: MemoryPackOrder(7)] RamAllocationUnits MemoryAllocation, [property: MemoryPackOrder(7)] RamAllocationUnits MemoryAllocation,
[property: MemoryPackOrder(8)] Guid JavaRuntimeGuid, [property: MemoryPackOrder(8)] Guid JavaRuntimeGuid,
[property: MemoryPackOrder(9)] ImmutableArray<string> JvmArguments, [property: MemoryPackOrder(9)] ImmutableArray<string> JvmArguments
[property: MemoryPackOrder(10)] bool LaunchAutomatically
); );

View File

@@ -10,22 +10,24 @@ public enum InstanceLaunchFailReason : byte {
InvalidJvmArguments, InvalidJvmArguments,
CouldNotDownloadMinecraftServer, CouldNotDownloadMinecraftServer,
CouldNotConfigureMinecraftServer, CouldNotConfigureMinecraftServer,
CouldNotPrepareMinecraftServerLauncher,
CouldNotStartMinecraftServer CouldNotStartMinecraftServer
} }
public static class InstanceLaunchFailReasonExtensions { public static class InstanceLaunchFailReasonExtensions {
public static string ToSentence(this InstanceLaunchFailReason reason) { public static string ToSentence(this InstanceLaunchFailReason reason) {
return reason switch { return reason switch {
InstanceLaunchFailReason.ServerPortNotAllowed => "Server port not allowed.", InstanceLaunchFailReason.ServerPortNotAllowed => "Server port not allowed.",
InstanceLaunchFailReason.ServerPortAlreadyInUse => "Server port already in use.", InstanceLaunchFailReason.ServerPortAlreadyInUse => "Server port already in use.",
InstanceLaunchFailReason.RconPortNotAllowed => "Rcon port not allowed.", InstanceLaunchFailReason.RconPortNotAllowed => "Rcon port not allowed.",
InstanceLaunchFailReason.RconPortAlreadyInUse => "Rcon port already in use.", InstanceLaunchFailReason.RconPortAlreadyInUse => "Rcon port already in use.",
InstanceLaunchFailReason.JavaRuntimeNotFound => "Java runtime not found.", InstanceLaunchFailReason.JavaRuntimeNotFound => "Java runtime not found.",
InstanceLaunchFailReason.InvalidJvmArguments => "Invalid JVM arguments.", InstanceLaunchFailReason.InvalidJvmArguments => "Invalid JVM arguments.",
InstanceLaunchFailReason.CouldNotDownloadMinecraftServer => "Could not download Minecraft server.", InstanceLaunchFailReason.CouldNotDownloadMinecraftServer => "Could not download Minecraft server.",
InstanceLaunchFailReason.CouldNotConfigureMinecraftServer => "Could not configure Minecraft server.", InstanceLaunchFailReason.CouldNotConfigureMinecraftServer => "Could not configure Minecraft server.",
InstanceLaunchFailReason.CouldNotStartMinecraftServer => "Could not start Minecraft server.", InstanceLaunchFailReason.CouldNotPrepareMinecraftServerLauncher => "Could not prepare Minecraft server launcher.",
_ => "Unknown error." InstanceLaunchFailReason.CouldNotStartMinecraftServer => "Could not start Minecraft server.",
_ => "Unknown error."
}; };
} }
} }

View File

@@ -0,0 +1,9 @@
using MemoryPack;
using Phantom.Common.Data.Minecraft;
namespace Phantom.Common.Data.Instance;
[MemoryPackable]
public sealed partial record InstanceLaunchProperties(
[property: MemoryPackOrder(0)] FileDownloadInfo? ServerDownloadInfo
);

View File

@@ -0,0 +1,30 @@
using MemoryPack;
using Phantom.Utils.Cryptography;
using Phantom.Utils.IO;
namespace Phantom.Common.Data.Minecraft;
[MemoryPackable]
public sealed partial class FileDownloadInfo {
[MemoryPackOrder(0)]
public string DownloadUrl { get; }
[MemoryPackOrder(1)]
[MemoryPackInclude]
private readonly string hash;
[MemoryPackIgnore]
public Sha1String Hash => Sha1String.FromString(hash);
[MemoryPackOrder(2)]
public FileSize Size { get; }
public FileDownloadInfo(string downloadUrl, Sha1String hash, FileSize size) : this(downloadUrl, hash.ToString(), size) {}
[MemoryPackConstructor]
private FileDownloadInfo(string downloadUrl, string hash, FileSize size) {
this.DownloadUrl = downloadUrl;
this.hash = hash;
this.Size = size;
}
}

View File

@@ -1,5 +1,6 @@
namespace Phantom.Common.Data.Minecraft; namespace Phantom.Common.Data.Minecraft;
public enum MinecraftServerKind : ushort { public enum MinecraftServerKind : ushort {
Vanilla = 1 Vanilla = 1,
Fabric = 2
} }

View File

@@ -8,6 +8,7 @@
<ItemGroup> <ItemGroup>
<PackageReference Include="Serilog" /> <PackageReference Include="Serilog" />
<PackageReference Include="Serilog.Sinks.Async" />
<PackageReference Include="Serilog.Sinks.Console" /> <PackageReference Include="Serilog.Sinks.Console" />
</ItemGroup> </ItemGroup>

View File

@@ -18,7 +18,7 @@ public static class PhantomLogger {
.MinimumLevel.Override("Microsoft.EntityFrameworkCore.Database.Command", DefaultLogLevel.Coerce(LogEventLevel.Warning)) .MinimumLevel.Override("Microsoft.EntityFrameworkCore.Database.Command", DefaultLogLevel.Coerce(LogEventLevel.Warning))
.Filter.ByExcluding(static e => e.Exception is OperationCanceledException) .Filter.ByExcluding(static e => e.Exception is OperationCanceledException)
.Enrich.FromLogContext() .Enrich.FromLogContext()
.WriteTo.Console(outputTemplate: template, formatProvider: CultureInfo.InvariantCulture, theme: AnsiConsoleTheme.Literate) .WriteTo.Async(c => c.Console(outputTemplate: template, formatProvider: CultureInfo.InvariantCulture, theme: AnsiConsoleTheme.Literate))
.CreateLogger(); .CreateLogger();
} }

View File

@@ -6,7 +6,9 @@ namespace Phantom.Common.Messages.ToAgent;
[MemoryPackable] [MemoryPackable]
public sealed partial record ConfigureInstanceMessage( public sealed partial record ConfigureInstanceMessage(
[property: MemoryPackOrder(0)] InstanceConfiguration Configuration [property: MemoryPackOrder(0)] InstanceConfiguration Configuration,
[property: MemoryPackOrder(1)] InstanceLaunchProperties LaunchProperties,
[property: MemoryPackOrder(2)] bool LaunchNow = false
) : IMessageToAgent<InstanceActionResult<ConfigureInstanceResult>> { ) : IMessageToAgent<InstanceActionResult<ConfigureInstanceResult>> {
public Task<InstanceActionResult<ConfigureInstanceResult>> Accept(IMessageToAgentListener listener) { public Task<InstanceActionResult<ConfigureInstanceResult>> Accept(IMessageToAgentListener listener) {
return listener.HandleConfigureInstance(this); return listener.HandleConfigureInstance(this);

View File

@@ -1,13 +1,12 @@
using System.Collections.Immutable; using System.Collections.Immutable;
using MemoryPack; using MemoryPack;
using Phantom.Common.Data.Instance;
using Phantom.Utils.Rpc.Message; using Phantom.Utils.Rpc.Message;
namespace Phantom.Common.Messages.ToAgent; namespace Phantom.Common.Messages.ToAgent;
[MemoryPackable] [MemoryPackable]
public sealed partial record RegisterAgentSuccessMessage( public sealed partial record RegisterAgentSuccessMessage(
[property: MemoryPackOrder(0)] ImmutableArray<InstanceConfiguration> InitialInstances [property: MemoryPackOrder(0)] ImmutableArray<ConfigureInstanceMessage> InitialInstanceConfigurations
) : IMessageToAgent { ) : IMessageToAgent {
public Task<NoReply> Accept(IMessageToAgentListener listener) { public Task<NoReply> Accept(IMessageToAgentListener listener) {
return listener.HandleRegisterAgentSuccess(this); return listener.HandleRegisterAgentSuccess(this);

View File

@@ -1,10 +0,0 @@
using Phantom.Utils.Cryptography;
using Phantom.Utils.IO;
namespace Phantom.Common.Minecraft;
public sealed record MinecraftServerExecutableInfo(
string DownloadUrl,
Sha1String Hash,
FileSize Size
);

View File

@@ -6,11 +6,4 @@
<Nullable>enable</Nullable> <Nullable>enable</Nullable>
</PropertyGroup> </PropertyGroup>
<ItemGroup>
<ProjectReference Include="..\..\Utils\Phantom.Utils.IO\Phantom.Utils.IO.csproj" />
<ProjectReference Include="..\..\Utils\Phantom.Utils.Runtime\Phantom.Utils.Runtime.csproj" />
<ProjectReference Include="..\Phantom.Common.Data\Phantom.Common.Data.csproj" />
<ProjectReference Include="..\Phantom.Common.Logging\Phantom.Common.Logging.csproj" />
</ItemGroup>
</Project> </Project>

View File

@@ -20,6 +20,7 @@
<ItemGroup> <ItemGroup>
<PackageReference Update="Serilog" Version="2.12.0" /> <PackageReference Update="Serilog" Version="2.12.0" />
<PackageReference Update="Serilog.AspNetCore" Version="6.1.0" /> <PackageReference Update="Serilog.AspNetCore" Version="6.1.0" />
<PackageReference Update="Serilog.Sinks.Async" Version="1.5.0" />
<PackageReference Update="Serilog.Sinks.Console" Version="4.1.0" /> <PackageReference Update="Serilog.Sinks.Console" Version="4.1.0" />
</ItemGroup> </ItemGroup>

View File

@@ -36,6 +36,8 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Phantom.Server.Database", "
EndProject EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Phantom.Server.Database.Postgres", "Server\Phantom.Server.Database.Postgres\Phantom.Server.Database.Postgres.csproj", "{81625B4A-3DB6-48BD-A739-D23DA02107D1}" Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Phantom.Server.Database.Postgres", "Server\Phantom.Server.Database.Postgres\Phantom.Server.Database.Postgres.csproj", "{81625B4A-3DB6-48BD-A739-D23DA02107D1}"
EndProject EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Phantom.Server.Minecraft", "Server\Phantom.Server.Minecraft\Phantom.Server.Minecraft.csproj", "{4B3B73E6-48DD-4846-87FD-DFB86619B67C}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Phantom.Server.Rpc", "Server\Phantom.Server.Rpc\Phantom.Server.Rpc.csproj", "{79312D72-44E0-431D-96A4-4C0A066B9671}" Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Phantom.Server.Rpc", "Server\Phantom.Server.Rpc\Phantom.Server.Rpc.csproj", "{79312D72-44E0-431D-96A4-4C0A066B9671}"
EndProject EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Phantom.Server.Services", "Server\Phantom.Server.Services\Phantom.Server.Services.csproj", "{90F0F1B1-EB0A-49C9-8DF0-1153A87F77C9}" Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Phantom.Server.Services", "Server\Phantom.Server.Services\Phantom.Server.Services.csproj", "{90F0F1B1-EB0A-49C9-8DF0-1153A87F77C9}"
@@ -118,6 +120,10 @@ Global
{81625B4A-3DB6-48BD-A739-D23DA02107D1}.Debug|Any CPU.Build.0 = Debug|Any CPU {81625B4A-3DB6-48BD-A739-D23DA02107D1}.Debug|Any CPU.Build.0 = Debug|Any CPU
{81625B4A-3DB6-48BD-A739-D23DA02107D1}.Release|Any CPU.ActiveCfg = Release|Any CPU {81625B4A-3DB6-48BD-A739-D23DA02107D1}.Release|Any CPU.ActiveCfg = Release|Any CPU
{81625B4A-3DB6-48BD-A739-D23DA02107D1}.Release|Any CPU.Build.0 = Release|Any CPU {81625B4A-3DB6-48BD-A739-D23DA02107D1}.Release|Any CPU.Build.0 = Release|Any CPU
{4B3B73E6-48DD-4846-87FD-DFB86619B67C}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{4B3B73E6-48DD-4846-87FD-DFB86619B67C}.Debug|Any CPU.Build.0 = Debug|Any CPU
{4B3B73E6-48DD-4846-87FD-DFB86619B67C}.Release|Any CPU.ActiveCfg = Release|Any CPU
{4B3B73E6-48DD-4846-87FD-DFB86619B67C}.Release|Any CPU.Build.0 = Release|Any CPU
{79312D72-44E0-431D-96A4-4C0A066B9671}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {79312D72-44E0-431D-96A4-4C0A066B9671}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{79312D72-44E0-431D-96A4-4C0A066B9671}.Debug|Any CPU.Build.0 = Debug|Any CPU {79312D72-44E0-431D-96A4-4C0A066B9671}.Debug|Any CPU.Build.0 = Debug|Any CPU
{79312D72-44E0-431D-96A4-4C0A066B9671}.Release|Any CPU.ActiveCfg = Release|Any CPU {79312D72-44E0-431D-96A4-4C0A066B9671}.Release|Any CPU.ActiveCfg = Release|Any CPU
@@ -184,6 +190,7 @@ Global
{A0F1C595-96B6-4DBF-8C16-6B99223F8F35} = {8AC8FB6C-033A-4626-820F-ED0F908756B2} {A0F1C595-96B6-4DBF-8C16-6B99223F8F35} = {8AC8FB6C-033A-4626-820F-ED0F908756B2}
{E3AD566F-384A-489A-A3BB-EA3BA400C18C} = {8AC8FB6C-033A-4626-820F-ED0F908756B2} {E3AD566F-384A-489A-A3BB-EA3BA400C18C} = {8AC8FB6C-033A-4626-820F-ED0F908756B2}
{81625B4A-3DB6-48BD-A739-D23DA02107D1} = {8AC8FB6C-033A-4626-820F-ED0F908756B2} {81625B4A-3DB6-48BD-A739-D23DA02107D1} = {8AC8FB6C-033A-4626-820F-ED0F908756B2}
{4B3B73E6-48DD-4846-87FD-DFB86619B67C} = {8AC8FB6C-033A-4626-820F-ED0F908756B2}
{79312D72-44E0-431D-96A4-4C0A066B9671} = {8AC8FB6C-033A-4626-820F-ED0F908756B2} {79312D72-44E0-431D-96A4-4C0A066B9671} = {8AC8FB6C-033A-4626-820F-ED0F908756B2}
{90F0F1B1-EB0A-49C9-8DF0-1153A87F77C9} = {8AC8FB6C-033A-4626-820F-ED0F908756B2} {90F0F1B1-EB0A-49C9-8DF0-1153A87F77C9} = {8AC8FB6C-033A-4626-820F-ED0F908756B2}
{7CA2E5FE-E507-4DC6-930C-E18711A9F856} = {8AC8FB6C-033A-4626-820F-ED0F908756B2} {7CA2E5FE-E507-4DC6-930C-E18711A9F856} = {8AC8FB6C-033A-4626-820F-ED0F908756B2}

View File

@@ -1,5 +1,4 @@
using System.Collections.Immutable; using System.Collections.Immutable;
using System.Diagnostics;
using System.Net.Http.Json; using System.Net.Http.Json;
using System.Text.Json; using System.Text.Json;
using Phantom.Common.Data.Minecraft; using Phantom.Common.Data.Minecraft;
@@ -9,71 +8,39 @@ using Phantom.Utils.IO;
using Phantom.Utils.Runtime; using Phantom.Utils.Runtime;
using Serilog; using Serilog;
namespace Phantom.Common.Minecraft; namespace Phantom.Server.Minecraft;
public sealed class MinecraftVersions : IDisposable { sealed class MinecraftVersionApi : IDisposable {
private static readonly ILogger Logger = PhantomLogger.Create<MinecraftVersions>(); private static readonly ILogger Logger = PhantomLogger.Create<MinecraftVersionApi>();
private static readonly TimeSpan CacheRetentionTime = TimeSpan.FromMinutes(10);
private const string VersionManifestUrl = "https://launchermeta.mojang.com/mc/game/version_manifest.json"; private const string VersionManifestUrl = "https://launchermeta.mojang.com/mc/game/version_manifest.json";
private readonly HttpClient http = new (); private readonly HttpClient http = new ();
private readonly Stopwatch cacheTimer = new ();
private readonly SemaphoreSlim cachedVersionsSemaphore = new (1, 1);
private ImmutableArray<MinecraftVersion>? cachedVersions;
private ImmutableArray<MinecraftVersion>? CachedVersionsUnlessExpired => cacheTimer.IsRunning && cacheTimer.Elapsed < CacheRetentionTime ? cachedVersions : null;
public void Dispose() { public void Dispose() {
http.Dispose(); http.Dispose();
cachedVersionsSemaphore.Dispose();
} }
public async Task<ImmutableArray<MinecraftVersion>> GetVersions(CancellationToken cancellationToken) { public async Task<ImmutableArray<MinecraftVersion>> GetVersions(CancellationToken cancellationToken) {
if (CachedVersionsUnlessExpired is {} earlyResult) { return await FetchVersions(cancellationToken) ?? ImmutableArray<MinecraftVersion>.Empty;
return earlyResult;
}
try {
await cachedVersionsSemaphore.WaitAsync(cancellationToken);
} catch (OperationCanceledException) {
return ImmutableArray<MinecraftVersion>.Empty;
}
try {
if (CachedVersionsUnlessExpired is {} racedResult) {
return racedResult;
}
ImmutableArray<MinecraftVersion> versions = await FetchVersions(cancellationToken) ?? ImmutableArray<MinecraftVersion>.Empty;
Logger.Information("Refreshed Minecraft version cache, {Versions} version(s) found.", versions.Length);
cachedVersions = versions;
cacheTimer.Restart();
return versions;
} finally {
cachedVersionsSemaphore.Release();
}
} }
private async Task<ImmutableArray<MinecraftVersion>?> FetchVersions(CancellationToken cancellationToken) { private async Task<ImmutableArray<MinecraftVersion>?> FetchVersions(CancellationToken cancellationToken) {
return await FetchOrFailSilently(async () => { return await FetchOrFailSilently(async () => {
var versionManifest = await FetchJson(http, VersionManifestUrl, "version manifest", cancellationToken); var versionManifest = await FetchJson(VersionManifestUrl, "version manifest", cancellationToken);
return GetVersionsFromManifest(versionManifest); return GetVersionsFromManifest(versionManifest);
}); });
} }
public async Task<MinecraftServerExecutableInfo?> GetServerExecutableInfo(string version, CancellationToken cancellationToken) { public async Task<FileDownloadInfo?> GetServerExecutableInfo(ImmutableArray<MinecraftVersion> versions, string version, CancellationToken cancellationToken) {
return await FetchOrFailSilently(async () => { var versionObject = versions.FirstOrDefault(v => v.Id == version);
var versions = await GetVersions(cancellationToken); if (versionObject == null) {
var versionObject = versions.FirstOrDefault(v => v.Id == version); Logger.Error("Version {Version} was not found in version manifest.", version);
if (versionObject == null) { return null;
Logger.Error("Version {Version} was not found in version manifest.", version); }
return null;
}
var versionMetadata = await FetchJson(http, versionObject.MetadataUrl, "version metadata", cancellationToken); return await FetchOrFailSilently(async () => {
var versionMetadata = await FetchJson(versionObject.MetadataUrl, "version metadata", cancellationToken);
return GetServerExecutableInfoFromMetadata(versionMetadata); return GetServerExecutableInfoFromMetadata(versionMetadata);
}); });
} }
@@ -81,8 +48,6 @@ public sealed class MinecraftVersions : IDisposable {
private static async Task<T?> FetchOrFailSilently<T>(Func<Task<T?>> task) { private static async Task<T?> FetchOrFailSilently<T>(Func<Task<T?>> task) {
try { try {
return await task(); return await task();
} catch (OperationCanceledException) {
return default;
} catch (StopProcedureException) { } catch (StopProcedureException) {
return default; return default;
} catch (Exception e) { } catch (Exception e) {
@@ -91,14 +56,12 @@ public sealed class MinecraftVersions : IDisposable {
} }
} }
private static async Task<JsonElement> FetchJson(HttpClient http, string url, string description, CancellationToken cancellationToken) { private async Task<JsonElement> FetchJson(string url, string description, CancellationToken cancellationToken) {
Logger.Information("Fetching {Description} JSON from: {Url}", description, url); Logger.Debug("Fetching {Description} JSON from: {Url}", description, url);
try { try {
return await http.GetFromJsonAsync<JsonElement>(url, cancellationToken); return await http.GetFromJsonAsync<JsonElement>(url, cancellationToken);
} catch (OperationCanceledException) { } catch (HttpRequestException e) {
throw StopProcedureException.Instance;
} catch (HttpRequestException e) {
Logger.Error(e, "Unable to download {Description}.", description); Logger.Error(e, "Unable to download {Description}.", description);
throw StopProcedureException.Instance; throw StopProcedureException.Instance;
} catch (Exception e) { } catch (Exception e) {
@@ -117,7 +80,7 @@ public sealed class MinecraftVersions : IDisposable {
} catch (StopProcedureException) {} } catch (StopProcedureException) {}
} }
return foundVersions.ToImmutable(); return foundVersions.MoveToImmutable();
} }
private static MinecraftVersion GetVersionFromManifestEntry(JsonElement versionElement) { private static MinecraftVersion GetVersionFromManifestEntry(JsonElement versionElement) {
@@ -129,7 +92,7 @@ public sealed class MinecraftVersions : IDisposable {
var type = MinecraftVersionTypes.FromString(typeString); var type = MinecraftVersionTypes.FromString(typeString);
if (type == MinecraftVersionType.Other) { if (type == MinecraftVersionType.Other) {
Logger.Verbose("Unknown version type: {Type} ({Version})", typeString, id); Logger.Warning("Unknown version type: {Type} ({Version})", typeString, id);
} }
JsonElement urlElement = GetJsonPropertyOrThrow(versionElement, "url", JsonValueKind.String, "version entry in version manifest"); JsonElement urlElement = GetJsonPropertyOrThrow(versionElement, "url", JsonValueKind.String, "version entry in version manifest");
@@ -148,7 +111,7 @@ public sealed class MinecraftVersions : IDisposable {
return new MinecraftVersion(id, type, url); return new MinecraftVersion(id, type, url);
} }
private static MinecraftServerExecutableInfo GetServerExecutableInfoFromMetadata(JsonElement versionMetadata) { private static FileDownloadInfo GetServerExecutableInfoFromMetadata(JsonElement versionMetadata) {
JsonElement downloadsElement = GetJsonPropertyOrThrow(versionMetadata, "downloads", JsonValueKind.Object, "version metadata"); JsonElement downloadsElement = GetJsonPropertyOrThrow(versionMetadata, "downloads", JsonValueKind.Object, "version metadata");
JsonElement serverElement = GetJsonPropertyOrThrow(downloadsElement, "server", JsonValueKind.Object, "downloads object in version metadata"); JsonElement serverElement = GetJsonPropertyOrThrow(downloadsElement, "server", JsonValueKind.Object, "downloads object in version metadata");
JsonElement urlElement = GetJsonPropertyOrThrow(serverElement, "url", JsonValueKind.String, "downloads.server object in version metadata"); JsonElement urlElement = GetJsonPropertyOrThrow(serverElement, "url", JsonValueKind.String, "downloads.server object in version metadata");
@@ -182,7 +145,7 @@ public sealed class MinecraftVersions : IDisposable {
throw StopProcedureException.Instance; throw StopProcedureException.Instance;
} }
return new MinecraftServerExecutableInfo(url, hash, new FileSize(size)); return new FileDownloadInfo(url, hash, new FileSize(size));
} }
private static JsonElement GetJsonPropertyOrThrow(JsonElement parentElement, string propertyKey, JsonValueKind expectedKind, string location) { private static JsonElement GetJsonPropertyOrThrow(JsonElement parentElement, string propertyKey, JsonValueKind expectedKind, string location) {

View File

@@ -0,0 +1,75 @@
using System.Collections.Immutable;
using System.Diagnostics;
using Phantom.Common.Data.Minecraft;
using Phantom.Common.Logging;
using Serilog;
namespace Phantom.Server.Minecraft;
public sealed class MinecraftVersions : IDisposable {
private static readonly ILogger Logger = PhantomLogger.Create<MinecraftVersions>();
private static readonly TimeSpan CacheRetentionTime = TimeSpan.FromMinutes(10);
private readonly MinecraftVersionApi api = new ();
private readonly Stopwatch cacheTimer = new ();
private readonly SemaphoreSlim cacheSemaphore = new (1, 1);
private bool IsCacheNotExpired => cacheTimer.IsRunning && cacheTimer.Elapsed < CacheRetentionTime;
private ImmutableArray<MinecraftVersion>? cachedVersions;
private readonly Dictionary<string, FileDownloadInfo?> cachedServerExecutables = new ();
public void Dispose() {
api.Dispose();
cacheSemaphore.Dispose();
}
public async Task<ImmutableArray<MinecraftVersion>> GetVersions(CancellationToken cancellationToken) {
return await GetCachedObject(() => cachedVersions != null, () => cachedVersions.GetValueOrDefault(), v => cachedVersions = v, LoadVersions, cancellationToken);
}
private async Task<ImmutableArray<MinecraftVersion>> LoadVersions(CancellationToken cancellationToken) {
ImmutableArray<MinecraftVersion> versions = await api.GetVersions(cancellationToken);
Logger.Information("Refreshed Minecraft version cache, {Versions} version(s) found.", versions.Length);
return versions;
}
public async Task<FileDownloadInfo?> GetServerExecutableInfo(string version, CancellationToken cancellationToken) {
var versions = await GetVersions(cancellationToken);
return await GetCachedObject(() => cachedServerExecutables.ContainsKey(version), () => cachedServerExecutables[version], v => cachedServerExecutables[version] = v, ct => LoadServerExecutableInfo(versions, version, ct), cancellationToken);
}
private async Task<FileDownloadInfo?> LoadServerExecutableInfo(ImmutableArray<MinecraftVersion> versions, string version, CancellationToken cancellationToken) {
var info = await api.GetServerExecutableInfo(versions, version, cancellationToken);
if (info == null) {
Logger.Information("Refreshed Minecraft {Version} server executable cache, no file found.", version);
}
else {
Logger.Information("Refreshed Minecraft {Version} server executable cache, found file: {Url}.", version, info.DownloadUrl);
}
return info;
}
private async Task<T> GetCachedObject<T>(Func<bool> isLoaded, Func<T> fieldGetter, Action<T> fieldSetter, Func<CancellationToken, Task<T>> fieldLoader, CancellationToken cancellationToken) {
if (IsCacheNotExpired && isLoaded()) {
return fieldGetter();
}
await cacheSemaphore.WaitAsync(cancellationToken);
try {
if (IsCacheNotExpired && isLoaded()) {
return fieldGetter();
}
T result = await fieldLoader(cancellationToken);
fieldSetter(result);
cacheTimer.Restart();
return result;
} finally {
cacheSemaphore.Release();
}
}
}

View File

@@ -0,0 +1,15 @@
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<TargetFramework>net7.0</TargetFramework>
<ImplicitUsings>enable</ImplicitUsings>
<Nullable>enable</Nullable>
</PropertyGroup>
<ItemGroup>
<ProjectReference Include="..\..\Common\Phantom.Common.Data\Phantom.Common.Data.csproj" />
<ProjectReference Include="..\..\Common\Phantom.Common.Logging\Phantom.Common.Logging.csproj" />
<ProjectReference Include="..\..\Utils\Phantom.Utils.Runtime\Phantom.Utils.Runtime.csproj" />
</ItemGroup>
</Project>

View File

@@ -46,7 +46,7 @@ public sealed class RpcLauncher : RpcRuntime<ServerSocket> {
void OnConnectionClosed(object? sender, RpcClientConnectionClosedEventArgs e) { void OnConnectionClosed(object? sender, RpcClientConnectionClosedEventArgs e) {
clients.Remove(e.RoutingId); clients.Remove(e.RoutingId);
logger.Verbose("Closed connection to {RoutingId}.", e.RoutingId); logger.Debug("Closed connection to {RoutingId}.", e.RoutingId);
} }
while (!cancellationToken.IsCancellationRequested) { while (!cancellationToken.IsCancellationRequested) {

View File

@@ -82,7 +82,9 @@ public sealed class AgentManager {
Logger.Information("Registered agent \"{Name}\" (GUID {Guid}).", agent.Name, agent.Guid); Logger.Information("Registered agent \"{Name}\" (GUID {Guid}).", agent.Name, agent.Guid);
await connection.Send(new RegisterAgentSuccessMessage(instanceManager.GetInstanceConfigurationsForAgent(agent.Guid))); var instanceConfigurations = await instanceManager.GetInstanceConfigurationsForAgent(agent.Guid);
await connection.Send(new RegisterAgentSuccessMessage(instanceConfigurations));
return true; return true;
} }

View File

@@ -5,17 +5,19 @@ public enum AddOrEditInstanceResult : byte {
Success, Success,
InstanceNameMustNotBeEmpty, InstanceNameMustNotBeEmpty,
InstanceMemoryMustNotBeZero, InstanceMemoryMustNotBeZero,
MinecraftVersionDownloadInfoNotFound,
AgentNotFound AgentNotFound
} }
public static class AddOrEditInstanceResultExtensions { public static class AddOrEditInstanceResultExtensions {
public static string ToSentence(this AddOrEditInstanceResult reason) { public static string ToSentence(this AddOrEditInstanceResult reason) {
return reason switch { return reason switch {
AddOrEditInstanceResult.Success => "Success.", AddOrEditInstanceResult.Success => "Success.",
AddOrEditInstanceResult.InstanceNameMustNotBeEmpty => "Instance name must not be empty.", AddOrEditInstanceResult.InstanceNameMustNotBeEmpty => "Instance name must not be empty.",
AddOrEditInstanceResult.InstanceMemoryMustNotBeZero => "Memory must not be 0 MB.", AddOrEditInstanceResult.InstanceMemoryMustNotBeZero => "Memory must not be 0 MB.",
AddOrEditInstanceResult.AgentNotFound => "Agent not found.", AddOrEditInstanceResult.MinecraftVersionDownloadInfoNotFound => "Could not find download information for the selected Minecraft version.",
_ => "Unknown error." AddOrEditInstanceResult.AgentNotFound => "Agent not found.",
_ => "Unknown error."
}; };
} }
} }

View File

@@ -4,7 +4,8 @@ namespace Phantom.Server.Services.Instances;
public sealed record Instance( public sealed record Instance(
InstanceConfiguration Configuration, InstanceConfiguration Configuration,
IInstanceStatus Status IInstanceStatus Status,
bool LaunchAutomatically
) { ) {
internal Instance(InstanceConfiguration configuration) : this(configuration, InstanceStatus.Offline) {} internal Instance(InstanceConfiguration configuration, bool launchAutomatically = false) : this(configuration, InstanceStatus.Offline, launchAutomatically) {}
} }

View File

@@ -10,6 +10,7 @@ using Phantom.Common.Messages.ToAgent;
using Phantom.Common.Minecraft; using Phantom.Common.Minecraft;
using Phantom.Server.Database; using Phantom.Server.Database;
using Phantom.Server.Database.Entities; using Phantom.Server.Database.Entities;
using Phantom.Server.Minecraft;
using Phantom.Server.Services.Agents; using Phantom.Server.Services.Agents;
using Phantom.Utils.Collections; using Phantom.Utils.Collections;
using Phantom.Utils.Events; using Phantom.Utils.Events;
@@ -26,12 +27,14 @@ public sealed class InstanceManager {
private readonly CancellationToken cancellationToken; private readonly CancellationToken cancellationToken;
private readonly AgentManager agentManager; private readonly AgentManager agentManager;
private readonly MinecraftVersions minecraftVersions;
private readonly DatabaseProvider databaseProvider; private readonly DatabaseProvider databaseProvider;
private readonly SemaphoreSlim modifyInstancesSemaphore = new (1, 1); private readonly SemaphoreSlim modifyInstancesSemaphore = new (1, 1);
public InstanceManager(ServiceConfiguration configuration, AgentManager agentManager, DatabaseProvider databaseProvider) { public InstanceManager(ServiceConfiguration configuration, AgentManager agentManager, MinecraftVersions minecraftVersions, DatabaseProvider databaseProvider) {
this.cancellationToken = configuration.CancellationToken; this.cancellationToken = configuration.CancellationToken;
this.agentManager = agentManager; this.agentManager = agentManager;
this.minecraftVersions = minecraftVersions;
this.databaseProvider = databaseProvider; this.databaseProvider = databaseProvider;
} }
@@ -49,11 +52,10 @@ public sealed class InstanceManager {
entity.MinecraftServerKind, entity.MinecraftServerKind,
entity.MemoryAllocation, entity.MemoryAllocation,
entity.JavaRuntimeGuid, entity.JavaRuntimeGuid,
JvmArgumentsHelper.Split(entity.JvmArguments), JvmArgumentsHelper.Split(entity.JvmArguments)
entity.LaunchAutomatically
); );
var instance = new Instance(configuration); var instance = new Instance(configuration, entity.LaunchAutomatically);
instances.ByGuid[instance.Configuration.InstanceGuid] = instance; instances.ByGuid[instance.Configuration.InstanceGuid] = instance;
} }
} }
@@ -73,23 +75,29 @@ public sealed class InstanceManager {
return InstanceActionResult.Concrete(AddOrEditInstanceResult.InstanceMemoryMustNotBeZero); return InstanceActionResult.Concrete(AddOrEditInstanceResult.InstanceMemoryMustNotBeZero);
} }
var serverExecutableInfo = await minecraftVersions.GetServerExecutableInfo(configuration.MinecraftVersion, cancellationToken);
if (serverExecutableInfo == null) {
return InstanceActionResult.Concrete(AddOrEditInstanceResult.MinecraftVersionDownloadInfoNotFound);
}
InstanceActionResult<AddOrEditInstanceResult> result; InstanceActionResult<AddOrEditInstanceResult> result;
bool isNewInstance; bool isNewInstance;
await modifyInstancesSemaphore.WaitAsync(cancellationToken); await modifyInstancesSemaphore.WaitAsync(cancellationToken);
try { try {
var instance = new Instance(configuration); isNewInstance = !instances.ByGuid.TryReplace(configuration.InstanceGuid, instance => instance with { Configuration = configuration });
instances.ByGuid.AddOrReplace(instance.Configuration.InstanceGuid, instance, out var oldInstance); if (isNewInstance) {
instances.ByGuid.TryAdd(configuration.InstanceGuid, new Instance(configuration));
}
var reply = await agentManager.SendMessage<ConfigureInstanceMessage, InstanceActionResult<ConfigureInstanceResult>>(configuration.AgentGuid, new ConfigureInstanceMessage(configuration), TimeSpan.FromSeconds(10)); var message = new ConfigureInstanceMessage(configuration, new InstanceLaunchProperties(serverExecutableInfo));
var reply = await agentManager.SendMessage<ConfigureInstanceMessage, InstanceActionResult<ConfigureInstanceResult>>(configuration.AgentGuid, message, TimeSpan.FromSeconds(10));
result = reply.DidNotReplyIfNull().Map(static result => result switch { result = reply.DidNotReplyIfNull().Map(static result => result switch {
ConfigureInstanceResult.Success => AddOrEditInstanceResult.Success, ConfigureInstanceResult.Success => AddOrEditInstanceResult.Success,
_ => AddOrEditInstanceResult.UnknownError _ => AddOrEditInstanceResult.UnknownError
}); });
isNewInstance = oldInstance == null;
if (result.Is(AddOrEditInstanceResult.Success)) { if (result.Is(AddOrEditInstanceResult.Success)) {
using var scope = databaseProvider.CreateScope(); using var scope = databaseProvider.CreateScope();
InstanceEntity entity = scope.Ctx.InstanceUpsert.Fetch(configuration.InstanceGuid); InstanceEntity entity = scope.Ctx.InstanceUpsert.Fetch(configuration.InstanceGuid);
@@ -103,7 +111,6 @@ public sealed class InstanceManager {
entity.MemoryAllocation = configuration.MemoryAllocation; entity.MemoryAllocation = configuration.MemoryAllocation;
entity.JavaRuntimeGuid = configuration.JavaRuntimeGuid; entity.JavaRuntimeGuid = configuration.JavaRuntimeGuid;
entity.JvmArguments = JvmArgumentsHelper.Join(configuration.JvmArguments); entity.JvmArguments = JvmArgumentsHelper.Join(configuration.JvmArguments);
entity.LaunchAutomatically = configuration.LaunchAutomatically;
await scope.Ctx.SaveChangesAsync(cancellationToken); await scope.Ctx.SaveChangesAsync(cancellationToken);
} }
@@ -180,9 +187,7 @@ public sealed class InstanceManager {
private async Task SetInstanceShouldLaunchAutomatically(Guid instanceGuid, bool shouldLaunchAutomatically) { private async Task SetInstanceShouldLaunchAutomatically(Guid instanceGuid, bool shouldLaunchAutomatically) {
await modifyInstancesSemaphore.WaitAsync(cancellationToken); await modifyInstancesSemaphore.WaitAsync(cancellationToken);
try { try {
instances.ByGuid.TryReplace(instanceGuid, instance => instance with { instances.ByGuid.TryReplace(instanceGuid, instance => instance with { LaunchAutomatically = shouldLaunchAutomatically });
Configuration = instance.Configuration with { LaunchAutomatically = shouldLaunchAutomatically }
});
using var scope = databaseProvider.CreateScope(); using var scope = databaseProvider.CreateScope();
var entity = await scope.Ctx.Instances.FindAsync(instanceGuid, cancellationToken); var entity = await scope.Ctx.Instances.FindAsync(instanceGuid, cancellationToken);
@@ -199,8 +204,15 @@ public sealed class InstanceManager {
return await SendInstanceActionMessage<SendCommandToInstanceMessage, SendCommandToInstanceResult>(instanceGuid, new SendCommandToInstanceMessage(instanceGuid, command)); return await SendInstanceActionMessage<SendCommandToInstanceMessage, SendCommandToInstanceResult>(instanceGuid, new SendCommandToInstanceMessage(instanceGuid, command));
} }
internal ImmutableArray<InstanceConfiguration> GetInstanceConfigurationsForAgent(Guid agentGuid) { internal async Task<ImmutableArray<ConfigureInstanceMessage>> GetInstanceConfigurationsForAgent(Guid agentGuid) {
return instances.ByGuid.ValuesCopy.Select(static instance => instance.Configuration).Where(configuration => configuration.AgentGuid == agentGuid).ToImmutableArray(); var configurationMessages = ImmutableArray.CreateBuilder<ConfigureInstanceMessage>();
foreach (var (configuration, _, launchAutomatically) in instances.ByGuid.ValuesCopy.Where(instance => instance.Configuration.AgentGuid == agentGuid)) {
var serverExecutableInfo = await minecraftVersions.GetServerExecutableInfo(configuration.MinecraftVersion, cancellationToken);
configurationMessages.Add(new ConfigureInstanceMessage(configuration, new InstanceLaunchProperties(serverExecutableInfo), launchAutomatically));
}
return configurationMessages.ToImmutable();
} }
private sealed class ObservableInstances : ObservableState<ImmutableDictionary<Guid, Instance>> { private sealed class ObservableInstances : ObservableState<ImmutableDictionary<Guid, Instance>> {

View File

@@ -16,6 +16,7 @@
<ProjectReference Include="..\..\Utils\Phantom.Utils.Collections\Phantom.Utils.Collections.csproj" /> <ProjectReference Include="..\..\Utils\Phantom.Utils.Collections\Phantom.Utils.Collections.csproj" />
<ProjectReference Include="..\..\Utils\Phantom.Utils.Events\Phantom.Utils.Events.csproj" /> <ProjectReference Include="..\..\Utils\Phantom.Utils.Events\Phantom.Utils.Events.csproj" />
<ProjectReference Include="..\Phantom.Server.Database\Phantom.Server.Database.csproj" /> <ProjectReference Include="..\Phantom.Server.Database\Phantom.Server.Database.csproj" />
<ProjectReference Include="..\Phantom.Server.Minecraft\Phantom.Server.Minecraft.csproj" />
<ProjectReference Include="..\Phantom.Server.Rpc\Phantom.Server.Rpc.csproj" /> <ProjectReference Include="..\Phantom.Server.Rpc\Phantom.Server.Rpc.csproj" />
</ItemGroup> </ItemGroup>

View File

@@ -9,6 +9,7 @@ using Phantom.Server.Services.Agents;
using Phantom.Server.Services.Events; using Phantom.Server.Services.Events;
using Phantom.Server.Services.Instances; using Phantom.Server.Services.Instances;
using Phantom.Utils.Rpc.Message; using Phantom.Utils.Rpc.Message;
using Phantom.Utils.Runtime;
namespace Phantom.Server.Services.Rpc; namespace Phantom.Server.Services.Rpc;
@@ -21,7 +22,7 @@ public sealed class MessageToServerListener : IMessageToServerListener {
private readonly InstanceLogManager instanceLogManager; private readonly InstanceLogManager instanceLogManager;
private readonly EventLog eventLog; private readonly EventLog eventLog;
private readonly TaskCompletionSource<Guid> agentGuidWaiter = new (); private readonly TaskCompletionSource<Guid> agentGuidWaiter = Tasks.CreateCompletionSource<Guid>();
public bool IsDisposed { get; private set; } public bool IsDisposed { get; private set; }

View File

@@ -40,7 +40,7 @@ public sealed class PhantomLoginManager {
var result = await signInManager.CheckPasswordSignInAsync(user, password, lockoutOnFailure: true); var result = await signInManager.CheckPasswordSignInAsync(user, password, lockoutOnFailure: true);
if (result == SignInResult.Success) { if (result == SignInResult.Success) {
Logger.Verbose("Created login token for {Username}.", username); Logger.Debug("Created login token for {Username}.", username);
string token = TokenGenerator.Create(60); string token = TokenGenerator.Create(60);
loginStore.Add(token, user, password, returnUrl ?? string.Empty); loginStore.Add(token, user, password, returnUrl ?? string.Empty);

View File

@@ -30,7 +30,7 @@ public sealed class PhantomLoginStore {
foreach (var (token, entry) in loginEntries) { foreach (var (token, entry) in loginEntries) {
if (entry.IsExpired) { if (entry.IsExpired) {
Logger.Verbose("Expired login entry for {Username}.", entry.User.UserName); Logger.Debug("Expired login entry for {Username}.", entry.User.UserName);
loginEntries.TryRemove(token, out _); loginEntries.TryRemove(token, out _);
} }
} }
@@ -50,7 +50,7 @@ public sealed class PhantomLoginStore {
} }
if (entry.IsExpired) { if (entry.IsExpired) {
Logger.Verbose("Expired login entry for {Username}.", entry.User.UserName); Logger.Debug("Expired login entry for {Username}.", entry.User.UserName);
return null; return null;
} }

View File

@@ -4,15 +4,13 @@
@using Phantom.Server.Services.Agents @using Phantom.Server.Services.Agents
@using Phantom.Server.Services.Events @using Phantom.Server.Services.Events
@using Phantom.Server.Services.Instances @using Phantom.Server.Services.Instances
@using Microsoft.AspNetCore.Identity
@using Phantom.Server.Database.Enums @using Phantom.Server.Database.Enums
@implements IDisposable @implements IDisposable
@inject AgentManager AgentManager @inject AgentManager AgentManager
@inject EventLog EventLog @inject EventLog EventLog
@inject InstanceManager InstanceManager @inject InstanceManager InstanceManager
@inject UserManager<IdentityUser> UserManager
<h1>Audit Log</h1> <h1>Event Log</h1>
<table class="table"> <table class="table">
<thead> <thead>

View File

@@ -29,7 +29,7 @@
</thead> </thead>
@if (!instances.IsEmpty) { @if (!instances.IsEmpty) {
<tbody> <tbody>
@foreach (var (configuration, status) in instances) { @foreach (var (configuration, status, _) in instances) {
var agentName = agentNames.TryGetValue(configuration.AgentGuid, out var name) ? name : string.Empty; var agentName = agentNames.TryGetValue(configuration.AgentGuid, out var name) ? name : string.Empty;
var instanceGuid = configuration.InstanceGuid.ToString(); var instanceGuid = configuration.InstanceGuid.ToString();
<tr> <tr>

View File

@@ -1,5 +1,6 @@
@using Phantom.Common.Data.Minecraft @using Phantom.Common.Data.Minecraft
@using Phantom.Common.Minecraft @using Phantom.Common.Minecraft
@using Phantom.Server.Minecraft
@using Phantom.Server.Services.Agents @using Phantom.Server.Services.Agents
@using Phantom.Server.Services.Audit @using Phantom.Server.Services.Audit
@using Phantom.Server.Services.Instances @using Phantom.Server.Services.Instances
@@ -324,8 +325,7 @@
form.MinecraftServerKind, form.MinecraftServerKind,
form.MemoryAllocation ?? RamAllocationUnits.Zero, form.MemoryAllocation ?? RamAllocationUnits.Zero,
form.JavaRuntimeGuid.GetValueOrDefault(), form.JavaRuntimeGuid.GetValueOrDefault(),
JvmArgumentsHelper.Split(form.JvmArguments), JvmArgumentsHelper.Split(form.JvmArguments)
EditedInstanceConfiguration?.LaunchAutomatically ?? false
); );
var result = await InstanceManager.AddOrEditInstance(instance); var result = await InstanceManager.AddOrEditInstance(instance);

View File

@@ -14,10 +14,10 @@
<ItemGroup> <ItemGroup>
<ProjectReference Include="..\..\Common\Phantom.Common.Data\Phantom.Common.Data.csproj" /> <ProjectReference Include="..\..\Common\Phantom.Common.Data\Phantom.Common.Data.csproj" />
<ProjectReference Include="..\..\Common\Phantom.Common.Logging\Phantom.Common.Logging.csproj" /> <ProjectReference Include="..\..\Common\Phantom.Common.Logging\Phantom.Common.Logging.csproj" />
<ProjectReference Include="..\..\Common\Phantom.Common.Minecraft\Phantom.Common.Minecraft.csproj" />
<ProjectReference Include="..\..\Utils\Phantom.Utils.IO\Phantom.Utils.IO.csproj" /> <ProjectReference Include="..\..\Utils\Phantom.Utils.IO\Phantom.Utils.IO.csproj" />
<ProjectReference Include="..\..\Utils\Phantom.Utils.Runtime\Phantom.Utils.Runtime.csproj" /> <ProjectReference Include="..\..\Utils\Phantom.Utils.Runtime\Phantom.Utils.Runtime.csproj" />
<ProjectReference Include="..\Phantom.Server.Database.Postgres\Phantom.Server.Database.Postgres.csproj" /> <ProjectReference Include="..\Phantom.Server.Database.Postgres\Phantom.Server.Database.Postgres.csproj" />
<ProjectReference Include="..\Phantom.Server.Minecraft\Phantom.Server.Minecraft.csproj" />
<ProjectReference Include="..\Phantom.Server.Rpc\Phantom.Server.Rpc.csproj" /> <ProjectReference Include="..\Phantom.Server.Rpc\Phantom.Server.Rpc.csproj" />
<ProjectReference Include="..\Phantom.Server.Services\Phantom.Server.Services.csproj" /> <ProjectReference Include="..\Phantom.Server.Services\Phantom.Server.Services.csproj" />
<ProjectReference Include="..\Phantom.Server.Web\Phantom.Server.Web.csproj" /> <ProjectReference Include="..\Phantom.Server.Web\Phantom.Server.Web.csproj" />

View File

@@ -1,6 +1,6 @@
using Microsoft.Extensions.DependencyInjection; using Microsoft.Extensions.DependencyInjection;
using Phantom.Common.Data.Agent; using Phantom.Common.Data.Agent;
using Phantom.Common.Minecraft; using Phantom.Server.Minecraft;
using Phantom.Server.Services; using Phantom.Server.Services;
using Phantom.Server.Services.Agents; using Phantom.Server.Services.Agents;
using Phantom.Server.Services.Audit; using Phantom.Server.Services.Audit;

View File

@@ -1,4 +1,5 @@
using System.Collections.Concurrent; using System.Collections.Concurrent;
using Phantom.Utils.Runtime;
using Serilog; using Serilog;
namespace Phantom.Utils.Rpc.Message; namespace Phantom.Utils.Rpc.Message;
@@ -15,7 +16,7 @@ public sealed class MessageReplyTracker {
public uint RegisterReply() { public uint RegisterReply() {
var sequenceId = Interlocked.Increment(ref lastSequenceId); var sequenceId = Interlocked.Increment(ref lastSequenceId);
replyTasks[sequenceId] = new TaskCompletionSource<byte[]>(TaskCreationOptions.None); replyTasks[sequenceId] = Tasks.CreateCompletionSource<byte[]>();
return sequenceId; return sequenceId;
} }

View File

@@ -43,7 +43,11 @@ public abstract class RpcRuntime<TSocket> where TSocket : ThreadSafeSocket, new(
Connect(socket); Connect(socket);
void RunTask() { void RunTask() {
Run(socket, replyTracker, taskManager); try {
Run(socket, replyTracker, taskManager);
} catch (Exception e) {
runtimeLogger.Error(e, "Caught exception in RPC thread.");
}
} }
try { try {

View File

@@ -15,7 +15,7 @@ public abstract class CancellableBackgroundTask {
} }
private async Task Run() { private async Task Run() {
Logger.Verbose("Task started."); Logger.Debug("Task started.");
try { try {
await RunTask(); await RunTask();
@@ -25,7 +25,7 @@ public abstract class CancellableBackgroundTask {
Logger.Fatal(e, "Caught exception in task."); Logger.Fatal(e, "Caught exception in task.");
} finally { } finally {
cancellationTokenSource.Dispose(); cancellationTokenSource.Dispose();
Logger.Verbose("Task stopped."); Logger.Debug("Task stopped.");
} }
} }

View File

@@ -0,0 +1,63 @@
using Serilog;
namespace Phantom.Utils.Runtime;
public sealed class OneShotProcess {
private readonly ILogger logger;
private readonly ProcessConfigurator configurator;
public event EventHandler<Process.Output>? OutputReceived;
public OneShotProcess(ILogger logger, ProcessConfigurator configurator) {
this.logger = logger;
this.configurator = configurator;
}
public async Task<bool> Run(CancellationToken cancellationToken) {
using var process = configurator.CreateProcess();
process.OutputReceived += OutputReceived;
try {
process.Start();
} catch (Exception e) {
logger.Error(e, "Caught exception launching process.");
return false;
}
try {
await process.WaitForExitAsync(cancellationToken);
} catch (OperationCanceledException) {
await TryKillProcess(process);
return false;
} catch (Exception e) {
logger.Error(e, "Caught exception waiting for process to exit.");
return false;
}
if (!process.HasExited) {
await TryKillProcess(process);
return false;
}
if (process.ExitCode != 0) {
logger.Error("Process exited with code {ExitCode}.", process.ExitCode);
return false;
}
logger.Debug("Process finished successfully.");
return true;
}
private async Task TryKillProcess(Process process) {
using var timeout = new CancellationTokenSource(TimeSpan.FromSeconds(2));
try {
process.Kill();
await process.WaitForExitAsync(timeout.Token);
} catch (OperationCanceledException) {
logger.Error("Timed out waiting for killed process to exit.");
} catch (Exception e) {
logger.Error(e, "Caught exception killing process.");
}
}
}

View File

@@ -0,0 +1,92 @@
using System.Diagnostics;
namespace Phantom.Utils.Runtime;
public sealed class Process : IDisposable {
public readonly record struct Output(string Line, bool IsError);
public event EventHandler<Output>? OutputReceived;
public event EventHandler Exited {
add {
wrapped.EnableRaisingEvents = true;
wrapped.Exited += value;
}
remove {
wrapped.Exited -= value;
}
}
public bool HasExited => wrapped.HasExited;
public int ExitCode => wrapped.ExitCode;
public StreamWriter StandardInput => wrapped.StandardInput;
private readonly System.Diagnostics.Process wrapped;
internal Process(System.Diagnostics.Process wrapped) {
this.wrapped = wrapped;
}
public void Start() {
if (!OperatingSystem.IsWindows()) {
this.wrapped.OutputDataReceived += OnStandardOutputDataReceived;
this.wrapped.ErrorDataReceived += OnStandardErrorDataReceived;
}
this.wrapped.Start();
// https://github.com/dotnet/runtime/issues/81896
if (OperatingSystem.IsWindows()) {
Task.Factory.StartNew(ReadStandardOutputSynchronously, TaskCreationOptions.LongRunning);
Task.Factory.StartNew(ReadStandardErrorSynchronously, TaskCreationOptions.LongRunning);
}
else {
this.wrapped.BeginOutputReadLine();
this.wrapped.BeginErrorReadLine();
}
}
private void OnStandardOutputDataReceived(object sender, DataReceivedEventArgs e) {
OnStandardStreamDataReceived(e.Data, isError: false);
}
private void OnStandardErrorDataReceived(object sender, DataReceivedEventArgs e) {
OnStandardStreamDataReceived(e.Data, isError: true);
}
private void OnStandardStreamDataReceived(string? line, bool isError) {
if (line != null) {
OutputReceived?.Invoke(this, new Output(line, isError));
}
}
private void ReadStandardOutputSynchronously() {
ReadStandardStreamSynchronously(wrapped.StandardOutput, isError: false);
}
private void ReadStandardErrorSynchronously() {
ReadStandardStreamSynchronously(wrapped.StandardError, isError: true);
}
private void ReadStandardStreamSynchronously(StreamReader reader, bool isError) {
try {
while (reader.ReadLine() is {} line) {
OutputReceived?.Invoke(this, new Output(line, isError));
}
} catch (ObjectDisposedException) {
// Ignore.
}
}
public Task WaitForExitAsync(CancellationToken cancellationToken) {
return wrapped.WaitForExitAsync(cancellationToken);
}
public void Kill(bool entireProcessTree = false) {
wrapped.Kill(entireProcessTree);
}
public void Dispose() {
wrapped.Dispose();
}
}

View File

@@ -0,0 +1,37 @@
using System.Collections.ObjectModel;
using System.Diagnostics;
namespace Phantom.Utils.Runtime;
public sealed class ProcessConfigurator {
private readonly ProcessStartInfo startInfo = new () {
RedirectStandardOutput = true,
RedirectStandardError = true
};
public string FileName {
get => startInfo.FileName;
set => startInfo.FileName = value;
}
public Collection<string> ArgumentList => startInfo.ArgumentList;
public string WorkingDirectory {
get => startInfo.WorkingDirectory;
set => startInfo.WorkingDirectory = value;
}
public bool RedirectInput {
get => startInfo.RedirectStandardInput;
set => startInfo.RedirectStandardInput = value;
}
public bool UseShellExecute {
get => startInfo.UseShellExecute;
set => startInfo.UseShellExecute = value;
}
public Process CreateProcess() {
return new Process(new System.Diagnostics.Process { StartInfo = startInfo });
}
}

View File

@@ -0,0 +1,11 @@
namespace Phantom.Utils.Runtime;
public static class Tasks {
public static TaskCompletionSource CreateCompletionSource() {
return new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously);
}
public static TaskCompletionSource<T> CreateCompletionSource<T>() {
return new TaskCompletionSource<T>(TaskCreationOptions.RunContinuationsAsynchronously);
}
}