ToxicMushroom/Dalamud
1
0
Fork 0
mirror of https://github.com/goatcorp/Dalamud.git synced 2025-12-12 10:17:22 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Merge pull request #2416 from Haselnussbomber/fix-testing-api-level

Browse source 
Fix for testing plugins with older stable releases
This commit is contained in:
goat 2025-11-04 20:36:49 +01:00 • committed by GitHub
commit 32e04458c6
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
7 changed files with 48 additions and 57 deletions
Download patch file Download diff file Expand all files Collapse all files

2
Dalamud/Interface/Internal/PluginCategoryManager.cs
View file

@ -294,7 +294,7 @@ internal class PluginCategoryManager
}
}
if (PluginManager.HasTestingVersion(manifest) || manifest.IsTestingExclusive)
if (manifest.IsTestingExclusive || manifest.IsAvailableForTesting)
categoryList.Add(CategoryKind.AvailableForTesting);
// always add, even if empty

22
Dalamud/Interface/Internal/Windows/PluginInstaller/PluginInstallerWindow.cs
View file

@ -2454,10 +2454,11 @@ internal class PluginInstallerWindow : Window, IDisposable
var configuration = Service<DalamudConfiguration>.Get();
var pluginManager = Service<PluginManager>.Get();
var canUseTesting = pluginManager.CanUseTesting(manifest);
var useTesting = pluginManager.UseTesting(manifest);
var wasSeen = this.WasPluginSeen(manifest.InternalName);
var effectiveApiLevel = useTesting && manifest.TestingDalamudApiLevel != null ? manifest.TestingDalamudApiLevel.Value : manifest.DalamudApiLevel;
var effectiveApiLevel = useTesting ? manifest.TestingDalamudApiLevel.Value : manifest.DalamudApiLevel;
var isOutdated = effectiveApiLevel < PluginManager.DalamudApiLevel;
var isIncompatible = manifest.MinimumDalamudVersion != null &&
@ -2487,7 +2488,7 @@ internal class PluginInstallerWindow : Window, IDisposable
{
label += Locs.PluginTitleMod_TestingExclusive;
}
else if (configuration.DoPluginTest && PluginManager.HasTestingVersion(manifest))
else if (canUseTesting)
{
label += Locs.PluginTitleMod_TestingAvailable;
}
@ -2593,8 +2594,7 @@ internal class PluginInstallerWindow : Window, IDisposable
var configuration = Service<DalamudConfiguration>.Get();
var pluginManager = Service<PluginManager>.Get();
var hasTestingVersionAvailable = configuration.DoPluginTest &&
PluginManager.HasTestingVersion(manifest);
var hasTestingVersionAvailable = configuration.DoPluginTest && manifest.IsAvailableForTesting;
if (ImGui.BeginPopupContextItem("ItemContextMenu"u8))
{
@ -2689,8 +2689,7 @@ internal class PluginInstallerWindow : Window, IDisposable
label += Locs.PluginTitleMod_TestingVersion;
}
var hasTestingAvailable = this.pluginListAvailable.Any(x => x.InternalName == plugin.InternalName &&
x.IsAvailableForTesting);
var hasTestingAvailable = this.pluginListAvailable.Any(x => x.InternalName == plugin.InternalName && x.IsAvailableForTesting);
if (hasTestingAvailable && configuration.DoPluginTest && testingOptIn == null)
{
label += Locs.PluginTitleMod_TestingAvailable;
@ -3784,16 +3783,7 @@ internal class PluginInstallerWindow : Window, IDisposable
private bool IsManifestFiltered(IPluginManifest manifest)
{
var hasSearchString = !string.IsNullOrWhiteSpace(this.searchText);
var oldApi = (manifest.TestingDalamudApiLevel == null
|| manifest.TestingDalamudApiLevel < PluginManager.DalamudApiLevel)
&& manifest.DalamudApiLevel < PluginManager.DalamudApiLevel;
var installed = this.IsManifestInstalled(manifest).IsInstalled;
if (oldApi && !hasSearchString && !installed)
return true;
if (!hasSearchString)
if (string.IsNullOrWhiteSpace(this.searchText))
return false;
return this.GetManifestSearchScore(manifest) < 1;

60
Dalamud/Plugin/Internal/PluginManager.cs
View file

@ -278,26 +278,6 @@ internal class PluginManager : IInternalDisposableService
return !manifest.IsHide;
}
/// <summary>
/// Check if a manifest even has an available testing version.
/// </summary>
/// <param name="manifest">The manifest to test.</param>
/// <returns>Whether a testing version is available.</returns>
public static bool HasTestingVersion(IPluginManifest manifest)
{
var av = manifest.AssemblyVersion;
var tv = manifest.TestingAssemblyVersion;
var hasTv = tv != null;
if (hasTv)
{
return tv > av &&
manifest.TestingDalamudApiLevel == DalamudApiLevel;
}
return false;
}
/// <summary>
/// Get a disposable that will lock plugin lists while it is not disposed.
/// You must NEVER use this in async code.
@ -371,6 +351,20 @@ internal class PluginManager : IInternalDisposableService
return this.configuration.PluginTestingOptIns!.Any(x => x.InternalName == manifest.InternalName);
}
/// <summary>
/// For a given manifest, determine if the testing version can be used over the normal version.
/// The higher of the two versions is calculated after checking other settings.
/// </summary>
/// <param name="manifest">Manifest to check.</param>
/// <returns>A value indicating whether testing can be used.</returns>
public bool CanUseTesting(IPluginManifest manifest)
{
if (!this.configuration.DoPluginTest)
return false;
return manifest.IsTestingExclusive || manifest.IsAvailableForTesting;
}
/// <summary>
/// For a given manifest, determine if the testing version should be used over the normal version.
/// The higher of the two versions is calculated after checking other settings.
@ -379,16 +373,7 @@ internal class PluginManager : IInternalDisposableService
/// <returns>A value indicating whether testing should be used.</returns>
public bool UseTesting(IPluginManifest manifest)
{
if (!this.configuration.DoPluginTest)
return false;
if (!this.HasTestingOptIn(manifest))
return false;
if (manifest.IsTestingExclusive)
return true;
return HasTestingVersion(manifest);
return this.CanUseTesting(manifest) && this.HasTestingOptIn(manifest);
}
/// <inheritdoc/>
@ -1208,9 +1193,18 @@ internal class PluginManager : IInternalDisposableService
return false;
// API level - we keep the API before this in the installer to show as "outdated"
var effectiveApiLevel = this.UseTesting(manifest) && manifest.TestingDalamudApiLevel != null ? manifest.TestingDalamudApiLevel.Value : manifest.DalamudApiLevel;
if (effectiveApiLevel < DalamudApiLevel - 1 && !this.LoadAllApiLevels)
return false;
if (!this.LoadAllApiLevels)
{
var effectiveDalamudApiLevel =
this.CanUseTesting(manifest) &&
manifest.TestingDalamudApiLevel.HasValue &&
manifest.TestingDalamudApiLevel.Value > manifest.DalamudApiLevel
? manifest.TestingDalamudApiLevel.Value
: manifest.DalamudApiLevel;
if (effectiveDalamudApiLevel < PluginManager.DalamudApiLevel - 1)
return false;
}
// Banned
if (this.IsManifestBanned(manifest))

