Merge pull request #14 from samba2/feature/refactor_file_watcher

Feature/refactor file watcher

Author: d2phap

Source/Demo/Form1.Designer.cs

@@ -16,7 +16,7 @@ public Form1()
 
         private void BtnStart_Click(object sender, EventArgs e)
         {
-            _fw = new FileSystemWatcherEx(txtPath.Text.Trim());
+            _fw = new FileSystemWatcherEx(txtPath.Text.Trim(), FW_OnLog);
 
             _fw.OnRenamed += FW_OnRenamed;
             _fw.OnCreated += FW_OnCreated;
@@ -26,7 +26,7 @@ private void BtnStart_Click(object sender, EventArgs e)
 
             _fw.SynchronizingObject = this;
             _fw.IncludeSubdirectories = true;
-            
+
             _fw.Start();
 
             btnStart.Enabled = false;
@@ -76,7 +76,10 @@ private void FW_OnRenamed(object? sender, FileChangedEvent e)
                 e.FullPath) + "\r\n";
         }
 
-
+        private void FW_OnLog(string value)
+        {
+            txtConsole.Text += $@"[log] {value}" + "\r\n";
+        }
 
         private void BtnStop_Click(object sender, EventArgs e)
         {
@@ -105,7 +108,6 @@ private void BtnSelectFolder_Click(object sender, EventArgs e)
 
         private void Form1_FormClosing(object sender, FormClosingEventArgs e)
         {
-            _fw.Stop();
             _fw.Dispose();
         }
     }

Source/Demo/Form1.cs

@@ -0,0 +1,9 @@
+Manual Testing
+--------------
+
+This little application is helpful for interactive testing of the library. 
+
+Symlinks
+--------
+To create a symlink directory on Windows, use `mklink`.
+Example: `mklink /D my-symbolic-link c:\temp\target-directory`

Source/Demo/README.md

@@ -17,9 +17,9 @@ public class FileSystemWatcherEx : IDisposable, IFileSystemWatcherEx
     private EventProcessor? _processor;
     private readonly BlockingCollection<FileChangedEvent> _fileEventQueue = new();
 
-    private FileWatcher? _watcher;
-    private IFileSystemWatcherWrapper? _fsw;
+    private SymlinkAwareFileWatcher? _watcher;
     private Func<IFileSystemWatcherWrapper>? _fswFactory;
+    private readonly Action<string> _logger;
 
     // Define the cancellation token.
     private CancellationTokenSource? _cancelSource;
@@ -86,6 +86,7 @@ public string Filter
 
     #endregion
 
+
     #region Public Events
 
     /// <summary>
@@ -134,11 +135,13 @@ public string Filter
     /// Initialize new instance of <see cref="FileSystemWatcherEx"/>
     /// </summary>
     /// <param name="folderPath"></param>
-    public FileSystemWatcherEx(string folderPath = "")
+    /// <param name="logger">Optional Action to log out library internals</param>
+    public FileSystemWatcherEx(string folderPath = "", Action<string>? logger = null)
     {
         FolderPath = folderPath;
+        _logger = logger ?? (_ => {}) ;
     }
-
+    
 
     /// <summary>
     /// Start watching files
@@ -233,10 +236,10 @@ void InvokeRenamedEvent(object? sender, FileChangedEvent fileEvent)
             }
         }, (log) =>
         {
-            Console.WriteLine(string.Format("{0} | {1}", Enum.GetName(typeof(ChangeType), ChangeType.LOG), log));
+            Console.WriteLine($"{Enum.GetName(typeof(ChangeType), ChangeType.LOG)} | {log}");
         });
 
-        _cancelSource = new();
+        _cancelSource = new CancellationTokenSource();
         _thread = new Thread(() => Thread_DoingWork(_cancelSource.Token))
         {
             // this ensures the thread does not block the process from terminating!
@@ -247,40 +250,32 @@ void InvokeRenamedEvent(object? sender, FileChangedEvent fileEvent)
 
 
         // Log each event in our special format to output queue
-        void onEvent(FileChangedEvent e)
+        void OnEvent(FileChangedEvent e)
         {
             _fileEventQueue.Add(e);
         }
 
 
-        // OnError
-        void onError(ErrorEventArgs e)
+        void OnError(ErrorEventArgs e)
         {
             if (e != null)
             {
-                OnError?.Invoke(this, e);
+                this.OnError?.Invoke(this, e);
             }
         }
 
-
-        // Start watcher
-        _watcher = new FileWatcher();
-
-        _fsw = _watcher.Create(FolderPath, onEvent, onError, FileSystemWatcherFactory);
-
-        foreach (var filter in Filters)
+        _watcher = new SymlinkAwareFileWatcher(FolderPath, OnEvent, OnError, FileSystemWatcherFactory, _logger)
         {
-            _fsw.Filters.Add(filter);
-        }
-
-        _fsw.NotifyFilter = NotifyFilter;
-        _fsw.IncludeSubdirectories = IncludeSubdirectories;
-        _fsw.SynchronizingObject = SynchronizingObject;
-
-        // Start watching
-        _fsw.EnableRaisingEvents = true;
+            NotifyFilter = NotifyFilter,
+            IncludeSubdirectories = IncludeSubdirectories,
+            SynchronizingObject = SynchronizingObject,
+            EnableRaisingEvents = true
+        };
+        Filters.ToList().ForEach(filter => _watcher.Filters.Add(filter));
+        _watcher.Init();
     }
 
+
     internal void StartForTesting(
         Func<string, FileAttributes> getFileAttributesFunc, 
         Func<string, DirectoryInfo[]> getDirectoryInfosFunc)
@@ -297,12 +292,6 @@ internal void StartForTesting(
     /// </summary>
     public void Stop()
     {
-        if (_fsw != null)
-        {
-            _fsw.EnableRaisingEvents = false;
-            _fsw.Dispose();
-        }
-
         _watcher?.Dispose();
 
         // stop the thread
@@ -316,14 +305,12 @@ public void Stop()
     /// </summary>
     public void Dispose()
     {
-        _fsw?.Dispose();
         _watcher?.Dispose();
         _cancelSource?.Dispose();
         GC.SuppressFinalize(this);
     }
 
 
-
     private void Thread_DoingWork(CancellationToken cancelToken)
     {
         while (true)
@@ -342,6 +329,5 @@ private void Thread_DoingWork(CancellationToken cancelToken)
             }
         }
     }
-
-
 }
+