2.0.0 (#92)

2.0.0 Changes:

- Reworked shell finder UI with compact or list view with profile tags showing with the listing, allowing moderators to broadcast the syncshell as well to have it be used more.
- Reworked user list in syncshell admin screen to have filter visible and moved away from table to its own thing, allowing to copy uid/note/alias when clicking on the name.
- Reworked download bars and download box to make it look more modern, removed the jitter around, so it shouldn't vibrate around much.
- Chat has been added to the top menu, working in Zone or in Syncshells to be used there.
- Paired system has been revamped to make pausing and unpausing faster, and loading people should be faster as well.
- Moved to the internal object table to have faster load times for users; people should load in faster
- Compactor is running on a multi-threaded level instead of single-threaded; this should increase the speed of compacting files
- Nameplate Service has been reworked so it wouldn't use the nameplate handler anymore.
- Files can be resized when downloading to reduce load on users if they aren't compressed. (can be toggled to resize all).
- Penumbra Collections are now only made when people are visible, reducing the load on boot-up when having many syncshells in your list.
- Lightfinder plates have been moved away from using Nameplates, but will use an overlay.
- Main UI has been changed a bit with a gradient, and on hover will glow up now.
- Reworked Profile UI for Syncshell and Users to be more user-facing with more customizable items.
- Reworked Settings UI to look more modern.
- Performance should be better due to new systems that would dispose of the collections and better caching of items.

Co-authored-by: defnotken <itsdefnotken@gmail.com>
Co-authored-by: azyges <aaaaaa@aaa.aaa>
Co-authored-by: choco <choco@patat.nl>
Co-authored-by: cake <admin@cakeandbanana.nl>
Co-authored-by: Minmoose <KennethBohr@outlook.com>
Reviewed-on: #92

LightlessSync/Interop/Ipc/Penumbra/PenumbraBase.cs

@@ -0,0 +1,27 @@
+using Dalamud.Plugin;
+using LightlessSync.Interop.Ipc.Framework;
+using LightlessSync.Services;
+using LightlessSync.Services.Mediator;
+using Microsoft.Extensions.Logging;
+
+namespace LightlessSync.Interop.Ipc.Penumbra;
+
+public abstract class PenumbraBase : IpcInteropBase
+{
+    protected PenumbraBase(
+        ILogger logger,
+        IDalamudPluginInterface pluginInterface,
+        DalamudUtilService dalamudUtil,
+        LightlessMediator mediator) : base(logger)
+    {
+        PluginInterface = pluginInterface;
+        DalamudUtil = dalamudUtil;
+        Mediator = mediator;
+    }
+
+    protected IDalamudPluginInterface PluginInterface { get; }
+
+    protected DalamudUtilService DalamudUtil { get; }
+
+    protected LightlessMediator Mediator { get; }
+}

LightlessSync/Interop/Ipc/Penumbra/PenumbraCollections.cs

@@ -0,0 +1,197 @@
+using System.Collections.Concurrent;
+using Dalamud.Plugin;
+using LightlessSync.Interop.Ipc.Framework;
+using LightlessSync.Services;
+using LightlessSync.Services.Mediator;
+using Microsoft.Extensions.Logging;
+using Penumbra.Api.Enums;
+using Penumbra.Api.IpcSubscribers;
+
+namespace LightlessSync.Interop.Ipc.Penumbra;
+
+public sealed class PenumbraCollections : PenumbraBase
+{
+    private readonly CreateTemporaryCollection _createNamedTemporaryCollection;
+    private readonly AssignTemporaryCollection _assignTemporaryCollection;
+    private readonly DeleteTemporaryCollection _removeTemporaryCollection;
+    private readonly AddTemporaryMod _addTemporaryMod;
+    private readonly RemoveTemporaryMod _removeTemporaryMod;
+    private readonly GetCollections _getCollections;
+    private readonly ConcurrentDictionary<Guid, string> _activeTemporaryCollections = new();
+
+    private int _cleanupScheduled;
+
+    public PenumbraCollections(
+        ILogger logger,
+        IDalamudPluginInterface pluginInterface,
+        DalamudUtilService dalamudUtil,
+        LightlessMediator mediator) : base(logger, pluginInterface, dalamudUtil, mediator)
+    {
+        _createNamedTemporaryCollection = new CreateTemporaryCollection(pluginInterface);
+        _assignTemporaryCollection = new AssignTemporaryCollection(pluginInterface);
+        _removeTemporaryCollection = new DeleteTemporaryCollection(pluginInterface);
+        _addTemporaryMod = new AddTemporaryMod(pluginInterface);
+        _removeTemporaryMod = new RemoveTemporaryMod(pluginInterface);
+        _getCollections = new GetCollections(pluginInterface);
+    }
+
+    public override string Name => "Penumbra.Collections";
+
+    public async Task AssignTemporaryCollectionAsync(ILogger logger, Guid collectionId, int objectIndex)
+    {
+        if (!IsAvailable || collectionId == Guid.Empty)
+        {
+            return;
+        }
+
+        await DalamudUtil.RunOnFrameworkThread(() =>
+        {
+            var result = _assignTemporaryCollection.Invoke(collectionId, objectIndex, forceAssignment: true);
+            logger.LogTrace("Assigning Temp Collection {CollectionId} to index {ObjectIndex}, Success: {Result}", collectionId, objectIndex, result);
+            return result;
+        }).ConfigureAwait(false);
+    }
+
+    public async Task<Guid> CreateTemporaryCollectionAsync(ILogger logger, string uid)
+    {
+        if (!IsAvailable)
+        {
+            return Guid.Empty;
+        }
+
+        var (collectionId, collectionName) = await DalamudUtil.RunOnFrameworkThread(() =>
+        {
+            var name = $"Lightless_{uid}";
+            _createNamedTemporaryCollection.Invoke(name, name, out var tempCollectionId);
+            logger.LogTrace("Creating Temp Collection {CollectionName}, GUID: {CollectionId}", name, tempCollectionId);
+            return (tempCollectionId, name);
+        }).ConfigureAwait(false);
+
+        if (collectionId != Guid.Empty)
+        {
+            _activeTemporaryCollections[collectionId] = collectionName;
+        }
+
+        return collectionId;
+    }
+
+    public async Task RemoveTemporaryCollectionAsync(ILogger logger, Guid applicationId, Guid collectionId)
+    {
+        if (!IsAvailable || collectionId == Guid.Empty)
+        {
+            return;
+        }
+
+        await DalamudUtil.RunOnFrameworkThread(() =>
+        {
+            logger.LogTrace("[{ApplicationId}] Removing temp collection for {CollectionId}", applicationId, collectionId);
+            var result = _removeTemporaryCollection.Invoke(collectionId);
+            logger.LogTrace("[{ApplicationId}] RemoveTemporaryCollection: {Result}", applicationId, result);
+        }).ConfigureAwait(false);
+
+        _activeTemporaryCollections.TryRemove(collectionId, out _);
+    }
+
+    public async Task SetTemporaryModsAsync(ILogger logger, Guid applicationId, Guid collectionId, IReadOnlyDictionary<string, string> modPaths)
+    {
+        if (!IsAvailable || collectionId == Guid.Empty)
+        {
+            return;
+        }
+
+        await DalamudUtil.RunOnFrameworkThread(() =>
+        {
+            foreach (var mod in modPaths)
+            {
+                logger.LogTrace("[{ApplicationId}] Change: {From} => {To}", applicationId, mod.Key, mod.Value);
+            }
+
+            var removeResult = _removeTemporaryMod.Invoke("LightlessChara_Files", collectionId, 0);
+            logger.LogTrace("[{ApplicationId}] Removing temp files mod for {CollectionId}, Success: {Result}", applicationId, collectionId, removeResult);
+
+            var addResult = _addTemporaryMod.Invoke("LightlessChara_Files", collectionId, new Dictionary<string, string>(modPaths), string.Empty, 0);
+            logger.LogTrace("[{ApplicationId}] Setting temp files mod for {CollectionId}, Success: {Result}", applicationId, collectionId, addResult);
+        }).ConfigureAwait(false);
+    }
+
+    public async Task SetManipulationDataAsync(ILogger logger, Guid applicationId, Guid collectionId, string manipulationData)
+    {
+        if (!IsAvailable || collectionId == Guid.Empty)
+        {
+            return;
+        }
+
+        await DalamudUtil.RunOnFrameworkThread(() =>
+        {
+            logger.LogTrace("[{ApplicationId}] Manip: {Data}", applicationId, manipulationData);
+            var result = _addTemporaryMod.Invoke("LightlessChara_Meta", collectionId, [], manipulationData, 0);
+            logger.LogTrace("[{ApplicationId}] Setting temp meta mod for {CollectionId}, Success: {Result}", applicationId, collectionId, result);
+        }).ConfigureAwait(false);
+    }
+
+    protected override void HandleStateChange(IpcConnectionState previous, IpcConnectionState current)
+    {
+        if (current == IpcConnectionState.Available)
+        {
+            ScheduleCleanup();
+        }
+        else if (previous == IpcConnectionState.Available && current != IpcConnectionState.Available)
+        {
+            Interlocked.Exchange(ref _cleanupScheduled, 0);
+        }
+    }
+
+    private void ScheduleCleanup()
+    {
+        if (Interlocked.Exchange(ref _cleanupScheduled, 1) != 0)
+        {
+            return;
+        }
+
+        _ = Task.Run(CleanupTemporaryCollectionsAsync);
+    }
+
+    private async Task CleanupTemporaryCollectionsAsync()
+    {
+        if (!IsAvailable)
+        {
+            return;
+        }
+
+        try
+        {
+            var collections = await DalamudUtil.RunOnFrameworkThread(() => _getCollections.Invoke()).ConfigureAwait(false);
+            foreach (var (collectionId, name) in collections)
+            {
+                if (!IsLightlessCollectionName(name) || _activeTemporaryCollections.ContainsKey(collectionId))
+                {
+                    continue;
+                }
+
+                Logger.LogDebug("Cleaning up stale temporary collection {CollectionName} ({CollectionId})", name, collectionId);
+                var deleteResult = await DalamudUtil.RunOnFrameworkThread(() =>
+                {
+                    var result = (PenumbraApiEc)_removeTemporaryCollection.Invoke(collectionId);
+                    Logger.LogTrace("Cleanup RemoveTemporaryCollection result for {CollectionName} ({CollectionId}): {Result}", name, collectionId, result);
+                    return result;
+                }).ConfigureAwait(false);
+
+                if (deleteResult == PenumbraApiEc.Success)
+                {
+                    _activeTemporaryCollections.TryRemove(collectionId, out _);
+                }
+                else
+                {
+                    Logger.LogDebug("Skipped removing temporary collection {CollectionName} ({CollectionId}). Result: {Result}", name, collectionId, deleteResult);
+                }
+            }
+        }
+        catch (Exception ex)
+        {
+            Logger.LogWarning(ex, "Failed to clean up Penumbra temporary collections");
+        }
+    }
+
+    private static bool IsLightlessCollectionName(string? name)
+        => !string.IsNullOrEmpty(name) && name.StartsWith("Lightless_", StringComparison.Ordinal);
+}

LightlessSync/Interop/Ipc/Penumbra/PenumbraRedraw.cs

@@ -0,0 +1,89 @@
+using Dalamud.Plugin;
+using LightlessSync.Interop.Ipc.Framework;
+using LightlessSync.PlayerData.Handlers;
+using LightlessSync.Services;
+using LightlessSync.Services.Mediator;
+using Microsoft.Extensions.Logging;
+using Penumbra.Api.Enums;
+using Penumbra.Api.Helpers;
+using Penumbra.Api.IpcSubscribers;
+
+namespace LightlessSync.Interop.Ipc.Penumbra;
+
+public sealed class PenumbraRedraw : PenumbraBase
+{
+    private readonly RedrawManager _redrawManager;
+    private readonly RedrawObject _penumbraRedraw;
+    private readonly EventSubscriber<nint, int> _penumbraObjectIsRedrawn;
+
+    public PenumbraRedraw(
+        ILogger logger,
+        IDalamudPluginInterface pluginInterface,
+        DalamudUtilService dalamudUtil,
+        LightlessMediator mediator,
+        RedrawManager redrawManager) : base(logger, pluginInterface, dalamudUtil, mediator)
+    {
+        _redrawManager = redrawManager;
+
+        _penumbraRedraw = new RedrawObject(pluginInterface);
+        _penumbraObjectIsRedrawn = GameObjectRedrawn.Subscriber(pluginInterface, HandlePenumbraRedrawEvent);
+    }
+
+    public override string Name => "Penumbra.Redraw";
+
+    public void CancelPendingRedraws()
+        => _redrawManager.Cancel();
+
+    public void RequestImmediateRedraw(int objectIndex, RedrawType redrawType)
+    {
+        if (!IsAvailable)
+        {
+            return;
+        }
+
+        _penumbraRedraw.Invoke(objectIndex, redrawType);
+    }
+
+    public async Task RedrawAsync(ILogger logger, GameObjectHandler handler, Guid applicationId, CancellationToken token)
+    {
+        if (!IsAvailable || DalamudUtil.IsZoning)
+        {
+            return;
+        }
+
+        var redrawSemaphore = _redrawManager.RedrawSemaphore;
+        var semaphoreAcquired = false;
+
+        try
+        {
+            await redrawSemaphore.WaitAsync(token).ConfigureAwait(false);
+            semaphoreAcquired = true;
+
+            await _redrawManager.PenumbraRedrawInternalAsync(logger, handler, applicationId, chara =>
+            {
+                logger.LogDebug("[{ApplicationId}] Calling on IPC: PenumbraRedraw", applicationId);
+                _penumbraRedraw.Invoke(chara.ObjectIndex, RedrawType.Redraw);
+            }, token).ConfigureAwait(false);
+        }
+        finally
+        {
+            if (semaphoreAcquired)
+            {
+                redrawSemaphore.Release();
+            }
+        }
+    }
+
+    private void HandlePenumbraRedrawEvent(IntPtr objectAddress, int objectTableIndex)
+        => Mediator.Publish(new PenumbraRedrawMessage(objectAddress, objectTableIndex, false));
+
+    protected override void HandleStateChange(IpcConnectionState previous, IpcConnectionState current)
+    {
+    }
+
+    public override void Dispose()
+    {
+        base.Dispose();
+        _penumbraObjectIsRedrawn.Dispose();
+    }
+}

LightlessSync/Interop/Ipc/Penumbra/PenumbraResource.cs

@@ -0,0 +1,141 @@
+using System.Collections.Concurrent;
+using Dalamud.Plugin;
+using LightlessSync.Interop.Ipc.Framework;
+using LightlessSync.PlayerData.Handlers;
+using LightlessSync.Services;
+using LightlessSync.Services.ActorTracking;
+using LightlessSync.Services.Mediator;
+using Microsoft.Extensions.Logging;
+using Penumbra.Api.Helpers;
+using Penumbra.Api.IpcSubscribers;
+
+namespace LightlessSync.Interop.Ipc.Penumbra;
+
+public sealed class PenumbraResource : PenumbraBase
+{
+    private readonly ActorObjectService _actorObjectService;
+    private readonly GetGameObjectResourcePaths _gameObjectResourcePaths;
+    private readonly ResolvePlayerPathsAsync _resolvePlayerPaths;
+    private readonly GetPlayerMetaManipulations _getPlayerMetaManipulations;
+    private readonly EventSubscriber<nint, string, string> _gameObjectResourcePathResolved;
+    private readonly ConcurrentDictionary<IntPtr, byte> _trackedActors = new();
+
+    public PenumbraResource(
+        ILogger logger,
+        IDalamudPluginInterface pluginInterface,
+        DalamudUtilService dalamudUtil,
+        LightlessMediator mediator,
+        ActorObjectService actorObjectService) : base(logger, pluginInterface, dalamudUtil, mediator)
+    {
+        _actorObjectService = actorObjectService;
+        _gameObjectResourcePaths = new GetGameObjectResourcePaths(pluginInterface);
+        _resolvePlayerPaths = new ResolvePlayerPathsAsync(pluginInterface);
+        _getPlayerMetaManipulations = new GetPlayerMetaManipulations(pluginInterface);
+        _gameObjectResourcePathResolved = GameObjectResourcePathResolved.Subscriber(pluginInterface, HandleResourceLoaded);
+
+        foreach (var descriptor in _actorObjectService.PlayerDescriptors)
+        {
+            TrackActor(descriptor.Address);
+        }
+    }
+
+    public override string Name => "Penumbra.Resources";
+
+    public async Task<Dictionary<string, HashSet<string>>?> GetCharacterDataAsync(ILogger logger, GameObjectHandler handler)
+    {
+        if (!IsAvailable)
+        {
+            return null;
+        }
+
+        return await DalamudUtil.RunOnFrameworkThread(() =>
+        {
+            logger.LogTrace("Calling On IPC: Penumbra.GetGameObjectResourcePaths");
+            var idx = handler.GetGameObject()?.ObjectIndex;
+            if (idx == null)
+            {
+                return null;
+            }
+
+            return _gameObjectResourcePaths.Invoke(idx.Value)[0];
+        }).ConfigureAwait(false);
+    }
+
+    public string GetMetaManipulations()
+        => IsAvailable ? _getPlayerMetaManipulations.Invoke() : string.Empty;
+
+    public async Task<(string[] forward, string[][] reverse)> ResolvePathsAsync(string[] forwardPaths, string[] reversePaths)
+    {
+        if (!IsAvailable)
+        {
+            return (Array.Empty<string>(), Array.Empty<string[]>());
+        }
+
+        return await _resolvePlayerPaths.Invoke(forwardPaths, reversePaths).ConfigureAwait(false);
+    }
+
+    public void TrackActor(nint address)
+    {
+        if (address != nint.Zero)
+        {
+            _trackedActors[(IntPtr)address] = 0;
+        }
+    }
+
+    public void UntrackActor(nint address)
+    {
+        if (address != nint.Zero)
+        {
+            _trackedActors.TryRemove((IntPtr)address, out _);
+        }
+    }
+
+    private void HandleResourceLoaded(nint ptr, string resolvedPath, string gamePath)
+    {
+        if (ptr == nint.Zero)
+        {
+            return;
+        }
+
+        if (!_trackedActors.ContainsKey(ptr))
+        {
+            var descriptor = _actorObjectService.PlayerDescriptors.FirstOrDefault(d => d.Address == ptr);
+            if (descriptor.Address != nint.Zero)
+            {
+                _trackedActors[ptr] = 0;
+            }
+            else
+            {
+                return;
+            }
+        }
+
+        if (string.Compare(resolvedPath, gamePath, StringComparison.OrdinalIgnoreCase) == 0)
+        {
+            return;
+        }
+
+        Mediator.Publish(new PenumbraResourceLoadMessage(ptr, resolvedPath, gamePath));
+    }
+
+    protected override void HandleStateChange(IpcConnectionState previous, IpcConnectionState current)
+    {
+        if (current != IpcConnectionState.Available)
+        {
+            _trackedActors.Clear();
+        }
+        else
+        {
+            foreach (var descriptor in _actorObjectService.PlayerDescriptors)
+            {
+                TrackActor(descriptor.Address);
+            }
+        }
+    }
+
+    public override void Dispose()
+    {
+        base.Dispose();
+        _gameObjectResourcePathResolved.Dispose();
+    }
+}

LightlessSync/Interop/Ipc/Penumbra/PenumbraTexture.cs

@@ -0,0 +1,121 @@
+using Dalamud.Plugin;
+using LightlessSync.Interop.Ipc.Framework;
+using LightlessSync.Services;
+using LightlessSync.Services.Mediator;
+using Microsoft.Extensions.Logging;
+using Penumbra.Api.Enums;
+using Penumbra.Api.IpcSubscribers;
+
+namespace LightlessSync.Interop.Ipc.Penumbra;
+
+public sealed class PenumbraTexture : PenumbraBase
+{
+    private readonly PenumbraRedraw _redrawFeature;
+    private readonly ConvertTextureFile _convertTextureFile;
+
+    public PenumbraTexture(
+        ILogger logger,
+        IDalamudPluginInterface pluginInterface,
+        DalamudUtilService dalamudUtil,
+        LightlessMediator mediator,
+        PenumbraRedraw redrawFeature) : base(logger, pluginInterface, dalamudUtil, mediator)
+    {
+        _redrawFeature = redrawFeature;
+        _convertTextureFile = new ConvertTextureFile(pluginInterface);
+    }
+
+    public override string Name => "Penumbra.Textures";
+
+    public async Task ConvertTextureFilesAsync(ILogger logger, IReadOnlyList<TextureConversionJob> jobs, IProgress<TextureConversionProgress>? progress, CancellationToken token)
+    {
+        if (!IsAvailable || jobs.Count == 0)
+        {
+            return;
+        }
+
+        Mediator.Publish(new HaltScanMessage(nameof(ConvertTextureFilesAsync)));
+
+        var totalJobs = jobs.Count;
+        var completedJobs = 0;
+
+        try
+        {
+            foreach (var job in jobs)
+            {
+                if (token.IsCancellationRequested)
+                {
+                    break;
+                }
+
+                progress?.Report(new TextureConversionProgress(completedJobs, totalJobs, job));
+                await ConvertSingleJobAsync(logger, job, token).ConfigureAwait(false);
+                completedJobs++;
+            }
+        }
+        finally
+        {
+            Mediator.Publish(new ResumeScanMessage(nameof(ConvertTextureFilesAsync)));
+        }
+
+        if (completedJobs > 0 && !token.IsCancellationRequested)
+        {
+            await DalamudUtil.RunOnFrameworkThread(async () =>
+            {
+                var player = await DalamudUtil.GetPlayerPointerAsync().ConfigureAwait(false);
+                if (player == null)
+                {
+                    return;
+                }
+
+                var gameObject = await DalamudUtil.CreateGameObjectAsync(player).ConfigureAwait(false);
+                if (gameObject == null)
+                {
+                    return;
+                }
+
+                _redrawFeature.RequestImmediateRedraw(gameObject.ObjectIndex, RedrawType.Redraw);
+            }).ConfigureAwait(false);
+        }
+    }
+
+    public async Task ConvertTextureFileDirectAsync(TextureConversionJob job, CancellationToken token)
+    {
+        if (!IsAvailable)
+        {
+            return;
+        }
+
+        await ConvertSingleJobAsync(Logger, job, token).ConfigureAwait(false);
+    }
+
+    private async Task ConvertSingleJobAsync(ILogger logger, TextureConversionJob job, CancellationToken token)
+    {
+        token.ThrowIfCancellationRequested();
+
+        logger.LogInformation("Converting texture {Input} -> {Output} ({Target})", job.InputFile, job.OutputFile, job.TargetType);
+        var convertTask = _convertTextureFile.Invoke(job.InputFile, job.OutputFile, job.TargetType, job.IncludeMipMaps);
+        await convertTask.ConfigureAwait(false);
+
+        if (!convertTask.IsCompletedSuccessfully || job.DuplicateTargets is not { Count: > 0 })
+        {
+            return;
+        }
+
+        foreach (var duplicate in job.DuplicateTargets)
+        {
+            try
+            {
+                logger.LogInformation("Synchronizing duplicate {Duplicate}", duplicate);
+                File.Copy(job.OutputFile, duplicate, overwrite: true);
+            }
+            catch (Exception ex)
+            {
+                logger.LogError(ex, "Failed to copy duplicate {Duplicate}", duplicate);
+            }
+        }
+    }
+
+    protected override void HandleStateChange(IpcConnectionState previous, IpcConnectionState current)
+    {
+    }
+}