GeneralConfiguration.cs

Go to the documentation of this file.

using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
 
using Microsoft.Extensions.Logging;
using Newtonsoft.Json;
using Newtonsoft.Json.Converters;
 
using Tgstation.Server.Api.Models.Internal;
using Tgstation.Server.Host.Extensions;
using Tgstation.Server.Host.Properties;
using Tgstation.Server.Host.Setup;
 
using YamlDotNet.Serialization;
 
namespace Tgstation.Server.Host.Configuration
{
    public sealed class GeneralConfiguration : ServerInformationBase
    {
        public const string Section = "General";
 
        public const ushort DefaultApiPort = 5000;
 
        const uint DefaultMinimumPasswordLength = 15;
 
        const uint DefaultInstanceLimit = 10;
 
        const uint DefaultUserLimit = 100;
 
        const uint DefaultUserGroupLimit = 25;
 
        const uint DefaultByondTopicTimeout = 5000;
 
        const uint DefaultRestartTimeoutMinutes = 1;
 
        const uint DefaultShutdownTimeoutMinutes = 300;
 
        const string DefaultOpenDreamGitUrl = "https://github.com/OpenDreamProject/OpenDream";
 
        const string DefaultOpenDreamGitTagPrefix = "v";
 
        public static readonly Version CurrentConfigVersion = Version.Parse(MasterVersionsAttribute.Instance.RawConfigurationVersion);
 
        public Version? ConfigVersion { get; set; }
 
        public ushort ApiPort { get; set; }
 
        public string? GitHubAccessToken { get; set; }
 
        [JsonConverter(typeof(StringEnumConverter))]
        public SetupWizardMode SetupWizardMode { get; set; }
 
        public uint ByondTopicTimeout { get; set; } = DefaultByondTopicTimeout;
 
        public uint RestartTimeoutMinutes { get; set; } = DefaultRestartTimeoutMinutes;
 
        public uint ShutdownTimeoutMinutes { get; set; } = DefaultShutdownTimeoutMinutes;
 
        public bool UseBasicWatchdog { get; set; }
 
        public bool HostApiDocumentation { get; set; }
 
        public bool SkipAddingByondFirewallException { get; set; }
 
        public uint? DeploymentDirectoryCopyTasksPerCore { get; set; }
 
        [YamlMember(SerializeAs = typeof(string))]
        public Uri OpenDreamGitUrl { get; set; } = new Uri(DefaultOpenDreamGitUrl);
 
        public string OpenDreamGitTagPrefix { get; set; } = DefaultOpenDreamGitTagPrefix;
 
        public bool OpenDreamSuppressInstallOutput { get; set; }
 
        public List<string>? AdditionalEventScriptsDirectories { get; set; }
 
        public GeneralConfiguration()
        {
            MinimumPasswordLength = DefaultMinimumPasswordLength;
            InstanceLimit = DefaultInstanceLimit;
            UserLimit = DefaultUserLimit;
            UserGroupLimit = DefaultUserGroupLimit;
        }
 
        public void CheckCompatibility(ILogger logger)
        {
            ArgumentNullException.ThrowIfNull(logger);
 
            if (ConfigVersion == null)
                logger.LogCritical(
                    "No `ConfigVersion` specified, your configuration may be out of date! The current version is \"{currentVersion}\"",
                    CurrentConfigVersion);
            else if (ConfigVersion != CurrentConfigVersion)
                if (ConfigVersion.Major != CurrentConfigVersion.Major)
                    logger.LogCritical(
                        "Your `ConfigVersion` is majorly out-of-date and may potentially cause issues running the server. Please follow migration instructions from the TGS release notes. The current config version is v{currentConfigVersion}.",
                        CurrentConfigVersion);
                else
                    logger.LogWarning("Your `ConfigVersion` is out-of-date. Please follow migration instructions from the TGS release notes.");
 
            if (DeploymentDirectoryCopyTasksPerCore == 0)
                throw new InvalidOperationException(
                    $"{nameof(DeploymentDirectoryCopyTasksPerCore)} must be at least 1!");
            else if (this.GetCopyDirectoryTaskThrottle() < 1)
                throw new InvalidOperationException(
                    $"{nameof(DeploymentDirectoryCopyTasksPerCore)} is too large for the CPU core count of {Environment.ProcessorCount} and overflows a 32-bit signed integer. Please lower the value!");
 
            if (ByondTopicTimeout <= 1000)
                logger.LogWarning("The timeout for sending BYOND topics is very low ({ms}ms). Topic calls may fail to complete at all!", ByondTopicTimeout);
 
            if (AdditionalEventScriptsDirectories?.Any(path => !Path.IsPathRooted(path)) == true)
                logger.LogWarning($"Config option \"{nameof(AdditionalEventScriptsDirectories)}\" contains non-rooted paths. These will be evaluated relative to each instances \"Configuration\" directory!");
        }
    }
}