Merge remote-tracking branch 'origin/master' into luna

# Conflicts:
#	Penumbra.GameData

OtterGui

@@ -1 +1 @@
-Subproject commit 9af1e5fce4c13ef98842807d4f593dec8ae80c87
+Subproject commit a63f6735cf4bed4f7502a022a10378607082b770

Penumbra.Api

@@ -1 +1 @@
-Subproject commit 97fe622e4ec0a5469a26aba8a8c3933fa8ef7fd6
+Subproject commit c23ee05c1e9fa103eaa52e6aa7e855ef568ee669

Penumbra/Configuration.cs

@@ -51,6 +51,7 @@ public class Configuration : IPluginConfiguration, ISavable, IService
 
     public string ModDirectory    { get; set; } = string.Empty;
     public string ExportDirectory { get; set; } = string.Empty;
+    public string WatchDirectory  { get; set; } = string.Empty;
 
     public bool? UseCrashHandler                { get; set; } = null;
     public bool  OpenWindowAtStart              { get; set; } = false;
@@ -74,6 +75,8 @@ public class Configuration : IPluginConfiguration, ISavable, IService
     public bool            HideRedrawBar                        { get; set; } = false;
     public bool            HideMachinistOffhandFromChangedItems { get; set; } = true;
     public bool            DefaultTemporaryMode                 { get; set; } = false;
+    public bool            EnableDirectoryWatch                 { get; set; } = false;
+    public bool            EnableAutomaticModImport             { get; set; } = false;
     public bool            EnableCustomShapes                   { get; set; } = true;
     public PcpSettings     PcpSettings = new();
     public RenameField     ShowRename                { get; set; } = RenameField.BothDataPrio;

Penumbra/Interop/PathResolving/CutsceneService.cs

@@ -73,6 +73,7 @@ public sealed class CutsceneService : Luna.IRequiredService, IDisposable
             return false;
 
         _copiedCharacters[copyIdx - CutsceneStartIdx] = (short)parentIdx;
+        _objects.InvokeRequiredUpdates();
         return true;
     }
 

Penumbra/Services/FileWatcher.cs

