Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions src/PKForge.App/Platforms/Android/AndroidEmulatorLauncher.cs
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
using Android.Content;
using Android.Content.PM;
using Android.Net;
using PKForge.App.ViewModels;
using PKForge.Domain;

namespace PKForge.App;
Expand Down Expand Up @@ -70,7 +71,7 @@ public Task<bool> OpenAppAsync(EmulatorKind kind, CancellationToken cancellation
break;
}
catch (ActivityNotFoundException) { }
catch (SecurityException) { }
catch (Java.Lang.SecurityException) { }
}
if (!opened)
Services.AppLog.Info("launch", $"Could not open {SaveDescriptions.EmulatorName(kind)} ({package}): no launchable activity.");
Expand Down Expand Up @@ -143,7 +144,7 @@ private static Task<bool> StartActivityAsync(Activity activity, Intent intent, R
{
started = false;
}
catch (SecurityException)
catch (Java.Lang.SecurityException)
{
started = false;
}
Expand Down
40 changes: 3 additions & 37 deletions src/PKForge.App/Services/HttpRetroAchievementsClient.cs
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,7 @@ public async Task<bool> VerifyCredentialsAsync(CancellationToken cancellationTok
await using var stream = await response.Content.ReadAsStreamAsync(timeout.Token).ConfigureAwait(false);
using var document = await JsonDocument.ParseAsync(stream, cancellationToken: timeout.Token).ConfigureAwait(false);
// An unknown user comes back as an error object, a valid one as a profile with an ID.
return document.RootElement.ValueKind == JsonValueKind.Object
&& document.RootElement.TryGetProperty("ID", out _);
return RetroAchievementsJson.LooksLikeProfile(document.RootElement);
}

public async Task<RetroGameProgress> GetGameProgressAsync(int gameId, CancellationToken cancellationToken = default)
Expand All @@ -55,46 +54,13 @@ public async Task<RetroGameProgress> GetGameProgressAsync(int gameId, Cancellati
await using var stream = await response.Content.ReadAsStreamAsync(timeout.Token).ConfigureAwait(false);
using var document = await JsonDocument.ParseAsync(stream, cancellationToken: timeout.Token).ConfigureAwait(false);
var root = document.RootElement;
if (root.ValueKind != JsonValueKind.Object || !root.TryGetProperty("ID", out _))
if (!RetroAchievementsJson.LooksLikeGame(root))
throw new InvalidOperationException("RetroAchievements did not recognise that game.");

var title = root.TryGetProperty("Title", out var titleElement) ? titleElement.GetString() ?? string.Empty : string.Empty;
var achievements = new List<RetroAchievement>();
if (root.TryGetProperty("Achievements", out var set) && set.ValueKind == JsonValueKind.Object)
{
foreach (var entry in set.EnumerateObject())
{
var a = entry.Value;
var id = a.TryGetProperty("ID", out var idElement) && idElement.TryGetInt32(out var parsedId) ? parsedId : 0;
var earned = a.TryGetProperty("DateEarned", out var dateEarned) && dateEarned.ValueKind == JsonValueKind.String;
var earnedHardcore = a.TryGetProperty("DateEarnedHardcore", out var dateHardcore) && dateHardcore.ValueKind == JsonValueKind.String;
achievements.Add(new RetroAchievement(
id,
a.TryGetProperty("Title", out var name) ? name.GetString() ?? string.Empty : string.Empty,
a.TryGetProperty("Description", out var description) ? description.GetString() ?? string.Empty : string.Empty,
a.TryGetProperty("Points", out var points) && points.TryGetInt32(out var pointValue) ? pointValue : 0,
a.TryGetProperty("BadgeName", out var badge) ? badge.GetString() ?? string.Empty : string.Empty,
earned,
earned && ParseTimestamp(a, "DateEarned"),
earnedHardcore));
}
}

var progress = new RetroGameProgress(gameId, title, [.. achievements.OrderBy(a => a.Id)]);
var progress = RetroAchievementsJson.ParseGameProgress(root, gameId);
cache.Store(progress);
return progress;
}

/// <summary>RA's "YYYY-MM-DD HH:mm:ss" timestamps, treated as UTC (the site's own clock).</summary>
private static DateTimeOffset? ParseTimestamp(JsonElement achievement, string property)
{
if (!achievement.TryGetProperty(property, out var value) || value.ValueKind != JsonValueKind.String) return null;
return DateTimeOffset.TryParse(
value.GetString(),
System.Globalization.CultureInfo.InvariantCulture,
System.Globalization.DateTimeStyles.AssumeUniversal | System.Globalization.DateTimeStyles.AdjustToUniversal,
out var parsed) ? parsed : null;
}
}

