Tgstation.Server.Api.Models.EngineVersion Class Reference

Information about an engine installation. More...

Inheritance diagram for Tgstation.Server.Api.Models.EngineVersion:

Collaboration diagram for Tgstation.Server.Api.Models.EngineVersion:

Public Member Functions
	EngineVersion ()
	Initializes a new instance of the EngineVersion class.
	EngineVersion (EngineVersion other)
	Initializes a new instance of the EngineVersion class.
bool	Equals (EngineVersion other)
override bool	Equals (object obj)
override string	ToString ()
override int	GetHashCode ()

Static Public Member Functions
static bool	TryParse (string input, out EngineVersion? engineVersion)
	Attempts to parse a stringified EngineVersion.
static EngineVersion	Parse (string input)
	Parses a stringified EngineVersion.

Properties
EngineType?	Engine [get, set]
	The EngineType.
Version?	Version [get, set]
	The System.Version of the engine. Currently only valid when Engine is EngineType.Byond.
string?	SourceSHA [get, set]
	The git commit SHA of the engine. Currently only valid when Engine is EngineType.OpenDream.
int?	CustomIteration [get, set]
	The revision of the custom build.

Static Private Attributes
static readonly char[]	DashChar = ['-']
	An array of a single '-' char.

Detailed Description

Information about an engine installation.

Definition at line 13 of file EngineVersion.cs.

Constructor & Destructor Documentation

EngineVersion() [1/2]

Tgstation.Server.Api.Models.EngineVersion.EngineVersion

(

)

Initializes a new instance of the EngineVersion class.

Definition at line 140 of file EngineVersion.cs.

        {
        }

EngineVersion() [2/2]

Tgstation.Server.Api.Models.EngineVersion.EngineVersion

(

EngineVersion

other

)

Initializes a new instance of the EngineVersion class.

Parameters

other

The EngineVersion to copy.

Definition at line 148 of file EngineVersion.cs.

        {
            if (other == null)
                throw new ArgumentNullException(nameof(other));
 
            Version = other.Version;
            Engine = other.Engine;
            SourceSHA = other.SourceSHA;
            CustomIteration = other.CustomIteration;
        }

References Tgstation.Server.Api.Models.EngineVersion.CustomIteration, Tgstation.Server.Api.Models.EngineVersion.Engine, Tgstation.Server.Api.Models.EngineVersion.SourceSHA, and Tgstation.Server.Api.Models.EngineVersion.Version.

Member Function Documentation

Equals() [1/2]

bool Tgstation.Server.Api.Models.EngineVersion.Equals

(

EngineVersion

other

)

Definition at line 160 of file EngineVersion.cs.

        {
            // https://github.com/dotnet/roslyn-analyzers/issues/2875
#pragma warning disable CA1062 // Validate arguments of public methods
            return other!.Version?.Semver() == Version?.Semver()
                && other.Engine == Engine
                && (other.SourceSHA == SourceSHA
                || (other.SourceSHA != null
                    && SourceSHA != null
                    && other.SourceSHA.Equals(SourceSHA, StringComparison.OrdinalIgnoreCase)))
                && other.CustomIteration == CustomIteration;
#pragma warning restore CA1062 // Validate arguments of public methods
        }

References Tgstation.Server.Api.Models.EngineVersion.CustomIteration, Tgstation.Server.Api.Models.EngineVersion.Engine, Tgstation.Server.Api.Models.EngineVersion.SourceSHA, and Tgstation.Server.Api.Models.EngineVersion.Version.

Referenced by Tgstation.Server.Host.Components.Engine.EngineManager.DeleteVersion().

Here is the caller graph for this function:

Equals() [2/2]

override bool Tgstation.Server.Api.Models.EngineVersion.Equals

(

object

obj

)

GetHashCode()

override int Tgstation.Server.Api.Models.EngineVersion.GetHashCode

(

)

Parse()

static EngineVersion Tgstation.Server.Api.Models.EngineVersion.Parse ( string  input )

static

Parses a stringified EngineVersion.

Parameters

input

The input string.

Returns

The output EngineVersion.

Exceptions

InvalidOperationException

If the input is not a valid stringified EngineVersion.

Definition at line 126 of file EngineVersion.cs.

        {
            if (input == null)
                throw new ArgumentNullException(nameof(input));
 
            if (TryParse(input, out var engineVersion))
                return engineVersion!;
 
            throw new InvalidOperationException($"Invalid engine version: {input}");
        }

References Tgstation.Server.Api.Models.EngineVersion.TryParse().

Referenced by Tgstation.Server.Host.Components.Chat.Commands.EngineCommand.Invoke().

Here is the call graph for this function:

Here is the caller graph for this function:

ToString()

override string Tgstation.Server.Api.Models.EngineVersion.ToString

(

)

Definition at line 179 of file EngineVersion.cs.

        {
            var isByond = Engine == EngineType.Byond;
 
            // BYOND encodes differently for backwards compatibility
            var enginePrefix = !isByond
                ? $"{Engine}-"
                : String.Empty;
            var displayedVersion = isByond
                ? (CustomIteration.HasValue
                    ? new Version(Version!.Major, Version.Minor, CustomIteration.Value)
                    : Version!).ToString()
                : SourceSHA;
            var displayedCustomIteration = !isByond && CustomIteration.HasValue
                ? $"-{CustomIteration}"
                : String.Empty;
            return $"{enginePrefix}{displayedVersion}{displayedCustomIteration}";
        }

References Tgstation.Server.Api.Models.EngineVersion.CustomIteration, Tgstation.Server.Api.Models.EngineVersion.Engine, Tgstation.Server.Api.Models.EngineVersion.SourceSHA, Tgstation.Server.Api.Models.EngineVersion.ToString(), and Tgstation.Server.Api.Models.EngineVersion.Version.

Referenced by Tgstation.Server.Host.Components.Engine.EngineManager.AssertAndLockVersion(), Tgstation.Server.Host.Components.Engine.EngineManager.ChangeVersion(), Tgstation.Server.Host.Components.Engine.EngineManager.DeleteVersion(), Tgstation.Server.Host.Components.Engine.EngineManager.InstallVersionFiles(), Tgstation.Server.Host.Components.Deployment.DreamMaker.RunCompileJob(), Tgstation.Server.Host.Components.Engine.EngineManager.StartAsync(), and Tgstation.Server.Api.Models.EngineVersion.ToString().

Here is the call graph for this function:

Here is the caller graph for this function:

TryParse()

static bool Tgstation.Server.Api.Models.EngineVersion.TryParse ( string  input, out EngineVersion?  engineVersion  )

static

Attempts to parse a stringified EngineVersion.

Parameters

input	The input string.
engineVersion	The output EngineVersion.

Returns

true if parsing was successful, false otherwise.

Definition at line 53 of file EngineVersion.cs.

        {
            if (input == null)
                throw new ArgumentNullException(nameof(input));
 
            var splits = input.Split(DashChar, StringSplitOptions.RemoveEmptyEntries);
            engineVersion = null;
 
            if (splits.Length > 3)
                return false;
 
            EngineType engine;
            var hasPrefix = splits.Length > 1;
            if (hasPrefix)
            {
                if (!Enum.TryParse(splits[0], out engine))
                    return false;
            }
            else
                engine = EngineType.Byond;
 
            Version? version;
            string? sha;
            int? customRev = null;
            if (engine == EngineType.Byond)
            {
                if (!Version.TryParse(splits.Last(), out version))
                    return false;
 
                if (version.Build > 0)
                {
                    customRev = version.Build;
                    version = new Version(version.Major, version.Minor);
                }
 
                sha = null;
            }
            else
            {
                Debug.Assert(engine == EngineType.OpenDream, "This does not support whatever ungodly new engine you've added");
 
                var shaIndex = hasPrefix ? 1 : 0;
                sha = splits[shaIndex];
                if (sha.Length != Limits.MaximumCommitShaLength)
                    return false;
 
                version = null;
 
                if (splits.Length - 1 > shaIndex)
                {
                    if (!Int32.TryParse(splits.Last(), out var customRevResult))
                        return false;
 
                    customRev = customRevResult;
                }
            }
 
            engineVersion = new EngineVersion
            {
                Engine = engine,
                Version = version,
                SourceSHA = sha,
                CustomIteration = customRev,
            };
            return true;
        }

References Tgstation.Server.Api.Models.EngineVersion.CustomIteration, Tgstation.Server.Api.Models.EngineVersion.DashChar, Tgstation.Server.Api.Models.EngineVersion.Engine, Tgstation.Server.Api.Models.Limits.MaximumCommitShaLength, Tgstation.Server.Api.Models.EngineVersion.SourceSHA, and Tgstation.Server.Api.Models.EngineVersion.Version.

Referenced by Tgstation.Server.Host.Components.Deployment.DmbFactory.FromCompileJobInternal(), Tgstation.Server.Api.Models.EngineVersion.Parse(), and Tgstation.Server.Host.Components.Engine.EngineManager.StartAsync().

Here is the caller graph for this function:

Member Data Documentation

DashChar

readonly char [] Tgstation.Server.Api.Models.EngineVersion.DashChar = ['-']

staticprivate

An array of a single '-' char.