@@ -0,0 +1,209 @@
+using OtterGui.Services;
+using Penumbra.Mods.Manager;
+
+namespace Penumbra.Services;
+
+public class FileWatcher : IDisposable, IService
+{
+    // TODO: use ConcurrentSet when it supports comparers in Luna.
+    private readonly ConcurrentDictionary<string, byte> _pending = new(StringComparer.OrdinalIgnoreCase);
+    private readonly ModImportManager                   _modImportManager;
+    private readonly MessageService                     _messageService;
+    private readonly Configuration                      _config;
+
+    private bool                     _pausedConsumer;
+    private FileSystemWatcher?       _fsw;
+    private CancellationTokenSource? _cts = new();
+    private Task?                    _consumer;
+
+    public FileWatcher(ModImportManager modImportManager, MessageService messageService, Configuration config)
+    {
+        _modImportManager = modImportManager;
+        _messageService   = messageService;
+        _config           = config;
+
+        if (_config.EnableDirectoryWatch)
+        {
+            SetupFileWatcher(_config.WatchDirectory);
+            SetupConsumerTask();
+        }
+    }
+
+    public void Toggle(bool value)
+    {
+        if (_config.EnableDirectoryWatch == value)
+            return;
+
+        _config.EnableDirectoryWatch = value;
+        _config.Save();
+        if (value)
+        {
+            SetupFileWatcher(_config.WatchDirectory);
+            SetupConsumerTask();
+        }
+        else
+        {
+            EndFileWatcher();
+            EndConsumerTask();
+        }
+    }
+
+    internal void PauseConsumer(bool pause)
+        => _pausedConsumer = pause;
+
+    private void EndFileWatcher()
+    {
+        if (_fsw is null)
+            return;
+
+        _fsw.Dispose();
+        _fsw = null;
+    }
+
+    private void SetupFileWatcher(string directory)
+    {
+        EndFileWatcher();
+        _fsw = new FileSystemWatcher
+        {
+            IncludeSubdirectories = false,
+            NotifyFilter          = NotifyFilters.FileName | NotifyFilters.CreationTime,
+            InternalBufferSize    = 32 * 1024,
+        };
+
+        // Only wake us for the exact patterns we care about
+        _fsw.Filters.Add("*.pmp");
+        _fsw.Filters.Add("*.pcp");
+        _fsw.Filters.Add("*.ttmp");
+        _fsw.Filters.Add("*.ttmp2");
+
+        _fsw.Created += OnPath;
+        _fsw.Renamed += OnPath;
+        UpdateDirectory(directory);
+    }
+
+
+    private void EndConsumerTask()
+    {
+        if (_cts is not null)
+        {
+            _cts.Cancel();
+            _cts = null;
+        }
+        _consumer = null;
+    }
+
+    private void SetupConsumerTask()
+    {
+        EndConsumerTask();
+        _cts = new CancellationTokenSource();
+        _consumer = Task.Factory.StartNew(
+            () => ConsumerLoopAsync(_cts.Token),
+            _cts.Token, TaskCreationOptions.LongRunning, TaskScheduler.Default).Unwrap();
+    }
+
+    public void UpdateDirectory(string newPath)
+    {
+        if (_config.WatchDirectory != newPath)
+        {
+            _config.WatchDirectory = newPath;
+            _config.Save();
+        }
+
+        if (_fsw is null)
+            return;
+
+        _fsw.EnableRaisingEvents = false;
+        if (!Directory.Exists(newPath) || newPath.Length is 0)
+        {
+            _fsw.Path = string.Empty;
+        }
+        else
+        {
+            _fsw.Path                = newPath;
+            _fsw.EnableRaisingEvents = true;
+        }
+    }
+
+    private void OnPath(object? sender, FileSystemEventArgs e)
+        => _pending.TryAdd(e.FullPath, 0);
+
+    private async Task ConsumerLoopAsync(CancellationToken token)
+    {
+        while (true)
+        {
+            var (path, _) = _pending.FirstOrDefault();
+            if (path is null || _pausedConsumer)
+            {
+                await Task.Delay(500, token).ConfigureAwait(false);
+                continue;
+            }
+
+            try
+            {
+                await ProcessOneAsync(path, token).ConfigureAwait(false);
+            }
+            catch (OperationCanceledException)
+            {
+                Penumbra.Log.Debug("[FileWatcher] Canceled via Token.");
+            }
+            catch (Exception ex)
+            {
+                Penumbra.Log.Warning($"[FileWatcher] Error during Processing: {ex}");
+            }
+            finally
+            {
+                _pending.TryRemove(path, out _);
+            }
+        }
+    }
+
+    private async Task ProcessOneAsync(string path, CancellationToken token)
+    {
+        // Downloads often finish via rename; file may be locked briefly.
+        // Wait until it exists and is readable; also require two stable size checks.
+        const int maxTries = 40;
+        long      lastLen  = -1;
+
+        for (var i = 0; i < maxTries && !token.IsCancellationRequested; i++)
+        {
+            if (!File.Exists(path))
+            {
+                await Task.Delay(100, token);
+                continue;
+            }
+
+            try
+            {
+                var fi  = new FileInfo(path);
+                var len = fi.Length;
+                if (len > 0 && len == lastLen)
+                {
+                    if (_config.EnableAutomaticModImport)
+                        _modImportManager.AddUnpack(path);
+                    else
+                        _messageService.AddMessage(new InstallNotification(_modImportManager, path), false);
+                    return;
+                }
+
+                lastLen = len;
+            }
+            catch (IOException)
+            {
+                Penumbra.Log.Debug($"[FileWatcher] File is still being written to.");
+            }
+            catch (UnauthorizedAccessException)
+            {
+                Penumbra.Log.Debug($"[FileWatcher] File is locked.");
+            }
+
+            await Task.Delay(150, token);
+        }
+    }
+
+
+    public void Dispose()
+    {
+        EndConsumerTask();
+        EndFileWatcher();
+    }
+}