/// <summary>
Expand Down
7 changes: 6 additions & 1 deletion src/PKForge.App/Services/TrophyScanService.cs
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,12 @@ public async Task<IReadOnlyList<SaveScanFacts>> ScanAllAsync(IReadOnlyList<Detec
owned++;
if (slot.IsShiny) shinySpecies.Add(species);
}
var playtime = TryParsePlaytime(save.PlayTime);
// The save's own playtime counter is the truth; the shelf string is only a
// fallback for formats whose stats the engine cannot open.
var stats = session.GetTrainerStats();
var playtime = stats.SupportsPlayTime && (stats.PlayTimeHours > 0 || stats.PlayTimeMinutes > 0)
? stats.PlayTimeHours
: TryParsePlaytime(save.PlayTime);
return new SaveScanFacts(
save.DocumentId,
save.EngineHint,
Expand Down
10 changes: 1 addition & 9 deletions src/PKForge.App/ViewModels/SavePickerViewModel.cs
Original file line number Diff line number Diff line change
Expand Up @@ -98,15 +98,7 @@ public static string GroupDetail(IReadOnlyList<DetectedSave> saves)
return string.Join(" · ", parts);
}

public static string EmulatorName(EmulatorKind kind) => kind switch
{
EmulatorKind.MelonDS => "melonDS",
EmulatorKind.DraStic => "DraStic",
EmulatorKind.PizzaBoyGba => "Pizza Boy GBA",
EmulatorKind.PizzaBoyGbc => "Pizza Boy GBC",
EmulatorKind.CitraMmj => "Citra MMJ",
_ => kind.ToString(),
};
public static string EmulatorName(EmulatorKind kind) => EmulatorCatalog.Name(kind);
}