Definition at line 18 of file EngineVersion.cs.

Referenced by Tgstation.Server.Api.Models.EngineVersion.TryParse().

Property Documentation

CustomIteration

int? Tgstation.Server.Api.Models.EngineVersion.CustomIteration

getset

The revision of the custom build.

Definition at line 45 of file EngineVersion.cs.

{ get; set; }

Referenced by Tgstation.Server.Host.Components.Engine.EngineManager.AssertAndLockVersion(), Tgstation.Server.Host.Components.Chat.Providers.DiscordProvider.BuildUpdateEmbedFields(), Tgstation.Server.Host.Components.Engine.EngineManager.CheckVersionParameter(), Tgstation.Server.Api.Models.EngineVersion.EngineVersion(), Tgstation.Server.Api.Models.EngineVersion.Equals(), Tgstation.Server.Host.Components.Chat.Commands.EngineCommand.Invoke(), Tgstation.Server.Api.Models.EngineVersion.ToString(), and Tgstation.Server.Api.Models.EngineVersion.TryParse().

Engine

EngineType? Tgstation.Server.Api.Models.EngineVersion.Engine

getset

The EngineType.

Definition at line 24 of file EngineVersion.cs.

{ get; set; }

Referenced by Tgstation.Server.Host.Components.Watchdog.WindowsWatchdog.ApplyInitialDmb(), Tgstation.Server.Host.Components.Chat.Providers.DiscordProvider.BuildUpdateEmbedFields(), Tgstation.Server.Host.Components.Engine.ByondInstallation.ByondInstallation(), Tgstation.Server.Host.Components.Watchdog.AdvancedWatchdog.CanUseSwappableDmbProvider(), Tgstation.Server.Host.Components.Watchdog.WatchdogBase.ChangeSettings(), Tgstation.Server.Host.Components.Engine.EngineManager.CheckVersionParameter(), Tgstation.Server.Host.Components.Engine.EngineInstallerBase.CheckVersionValidity(), Tgstation.Server.Host.Components.Engine.DelegatingEngineInstaller.DelegateCall< TReturn >(), Tgstation.Server.Api.Models.EngineVersion.EngineVersion(), Tgstation.Server.Api.Models.EngineVersion.Equals(), Tgstation.Server.Host.Components.Chat.Commands.EngineCommand.Invoke(), Tgstation.Server.Host.Components.Session.SessionControllerFactory.LaunchNew(), Tgstation.Server.Host.Components.Engine.OpenDreamInstallation.OpenDreamInstallation(), Tgstation.Server.Host.Components.Session.SessionController.ProcessBridgeCommand(), Tgstation.Server.Host.Components.Chat.Providers.DiscordProvider.SendUpdateMessage(), Tgstation.Server.Api.Models.EngineVersion.ToString(), and Tgstation.Server.Api.Models.EngineVersion.TryParse().

SourceSHA

string? Tgstation.Server.Api.Models.EngineVersion.SourceSHA

getset

The git commit SHA of the engine. Currently only valid when Engine is EngineType.OpenDream.

caa1e1f400c8b6a535e03cff28cf57f919e9378c

Definition at line 39 of file EngineVersion.cs.

{ get; set; }

Referenced by Tgstation.Server.Api.Models.EngineVersion.EngineVersion(), Tgstation.Server.Api.Models.EngineVersion.Equals(), Tgstation.Server.Api.Models.EngineVersion.ToString(), and Tgstation.Server.Api.Models.EngineVersion.TryParse().

Version

Version? Tgstation.Server.Api.Models.EngineVersion.Version

getset

The System.Version of the engine. Currently only valid when Engine is EngineType.Byond.

516.1651.0

Definition at line 31 of file EngineVersion.cs.

{ get; set; }

Referenced by Tgstation.Server.Host.Components.Engine.WindowsByondInstaller.AddDreamDaemonToFirewall(), Tgstation.Server.Host.Components.Engine.ByondInstallerBase.CreateInstallation(), Tgstation.Server.Api.Models.EngineVersion.EngineVersion(), Tgstation.Server.Api.Models.EngineVersion.Equals(), Tgstation.Server.Host.Components.Engine.ByondInstallerBase.GetDownloadZipUrl(), Tgstation.Server.Host.Components.Engine.PosixByondInstaller.Install(), Tgstation.Server.Api.Models.EngineVersion.ToString(), Tgstation.Server.Api.Models.EngineVersion.TryParse(), and Tgstation.Server.Host.Components.Engine.WindowsByondInstaller.UpgradeInstallation().

---

The documentation for this class was generated from the following file:

• src/Tgstation.Server.Api/Models/EngineVersion.cs