summaryrefslogtreecommitdiff
path: root/src/SMAPI.Web/Framework/ModRepositories/ChucklefishRepository.cs
blob: 06ec58ed89c5f2b4953ffd83855bce2e78d02147 (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
using System;
using System.Net;
using System.Threading.Tasks;
using HtmlAgilityPack;
using Pathoschild.Http.Client;
using StardewModdingAPI.Common.Models;

namespace StardewModdingAPI.Web.Framework.ModRepositories
{
    /// <summary>An HTTP client for fetching mod metadata from the Chucklefish mod site.</summary>
    internal class ChucklefishRepository : RepositoryBase
    {
        /*********
        ** Properties
        *********/
        /// <summary>The base URL for the Chucklefish mod site.</summary>
        private readonly string BaseUrl;

        /// <summary>The URL for a mod page excluding the base URL, where {0} is the mod ID.</summary>
        private readonly string ModPageUrlFormat;

        /// <summary>The underlying HTTP client.</summary>
        private readonly IClient Client;


        /*********
        ** Public methods
        *********/
        /// <summary>Construct an instance.</summary>
        /// <param name="vendorKey">The unique key for this vendor.</param>
        /// <param name="userAgent">The user agent for the API client.</param>
        /// <param name="baseUrl">The base URL for the Chucklefish mod site.</param>
        /// <param name="modPageUrlFormat">The URL for a mod page excluding the <paramref name="baseUrl"/>, where {0} is the mod ID.</param>
        public ChucklefishRepository(string vendorKey, string userAgent, string baseUrl, string modPageUrlFormat)
            : base(vendorKey)
        {
            this.BaseUrl = baseUrl;
            this.ModPageUrlFormat = modPageUrlFormat;
            this.Client = new FluentClient(baseUrl).SetUserAgent(userAgent);
        }

        /// <summary>Get metadata about a mod in the repository.</summary>
        /// <param name="id">The mod ID in this repository.</param>
        public override async Task<ModInfoModel> GetModInfoAsync(string id)
        {
            // validate ID format
            if (!uint.TryParse(id, out uint _))
                return new ModInfoModel($"The value '{id}' isn't a valid Chucklefish mod ID, must be an integer ID.");

            // fetch info
            try
            {
                // fetch HTML
                string html;
                try
                {
                    html = await this.Client
                        .GetAsync(string.Format(this.ModPageUrlFormat, id))
                        .AsString();
                }
                catch (ApiException ex) when (ex.Status == HttpStatusCode.NotFound)
                {
                    return new ModInfoModel("Found no mod with this ID.");
                }

                // parse HTML
                var doc = new HtmlDocument();
                doc.LoadHtml(html);

                // extract mod info
                string url = new UriBuilder(new Uri(this.BaseUrl)) { Path = string.Format(this.ModPageUrlFormat, id) }.Uri.ToString();
                string name = doc.DocumentNode.SelectSingleNode("//meta[@name='twitter:title']").Attributes["content"].Value;
                if (name.StartsWith("[SMAPI] "))
                    name = name.Substring("[SMAPI] ".Length);
                string version = doc.DocumentNode.SelectSingleNode("//h1/span").InnerText;

                // create model
                return new ModInfoModel(name, this.NormaliseVersion(version), url);
            }
            catch (Exception ex)
            {
                return new ModInfoModel(ex.ToString());
            }
        }

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