public partial class SavePickerViewModel : ObservableObject
Expand Down
7 changes: 4 additions & 3 deletions src/PKForge.App/Views/EmulatorsPage.cs
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
using CommunityToolkit.Mvvm.Input;
using PKForge.App.Services;
using PKForge.App.Theme;
using PKForge.App.ViewModels;
using PKForge.Domain;
Expand Down Expand Up @@ -262,11 +263,11 @@ private bool MoveCursor(int delta)
if (_chips.Count == 0) return true;
var previous = _index >= 0 && _index < _rows.Children.Count ? _rows.Children[_index] as VisualElement : null;
_index = Math.Clamp(_index < 0 ? 0 : _index + delta, 0, _chips.Count - 1);
_ = previous?.ScaleTo(1.0, 80);
if (previous is not null) _ = previous.ScaleToAsync(1.0, 80);
if (_rows.Children[_index] is VisualElement current)
{
_ = current.ScaleTo(1.03, 90);
_ = current.ScaleTo(1.0, 80);
_ = current.ScaleToAsync(1.03, 90);
_ = current.ScaleToAsync(1.0, 80);
}
return true;
}
Expand Down
4 changes: 2 additions & 2 deletions src/PKForge.App/Views/SaveIdentitySheet.cs
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,10 @@ public static async Task<bool> ShowAsync(Grid host, SavePickerViewModel picker,
var options = new List<PadOption>();
var romLink = RomLinks?.FindBySave(save.DocumentId);
if (offerOpen) options.Add(new PadOption(OpenOption, IconPath: "play"));
if (romLink is { } link)
if (romLink is { } linked)
{
options.Add(new PadOption(PlayOption, IconPath: "play",
Detail: $"Launch {link.RomFileName} in {SaveDescriptions.EmulatorName(link.Emulator)}"));
Detail: $"Launch {linked.RomFileName} in {SaveDescriptions.EmulatorName(linked.Emulator)}"));
options.Add(new PadOption(UnlinkRomOption, IconPath: "unlink", Detail: "Forget this save's ROM. The save file stays."));
}
options.Add(new PadOption(LinkRomOption, IconPath: "file",
Expand Down
1 change: 0 additions & 1 deletion src/PKForge.App/Views/TrophiesPage.cs
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@ public sealed class TrophiesPage : ContentPage, IPadHandler
private VerticalStackLayout _rows = null!;
private Grid _hostGrid = null!;
private Label _readout = null!;
private GameTrophyCard? _open;

public TrophiesPage(SavePickerViewModel saves, TrophyScanService scanner, ITrophyStore trophies)
{
Expand Down
29 changes: 28 additions & 1 deletion src/PKForge.Domain/AppUpdate.cs
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,12 @@ public static bool IsNewerVersion(string installed, string candidate)
var core = next.Core.CompareTo(current.Core);
if (core != 0)
return core > 0;
// SemVer: a release outranks any prerelease of the same version; among two
// prereleases, the one with the more dot-separated identifiers wins when all
// shared identifiers tie (1.4.0-beta.2 > 1.4.0-beta.1 > 1.4.0-beta).
if (next.Prerelease.Length == 0 || current.Prerelease.Length == 0)
return next.Prerelease.Length == 0 && current.Prerelease.Length != 0;
return string.CompareOrdinal(next.Prerelease, current.Prerelease) > 0;
return ComparePrerelease(next.Prerelease, current.Prerelease) > 0;
}

/// <summary>Don't-remind-me applies to one release. A newer release always asks again.</summary>
Expand Down Expand Up @@ -66,5 +69,29 @@ private static bool TryParse(string value, out ReleaseVersion version)
return true;
}

/// <summary>SemVer prerelease ordering: numeric identifiers compare numerically and
/// rank below alphanumeric ones; more identifiers win when the shared prefix ties.</summary>
private static int ComparePrerelease(string left, string right)
{
var a = left.Split('.');
var b = right.Split('.');
for (var i = 0; i < Math.Min(a.Length, b.Length); i++)
{
var aNumeric = int.TryParse(a[i], out var an);
var bNumeric = int.TryParse(b[i], out var bn);
int order;
if (aNumeric && bNumeric)
order = an.CompareTo(bn);
else if (aNumeric)
order = -1; // numeric identifiers rank lower than alphanumeric ones
else if (bNumeric)
order = 1;
else
order = string.CompareOrdinal(a[i], b[i]);
if (order != 0) return order;
}
return a.Length.CompareTo(b.Length);
}

private readonly record struct ReleaseVersion(Version Core, string Prerelease);
}
11 changes: 11 additions & 0 deletions src/PKForge.Domain/EmulatorCatalog.cs
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,17 @@ public static EmulatorApp App(EmulatorKind kind) =>
All.FirstOrDefault(app => app.Kind == kind)
?? new EmulatorApp(kind, [kind.ToString().ToLowerInvariant()], RomLaunchStyle.OpenAppOnly);

/// <summary>The display name of an emulator ("melonDS", "Pizza Boy GBA", ...).</summary>
public static string Name(EmulatorKind kind) => kind switch
{
EmulatorKind.MelonDS => "melonDS",
EmulatorKind.DraStic => "DraStic",
EmulatorKind.PizzaBoyGba => "Pizza Boy GBA",
EmulatorKind.PizzaBoyGbc => "Pizza Boy GBC",
EmulatorKind.CitraMmj => "Citra MMJ",
_ => kind.ToString(),
};

/// <summary>True when any of the emulator's packages is installed.</summary>
public static bool IsInstalled(EmulatorKind kind, Func<string, bool> isPackageInstalled) =>
App(kind).PackageIds.Any(isPackageInstalled);
Expand Down
59 changes: 59 additions & 0 deletions src/PKForge.Domain/RetroAchievements.cs
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
using System.Text.Json;

namespace PKForge.Domain;

/// <summary>The player's RetroAchievements credentials. The API key is a secret: it is
Expand All @@ -13,6 +15,63 @@ public interface IRetroCredentialStore
void Save(RetroCredentials? credentials);
}