Penumbra/Services/InstallNotification.cs

@@ -0,0 +1,39 @@
+using Dalamud.Bindings.ImGui;
+using Dalamud.Interface.ImGuiNotification;
+using Dalamud.Interface.ImGuiNotification.EventArgs;
+using OtterGui.Text;
+using Penumbra.Mods.Manager;
+
+namespace Penumbra.Services;
+
+public class InstallNotification(ModImportManager modImportManager, string filePath) : OtterGui.Classes.MessageService.IMessage
+{
+    public string Message
+        => "A new mod has been found!";
+
+    public NotificationType NotificationType
+        => NotificationType.Info;
+
+    public uint NotificationDuration
+        => uint.MaxValue;
+
+    public string NotificationTitle { get; } = Path.GetFileNameWithoutExtension(filePath);
+
+    public string LogMessage
+        => $"A new mod has been found: {Path.GetFileName(filePath)}";
+
+    public void OnNotificationActions(INotificationDrawArgs args)
+    {
+        var region     = ImGui.GetContentRegionAvail();
+        var buttonSize = new Vector2((region.X - ImGui.GetStyle().ItemSpacing.X) / 2, 0);
+        if (ImUtf8.ButtonEx("Install"u8, ""u8, buttonSize))
+        {
+            modImportManager.AddUnpack(filePath);
+            args.Notification.DismissNow();
+        }
+
+        ImGui.SameLine();
+        if (ImUtf8.ButtonEx("Ignore"u8, ""u8, buttonSize))
+            args.Notification.DismissNow();
+    }
+}

Penumbra/UI/Tabs/SettingsTab.cs

@@ -36,6 +36,7 @@ public class SettingsTab : ITab, IUiService
     private readonly Penumbra                    _penumbra;
     private readonly FileDialogService           _fileDialog;
     private readonly ModManager                  _modManager;
+    private readonly FileWatcher                 _fileWatcher;
     private readonly ModExportManager            _modExportManager;
     private readonly ModFileSystemSelector       _selector;
     private readonly CharacterUtility            _characterUtility;
@@ -64,7 +65,8 @@ public class SettingsTab : ITab, IUiService
 
     public SettingsTab(IDalamudPluginInterface pluginInterface, Configuration config, FontReloader fontReloader, TutorialService tutorial,
         Penumbra penumbra, FileDialogService fileDialog, ModManager modManager, ModFileSystemSelector selector,
-        CharacterUtility characterUtility, ResidentResourceManager residentResources, ModExportManager modExportManager, HttpApi httpApi,
+        CharacterUtility characterUtility, ResidentResourceManager residentResources, ModExportManager modExportManager,
+        FileWatcher fileWatcher, HttpApi httpApi,
         DalamudSubstitutionProvider dalamudSubstitutionProvider, FileCompactor compactor, DalamudConfigService dalamudConfig,
         IDataManager gameData, PredefinedTagManager predefinedTagConfig, CrashHandlerService crashService,
         MigrationSectionDrawer migrationDrawer, CollectionAutoSelector autoSelector, CleanupService cleanupService,
@@ -81,6 +83,7 @@ public class SettingsTab : ITab, IUiService
         _characterUtility            = characterUtility;
         _residentResources           = residentResources;
         _modExportManager            = modExportManager;
+        _fileWatcher                 = fileWatcher;
         _httpApi                     = httpApi;
         _dalamudSubstitutionProvider = dalamudSubstitutionProvider;
         _compactor                   = compactor;
@@ -722,6 +725,13 @@ public class SettingsTab : ITab, IUiService
         DrawPcpFolder();
         DrawPcpExtension();
         DrawDefaultModExportPath();
+        Checkbox("Enable Directory Watcher",
+            "Enables a File Watcher that automatically listens for Mod files that enter a specified directory, causing Penumbra to open a popup to import these mods.",
+            _config.EnableDirectoryWatch, _fileWatcher.Toggle);
+        Checkbox("Enable Fully Automatic Import",
+            "Uses the File Watcher in order to skip the query popup and automatically import any new mods.",
+            _config.EnableAutomaticModImport, v => _config.EnableAutomaticModImport = v);
+        DrawFileWatcherPath();
     }
 
 
