GeneralConfiguration.cs

Go to the documentation of this file.

using Microsoft.Extensions.Logging;
using Newtonsoft.Json;
using Newtonsoft.Json.Converters;
using System;
using Tgstation.Server.Api.Models.Internal;

namespace Tgstation.Server.Host.Configuration
{
    public sealed class GeneralConfiguration : ServerInformation
    {
        public const string Section = "General";

        public const ushort DefaultApiPort = 5000;

        public static readonly Version CurrentConfigVersion = new Version(2, 0, 0);

        const uint DefaultMinimumPasswordLength = 15;

        const uint DefaultInstanceLimit = 10;

        const uint DefaultUserLimit = 100;

        const uint DefaultByondTopicTimeout = 5000;

        const uint DefaultRestartTimeout = 60000;

        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 RestartTimeout { get; set; } = DefaultRestartTimeout;

        public bool UseBasicWatchdog { get; set; }

        public GeneralConfiguration()
        {
            MinimumPasswordLength = DefaultMinimumPasswordLength;
            InstanceLimit = DefaultInstanceLimit;
            UserLimit = DefaultUserLimit;
        }

        public void CheckCompatibility(ILogger logger)
        {
            if (logger == null)
                throw new ArgumentNullException(nameof(logger));

            if (ConfigVersion == null)
                logger.LogCritical(
                    "No `ConfigVersion` specified, your configuration may be out of date! The current version is \"{0}\"",
                    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.",
                        CurrentConfigVersion);
                else
                    logger.LogWarning("Your `ConfigVersion` is out-of-date. Please follow migration instructions from the TGS release notes.");
        }
    }
}