/// <summary>
/// Parses the RetroAchievements web API's JSON, in isolation from HTTP so the mapping
/// is unit tested. Follows API_GetGameInfoAndUserProgress: an achievement carries
/// DateEarned/DateEarnedHardcore only once unlocked, but older API responses returned
/// an empty string for a locked one - presence alone is never proof of an unlock.
/// </summary>
public static class RetroAchievementsJson
{
public static bool LooksLikeGame(JsonElement root) =>
root.ValueKind == JsonValueKind.Object && root.TryGetProperty("ID", out _);

public static bool LooksLikeProfile(JsonElement root) =>
root.ValueKind == JsonValueKind.Object && root.TryGetProperty("ID", out _);

public static RetroGameProgress ParseGameProgress(JsonElement root, int requestedGameId)
{
var title = root.TryGetProperty("Title", out var titleElement) ? titleElement.GetString() ?? string.Empty : string.Empty;
var achievements = new List<RetroAchievement>();
if (root.TryGetProperty("Achievements", out var set) && set.ValueKind == JsonValueKind.Object)
{
foreach (var entry in set.EnumerateObject())
{
var a = entry.Value;
var id = a.TryGetProperty("ID", out var idElement) && idElement.TryGetInt32(out var parsedId) ? parsedId : 0;
var earned = IsEarned(a, "DateEarned");
var earnedHardcore = IsEarned(a, "DateEarnedHardcore");
achievements.Add(new RetroAchievement(
id,
a.TryGetProperty("Title", out var name) ? name.GetString() ?? string.Empty : string.Empty,
a.TryGetProperty("Description", out var description) ? description.GetString() ?? string.Empty : string.Empty,
a.TryGetProperty("Points", out var points) && points.TryGetInt32(out var pointValue) ? pointValue : 0,
a.TryGetProperty("BadgeName", out var badge) ? badge.GetString() ?? string.Empty : string.Empty,
earned,
earned ? ParseTimestamp(a, "DateEarned") : null,
earnedHardcore));
}
}
return new RetroGameProgress(requestedGameId, title, [.. achievements.OrderBy(a => a.Id)]);
}

private static bool IsEarned(JsonElement achievement, string property) =>
achievement.TryGetProperty(property, out var value)
&& value.ValueKind == JsonValueKind.String
&& !string.IsNullOrWhiteSpace(value.GetString());

/// <summary>RA's "YYYY-MM-DD HH:mm:ss" timestamps, treated as UTC (the site's own clock).</summary>
private static DateTimeOffset? ParseTimestamp(JsonElement achievement, string property)
{
if (!achievement.TryGetProperty(property, out var value) || value.ValueKind != JsonValueKind.String) return null;
return DateTimeOffset.TryParse(
value.GetString(),
System.Globalization.CultureInfo.InvariantCulture,
System.Globalization.DateTimeStyles.AssumeUniversal | System.Globalization.DateTimeStyles.AdjustToUniversal,
out var parsed) ? parsed : null;
}
}