@@ -801,6 +811,46 @@ public class SettingsTab : ITab, IUiService
           + "Keep this empty to use the root directory.");
     }
 
+    private string? _tempWatchDirectory;
+
+    /// <summary> Draw input for the Automatic Mod import path. </summary>
+    private void DrawFileWatcherPath()
+    {
+        var       tmp     = _tempWatchDirectory ?? _config.WatchDirectory;
+        var       spacing = new Vector2(UiHelpers.ScaleX3);
+        using var style   = ImRaii.PushStyle(ImGuiStyleVar.ItemSpacing, spacing);
+        ImGui.SetNextItemWidth(UiHelpers.InputTextMinusButton3);
+        if (ImGui.InputText("##fileWatchPath", ref tmp, 256))
+            _tempWatchDirectory = tmp;
+
+        if (ImGui.IsItemDeactivated() && _tempWatchDirectory is not null)
+        {
+            if (ImGui.IsItemDeactivatedAfterEdit())
+                _fileWatcher.UpdateDirectory(_tempWatchDirectory);
+            _tempWatchDirectory = null;
+        }
+
+        ImGui.SameLine();
+        if (ImGuiUtil.DrawDisabledButton($"{FontAwesomeIcon.Folder.ToIconString()}##fileWatch", UiHelpers.IconButtonSize,
+                "Select a directory via dialog.", false, true))
+        {
+            var startDir = _config.WatchDirectory.Length > 0 && Directory.Exists(_config.WatchDirectory)
+                ? _config.WatchDirectory
+                : Directory.Exists(_config.ModDirectory)
+                    ? _config.ModDirectory
+                    : null;
+            _fileDialog.OpenFolderPicker("Choose Automatic Import Directory", (b, s) =>
+            {
+                if (b)
+                    _fileWatcher.UpdateDirectory(s);
+            }, startDir, false);
+        }
+
+        style.Pop();
+        ImGuiUtil.LabeledHelpMarker("Automatic Import Director",
+            "Choose the Directory the File Watcher listens to.");
+    }
+
     /// <summary> Draw input for the default name to input as author into newly generated mods. </summary>
     private void DrawDefaultModAuthor()
     {

repo.json

@@ -6,7 +6,7 @@
     "Description": "Runtime mod loader and manager.",
     "InternalName": "Penumbra",
     "AssemblyVersion": "1.5.1.6",
-    "TestingAssemblyVersion": "1.5.1.6",
+    "TestingAssemblyVersion": "1.5.1.7",
     "RepoUrl": "https://github.com/xivdev/Penumbra",
     "ApplicableVersion": "any",
     "DalamudApiLevel": 13,
@@ -19,7 +19,7 @@
     "LoadRequiredState": 2,
     "LoadSync": true,
     "DownloadLinkInstall": "https://github.com/xivdev/Penumbra/releases/download/1.5.1.6/Penumbra.zip",
-    "DownloadLinkTesting": "https://github.com/xivdev/Penumbra/releases/download/1.5.1.6/Penumbra.zip",
+    "DownloadLinkTesting": "https://github.com/xivdev/Penumbra/releases/download/testing_1.5.1.7/Penumbra.zip",
     "DownloadLinkUpdate": "https://github.com/xivdev/Penumbra/releases/download/1.5.1.6/Penumbra.zip",
     "IconUrl": "https://raw.githubusercontent.com/xivdev/Penumbra/master/images/icon.png"
   }