Skip to content

IPC for the retrieval and monitoring of a CollectionCache's ResolvedFiles. (Effective Changes) #539

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
CordeliaMist wants to merge 4 commits into
base: master
Choose a base branch
from
Open

IPC for the retrieval and monitoring of a CollectionCache's ResolvedFiles. (Effective Changes) #539

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2b60f20
Track CollectionCache ResolvedFiles
CordeliaMist Dec 30, 2025
45deebc
Properly debug in IPCTester, as much as the current implementation al…
CordeliaMist Dec 30, 2025
d110a5e
Remove log message.
CordeliaMist Dec 30, 2025
9bac468
Fix the ImGuiAssert on the debug tab
CordeliaMist Dec 31, 2025
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
100 changes: 73 additions & 27 deletions Penumbra/Api/Api/CollectionApi.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,28 +2,51 @@
using Penumbra.Api.Enums;
using Penumbra.Collections;
using Penumbra.Collections.Manager;
using Penumbra.Communication;
using Penumbra.Mods;
using Penumbra.Mods.Editor;
using Penumbra.Services;
using Penumbra.String.Classes;

namespace Penumbra.Api.Api;

public class CollectionApi(CollectionManager collections, ApiHelpers helpers) : IPenumbraApiCollection, IApiService
public class CollectionApi : IPenumbraApiCollection, IApiService, IDisposable
{
private readonly CollectionManager _collections;
private readonly ApiHelpers _helpers;
private readonly CommunicatorService _communicator;

public CollectionApi(CollectionManager collections, ApiHelpers helpers, CommunicatorService communicator)
{
_collections = collections;
_helpers = helpers;
_communicator = communicator;
_communicator.ResolvedFileChanged.Subscribe(OnResolvedFileChange, Communication.ResolvedFileChanged.Priority.ApiResolvedFile);
}

public void Dispose()
{
_communicator.ResolvedFileChanged.Unsubscribe(OnResolvedFileChange);
}

public event ResolvedFileChangedDelegate? ResolvedFileChanged;

public Dictionary<Guid, string> GetCollections()
=> collections.Storage.ToDictionary(c => c.Identity.Id, c => c.Identity.Name);
=> _collections.Storage.ToDictionary(c => c.Identity.Id, c => c.Identity.Name);

public List<(Guid Id, string Name)> GetCollectionsByIdentifier(string identifier)
{
if (identifier.Length == 0)
return [];

var list = new List<(Guid Id, string Name)>(4);
if (Guid.TryParse(identifier, out var guid) && collections.Storage.ById(guid, out var collection) && collection != ModCollection.Empty)
if (Guid.TryParse(identifier, out var guid) && _collections.Storage.ById(guid, out var collection) && collection != ModCollection.Empty)
list.Add((collection.Identity.Id, collection.Identity.Name));
else if (identifier.Length >= 8)
list.AddRange(collections.Storage.Where(c => c.Identity.Identifier.StartsWith(identifier, StringComparison.OrdinalIgnoreCase))
list.AddRange(_collections.Storage.Where(c => c.Identity.Identifier.StartsWith(identifier, StringComparison.OrdinalIgnoreCase))
.Select(c => (c.Identity.Id, c.Identity.Name)));

list.AddRange(collections.Storage
list.AddRange(_collections.Storage
.Where(c => string.Equals(c.Identity.Name, identifier, StringComparison.OrdinalIgnoreCase)
&& !list.Contains((c.Identity.Id, c.Identity.Name)))
.Select(c => (c.Identity.Id, c.Identity.Name)));
Expand All @@ -32,7 +55,7 @@ public Dictionary<Guid, string> GetCollections()

public Func<string, (string ModDirectory, string ModName)[]> CheckCurrentChangedItemFunc()
{
var weakRef = new WeakReference<CollectionManager>(collections);
var weakRef = new WeakReference<CollectionManager>(_collections);
return s =>
{
if (!weakRef.TryGetTarget(out var c))
Expand All @@ -45,11 +68,31 @@ public Dictionary<Guid, string> GetCollections()
};
}

public Dictionary<string, string> GetResolvedFilesForCollection(Guid collectionId)
{
try
{
if (!_collections.Storage.ById(collectionId, out var collection))
collection = ModCollection.Empty;

if (collection.HasCache)
return collection.ResolvedFiles.ToDictionary(kvp => kvp.Key.ToString(), kvp => kvp.Value.Path.ToString());

Penumbra.Log.Warning($"Collection {collectionId} does not exist or is not loaded.");
return [];
}
catch (Exception e)
{
Penumbra.Log.Error($"Could not obtain Resolved Files for {collectionId}:\n{e}");
throw;
}
}

public Dictionary<string, object?> GetChangedItemsForCollection(Guid collectionId)
{
try
{
if (!collections.Storage.ById(collectionId, out var collection))
if (!_collections.Storage.ById(collectionId, out var collection))
collection = ModCollection.Empty;

if (collection.HasCache)
Expand All @@ -70,7 +113,7 @@ public Dictionary<Guid, string> GetCollections()
if (!Enum.IsDefined(type))
return null;

var collection = collections.Active.ByType((CollectionType)type);
var collection = _collections.Active.ByType((CollectionType)type);
return collection == null ? null : (collection.Identity.Id, collection.Identity.Name);
}

Expand All @@ -79,19 +122,19 @@ public Dictionary<Guid, string> GetCollections()

public (bool ObjectValid, bool IndividualSet, (Guid Id, string Name) EffectiveCollection) GetCollectionForObject(int gameObjectIdx)
{
var id = helpers.AssociatedIdentifier(gameObjectIdx);
var id = _helpers.AssociatedIdentifier(gameObjectIdx);
if (!id.IsValid)
return (false, false, (collections.Active.Default.Identity.Id, collections.Active.Default.Identity.Name));
return (false, false, (_collections.Active.Default.Identity.Id, _collections.Active.Default.Identity.Name));

if (collections.Active.Individuals.TryGetValue(id, out var collection))
if (_collections.Active.Individuals.TryGetValue(id, out var collection))
return (true, true, (collection.Identity.Id, collection.Identity.Name));

helpers.AssociatedCollection(gameObjectIdx, out collection);
_helpers.AssociatedCollection(gameObjectIdx, out collection);
return (true, false, (collection.Identity.Id, collection.Identity.Name));
}

public Guid[] GetCollectionByName(string name)
=> collections.Storage.Where(c => string.Equals(name, c.Identity.Name, StringComparison.OrdinalIgnoreCase)).Select(c => c.Identity.Id)
=> _collections.Storage.Where(c => string.Equals(name, c.Identity.Name, StringComparison.OrdinalIgnoreCase)).Select(c => c.Identity.Id)
.ToArray();

public (PenumbraApiEc, (Guid Id, string Name)? OldCollection) SetCollection(ApiCollectionType type, Guid? collectionId,
Expand All @@ -100,7 +143,7 @@ public Guid[] GetCollectionByName(string name)
if (!Enum.IsDefined(type))
return (PenumbraApiEc.InvalidArgument, null);

var oldCollection = collections.Active.ByType((CollectionType)type);
var oldCollection = _collections.Active.ByType((CollectionType)type);
var old = oldCollection != null ? (oldCollection.Identity.Id, oldCollection.Identity.Name) : new ValueTuple<Guid, string>?();
if (collectionId == null)
{
Expand All @@ -110,37 +153,37 @@ public Guid[] GetCollectionByName(string name)
if (!allowDelete || type is ApiCollectionType.Current or ApiCollectionType.Default or ApiCollectionType.Interface)
return (PenumbraApiEc.AssignmentDeletionDisallowed, old);

collections.Active.RemoveSpecialCollection((CollectionType)type);
_collections.Active.RemoveSpecialCollection((CollectionType)type);
return (PenumbraApiEc.Success, old);
}

if (!collections.Storage.ById(collectionId.Value, out var collection))
if (!_collections.Storage.ById(collectionId.Value, out var collection))
return (PenumbraApiEc.CollectionMissing, old);

if (old == null)
{
if (!allowCreateNew)
return (PenumbraApiEc.AssignmentCreationDisallowed, old);

collections.Active.CreateSpecialCollection((CollectionType)type);
_collections.Active.CreateSpecialCollection((CollectionType)type);
}
else if (old.Value.Item1 == collection.Identity.Id)
{
return (PenumbraApiEc.NothingChanged, old);
}

collections.Active.SetCollection(collection, (CollectionType)type);
_collections.Active.SetCollection(collection, (CollectionType)type);
return (PenumbraApiEc.Success, old);
}

public (PenumbraApiEc, (Guid Id, string Name)? OldCollection) SetCollectionForObject(int gameObjectIdx, Guid? collectionId,
bool allowCreateNew, bool allowDelete)
{
var id = helpers.AssociatedIdentifier(gameObjectIdx);
var id = _helpers.AssociatedIdentifier(gameObjectIdx);
if (!id.IsValid)
return (PenumbraApiEc.InvalidIdentifier, (collections.Active.Default.Identity.Id, collections.Active.Default.Identity.Name));
return (PenumbraApiEc.InvalidIdentifier, (_collections.Active.Default.Identity.Id, _collections.Active.Default.Identity.Name));

var oldCollection = collections.Active.Individuals.TryGetValue(id, out var c) ? c : null;
var oldCollection = _collections.Active.Individuals.TryGetValue(id, out var c) ? c : null;
var old = oldCollection != null ? (oldCollection.Identity.Id, oldCollection.Identity.Name) : new ValueTuple<Guid, string>?();
if (collectionId == null)
{
Expand All @@ -150,28 +193,31 @@ public Guid[] GetCollectionByName(string name)
if (!allowDelete)
return (PenumbraApiEc.AssignmentDeletionDisallowed, old);

var idx = collections.Active.Individuals.Index(id);
collections.Active.RemoveIndividualCollection(idx);
var idx = _collections.Active.Individuals.Index(id);
_collections.Active.RemoveIndividualCollection(idx);
return (PenumbraApiEc.Success, old);
}

if (!collections.Storage.ById(collectionId.Value, out var collection))
if (!_collections.Storage.ById(collectionId.Value, out var collection))
return (PenumbraApiEc.CollectionMissing, old);

if (old == null)
{
if (!allowCreateNew)
return (PenumbraApiEc.AssignmentCreationDisallowed, old);

var ids = collections.Active.Individuals.GetGroup(id);
collections.Active.CreateIndividualCollection(ids);
var ids = _collections.Active.Individuals.GetGroup(id);
_collections.Active.CreateIndividualCollection(ids);
}
else if (old.Value.Item1 == collection.Identity.Id)
{
return (PenumbraApiEc.NothingChanged, old);
}

collections.Active.SetCollection(collection, CollectionType.Individual, collections.Active.Individuals.Index(id));
_collections.Active.SetCollection(collection, CollectionType.Individual, _collections.Active.Individuals.Index(id));
return (PenumbraApiEc.Success, old);
}

private void OnResolvedFileChange(ModCollection collection, ResolvedFileChange type, Utf8GamePath gamePath, FullPath newPath, FullPath oldPath, IMod? mod)
=> ResolvedFileChanged?.Invoke(type, collection.Identity.Id, mod?.Name ?? string.Empty, gamePath.ToString(), oldPath.ToString(), newPath.ToString());
}
13 changes: 7 additions & 6 deletions Penumbra/Api/DalamudSubstitutionProvider.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
using Dalamud.Interface;
using Dalamud.Plugin.Services;
using OtterGui.Services;
using Penumbra.Api.Enums;
using Penumbra.Collections;
using Penumbra.Collections.Manager;
using Penumbra.Communication;
Expand Down Expand Up @@ -85,21 +86,21 @@ private void OnCollectionChange(CollectionType type, ModCollection? oldCollectio
ResetSubstitutions(enumerable);
}

private void OnResolvedFileChange(ModCollection collection, ResolvedFileChanged.Type type, Utf8GamePath key, FullPath _1, FullPath _2,
private void OnResolvedFileChange(ModCollection collection, ResolvedFileChange type, Utf8GamePath key, FullPath _1, FullPath _2,
IMod? _3)
{
if (_activeCollectionData.Interface != collection)
return;

switch (type)
{
case ResolvedFileChanged.Type.Added:
case ResolvedFileChanged.Type.Removed:
case ResolvedFileChanged.Type.Replaced:
case ResolvedFileChange.Added:
case ResolvedFileChange.Removed:
case ResolvedFileChange.Replaced:
ResetSubstitutions([key]);
break;
case ResolvedFileChanged.Type.FullRecomputeStart:
case ResolvedFileChanged.Type.FullRecomputeFinished:
case ResolvedFileChange.FullRecomputeStart:
case ResolvedFileChange.FullRecomputeFinished:
ResetSubstitutions(collection.ResolvedFiles.Keys);
break;
}
Expand Down
2 changes: 2 additions & 0 deletions Penumbra/Api/IpcProviders.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,14 @@ public IpcProviders(IDalamudPluginInterface pi, IPenumbraApi api, CharacterUtili
[
IpcSubscribers.GetCollections.Provider(pi, api.Collection),
IpcSubscribers.GetCollectionsByIdentifier.Provider(pi, api.Collection),
IpcSubscribers.GetResolvedFilesForCollection.Provider(pi, api.Collection),
IpcSubscribers.GetChangedItemsForCollection.Provider(pi, api.Collection),
IpcSubscribers.GetCollection.Provider(pi, api.Collection),
IpcSubscribers.GetCollectionForObject.Provider(pi, api.Collection),
IpcSubscribers.SetCollection.Provider(pi, api.Collection),
IpcSubscribers.SetCollectionForObject.Provider(pi, api.Collection),
IpcSubscribers.CheckCurrentChangedItemFunc.Provider(pi, api.Collection),
IpcSubscribers.ResolvedFileChanged.Provider(pi, api.Collection),

IpcSubscribers.ConvertTextureFile.Provider(pi, api.Editing),
IpcSubscribers.ConvertTextureData.Provider(pi, api.Editing),
Expand Down
Loading