mirror of
https://github.com/chylex/Minecraft-Phantom-Panel.git
synced 2025-09-15 06:32:10 +02:00
Compare commits
8 Commits
8f003c6351
...
wip-launch
Author | SHA1 | Date | |
---|---|---|---|
101ca865fe
|
|||
dd57c442af
|
|||
dacd786b4c
|
|||
89e67e1690
|
|||
33de01f564
|
|||
dd0d9b3ddb
|
|||
9971855bf8
|
|||
ffa0ff24fa
|
@@ -1,5 +1,4 @@
|
||||
using System.Diagnostics;
|
||||
using Phantom.Utils.Collections;
|
||||
using Phantom.Utils.Collections;
|
||||
using Phantom.Utils.Runtime;
|
||||
|
||||
namespace Phantom.Agent.Minecraft.Instance;
|
||||
@@ -19,10 +18,8 @@ public sealed class InstanceProcess : IDisposable {
|
||||
internal InstanceProcess(InstanceProperties instanceProperties, Process process) {
|
||||
this.InstanceProperties = instanceProperties;
|
||||
this.process = process;
|
||||
this.process.EnableRaisingEvents = true;
|
||||
this.process.Exited += ProcessOnExited;
|
||||
this.process.OutputDataReceived += HandleOutputLine;
|
||||
this.process.ErrorDataReceived += HandleOutputLine;
|
||||
this.process.OutputReceived += ProcessOutputReceived;
|
||||
}
|
||||
|
||||
public async Task SendCommand(string command, CancellationToken cancellationToken) {
|
||||
@@ -41,11 +38,9 @@ public sealed class InstanceProcess : IDisposable {
|
||||
OutputEvent -= listener;
|
||||
}
|
||||
|
||||
private void HandleOutputLine(object sender, DataReceivedEventArgs args) {
|
||||
if (args.Data is {} line) {
|
||||
outputBuffer.Add(line);
|
||||
OutputEvent?.Invoke(this, line);
|
||||
}
|
||||
private void ProcessOutputReceived(object? sender, Process.Output output) {
|
||||
outputBuffer.Add(output.Line);
|
||||
OutputEvent?.Invoke(this, output.Line);
|
||||
}
|
||||
|
||||
private void ProcessOnExited(object? sender, EventArgs e) {
|
||||
|
@@ -1,17 +1,17 @@
|
||||
using System.Diagnostics;
|
||||
using System.Text;
|
||||
using System.Text;
|
||||
using Kajabity.Tools.Java;
|
||||
using Phantom.Agent.Minecraft.Instance;
|
||||
using Phantom.Agent.Minecraft.Java;
|
||||
using Phantom.Agent.Minecraft.Server;
|
||||
using Phantom.Common.Minecraft;
|
||||
using Phantom.Utils.Runtime;
|
||||
using Serilog;
|
||||
|
||||
namespace Phantom.Agent.Minecraft.Launcher;
|
||||
|
||||
public abstract class BaseLauncher {
|
||||
public abstract class BaseLauncher : IServerLauncher {
|
||||
private readonly InstanceProperties instanceProperties;
|
||||
|
||||
|
||||
protected string MinecraftVersion => instanceProperties.ServerVersion;
|
||||
|
||||
private protected BaseLauncher(InstanceProperties instanceProperties) {
|
||||
@@ -34,7 +34,7 @@ public abstract class BaseLauncher {
|
||||
|
||||
ServerJarInfo? serverJar;
|
||||
try {
|
||||
serverJar = await PrepareServerJar(logger, vanillaServerJarPath, instanceProperties.InstanceFolder, cancellationToken);
|
||||
serverJar = await PrepareServerJar(logger, vanillaServerJarPath, cancellationToken);
|
||||
} catch (OperationCanceledException) {
|
||||
throw;
|
||||
} catch (Exception e) {
|
||||
@@ -55,20 +55,17 @@ public abstract class BaseLauncher {
|
||||
return new LaunchResult.CouldNotConfigureMinecraftServer();
|
||||
}
|
||||
|
||||
var startInfo = new ProcessStartInfo {
|
||||
var processConfigurator = new ProcessConfigurator {
|
||||
FileName = javaRuntimeExecutable.ExecutablePath,
|
||||
WorkingDirectory = instanceProperties.InstanceFolder,
|
||||
RedirectStandardInput = true,
|
||||
RedirectStandardOutput = true,
|
||||
RedirectStandardError = true,
|
||||
UseShellExecute = false,
|
||||
CreateNoWindow = false
|
||||
RedirectInput = true,
|
||||
UseShellExecute = false
|
||||
};
|
||||
|
||||
var jvmArguments = new JvmArgumentBuilder(instanceProperties.JvmProperties, instanceProperties.JvmArguments);
|
||||
CustomizeJvmArguments(jvmArguments);
|
||||
|
||||
var processArguments = startInfo.ArgumentList;
|
||||
var processArguments = processConfigurator.ArgumentList;
|
||||
jvmArguments.Build(processArguments);
|
||||
|
||||
foreach (var extraArgument in serverJar.ExtraArgs) {
|
||||
@@ -79,13 +76,11 @@ public abstract class BaseLauncher {
|
||||
processArguments.Add(serverJar.FilePath);
|
||||
processArguments.Add("nogui");
|
||||
|
||||
var process = new Process { StartInfo = startInfo };
|
||||
var process = processConfigurator.CreateProcess();
|
||||
var instanceProcess = new InstanceProcess(instanceProperties, process);
|
||||
|
||||
try {
|
||||
process.Start();
|
||||
process.BeginOutputReadLine();
|
||||
process.BeginErrorReadLine();
|
||||
} catch (Exception launchException) {
|
||||
logger.Error(launchException, "Caught exception launching the server process.");
|
||||
|
||||
@@ -103,7 +98,7 @@ public abstract class BaseLauncher {
|
||||
|
||||
private protected virtual void CustomizeJvmArguments(JvmArgumentBuilder arguments) {}
|
||||
|
||||
private protected virtual Task<ServerJarInfo> PrepareServerJar(ILogger logger, string serverJarPath, string instanceFolderPath, CancellationToken cancellationToken) {
|
||||
private protected virtual Task<ServerJarInfo> PrepareServerJar(ILogger logger, string serverJarPath, CancellationToken cancellationToken) {
|
||||
return Task.FromResult(new ServerJarInfo(serverJarPath));
|
||||
}
|
||||
|
||||
|
@@ -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);
|
||||
}
|
@@ -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);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
@@ -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
|
||||
}
|
||||
}
|
@@ -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());
|
||||
}
|
||||
}
|
@@ -26,7 +26,7 @@ sealed class MinecraftServerExecutableDownloader {
|
||||
|
||||
public void Register(MinecraftServerExecutableDownloadListener listener) {
|
||||
++listeners;
|
||||
Logger.Verbose("Registered download listener, current listener count: {Listeners}", listeners);
|
||||
Logger.Debug("Registered download listener, current listener count: {Listeners}", listeners);
|
||||
|
||||
DownloadProgress += listener.DownloadProgressEventHandler;
|
||||
listener.CancellationToken.Register(Unregister, listener);
|
||||
@@ -37,11 +37,11 @@ sealed class MinecraftServerExecutableDownloader {
|
||||
DownloadProgress -= listener.DownloadProgressEventHandler;
|
||||
|
||||
if (--listeners <= 0) {
|
||||
Logger.Verbose("Unregistered last download listener, cancelling download.");
|
||||
Logger.Debug("Unregistered last download listener, cancelling download.");
|
||||
cancellationTokenSource.Cancel();
|
||||
}
|
||||
else {
|
||||
Logger.Verbose("Unregistered download listener, current listener count: {Listeners}", listeners);
|
||||
Logger.Debug("Unregistered download listener, current listener count: {Listeners}", listeners);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -50,7 +50,7 @@ sealed class MinecraftServerExecutableDownloader {
|
||||
}
|
||||
|
||||
private void OnCompleted(Task task) {
|
||||
Logger.Verbose("Download task completed.");
|
||||
Logger.Debug("Download task completed.");
|
||||
Completed?.Invoke(this, EventArgs.Empty);
|
||||
Completed = null;
|
||||
DownloadProgress = null;
|
||||
|
@@ -84,7 +84,7 @@ public sealed class ServerStatusProtocol {
|
||||
return null;
|
||||
}
|
||||
|
||||
logger.Verbose("Detected {OnlinePlayerCount} online player(s).", onlinePlayerCount);
|
||||
logger.Debug("Detected {OnlinePlayerCount} online player(s).", onlinePlayerCount);
|
||||
return onlinePlayerCount;
|
||||
} finally {
|
||||
ArrayPool<byte>.Shared.Return(messageBuffer);
|
||||
|
@@ -69,7 +69,7 @@ public sealed class RpcLauncher : RpcRuntime<ClientSocket> {
|
||||
} catch (OperationCanceledException) {
|
||||
// Ignore.
|
||||
} finally {
|
||||
logger.Verbose("ZeroMQ client stopped receiving messages.");
|
||||
logger.Debug("ZeroMQ client stopped receiving messages.");
|
||||
|
||||
disconnectSemaphore.Wait(CancellationToken.None);
|
||||
keepAliveLoop.Cancel();
|
||||
|
@@ -69,7 +69,7 @@ sealed class BackupArchiver {
|
||||
return null;
|
||||
}
|
||||
|
||||
logger.Verbose("Created world backup: {FilePath}", backupFilePath);
|
||||
logger.Debug("Created world backup: {FilePath}", backupFilePath);
|
||||
return backupFilePath;
|
||||
}
|
||||
|
||||
@@ -135,7 +135,7 @@ sealed class BackupArchiver {
|
||||
foreach (FileInfo file in sourceFolder.EnumerateFiles()) {
|
||||
var filePath = relativePath.Add(file.Name);
|
||||
if (IsFileSkipped(filePath)) {
|
||||
logger.Verbose("Skipping file: {File}", string.Join('/', filePath));
|
||||
logger.Debug("Skipping file: {File}", string.Join('/', filePath));
|
||||
continue;
|
||||
}
|
||||
|
||||
@@ -150,7 +150,7 @@ sealed class BackupArchiver {
|
||||
foreach (DirectoryInfo directory in sourceFolder.EnumerateDirectories()) {
|
||||
var folderPath = relativePath.Add(directory.Name);
|
||||
if (IsFolderSkipped(folderPath)) {
|
||||
logger.Verbose("Skipping folder: {Folder}", string.Join('/', folderPath));
|
||||
logger.Debug("Skipping folder: {Folder}", string.Join('/', folderPath));
|
||||
continue;
|
||||
}
|
||||
|
||||
|
@@ -1,5 +1,4 @@
|
||||
using System.Diagnostics;
|
||||
using Phantom.Common.Logging;
|
||||
using Phantom.Common.Logging;
|
||||
using Phantom.Utils.Runtime;
|
||||
using Serilog;
|
||||
|
||||
@@ -41,7 +40,7 @@ static class BackupCompressor {
|
||||
return false;
|
||||
}
|
||||
|
||||
var startInfo = new ProcessStartInfo {
|
||||
var launcher = new ProcessConfigurator {
|
||||
FileName = "zstd",
|
||||
WorkingDirectory = workingDirectory,
|
||||
ArgumentList = {
|
||||
@@ -57,14 +56,14 @@ static class BackupCompressor {
|
||||
}
|
||||
};
|
||||
|
||||
static void OnZstdOutput(object? sender, DataReceivedEventArgs e) {
|
||||
if (!string.IsNullOrWhiteSpace(e.Data)) {
|
||||
ZstdLogger.Verbose("[Output] {Line}", e.Data);
|
||||
static void OnZstdOutput(object? sender, Process.Output output) {
|
||||
if (!string.IsNullOrWhiteSpace(output.Line)) {
|
||||
ZstdLogger.Debug("[Output] {Line}", output.Line);
|
||||
}
|
||||
}
|
||||
|
||||
var process = new OneShotProcess(ZstdLogger, startInfo);
|
||||
process.Output += OnZstdOutput;
|
||||
var process = new OneShotProcess(ZstdLogger, launcher);
|
||||
process.OutputReceived += OnZstdOutput;
|
||||
return await process.Run(cancellationToken);
|
||||
}
|
||||
}
|
||||
|
@@ -79,7 +79,7 @@ sealed class BackupScheduler : CancellableBackgroundTask {
|
||||
|
||||
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);
|
||||
}
|
||||
} finally {
|
||||
@@ -90,7 +90,7 @@ sealed class BackupScheduler : CancellableBackgroundTask {
|
||||
private void ServerOutputListener(object? sender, string line) {
|
||||
if (!serverOutputWhileWaitingForOnlinePlayers.IsSet) {
|
||||
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.");
|
||||
}
|
||||
}
|
||||
}
|
||||
|
@@ -1,6 +1,7 @@
|
||||
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;
|
||||
@@ -13,9 +14,9 @@ sealed partial class BackupServerCommandDispatcher : IDisposable {
|
||||
private readonly InstanceProcess process;
|
||||
private readonly CancellationToken cancellationToken;
|
||||
|
||||
private readonly TaskCompletionSource automaticSavingDisabled = new ();
|
||||
private readonly TaskCompletionSource savedTheGame = new ();
|
||||
private readonly TaskCompletionSource automaticSavingEnabled = new ();
|
||||
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;
|
||||
@@ -59,19 +60,19 @@ sealed partial class BackupServerCommandDispatcher : IDisposable {
|
||||
|
||||
if (!automaticSavingDisabled.Task.IsCompleted) {
|
||||
if (info == "Automatic saving is now disabled") {
|
||||
logger.Verbose("Detected that automatic saving is disabled.");
|
||||
logger.Debug("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.");
|
||||
logger.Debug("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.");
|
||||
logger.Debug("Detected that automatic saving is enabled.");
|
||||
automaticSavingEnabled.SetResult();
|
||||
}
|
||||
}
|
||||
|
@@ -18,15 +18,10 @@ sealed class Instance : IDisposable {
|
||||
return prefix[..prefix.IndexOf('-')] + "/" + Interlocked.Increment(ref loggerSequenceId);
|
||||
}
|
||||
|
||||
public static Instance Create(InstanceConfiguration configuration, InstanceServices services, BaseLauncher launcher) {
|
||||
var instance = new Instance(configuration, services, launcher);
|
||||
instance.SetStatus(instance.currentStatus);
|
||||
return instance;
|
||||
}
|
||||
|
||||
public InstanceConfiguration Configuration { get; private set; }
|
||||
private InstanceServices Services { get; }
|
||||
private BaseLauncher Launcher { get; set; }
|
||||
|
||||
public InstanceConfiguration Configuration { get; private set; }
|
||||
private IServerLauncher Launcher { get; set; }
|
||||
|
||||
private readonly string shortName;
|
||||
private readonly ILogger logger;
|
||||
@@ -41,29 +36,41 @@ sealed class Instance : IDisposable {
|
||||
|
||||
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.logger = PhantomLogger.Create<Instance>(shortName);
|
||||
|
||||
this.Configuration = configuration;
|
||||
this.Services = services;
|
||||
this.Configuration = configuration;
|
||||
this.Launcher = launcher;
|
||||
|
||||
this.currentState = new InstanceNotRunningState();
|
||||
this.currentStatus = InstanceStatus.NotRunning;
|
||||
}
|
||||
|
||||
private void SetStatus(IInstanceStatus status) {
|
||||
private void TryUpdateStatus(string taskName, Func<Task> getUpdateTask) {
|
||||
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) {
|
||||
currentStatus = status;
|
||||
await ServerMessaging.Send(new ReportInstanceStatusMessage(Configuration.InstanceGuid, status));
|
||||
await getUpdateTask();
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
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) {
|
||||
var message = new ReportInstanceEventMessage(Guid.NewGuid(), DateTime.UtcNow, Configuration.InstanceGuid, instanceEvent);
|
||||
Services.TaskManager.Run("Report event for instance " + shortName, async () => await ServerMessaging.Send(message));
|
||||
@@ -78,7 +85,7 @@ sealed class Instance : IDisposable {
|
||||
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;
|
||||
currentState = newState;
|
||||
@@ -94,7 +101,7 @@ sealed class Instance : IDisposable {
|
||||
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);
|
||||
try {
|
||||
Configuration = configuration;
|
||||
@@ -147,7 +154,7 @@ sealed class Instance : IDisposable {
|
||||
private readonly Instance instance;
|
||||
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.shutdownCancellationToken = shutdownCancellationToken;
|
||||
}
|
||||
@@ -156,7 +163,7 @@ sealed class Instance : IDisposable {
|
||||
public override string ShortName => instance.shortName;
|
||||
|
||||
public override void SetStatus(IInstanceStatus newStatus) {
|
||||
instance.SetStatus(newStatus);
|
||||
instance.ReportAndSetStatus(newStatus);
|
||||
}
|
||||
|
||||
public override void ReportEvent(IInstanceEvent instanceEvent) {
|
||||
@@ -170,12 +177,12 @@ sealed class Instance : IDisposable {
|
||||
|
||||
if (!instance.IsRunning) {
|
||||
// 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;
|
||||
}
|
||||
|
||||
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;
|
||||
}
|
||||
|
||||
|
@@ -6,17 +6,17 @@ using Serilog;
|
||||
namespace Phantom.Agent.Services.Instances;
|
||||
|
||||
abstract class InstanceContext {
|
||||
public InstanceConfiguration Configuration { get; }
|
||||
public BaseLauncher Launcher { get; }
|
||||
public InstanceServices Services { get; }
|
||||
public InstanceConfiguration Configuration { get; }
|
||||
public IServerLauncher Launcher { get; }
|
||||
|
||||
public abstract ILogger Logger { 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;
|
||||
Launcher = launcher;
|
||||
Services = services;
|
||||
}
|
||||
|
||||
public abstract void SetStatus(IInstanceStatus newStatus);
|
||||
|
@@ -27,7 +27,6 @@ sealed class InstanceSessionManager : IDisposable {
|
||||
private readonly AgentInfo agentInfo;
|
||||
private readonly string basePath;
|
||||
|
||||
private readonly MinecraftServerExecutables minecraftServerExecutables;
|
||||
private readonly InstanceServices instanceServices;
|
||||
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) {
|
||||
this.agentInfo = agentInfo;
|
||||
this.basePath = agentFolders.InstancesFolderPath;
|
||||
this.minecraftServerExecutables = new MinecraftServerExecutables(agentFolders.ServerExecutableFolderPath);
|
||||
this.shutdownCancellationToken = shutdownCancellationTokenSource.Token;
|
||||
|
||||
var minecraftServerExecutables = new MinecraftServerExecutables(agentFolders.ServerExecutableFolderPath);
|
||||
var launchServices = new LaunchServices(minecraftServerExecutables, javaRuntimeRepository);
|
||||
var portManager = new PortManager(agentInfo.AllowedServerPorts, agentInfo.AllowedRconPorts);
|
||||
|
||||
this.instanceServices = new InstanceServices(taskManager, portManager, backupManager, launchServices);
|
||||
}
|
||||
|
||||
@@ -71,7 +71,7 @@ sealed class InstanceSessionManager : IDisposable {
|
||||
});
|
||||
}
|
||||
|
||||
public async Task<InstanceActionResult<ConfigureInstanceResult>> Configure(InstanceConfiguration configuration, InstanceLaunchProperties launchProperties, bool launchNow) {
|
||||
public async Task<InstanceActionResult<ConfigureInstanceResult>> Configure(InstanceConfiguration configuration, InstanceLaunchProperties launchProperties, bool launchNow, bool alwaysReportStatus) {
|
||||
return await AcquireSemaphoreAndRun(async () => {
|
||||
var instanceGuid = configuration.InstanceGuid;
|
||||
var instanceFolder = Path.Combine(basePath, instanceGuid.ToString());
|
||||
@@ -94,16 +94,26 @@ sealed class InstanceSessionManager : IDisposable {
|
||||
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)) {
|
||||
await instance.Reconfigure(configuration, launcher, shutdownCancellationToken);
|
||||
Logger.Information("Reconfigured instance \"{Name}\" (GUID {Guid}).", configuration.InstanceName, configuration.InstanceGuid);
|
||||
|
||||
if (alwaysReportStatus) {
|
||||
instance.ReportLastStatus();
|
||||
}
|
||||
}
|
||||
else {
|
||||
instances[instanceGuid] = instance = Instance.Create(configuration, instanceServices, launcher);
|
||||
instance.IsRunningChanged += OnInstanceIsRunningChanged;
|
||||
instances[instanceGuid] = instance = new Instance(instanceServices, configuration, launcher);
|
||||
Logger.Information("Created instance \"{Name}\" (GUID {Guid}).", configuration.InstanceName, configuration.InstanceGuid);
|
||||
|
||||
instance.ReportLastStatus();
|
||||
instance.IsRunningChanged += OnInstanceIsRunningChanged;
|
||||
}
|
||||
|
||||
if (launchNow) {
|
||||
|
@@ -16,7 +16,7 @@ sealed class InstanceSession : IDisposable {
|
||||
}
|
||||
|
||||
private void SessionOutput(object? sender, string line) {
|
||||
context.Logger.Verbose("[Server] {Line}", line);
|
||||
context.Logger.Debug("[Server] {Line}", line);
|
||||
logSender.Enqueue(line);
|
||||
}
|
||||
|
||||
|
@@ -110,7 +110,7 @@ sealed class InstanceRunningState : IInstanceState {
|
||||
}
|
||||
}
|
||||
} catch (OperationCanceledException) {
|
||||
context.Logger.Verbose("Cancelled delayed stop.");
|
||||
context.Logger.Debug("Cancelled delayed stop.");
|
||||
return;
|
||||
} catch (ObjectDisposedException) {
|
||||
return;
|
||||
|
@@ -33,7 +33,7 @@ public sealed class MessageListener : IMessageToAgentListener {
|
||||
}
|
||||
|
||||
foreach (var configureInstanceMessage in message.InitialInstanceConfigurations) {
|
||||
var result = await HandleConfigureInstance(configureInstanceMessage);
|
||||
var result = await HandleConfigureInstance(configureInstanceMessage, alwaysReportStatus: true);
|
||||
if (!result.Is(ConfigureInstanceResult.Success)) {
|
||||
ShutdownAfterConfigurationFailed(configureInstanceMessage.Configuration);
|
||||
return NoReply.Instance;
|
||||
@@ -59,8 +59,12 @@ public sealed class MessageListener : IMessageToAgentListener {
|
||||
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) {
|
||||
return await agent.InstanceSessionManager.Configure(message.Configuration, message.LaunchProperties, message.LaunchNow);
|
||||
return await HandleConfigureInstance(message, alwaysReportStatus: false);
|
||||
}
|
||||
|
||||
public async Task<InstanceActionResult<LaunchInstanceResult>> HandleLaunchInstance(LaunchInstanceMessage message) {
|
||||
|
@@ -1,5 +1,6 @@
|
||||
namespace Phantom.Common.Data.Minecraft;
|
||||
|
||||
public enum MinecraftServerKind : ushort {
|
||||
Vanilla = 1
|
||||
Vanilla = 1,
|
||||
Fabric = 2
|
||||
}
|
||||
|
@@ -8,6 +8,7 @@
|
||||
|
||||
<ItemGroup>
|
||||
<PackageReference Include="Serilog" />
|
||||
<PackageReference Include="Serilog.Sinks.Async" />
|
||||
<PackageReference Include="Serilog.Sinks.Console" />
|
||||
</ItemGroup>
|
||||
|
||||
|
@@ -18,7 +18,7 @@ public static class PhantomLogger {
|
||||
.MinimumLevel.Override("Microsoft.EntityFrameworkCore.Database.Command", DefaultLogLevel.Coerce(LogEventLevel.Warning))
|
||||
.Filter.ByExcluding(static e => e.Exception is OperationCanceledException)
|
||||
.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();
|
||||
}
|
||||
|
||||
|
@@ -20,6 +20,7 @@
|
||||
<ItemGroup>
|
||||
<PackageReference Update="Serilog" Version="2.12.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" />
|
||||
</ItemGroup>
|
||||
|
||||
|
164
Server/Phantom.Server.Minecraft/MinecraftVersionApi.cs
Normal file
164
Server/Phantom.Server.Minecraft/MinecraftVersionApi.cs
Normal file
@@ -0,0 +1,164 @@
|
||||
using System.Collections.Immutable;
|
||||
using System.Net.Http.Json;
|
||||
using System.Text.Json;
|
||||
using Phantom.Common.Data.Minecraft;
|
||||
using Phantom.Common.Logging;
|
||||
using Phantom.Utils.Cryptography;
|
||||
using Phantom.Utils.IO;
|
||||
using Phantom.Utils.Runtime;
|
||||
using Serilog;
|
||||
|
||||
namespace Phantom.Server.Minecraft;
|
||||
|
||||
sealed class MinecraftVersionApi : IDisposable {
|
||||
private static readonly ILogger Logger = PhantomLogger.Create<MinecraftVersionApi>();
|
||||
|
||||
private const string VersionManifestUrl = "https://launchermeta.mojang.com/mc/game/version_manifest.json";
|
||||
|
||||
private readonly HttpClient http = new ();
|
||||
|
||||
public void Dispose() {
|
||||
http.Dispose();
|
||||
}
|
||||
|
||||
public async Task<ImmutableArray<MinecraftVersion>> GetVersions(CancellationToken cancellationToken) {
|
||||
return await FetchVersions(cancellationToken) ?? ImmutableArray<MinecraftVersion>.Empty;
|
||||
}
|
||||
|
||||
private async Task<ImmutableArray<MinecraftVersion>?> FetchVersions(CancellationToken cancellationToken) {
|
||||
return await FetchOrFailSilently(async () => {
|
||||
var versionManifest = await FetchJson(VersionManifestUrl, "version manifest", cancellationToken);
|
||||
return GetVersionsFromManifest(versionManifest);
|
||||
});
|
||||
}
|
||||
|
||||
public async Task<FileDownloadInfo?> GetServerExecutableInfo(ImmutableArray<MinecraftVersion> versions, string version, CancellationToken cancellationToken) {
|
||||
var versionObject = versions.FirstOrDefault(v => v.Id == version);
|
||||
if (versionObject == null) {
|
||||
Logger.Error("Version {Version} was not found in version manifest.", version);
|
||||
return null;
|
||||
}
|
||||
|
||||
return await FetchOrFailSilently(async () => {
|
||||
var versionMetadata = await FetchJson(versionObject.MetadataUrl, "version metadata", cancellationToken);
|
||||
return GetServerExecutableInfoFromMetadata(versionMetadata);
|
||||
});
|
||||
}
|
||||
|
||||
private static async Task<T?> FetchOrFailSilently<T>(Func<Task<T?>> task) {
|
||||
try {
|
||||
return await task();
|
||||
} catch (StopProcedureException) {
|
||||
return default;
|
||||
} catch (Exception e) {
|
||||
Logger.Error(e, "An unexpected error occurred.");
|
||||
return default;
|
||||
}
|
||||
}
|
||||
|
||||
private async Task<JsonElement> FetchJson(string url, string description, CancellationToken cancellationToken) {
|
||||
Logger.Debug("Fetching {Description} JSON from: {Url}", description, url);
|
||||
|
||||
try {
|
||||
return await http.GetFromJsonAsync<JsonElement>(url, cancellationToken);
|
||||
} catch (HttpRequestException e) {
|
||||
Logger.Error(e, "Unable to download {Description}.", description);
|
||||
throw StopProcedureException.Instance;
|
||||
} catch (Exception e) {
|
||||
Logger.Error(e, "Unable to parse {Description} as JSON.", description);
|
||||
throw StopProcedureException.Instance;
|
||||
}
|
||||
}
|
||||
|
||||
private static ImmutableArray<MinecraftVersion> GetVersionsFromManifest(JsonElement versionManifest) {
|
||||
JsonElement versionsElement = GetJsonPropertyOrThrow(versionManifest, "versions", JsonValueKind.Array, "version manifest");
|
||||
var foundVersions = ImmutableArray.CreateBuilder<MinecraftVersion>(versionsElement.GetArrayLength());
|
||||
|
||||
foreach (var versionElement in versionsElement.EnumerateArray()) {
|
||||
try {
|
||||
foundVersions.Add(GetVersionFromManifestEntry(versionElement));
|
||||
} catch (StopProcedureException) {}
|
||||
}
|
||||
|
||||
return foundVersions.MoveToImmutable();
|
||||
}
|
||||
|
||||
private static MinecraftVersion GetVersionFromManifestEntry(JsonElement versionElement) {
|
||||
JsonElement idElement = GetJsonPropertyOrThrow(versionElement, "id", JsonValueKind.String, "version entry in version manifest");
|
||||
string id = idElement.GetString() ?? throw new InvalidOperationException();
|
||||
|
||||
JsonElement typeElement = GetJsonPropertyOrThrow(versionElement, "type", JsonValueKind.String, "version entry in version manifest");
|
||||
string? typeString = typeElement.GetString();
|
||||
|
||||
var type = MinecraftVersionTypes.FromString(typeString);
|
||||
if (type == MinecraftVersionType.Other) {
|
||||
Logger.Warning("Unknown version type: {Type} ({Version})", typeString, id);
|
||||
}
|
||||
|
||||
JsonElement urlElement = GetJsonPropertyOrThrow(versionElement, "url", JsonValueKind.String, "version entry in version manifest");
|
||||
string? url = urlElement.GetString();
|
||||
|
||||
if (!Uri.TryCreate(url, UriKind.Absolute, out var uri)) {
|
||||
Logger.Error("The \"url\" key in version entry in version manifest does not contain a valid URL: {Url}", url);
|
||||
throw StopProcedureException.Instance;
|
||||
}
|
||||
|
||||
if (uri.Scheme != "https" || !uri.AbsolutePath.EndsWith(".json", StringComparison.OrdinalIgnoreCase)) {
|
||||
Logger.Error("The \"url\" key in version entry in version manifest does not contain an accepted URL: {Url}", url);
|
||||
throw StopProcedureException.Instance;
|
||||
}
|
||||
|
||||
return new MinecraftVersion(id, type, url);
|
||||
}
|
||||
|
||||
private static FileDownloadInfo GetServerExecutableInfoFromMetadata(JsonElement versionMetadata) {
|
||||
JsonElement downloadsElement = GetJsonPropertyOrThrow(versionMetadata, "downloads", JsonValueKind.Object, "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");
|
||||
string? url = urlElement.GetString();
|
||||
|
||||
if (!Uri.TryCreate(url, UriKind.Absolute, out var uri)) {
|
||||
Logger.Error("The \"url\" key in downloads.server object in version metadata does not contain a valid URL: {Url}", url);
|
||||
throw StopProcedureException.Instance;
|
||||
}
|
||||
|
||||
if (uri.Scheme != "https" || !uri.AbsolutePath.EndsWith(".jar", StringComparison.OrdinalIgnoreCase)) {
|
||||
Logger.Error("The \"url\" key in downloads.server object in version metadata does not contain a accepted URL: {Url}", url);
|
||||
throw StopProcedureException.Instance;
|
||||
}
|
||||
|
||||
JsonElement sizeElement = GetJsonPropertyOrThrow(serverElement, "size", JsonValueKind.Number, "downloads.server object in version metadata");
|
||||
ulong size;
|
||||
try {
|
||||
size = sizeElement.GetUInt64();
|
||||
} catch (FormatException) {
|
||||
Logger.Error("The \"size\" key in downloads.server object in version metadata contains an invalid file size: {Size}", sizeElement);
|
||||
throw StopProcedureException.Instance;
|
||||
}
|
||||
|
||||
JsonElement sha1Element = GetJsonPropertyOrThrow(serverElement, "sha1", JsonValueKind.String, "downloads.server object in version metadata");
|
||||
Sha1String hash;
|
||||
try {
|
||||
hash = Sha1String.FromString(sha1Element.GetString());
|
||||
} catch (Exception) {
|
||||
Logger.Error("The \"sha1\" key in downloads.server object in version metadata does not contain a valid SHA-1 hash: {Sha1}", sha1Element.GetString());
|
||||
throw StopProcedureException.Instance;
|
||||
}
|
||||
|
||||
return new FileDownloadInfo(url, hash, new FileSize(size));
|
||||
}
|
||||
|
||||
private static JsonElement GetJsonPropertyOrThrow(JsonElement parentElement, string propertyKey, JsonValueKind expectedKind, string location) {
|
||||
if (!parentElement.TryGetProperty(propertyKey, out var valueElement)) {
|
||||
Logger.Error("Missing \"{Property}\" key in " + location + ".", propertyKey);
|
||||
throw StopProcedureException.Instance;
|
||||
}
|
||||
|
||||
if (valueElement.ValueKind != expectedKind) {
|
||||
Logger.Error("The \"{Property}\" key in " + location + " does not contain a JSON {ExpectedType}. Actual type: {ActualType}", propertyKey, expectedKind, valueElement.ValueKind);
|
||||
throw StopProcedureException.Instance;
|
||||
}
|
||||
|
||||
return valueElement;
|
||||
}
|
||||
}
|
@@ -1,12 +1,7 @@
|
||||
using System.Collections.Immutable;
|
||||
using System.Diagnostics;
|
||||
using System.Net.Http.Json;
|
||||
using System.Text.Json;
|
||||
using Phantom.Common.Data.Minecraft;
|
||||
using Phantom.Common.Logging;
|
||||
using Phantom.Utils.Cryptography;
|
||||
using Phantom.Utils.IO;
|
||||
using Phantom.Utils.Runtime;
|
||||
using Serilog;
|
||||
|
||||
namespace Phantom.Server.Minecraft;
|
||||
@@ -15,178 +10,66 @@ public sealed class MinecraftVersions : IDisposable {
|
||||
private static readonly ILogger Logger = PhantomLogger.Create<MinecraftVersions>();
|
||||
private static readonly TimeSpan CacheRetentionTime = TimeSpan.FromMinutes(10);
|
||||
|
||||
private const string VersionManifestUrl = "https://launchermeta.mojang.com/mc/game/version_manifest.json";
|
||||
|
||||
private readonly HttpClient http = new ();
|
||||
|
||||
private readonly MinecraftVersionApi api = new ();
|
||||
private readonly Stopwatch cacheTimer = new ();
|
||||
private readonly SemaphoreSlim cachedVersionsSemaphore = new (1, 1);
|
||||
private readonly SemaphoreSlim cacheSemaphore = new (1, 1);
|
||||
|
||||
private bool IsCacheNotExpired => cacheTimer.IsRunning && cacheTimer.Elapsed < CacheRetentionTime;
|
||||
|
||||
private ImmutableArray<MinecraftVersion>? cachedVersions;
|
||||
private ImmutableArray<MinecraftVersion>? CachedVersionsUnlessExpired => cacheTimer.IsRunning && cacheTimer.Elapsed < CacheRetentionTime ? cachedVersions : null;
|
||||
private readonly Dictionary<string, FileDownloadInfo?> cachedServerExecutables = new ();
|
||||
|
||||
public void Dispose() {
|
||||
http.Dispose();
|
||||
cachedVersionsSemaphore.Dispose();
|
||||
api.Dispose();
|
||||
cacheSemaphore.Dispose();
|
||||
}
|
||||
|
||||
public async Task<ImmutableArray<MinecraftVersion>> GetVersions(CancellationToken cancellationToken) {
|
||||
if (CachedVersionsUnlessExpired is {} earlyResult) {
|
||||
return earlyResult;
|
||||
}
|
||||
|
||||
await cachedVersionsSemaphore.WaitAsync(cancellationToken);
|
||||
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();
|
||||
}
|
||||
return await GetCachedObject(() => cachedVersions != null, () => cachedVersions.GetValueOrDefault(), v => cachedVersions = v, LoadVersions, cancellationToken);
|
||||
}
|
||||
|
||||
private async Task<ImmutableArray<MinecraftVersion>?> FetchVersions(CancellationToken cancellationToken) {
|
||||
return await FetchOrFailSilently(async () => {
|
||||
var versionManifest = await FetchJson(http, VersionManifestUrl, "version manifest", cancellationToken);
|
||||
return GetVersionsFromManifest(versionManifest);
|
||||
});
|
||||
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) {
|
||||
return await FetchOrFailSilently(async () => {
|
||||
var versions = await GetVersions(cancellationToken);
|
||||
var versionObject = versions.FirstOrDefault(v => v.Id == version);
|
||||
if (versionObject == null) {
|
||||
Logger.Error("Version {Version} was not found in version manifest.", version);
|
||||
return null;
|
||||
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();
|
||||
}
|
||||
|
||||
var versionMetadata = await FetchJson(http, versionObject.MetadataUrl, "version metadata", cancellationToken);
|
||||
return GetServerExecutableInfoFromMetadata(versionMetadata);
|
||||
});
|
||||
}
|
||||
|
||||
private static async Task<T?> FetchOrFailSilently<T>(Func<Task<T?>> task) {
|
||||
try {
|
||||
return await task();
|
||||
} catch (StopProcedureException) {
|
||||
return default;
|
||||
} catch (Exception e) {
|
||||
Logger.Error(e, "An unexpected error occurred.");
|
||||
return default;
|
||||
T result = await fieldLoader(cancellationToken);
|
||||
fieldSetter(result);
|
||||
|
||||
cacheTimer.Restart();
|
||||
return result;
|
||||
} finally {
|
||||
cacheSemaphore.Release();
|
||||
}
|
||||
}
|
||||
|
||||
private static async Task<JsonElement> FetchJson(HttpClient http, string url, string description, CancellationToken cancellationToken) {
|
||||
Logger.Information("Fetching {Description} JSON from: {Url}", description, url);
|
||||
|
||||
try {
|
||||
return await http.GetFromJsonAsync<JsonElement>(url, cancellationToken);
|
||||
} catch (HttpRequestException e) {
|
||||
Logger.Error(e, "Unable to download {Description}.", description);
|
||||
throw StopProcedureException.Instance;
|
||||
} catch (Exception e) {
|
||||
Logger.Error(e, "Unable to parse {Description} as JSON.", description);
|
||||
throw StopProcedureException.Instance;
|
||||
}
|
||||
}
|
||||
|
||||
private static ImmutableArray<MinecraftVersion> GetVersionsFromManifest(JsonElement versionManifest) {
|
||||
JsonElement versionsElement = GetJsonPropertyOrThrow(versionManifest, "versions", JsonValueKind.Array, "version manifest");
|
||||
var foundVersions = ImmutableArray.CreateBuilder<MinecraftVersion>(versionsElement.GetArrayLength());
|
||||
|
||||
foreach (var versionElement in versionsElement.EnumerateArray()) {
|
||||
try {
|
||||
foundVersions.Add(GetVersionFromManifestEntry(versionElement));
|
||||
} catch (StopProcedureException) {}
|
||||
}
|
||||
|
||||
return foundVersions.MoveToImmutable();
|
||||
}
|
||||
|
||||
private static MinecraftVersion GetVersionFromManifestEntry(JsonElement versionElement) {
|
||||
JsonElement idElement = GetJsonPropertyOrThrow(versionElement, "id", JsonValueKind.String, "version entry in version manifest");
|
||||
string id = idElement.GetString() ?? throw new InvalidOperationException();
|
||||
|
||||
JsonElement typeElement = GetJsonPropertyOrThrow(versionElement, "type", JsonValueKind.String, "version entry in version manifest");
|
||||
string? typeString = typeElement.GetString();
|
||||
|
||||
var type = MinecraftVersionTypes.FromString(typeString);
|
||||
if (type == MinecraftVersionType.Other) {
|
||||
Logger.Verbose("Unknown version type: {Type} ({Version})", typeString, id);
|
||||
}
|
||||
|
||||
JsonElement urlElement = GetJsonPropertyOrThrow(versionElement, "url", JsonValueKind.String, "version entry in version manifest");
|
||||
string? url = urlElement.GetString();
|
||||
|
||||
if (!Uri.TryCreate(url, UriKind.Absolute, out var uri)) {
|
||||
Logger.Error("The \"url\" key in version entry in version manifest does not contain a valid URL: {Url}", url);
|
||||
throw StopProcedureException.Instance;
|
||||
}
|
||||
|
||||
if (uri.Scheme != "https" || !uri.AbsolutePath.EndsWith(".json", StringComparison.OrdinalIgnoreCase)) {
|
||||
Logger.Error("The \"url\" key in version entry in version manifest does not contain an accepted URL: {Url}", url);
|
||||
throw StopProcedureException.Instance;
|
||||
}
|
||||
|
||||
return new MinecraftVersion(id, type, url);
|
||||
}
|
||||
|
||||
private static FileDownloadInfo GetServerExecutableInfoFromMetadata(JsonElement versionMetadata) {
|
||||
JsonElement downloadsElement = GetJsonPropertyOrThrow(versionMetadata, "downloads", JsonValueKind.Object, "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");
|
||||
string? url = urlElement.GetString();
|
||||
|
||||
if (!Uri.TryCreate(url, UriKind.Absolute, out var uri)) {
|
||||
Logger.Error("The \"url\" key in downloads.server object in version metadata does not contain a valid URL: {Url}", url);
|
||||
throw StopProcedureException.Instance;
|
||||
}
|
||||
|
||||
if (uri.Scheme != "https" || !uri.AbsolutePath.EndsWith(".jar", StringComparison.OrdinalIgnoreCase)) {
|
||||
Logger.Error("The \"url\" key in downloads.server object in version metadata does not contain a accepted URL: {Url}", url);
|
||||
throw StopProcedureException.Instance;
|
||||
}
|
||||
|
||||
JsonElement sizeElement = GetJsonPropertyOrThrow(serverElement, "size", JsonValueKind.Number, "downloads.server object in version metadata");
|
||||
ulong size;
|
||||
try {
|
||||
size = sizeElement.GetUInt64();
|
||||
} catch (FormatException) {
|
||||
Logger.Error("The \"size\" key in downloads.server object in version metadata contains an invalid file size: {Size}", sizeElement);
|
||||
throw StopProcedureException.Instance;
|
||||
}
|
||||
|
||||
JsonElement sha1Element = GetJsonPropertyOrThrow(serverElement, "sha1", JsonValueKind.String, "downloads.server object in version metadata");
|
||||
Sha1String hash;
|
||||
try {
|
||||
hash = Sha1String.FromString(sha1Element.GetString());
|
||||
} catch (Exception) {
|
||||
Logger.Error("The \"sha1\" key in downloads.server object in version metadata does not contain a valid SHA-1 hash: {Sha1}", sha1Element.GetString());
|
||||
throw StopProcedureException.Instance;
|
||||
}
|
||||
|
||||
return new FileDownloadInfo(url, hash, new FileSize(size));
|
||||
}
|
||||
|
||||
private static JsonElement GetJsonPropertyOrThrow(JsonElement parentElement, string propertyKey, JsonValueKind expectedKind, string location) {
|
||||
if (!parentElement.TryGetProperty(propertyKey, out var valueElement)) {
|
||||
Logger.Error("Missing \"{Property}\" key in " + location + ".", propertyKey);
|
||||
throw StopProcedureException.Instance;
|
||||
}
|
||||
|
||||
if (valueElement.ValueKind != expectedKind) {
|
||||
Logger.Error("The \"{Property}\" key in " + location + " does not contain a JSON {ExpectedType}. Actual type: {ActualType}", propertyKey, expectedKind, valueElement.ValueKind);
|
||||
throw StopProcedureException.Instance;
|
||||
}
|
||||
|
||||
return valueElement;
|
||||
}
|
||||
}
|
||||
|
@@ -46,7 +46,7 @@ public sealed class RpcLauncher : RpcRuntime<ServerSocket> {
|
||||
|
||||
void OnConnectionClosed(object? sender, RpcClientConnectionClosedEventArgs e) {
|
||||
clients.Remove(e.RoutingId);
|
||||
logger.Verbose("Closed connection to {RoutingId}.", e.RoutingId);
|
||||
logger.Debug("Closed connection to {RoutingId}.", e.RoutingId);
|
||||
}
|
||||
|
||||
while (!cancellationToken.IsCancellationRequested) {
|
||||
|
@@ -9,6 +9,7 @@ using Phantom.Server.Services.Agents;
|
||||
using Phantom.Server.Services.Events;
|
||||
using Phantom.Server.Services.Instances;
|
||||
using Phantom.Utils.Rpc.Message;
|
||||
using Phantom.Utils.Runtime;
|
||||
|
||||
namespace Phantom.Server.Services.Rpc;
|
||||
|
||||
@@ -21,7 +22,7 @@ public sealed class MessageToServerListener : IMessageToServerListener {
|
||||
private readonly InstanceLogManager instanceLogManager;
|
||||
private readonly EventLog eventLog;
|
||||
|
||||
private readonly TaskCompletionSource<Guid> agentGuidWaiter = new ();
|
||||
private readonly TaskCompletionSource<Guid> agentGuidWaiter = Tasks.CreateCompletionSource<Guid>();
|
||||
|
||||
public bool IsDisposed { get; private set; }
|
||||
|
||||
|
@@ -40,7 +40,7 @@ public sealed class PhantomLoginManager {
|
||||
|
||||
var result = await signInManager.CheckPasswordSignInAsync(user, password, lockoutOnFailure: true);
|
||||
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);
|
||||
loginStore.Add(token, user, password, returnUrl ?? string.Empty);
|
||||
|
@@ -30,7 +30,7 @@ public sealed class PhantomLoginStore {
|
||||
|
||||
foreach (var (token, entry) in loginEntries) {
|
||||
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 _);
|
||||
}
|
||||
}
|
||||
@@ -50,7 +50,7 @@ public sealed class PhantomLoginStore {
|
||||
}
|
||||
|
||||
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;
|
||||
}
|
||||
|
||||
|
@@ -1,4 +1,5 @@
|
||||
using System.Collections.Concurrent;
|
||||
using Phantom.Utils.Runtime;
|
||||
using Serilog;
|
||||
|
||||
namespace Phantom.Utils.Rpc.Message;
|
||||
@@ -15,7 +16,7 @@ public sealed class MessageReplyTracker {
|
||||
|
||||
public uint RegisterReply() {
|
||||
var sequenceId = Interlocked.Increment(ref lastSequenceId);
|
||||
replyTasks[sequenceId] = new TaskCompletionSource<byte[]>(TaskCreationOptions.None);
|
||||
replyTasks[sequenceId] = Tasks.CreateCompletionSource<byte[]>();
|
||||
return sequenceId;
|
||||
}
|
||||
|
||||
|
@@ -43,7 +43,11 @@ public abstract class RpcRuntime<TSocket> where TSocket : ThreadSafeSocket, new(
|
||||
Connect(socket);
|
||||
|
||||
void RunTask() {
|
||||
Run(socket, replyTracker, taskManager);
|
||||
try {
|
||||
Run(socket, replyTracker, taskManager);
|
||||
} catch (Exception e) {
|
||||
runtimeLogger.Error(e, "Caught exception in RPC thread.");
|
||||
}
|
||||
}
|
||||
|
||||
try {
|
||||
|
@@ -15,7 +15,7 @@ public abstract class CancellableBackgroundTask {
|
||||
}
|
||||
|
||||
private async Task Run() {
|
||||
Logger.Verbose("Task started.");
|
||||
Logger.Debug("Task started.");
|
||||
|
||||
try {
|
||||
await RunTask();
|
||||
@@ -25,7 +25,7 @@ public abstract class CancellableBackgroundTask {
|
||||
Logger.Fatal(e, "Caught exception in task.");
|
||||
} finally {
|
||||
cancellationTokenSource.Dispose();
|
||||
Logger.Verbose("Task stopped.");
|
||||
Logger.Debug("Task stopped.");
|
||||
}
|
||||
}
|
||||
|
||||
|
@@ -1,30 +1,24 @@
|
||||
using System.Diagnostics;
|
||||
using Serilog;
|
||||
using Serilog;
|
||||
|
||||
namespace Phantom.Utils.Runtime;
|
||||
|
||||
public sealed class OneShotProcess {
|
||||
private readonly ILogger logger;
|
||||
private readonly ProcessStartInfo startInfo;
|
||||
private readonly ProcessConfigurator configurator;
|
||||
|
||||
public event DataReceivedEventHandler? Output;
|
||||
public event EventHandler<Process.Output>? OutputReceived;
|
||||
|
||||
public OneShotProcess(ILogger logger, ProcessStartInfo startInfo) {
|
||||
public OneShotProcess(ILogger logger, ProcessConfigurator configurator) {
|
||||
this.logger = logger;
|
||||
this.startInfo = startInfo;
|
||||
this.startInfo.RedirectStandardOutput = true;
|
||||
this.startInfo.RedirectStandardError = true;
|
||||
this.configurator = configurator;
|
||||
}
|
||||
|
||||
public async Task<bool> Run(CancellationToken cancellationToken) {
|
||||
using var process = new Process { StartInfo = startInfo };
|
||||
process.OutputDataReceived += Output;
|
||||
process.ErrorDataReceived += Output;
|
||||
using var process = configurator.CreateProcess();
|
||||
process.OutputReceived += OutputReceived;
|
||||
|
||||
try {
|
||||
process.Start();
|
||||
process.BeginOutputReadLine();
|
||||
process.BeginErrorReadLine();
|
||||
} catch (Exception e) {
|
||||
logger.Error(e, "Caught exception launching process.");
|
||||
return false;
|
||||
@@ -50,7 +44,7 @@ public sealed class OneShotProcess {
|
||||
return false;
|
||||
}
|
||||
|
||||
logger.Verbose("Process finished successfully.");
|
||||
logger.Debug("Process finished successfully.");
|
||||
return true;
|
||||
}
|
||||
|
||||
|
92
Utils/Phantom.Utils.Runtime/Process.cs
Normal file
92
Utils/Phantom.Utils.Runtime/Process.cs
Normal 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();
|
||||
}
|
||||
}
|
37
Utils/Phantom.Utils.Runtime/ProcessConfigurator.cs
Normal file
37
Utils/Phantom.Utils.Runtime/ProcessConfigurator.cs
Normal 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 });
|
||||
}
|
||||
}
|
11
Utils/Phantom.Utils.Runtime/Tasks.cs
Normal file
11
Utils/Phantom.Utils.Runtime/Tasks.cs
Normal 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);
|
||||
}
|
||||
}
|
Reference in New Issue
Block a user