summaryrefslogtreecommitdiff
path: root/src/SMAPI.Web/ViewModels/ModModel.cs
blob: ae81acf5efb7fe36194b53cfa61953f8fc92c5f7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
using System.Collections.Generic;
using System.Linq;
using StardewModdingAPI.Toolkit.Framework.Clients.Wiki;

namespace StardewModdingAPI.Web.ViewModels
{
    /// <summary>Metadata about a mod.</summary>
    public class ModModel
    {
        /*********
        ** Accessors
        *********/
        /// <summary>The mod name.</summary>
        public string Name { get; set; }

        /// <summary>The mod's alternative names, if any.</summary>
        public string AlternateNames { get; set; }

        /// <summary>The mod author's name.</summary>
        public string Author { get; set; }

        /// <summary>The mod author's alternative names, if any.</summary>
        public string AlternateAuthors { get; set; }

        /// <summary>The URL to the mod's source code, if any.</summary>
        public string SourceUrl { get; set; }

        /// <summary>The compatibility status for the stable version of the game.</summary>
        public ModCompatibilityModel Compatibility { get; set; }

        /// <summary>The compatibility status for the beta version of the game.</summary>
        public ModCompatibilityModel BetaCompatibility { get; set; }

        /// <summary>Whether the mod is ready for the upcoming SMAPI 3.0.</summary>
        public string Smapi3Status { get; set; }

        /// <summary>A URL related to the <see cref="Smapi3Status"/>.</summary>
        public string Smapi3Url { get; set; }

        /// <summary>Links to the available mod pages.</summary>
        public ModLinkModel[] ModPages { get; set; }

        /// <summary>The human-readable warnings for players about this mod.</summary>
        public string[] Warnings { get; set; }

        /// <summary>A unique identifier for the mod that can be used in an anchor URL.</summary>
        public string Slug { get; set; }

        /// <summary>The sites where the mod can be downloaded.</summary>
        public string[] ModPageSites => this.ModPages.Select(p => p.Text).ToArray();


        /*********
        ** Public methods
        *********/
        /// <summary>Construct an instance.</summary>
        /// <param name="entry">The mod metadata.</param>
        public ModModel(WikiModEntry entry)
        {
            // basic info
            this.Name = entry.Name.FirstOrDefault();
            this.AlternateNames = string.Join(", ", entry.Name.Skip(1).ToArray());
            this.Author = entry.Author.FirstOrDefault();
            this.AlternateAuthors = string.Join(", ", entry.Author.Skip(1).ToArray());
            this.SourceUrl = this.GetSourceUrl(entry);
            this.Compatibility = new ModCompatibilityModel(entry.Compatibility);
            this.BetaCompatibility = entry.BetaCompatibility != null ? new ModCompatibilityModel(entry.BetaCompatibility) : null;
            this.Smapi3Status = entry.Smapi3Status.ToString().ToLower();
            this.Smapi3Url = entry.Smapi3Url;
            this.ModPages = this.GetModPageUrls(entry).ToArray();
            this.Warnings = entry.Warnings;
            this.Slug = entry.Anchor;
        }


        /*********
        ** Private methods
        *********/
        /// <summary>Get the web URL for the mod's source code repository, if any.</summary>
        /// <param name="entry">The mod metadata.</param>
        private string GetSourceUrl(WikiModEntry entry)
        {
            if (!string.IsNullOrWhiteSpace(entry.GitHubRepo))
                return $"https://github.com/{entry.GitHubRepo}";
            if (!string.IsNullOrWhiteSpace(entry.CustomSourceUrl))
                return entry.CustomSourceUrl;
            return null;
        }

        /// <summary>Get the web URLs for the mod pages, if any.</summary>
        /// <param name="entry">The mod metadata.</param>
        private IEnumerable<ModLinkModel> GetModPageUrls(WikiModEntry entry)
        {
            bool anyFound = false;

            // normal mod pages
            if (entry.NexusID.HasValue)
            {
                anyFound = true;
                yield return new ModLinkModel($"https://www.nexusmods.com/stardewvalley/mods/{entry.NexusID}", "Nexus");
            }
            if (entry.ChucklefishID.HasValue)
            {
                anyFound = true;
                yield return new ModLinkModel($"https://community.playstarbound.com/resources/{entry.ChucklefishID}", "Chucklefish");
            }
            if (entry.ModDropID.HasValue)
            {
                anyFound = true;
                yield return new ModLinkModel($"https://www.moddrop.com/sdv/mod/{entry.ModDropID}", "ModDrop");
            }

            // fallback
            if (!anyFound && !string.IsNullOrWhiteSpace(entry.CustomUrl))
            {
                anyFound = true;
                yield return new ModLinkModel(entry.CustomUrl, "custom");
            }
            if (!anyFound && !string.IsNullOrWhiteSpace(entry.GitHubRepo))
                yield return new ModLinkModel($"https://github.com/{entry.GitHubRepo}/releases", "GitHub");
        }
    }
}