WindowsOpenDreamInstaller.cs

Go to the documentation of this file.

using System;
using System.Threading;
using System.Threading.Tasks;
 
using Microsoft.Extensions.Logging;
using Microsoft.Extensions.Options;
 
using Tgstation.Server.Api.Models;
using Tgstation.Server.Common.Extensions;
using Tgstation.Server.Common.Http;
using Tgstation.Server.Host.Components.Repository;
using Tgstation.Server.Host.Configuration;
using Tgstation.Server.Host.IO;
using Tgstation.Server.Host.Jobs;
using Tgstation.Server.Host.System;
using Tgstation.Server.Host.Utils;
 
namespace Tgstation.Server.Host.Components.Engine
{
    sealed class WindowsOpenDreamInstaller : OpenDreamInstaller
    {
        readonly IFilesystemLinkFactory linkFactory;
 
        public WindowsOpenDreamInstaller(
            IIOManager ioManager,
            ILogger<WindowsOpenDreamInstaller> logger,
            IPlatformIdentifier platformIdentifier,
            IProcessExecutor processExecutor,
            IRepositoryManager repositoryManager,
            IAsyncDelayer asyncDelayer,
            IAbstractHttpClientFactory httpClientFactory,
            IOptions<GeneralConfiguration> generalConfigurationOptions,
            IOptions<SessionConfiguration> sessionConfigurationOptions,
            IFilesystemLinkFactory linkFactory)
            : base(
                ioManager,
                logger,
                platformIdentifier,
                processExecutor,
                repositoryManager,
                asyncDelayer,
                httpClientFactory,
                generalConfigurationOptions,
                sessionConfigurationOptions)
        {
            this.linkFactory = linkFactory ?? throw new ArgumentNullException(nameof(linkFactory));
        }
 
        public override ValueTask Install(EngineVersion version, string installPath, bool deploymentPipelineProcesses, CancellationToken cancellationToken)
        {
            var installTask = base.Install(
                version,
                installPath,
                deploymentPipelineProcesses,
                cancellationToken);
            var firewallTask = AddServerFirewallException(
                version,
                installPath,
                deploymentPipelineProcesses,
                cancellationToken);
 
            return ValueTaskExtensions.WhenAll(installTask, firewallTask);
        }
 
        protected override async ValueTask HandleExtremelyLongPathOperation(Func<string, ValueTask> shortenedPathOperation, string originalPath, CancellationToken cancellationToken)
        {
            var shortPath = $"C:/{Guid.NewGuid()}";
            Logger.LogDebug("Shortening path for build from {long} to {short}...", originalPath, shortPath);
            await linkFactory.CreateSymbolicLink(originalPath, shortPath, cancellationToken);
            try
            {
                await shortenedPathOperation(shortPath);
            }
            finally
            {
                await IOManager.DeleteDirectory(shortPath, CancellationToken.None); // DCT: Should always run
            }
        }
 
        async ValueTask AddServerFirewallException(EngineVersion version, string path, bool deploymentPipelineProcesses, CancellationToken cancellationToken)
        {
            if (GeneralConfiguration.SkipAddingByondFirewallException)
                return;
 
            GetExecutablePaths(path, out var serverExePath, out _);
 
            int exitCode;
            try
            {
                // I really wish we could add the instance name here but
                // 1. It'd make IByondInstaller need to be transient per-instance and WindowsByondInstaller relys on being a singleton for its DX installer call
                // 2. The instance could be renamed, so it'd have to be an unfriendly ID anyway.
                var ruleName = $"TGS OpenDream {version}";
 
                exitCode = await WindowsFirewallHelper.AddFirewallException(
                    ProcessExecutor,
                    Logger,
                    ruleName,
                    serverExePath,
                    deploymentPipelineProcesses && SessionConfiguration.LowPriorityDeploymentProcesses,
                    cancellationToken);
            }
            catch (Exception ex)
            {
                throw new JobException(ErrorCode.EngineFirewallFail, ex);
            }
 
            if (exitCode != 0)
                throw new JobException(ErrorCode.EngineFirewallFail, new JobException($"Invalid exit code: {exitCode}"));
        }
    }
}