2
Dalamud/Plugin/Internal/Types/LocalPlugin.cs
View file

@ -301,7 +301,7 @@ internal class LocalPlugin : IAsyncDisposable
throw new PluginPreconditionFailedException($"Unable to load {this.Name}, game is newer than applicable version {this.manifest.ApplicableVersion}");
// We want to allow loading dev plugins with a lower API level than the current Dalamud API level, for ease of development
if (this.manifest.EffectiveApiLevel < PluginManager.DalamudApiLevel && !pluginManager.LoadAllApiLevels && !this.IsDev)
if (!pluginManager.LoadAllApiLevels && !this.IsDev && this.manifest.EffectiveApiLevel < PluginManager.DalamudApiLevel)
throw new PluginPreconditionFailedException($"Unable to load {this.Name}, incompatible API level {this.manifest.EffectiveApiLevel}");
// We might want to throw here?

7
Dalamud/Plugin/Internal/Types/Manifest/IPluginManifest.cs
View file

@ -1,4 +1,4 @@
using System.Collections.Generic;
using System.Collections.Generic;
namespace Dalamud.Plugin.Internal.Types.Manifest;
@ -118,4 +118,9 @@ public interface IPluginManifest
/// Gets an URL for the plugin's icon.
/// </summary>
public string? IconUrl { get; }
/// <summary>
/// Gets a value indicating whether this plugin is eligible for testing.
/// </summary>
public bool IsAvailableForTesting { get; }
}

5
Dalamud/Plugin/Internal/Types/Manifest/RemotePluginManifest.cs
View file

@ -21,9 +21,4 @@ internal record RemotePluginManifest : PluginManifest
/// Gets or sets the changelog to be shown when obtaining the testing version of the plugin.
/// </summary>
public string? TestingChangelog { get; set; }
/// <summary>
/// Gets a value indicating whether this plugin is eligible for testing.
/// </summary>
public bool IsAvailableForTesting => this.TestingAssemblyVersion != null && this.TestingAssemblyVersion > this.AssemblyVersion;
}

7
Dalamud/Plugin/Internal/Types/PluginManifest.cs
View file

@ -160,4 +160,11 @@ internal record PluginManifest : IPluginManifest
/// <inheritdoc/>
[JsonProperty("_Dip17Channel")]
public string? Dip17Channel { get; init; }
/// <inheritdoc/>
[JsonIgnore]
public bool IsAvailableForTesting
=> this.TestingAssemblyVersion != null &&
this.TestingAssemblyVersion > this.AssemblyVersion &&
this.TestingDalamudApiLevel == PluginManager.DalamudApiLevel;
}