ByondInstallation.cs

Go to the documentation of this file.

using System;
using System.Collections.Generic;
using System.Globalization;
using System.Threading.Tasks;
 
using Tgstation.Server.Api.Models;
using Tgstation.Server.Api.Models.Internal;
using Tgstation.Server.Host.Components.Deployment;
using Tgstation.Server.Host.IO;
 
namespace Tgstation.Server.Host.Components.Engine
{
    sealed class ByondInstallation : EngineInstallationBase
    {
        public override EngineVersion Version { get; }
 
        public override string ServerExePath { get; }
 
        public override string CompilerExePath { get; }
 
        public override bool PromptsForNetworkAccess { get; }
 
        public override bool HasStandardOutput { get; }
 
        public override bool PreferFileLogging => false;
 
        public override bool UseDotnetDump => false;
 
        public override Task InstallationTask { get; }
 
        readonly bool supportsMapThreads;
 
        static string SecurityWord(DreamDaemonSecurity securityLevel)
        {
            return securityLevel switch
            {
                DreamDaemonSecurity.Safe => "safe",
                DreamDaemonSecurity.Trusted => "trusted",
                DreamDaemonSecurity.Ultrasafe => "ultrasafe",
                _ => throw new ArgumentOutOfRangeException(nameof(securityLevel), securityLevel, String.Format(CultureInfo.InvariantCulture, "Bad DreamDaemon security level: {0}", securityLevel)),
            };
        }
 
        static string VisibilityWord(DreamDaemonVisibility visibility)
        {
            return visibility switch
            {
                DreamDaemonVisibility.Public => "public",
                DreamDaemonVisibility.Private => "private",
                DreamDaemonVisibility.Invisible => "invisible",
                _ => throw new ArgumentOutOfRangeException(nameof(visibility), visibility, String.Format(CultureInfo.InvariantCulture, "Bad DreamDaemon visibility level: {0}", visibility)),
            };
        }
 
        public ByondInstallation(
            IIOManager installationIOManager,
            Task installationTask,
            EngineVersion version,
            string dreamDaemonPath,
            string dreamMakerPath,
            bool supportsCli,
            bool supportsMapThreads)
            : base(installationIOManager)
        {
            InstallationTask = installationTask ?? throw new ArgumentNullException(nameof(installationTask));
            ArgumentNullException.ThrowIfNull(version);
 
            if (version.Engine != EngineType.Byond)
                throw new ArgumentException($"Invalid EngineType: {version.Engine}", nameof(version));
 
            Version = version ?? throw new ArgumentNullException(nameof(version));
            ServerExePath = dreamDaemonPath ?? throw new ArgumentNullException(nameof(dreamDaemonPath));
            CompilerExePath = dreamMakerPath ?? throw new ArgumentNullException(nameof(dreamMakerPath));
            HasStandardOutput = supportsCli;
            PromptsForNetworkAccess = !supportsCli;
            this.supportsMapThreads = supportsMapThreads;
        }
 
        public override string FormatServerArguments(
            IDmbProvider dmbProvider,
            IReadOnlyDictionary<string, string>? parameters,
            DreamDaemonLaunchParameters launchParameters,
            string accessIdentifier,
            string? logFilePath)
        {
            ArgumentNullException.ThrowIfNull(dmbProvider);
            ArgumentNullException.ThrowIfNull(launchParameters);
            ArgumentNullException.ThrowIfNull(accessIdentifier);
 
            var encodedParameters = EncodeParameters(parameters, launchParameters);
            var parametersString = !String.IsNullOrEmpty(encodedParameters)
                ? $" -params \"{encodedParameters}\""
                : String.Empty;
 
            // important to run on all ports to allow port changing
            var arguments = String.Format(
                CultureInfo.InvariantCulture,
                "\"{0}\" -port {1} -ports 1-65535 {2}-close -verbose -{3} -{4}{5}{6}{7}{8}",
                dmbProvider.DmbName,
                launchParameters.Port!.Value,
                launchParameters.AllowWebClient!.Value
                    ? "-webclient "
                    : String.Empty,
                SecurityWord(launchParameters.SecurityLevel!.Value),
                VisibilityWord(launchParameters.Visibility!.Value),
                logFilePath != null
                    ? $" -logself -log {logFilePath}"
                    : String.Empty, // DD doesn't output anything if -logself is set???
                launchParameters.StartProfiler!.Value
                    ? " -profile"
                    : String.Empty,
                supportsMapThreads && launchParameters.MapThreads!.Value != 0
                    ? $" -map-threads {launchParameters.MapThreads.Value}"
                    : String.Empty,
                parametersString);
            return arguments;
        }
 
        public override string FormatCompilerArguments(string dmePath, string? additionalArguments)
        {
            if (String.IsNullOrWhiteSpace(additionalArguments))
                additionalArguments = String.Empty;
            else
                additionalArguments = $"{additionalArguments.Trim()} ";
 
            return $"-clean {additionalArguments}\"{dmePath ?? throw new ArgumentNullException(nameof(dmePath))}\"";
        }
    }
}