summaryrefslogtreecommitdiff
path: root/src/SMAPI.Web/Framework/Clients/ModDrop/ModDropClient.cs
blob: f5a5f930ae14e15eb56657c574be0a24c0a15051 (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
using System.Collections.Generic;
using System.Diagnostics.CodeAnalysis;
using System.Threading.Tasks;
using Pathoschild.Http.Client;
using StardewModdingAPI.Toolkit.Framework.UpdateData;
using StardewModdingAPI.Web.Framework.Clients.ModDrop.ResponseModels;

namespace StardewModdingAPI.Web.Framework.Clients.ModDrop
{
    /// <summary>An HTTP client for fetching mod metadata from the ModDrop API.</summary>
    internal class ModDropClient : IModDropClient
    {
        /*********
        ** Fields
        *********/
        /// <summary>The underlying HTTP client.</summary>
        private readonly IClient Client;

        /// <summary>The URL for a ModDrop mod page for the user, where {0} is the mod ID.</summary>
        private readonly string ModUrlFormat;


        /*********
        ** Accessors
        *********/
        /// <summary>The unique key for the mod site.</summary>
        public ModSiteKey SiteKey => ModSiteKey.ModDrop;


        /*********
        ** Public methods
        *********/
        /// <summary>Construct an instance.</summary>
        /// <param name="userAgent">The user agent for the API client.</param>
        /// <param name="apiUrl">The base URL for the ModDrop API.</param>
        /// <param name="modUrlFormat">The URL for a ModDrop mod page for the user, where {0} is the mod ID.</param>
        public ModDropClient(string userAgent, string apiUrl, string modUrlFormat)
        {
            this.Client = new FluentClient(apiUrl).SetUserAgent(userAgent);
            this.ModUrlFormat = modUrlFormat;
        }

        /// <summary>Get update check info about a mod.</summary>
        /// <param name="id">The mod ID.</param>
        [SuppressMessage("ReSharper", "ConditionalAccessQualifierIsNonNullableAccordingToAPIContract", Justification = "The nullability is validated in this method.")]
        public async Task<IModPage?> GetModData(string id)
        {
            IModPage page = new GenericModPage(this.SiteKey, id);

            if (!long.TryParse(id, out long parsedId))
                return page.SetError(RemoteModStatus.DoesNotExist, $"The value '{id}' isn't a valid ModDrop mod ID, must be an integer ID.");

            // get raw data
            ModListModel response = await this.Client
                .PostAsync("")
                .WithBody(new
                {
                    ModIDs = new[] { parsedId },
                    Files = true,
                    Mods = true
                })
                .As<ModListModel>();

            if (!response.Mods.TryGetValue(parsedId, out ModModel? mod) || mod?.Mod is null)
                return page.SetError(RemoteModStatus.DoesNotExist, "Found no ModDrop page with this ID.");
            if (mod.Mod.ErrorCode is not null)
                return page.SetError(RemoteModStatus.InvalidData, $"ModDrop returned error code {mod.Mod.ErrorCode} for mod ID '{id}'.");

            // get files
            var downloads = new List<IModDownload>();
            foreach (FileDataModel file in mod.Files)
            {
                if (file.IsOld || file.IsDeleted || file.IsHidden)
                    continue;

                downloads.Add(
                    new GenericModDownload(file.Name, file.Description, file.Version)
                );
            }

            // return info
            string name = mod.Mod.Title;
            string url = string.Format(this.ModUrlFormat, id);
            return page.SetInfo(name: name, version: null, url: url, downloads: downloads);
        }

        /// <summary>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.</summary>
        public void Dispose()
        {
            this.Client.Dispose();
        }
    }
}