using System;
using System.Linq;
using System.Net;
using System.Threading.Tasks;
using Pathoschild.Http.Client;
using StardewModdingAPI.Toolkit.Framework.UpdateData;
namespace StardewModdingAPI.Web.Framework.Clients.GitHub
{
/// An HTTP client for fetching metadata from GitHub.
internal class GitHubClient : IGitHubClient
{
/*********
** Fields
*********/
/// The underlying HTTP client.
private readonly IClient Client;
/*********
** Accessors
*********/
/// The unique key for the mod site.
public ModSiteKey SiteKey => ModSiteKey.GitHub;
/*********
** Public methods
*********/
/// Construct an instance.
/// The base URL for the GitHub API.
/// The user agent for the API client.
/// The Accept header value expected by the GitHub API.
/// The username with which to authenticate to the GitHub API.
/// The password with which to authenticate to the GitHub API.
public GitHubClient(string baseUrl, string userAgent, string acceptHeader, string? username, string? password)
{
this.Client = new FluentClient(baseUrl)
.SetUserAgent(userAgent)
.AddDefault(req => req.WithHeader("Accept", acceptHeader));
if (!string.IsNullOrWhiteSpace(username))
this.Client = this.Client.SetBasicAuthentication(username, password!);
}
/// Get basic metadata for a GitHub repository, if available.
/// The repository key (like Pathoschild/SMAPI).
/// Returns the repository info if it exists, else null.
public async Task GetRepositoryAsync(string repo)
{
this.AssertKeyFormat(repo);
try
{
return await this.Client
.GetAsync($"repos/{repo}")
.As();
}
catch (ApiException ex) when (ex.Status == HttpStatusCode.NotFound)
{
return null;
}
}
/// Get the latest release for a GitHub repository.
/// The repository key (like Pathoschild/SMAPI).
/// Whether to return a prerelease version if it's latest.
/// Returns the release if found, else null.
public async Task GetLatestReleaseAsync(string repo, bool includePrerelease = false)
{
this.AssertKeyFormat(repo);
try
{
if (includePrerelease)
{
GitRelease[] results = await this.Client
.GetAsync($"repos/{repo}/releases?per_page=2") // allow for draft release (only visible if GitHub repo is owned by same account as the update check credentials)
.AsArray();
return results.FirstOrDefault(p => !p.IsDraft);
}
return await this.Client
.GetAsync($"repos/{repo}/releases/latest")
.As();
}
catch (ApiException ex) when (ex.Status == HttpStatusCode.NotFound)
{
return null;
}
}
/// Get update check info about a mod.
/// The mod ID.
public async Task GetModData(string id)
{
IModPage page = new GenericModPage(this.SiteKey, id);
if (!id.Contains("/") || id.IndexOf("/", StringComparison.OrdinalIgnoreCase) != id.LastIndexOf("/", StringComparison.OrdinalIgnoreCase))
return page.SetError(RemoteModStatus.DoesNotExist, $"The value '{id}' isn't a valid GitHub mod ID, must be a username and project name like 'Pathoschild/SMAPI'.");
// fetch repo info
GitRepo? repository = await this.GetRepositoryAsync(id);
if (repository == null)
return page.SetError(RemoteModStatus.DoesNotExist, "Found no GitHub repository for this ID.");
string name = repository.FullName;
string url = $"{repository.WebUrl}/releases";
// get releases
GitRelease? latest;
GitRelease? preview;
{
// get latest release (whether preview or stable)
latest = await this.GetLatestReleaseAsync(id, includePrerelease: true);
if (latest == null)
return page.SetError(RemoteModStatus.DoesNotExist, "Found no GitHub release for this ID.");
// get stable version if different
preview = null;
if (latest.IsPrerelease)
{
GitRelease? release = await this.GetLatestReleaseAsync(id, includePrerelease: false);
if (release != null)
{
preview = latest;
latest = release;
}
}
}
// get downloads
IModDownload[] downloads = new[] { latest, preview }
.Where(release => release is not null)
.Select(release => (IModDownload)new GenericModDownload(release!.Name, release.Body, release.Tag))
.ToArray();
// return info
return page.SetInfo(name: name, url: url, version: null, downloads: downloads);
}
/// Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
public void Dispose()
{
this.Client.Dispose();
}
/*********
** Private methods
*********/
/// Assert that a repository key is formatted correctly.
/// The repository key (like Pathoschild/SMAPI).
/// The repository key is invalid.
private void AssertKeyFormat(string repo)
{
if (repo == null || !repo.Contains("/") || repo.IndexOf("/", StringComparison.OrdinalIgnoreCase) != repo.LastIndexOf("/", StringComparison.OrdinalIgnoreCase))
throw new ArgumentException($"The value '{repo}' isn't a valid GitHub repository key, must be a username and project name like 'Pathoschild/SMAPI'.", nameof(repo));
}
}
}