/// <summary>One official RetroAchievements achievement, as PKForge shows it.</summary>
public sealed record RetroAchievement(
int Id,
Expand Down
2 changes: 1 addition & 1 deletion src/PKForge.Domain/RomLinks.cs
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ public static IReadOnlyList<EmulatorKind> EmulatorsForRom(int generation, string

/// <summary>The subtitle the Emulators tab and the identity menu show for a link.</summary>
public static string Describe(RomLink link) =>
$"{link.RomFileName} · {SaveDescriptions.EmulatorName(link.Emulator)}";
$"{link.RomFileName} · {EmulatorCatalog.Name(link.Emulator)}";

private static string ExtensionOf(string fileName)
{
Expand Down
2 changes: 1 addition & 1 deletion src/PKForge.Engine/LegalizerService.cs
Original file line number Diff line number Diff line change
Expand Up @@ -252,7 +252,7 @@ internal static PKM LegalizeKeepingOrigin(SaveFile save, PKM current, Shiny shin
made = TryKeep(made, pk => pk.Ball = current.Ball);
if (current.CurrentLevel > made.CurrentLevel) made = TryKeep(made, pk => { pk.CurrentLevel = current.CurrentLevel; pk.ResetPartyStats(); });
if (moves.Length > 0) made = TryKeep(made, pk => { pk.SetMoves(moves); pk.HealPP(); });
if (current.IsNicknamed) made = TryKeep(made, pk => pk.SetNickname(current.Nickname));
if (current.IsNicknamed) made = TryKeep(made, pk => pk.SetNickname(SaveEngineSession.TrimToNicknameLimit(current.Nickname, pk)));
return made;
}
return null;
Expand Down
9 changes: 0 additions & 9 deletions src/PKForge.Engine/SaveEngine.cs
Original file line number Diff line number Diff line change
Expand Up @@ -279,13 +279,4 @@ public ISaveEngineSession OpenBlankSession(int generation, string? displayName =
};
return save.Generation <= 3 && tag != "JA" ? null : tag;
}

/// <summary>
/// Unbound relocates the PC and extends FireRed's species table, so editing it with
/// the stock FireRed engine would corrupt the save. It is recognized (and labeled)
/// everywhere, but stays closed until the dedicated Unbound engine ships.
/// </summary>
private static InvalidOperationException UnboundNotEditable() => new(
"Pokémon Unbound is recognized, but its CFRU save layout needs the Unbound editor " +
"(coming soon). The save file was not touched.");
}
23 changes: 18 additions & 5 deletions src/PKForge.Engine/SaveEngineSession.cs
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ public void ApplyEdit(int box, int slot, EntityEdit edit)
}
if (edit.Nickname is { } nickname && !string.Equals(entity.Nickname, nickname, StringComparison.Ordinal))
{
entity.SetNickname(nickname);
entity.SetNickname(TrimToNicknameLimit(nickname, entity));
changed = true;
}
if (edit.Level is { } level && entity.CurrentLevel != Math.Clamp(level, 1, 100))
Expand Down Expand Up @@ -268,7 +268,7 @@ public void ApplyEdit(int box, int slot, EntityEdit edit)
}
if (edit.OriginalTrainer is { } ot && !string.Equals(entity.OriginalTrainerName, ot, StringComparison.Ordinal))
{
SetOriginalTrainerName(entity, ot, _save);
SetOriginalTrainerName(entity, TrimToTrainerNameLimit(ot, entity), _save);
changed = true;
}
if (edit.Gender is { } gender && entity.Gender != Math.Clamp(gender, 0, 2))
Expand Down Expand Up @@ -897,11 +897,11 @@ internal static bool ApplyInstructions(PKM entity, IReadOnlyList<string> instruc
break;
}
case "nickname":
entity.SetNickname(value);
entity.SetNickname(TrimToNicknameLimit(value, entity));
changed = true;
break;
case "ot" or "trainer":
SetOriginalTrainerName(entity, value);
SetOriginalTrainerName(entity, TrimToTrainerNameLimit(value, entity));
changed = true;
break;
}
Expand Down Expand Up @@ -1639,7 +1639,16 @@ internal bool MakeOwned(PKM entity, TrainerProfile? profile, out string? failure
/// (Japanese: 5 characters and a terminator, the alignment bytes stay zero). A plain
/// overwrite keeps the old name's tail after the new terminator, which PKHeX rightly flags
/// as "Final terminator missing". Other formats have no such buffer rule.</summary>
/// <summary>
/// Cuts a nickname to what the mon's format stores (PKHeX's own per-format buffer size:
/// 10 in Gen 1-5, 12 from Gen 6 on, 5 for Japanese Gen 1/2). A longer name would
/// overflow the buffer when the string is encoded into the save.
/// </summary>
internal static string TrimToNicknameLimit(string nickname, PKM entity) =>
nickname.Length <= entity.MaxStringLengthNickname ? nickname : nickname[..entity.MaxStringLengthNickname];

internal static void SetOriginalTrainerName(PKM entity, string name, SaveFile? owner = null)

{
if (entity is PK3 pk3)
{
Expand All @@ -1651,9 +1660,13 @@ internal static void SetOriginalTrainerName(PKM entity, string name, SaveFile? o
}
PrefillTrainerName3(trash, pk3.Japanese);
}
entity.OriginalTrainerName = name;
entity.OriginalTrainerName = TrimToTrainerNameLimit(name, entity);
}

/// <summary>Cuts an OT name to the mon's trainer-name buffer (PKHeX's own per-format size).</summary>
internal static string TrimToTrainerNameLimit(string name, PKM entity) =>
name.Length <= entity.MaxStringLengthTrainer ? name : name[..entity.MaxStringLengthTrainer];

/// <summary>The Gen 3 naming screen's buffer before a name is written: terminators for
/// every character the language allows plus one, zero beyond.</summary>
private static void PrefillTrainerName3(Span<byte> buffer, bool japanese)
Expand Down
Loading
Loading