Add pause and cancel functionality

Iridium-IO · Iridium-IO · commit 33bd05da7792 · 2024-02-13T15:54:36.000+10:00
- Version bump to 3.1.0
diff --git a/CompactGUI.Core/Compactor.vb b/CompactGUI.Core/Compactor.vb
@@ -25,24 +25,61 @@ Public Class Compactor
     Private _EFInfo As _WOF_FILE_COMPRESSION_INFO_V1
     Private _EFInfoPtr As IntPtr
 
+    Private _pauseSemaphore As New SemaphoreSlim(1, 2)
 
 
+    Private _processedFileCount As New Concurrent.ConcurrentDictionary(Of String, Integer)
+
+    Private _cancellationTokenSource As New CancellationTokenSource
+
     Public Async Function RunCompactAsync(Optional progressMonitor As IProgress(Of (percentageProgress As Integer, currentFile As String)) = Nothing) As Task(Of Boolean)
 
         Dim FilesList = Await BuildWorkingFilesList()
         Dim totalFiles As Integer = FilesList.Count
-        Dim processedFileCount As Integer = 0
+
+        _processedFileCount.Clear()
 
         Await Parallel.ForEachAsync(FilesList,
-                                    Function(file, _ctx)
-                                        Dim res = WOFCompressFile(file)
-                                        Dim incremented = Interlocked.Increment(processedFileCount)
-                                        progressMonitor.Report((CInt(((incremented / totalFiles) * 100)), file))
-                                    End Function).ConfigureAwait(False)
+                                Function(file, _ctx) As ValueTask
+                                    Return New ValueTask(PauseAndProcessFile(file, _cancellationTokenSource.Token, totalFiles, progressMonitor))
+                                End Function).ConfigureAwait(False)
+
+        If _cancellationTokenSource.IsCancellationRequested Then Return False
 
         Return True
     End Function
 
+    Private Async Function PauseAndProcessFile(file As String, _ctx As CancellationToken, totalFiles As Integer, progressMonitor As IProgress(Of (percentageProgress As Integer, currentFile As String))) As Task
+
+        If _ctx.IsCancellationRequested Then Return
+        Try
+            Await _pauseSemaphore.WaitAsync(_ctx).ConfigureAwait(False)
+            _pauseSemaphore.Release()
+
+        Catch ex As OperationCanceledException
+            Return
+        End Try
+
+        If _ctx.IsCancellationRequested Then Return
+
+        Dim res = WOFCompressFile(file)
+        _processedFileCount.TryAdd(file, 1)
+        Dim incremented = _processedFileCount.Count
+        progressMonitor.Report((CInt(((incremented / totalFiles) * 100)), file))
+    End Function
+
+    Public Sub PauseCompression()
+        _pauseSemaphore.Wait()
+    End Sub
+
+    Public Sub ResumeCompression()
+        If _pauseSemaphore.CurrentCount = 0 Then _pauseSemaphore.Release()
+    End Sub
+
+    Public Sub Cancel()
+        ResumeCompression()
+        _cancellationTokenSource.Cancel()
+    End Sub
 
     Private Function WOFCompressFile(path As String)
 
diff --git a/CompactGUI.Core/Uncompactor.vb b/CompactGUI.Core/Uncompactor.vb
@@ -3,20 +3,42 @@ Imports System.Threading
 
 Public Class Uncompactor
 
+
+    Private _pauseSemaphore As New SemaphoreSlim(1, 2)
+    Private _processedFileCount As New Concurrent.ConcurrentDictionary(Of String, Integer)
+    Private _cancellationTokenSource As New CancellationTokenSource
+
+
     Public Async Function UncompactFiles(filesList As List(Of String), Optional progressMonitor As IProgress(Of (percentageProgress As Integer, currentFile As String)) = Nothing) As Task(Of Boolean)
 
         Dim totalFiles As Integer = filesList.Count
-        Dim processedFiles As Integer = 0
 
+        _processedFileCount.Clear()
         Await Parallel.ForEachAsync(filesList,
-                                    Function(file, _ctx)
-                                        Dim res = WOFDecompressFile(file)
-                                        Dim incremented = Interlocked.Increment(processedFiles)
-                                        progressMonitor.Report((CInt(((incremented / totalFiles) * 100)), file))
-                                    End Function).ConfigureAwait(False)
+                                   Function(file, _ctx) As ValueTask
+                                       Return New ValueTask(PauseAndProcessFile(file, _cancellationTokenSource.Token, totalFiles, progressMonitor))
+                                   End Function).ConfigureAwait(False)
         Return True
     End Function
 
+    Private Async Function PauseAndProcessFile(file As String, _ctx As CancellationToken, totalFiles As Integer, progressMonitor As IProgress(Of (percentageProgress As Integer, currentFile As String))) As Task
+        If _ctx.IsCancellationRequested Then Return
+
+        Try
+            Await _pauseSemaphore.WaitAsync(_ctx).ConfigureAwait(False)
+            _pauseSemaphore.Release()
+
+        Catch ex As OperationCanceledException
+            Return
+        End Try
+
+        If _ctx.IsCancellationRequested Then Return
+        Dim res = WOFDecompressFile(file)
+        _processedFileCount.TryAdd(file, 1)
+        Dim incremented = _processedFileCount.Count
+        progressMonitor.Report((CInt(((incremented / totalFiles) * 100)), file))
+    End Function
+
     Private Function WOFDecompressFile(path As String)
 
         Try
@@ -32,4 +54,17 @@ Public Class Uncompactor
 
     End Function
 
+
+    Public Sub PauseCompression()
+        _pauseSemaphore.Wait()
+    End Sub
+
+    Public Sub ResumeCompression()
+        If _pauseSemaphore.CurrentCount = 0 Then _pauseSemaphore.Release()
+    End Sub
+    Public Sub Cancel()
+        ResumeCompression()
+        _cancellationTokenSource.Cancel()
+    End Sub
+
 End Class
diff --git a/CompactGUI/Models/UpdateHandler.vb b/CompactGUI/Models/UpdateHandler.vb
@@ -2,7 +2,7 @@
 Imports System.Text.Json
 Public Class UpdateHandler
 
-    Public Shared CurrentVersion As New SemVersion(3, 0, 4)
+    Public Shared CurrentVersion As New SemVersion(3, 1, 0)
     Public Shared NewVersion As SemVersion
     Shared UpdateURL As String = "https://raw.githubusercontent.com/IridiumIO/CompactGUI/database/version.json"
 
diff --git a/CompactGUI/ViewModels/MainViewModel.vb b/CompactGUI/ViewModels/MainViewModel.vb
@@ -146,9 +146,14 @@ Public Class MainViewModel : Inherits ObservableObject
     End Sub
 
 
+    Private Property CoreCompactor As Core.Compactor
+    Private Property CoreUncompactor As Core.Uncompactor
+
     Private Async Sub CompressBegin()
 
         State = "CurrentlyCompressing"
+        PauseResumeStatus = "Pause"
+        CancelStatus = "Cancel"
         Watcher.IsActive = True
         CProgress.Report((0, ""))
 
@@ -161,10 +166,11 @@ Public Class MainViewModel : Inherits ObservableObject
         End If
 
 
-        Dim cm As New Core.Compactor(ActiveFolder.FolderName, Core.WOFConvertCompressionLevel(ActiveFolder.SelectedCompressionMode), exclist)
-        Dim res = Await cm.RunCompactAsync(CProgress)
+        CoreCompactor = New Core.Compactor(ActiveFolder.FolderName, Core.WOFConvertCompressionLevel(ActiveFolder.SelectedCompressionMode), exclist)
+        Dim res = Await CoreCompactor.RunCompactAsync(CProgress)
 
-        ActiveFolder.IsFreshlyCompressed = True
+        ActiveFolder.IsFreshlyCompressed = False
+        If res Then ActiveFolder.IsFreshlyCompressed = True
 
         BindableSettings.SelectedCompressionMode = ActiveFolder.SelectedCompressionMode
         BindableSettings.Save()
@@ -176,11 +182,14 @@ Public Class MainViewModel : Inherits ObservableObject
 
     Private Async Sub UncompressBegin()
         State = "CurrentlyCompressing"
+        PauseResumeStatus = "Pause"
+        CancelStatus = "Cancel"
+
         CProgress.Report((0, ""))
 
         Dim compressedFilesList = ActiveFolder.AnalysisResults.Where(Function(rs) rs.CompressedSize < rs.UncompressedSize).Select(Of String)(Function(f) f.FileName).ToList
-        Dim ucm As New Core.Uncompactor
-        Dim res = Await ucm.UncompactFiles(compressedFilesList, CProgress)
+        CoreUncompactor = New Core.Uncompactor
+        Dim res = Await CoreUncompactor.UncompactFiles(compressedFilesList, CProgress)
 
         ActiveFolder.IsFreshlyCompressed = False
         AnalyseBegin()
@@ -283,6 +292,8 @@ Public Class MainViewModel : Inherits ObservableObject
         End Get
     End Property
     Public ReadOnly Property Version As String = UpdateHandler.CurrentVersion.Friendly
+    Public Property PauseResumeStatus As String = "Pause"
+    Public Property CancelStatus As String = "Cancel"
 
 #End Region
 
@@ -297,7 +308,26 @@ Public Class MainViewModel : Inherits ObservableObject
     Public Property RemoveWatcherCommand As ICommand = New RelayCommand(Of Watcher.WatchedFolder)(Sub(f) Watcher.RemoveWatched(f))
     Public Property ReCompressWatchedCommand As ICommand = New RelayCommand(Of Watcher.WatchedFolder)(Sub(f) SelectFolder(f.Folder))
     Property RefreshWatchedCommand As ICommand = New RelayCommand(Sub() Task.Run(Function() Watcher.ParseWatchers(True)))
-
+    Public Property PauseCompressionCommand As RelayCommand = New RelayCommand(Sub()
+
+                                                                                   If PauseResumeStatus = "Pause" Then
+                                                                                       PauseResumeStatus = "Pausing..."
+                                                                                       If CoreCompactor IsNot Nothing Then CoreCompactor.PauseCompression()
+                                                                                       If CoreUncompactor IsNot Nothing Then CoreUncompactor.PauseCompression()
+                                                                                       PauseResumeStatus = "Resume"
+                                                                                   Else
+                                                                                       If CoreCompactor IsNot Nothing Then CoreCompactor.ResumeCompression()
+                                                                                       If CoreUncompactor IsNot Nothing Then CoreUncompactor.ResumeCompression()
+                                                                                       PauseResumeStatus = "Pause"
+                                                                                   End If
+
+                                                                               End Sub)
+
+    Public Property CancelCompressionCommand As RelayCommand = New RelayCommand(Sub()
+                                                                                    CancelStatus = "Cancelling..."
+                                                                                    If CoreCompactor IsNot Nothing Then CoreCompactor.Cancel()
+                                                                                    If CoreUncompactor IsNot Nothing Then CoreUncompactor.Cancel()
+                                                                                End Sub)
 
 #End Region
 
diff --git a/CompactGUI/Views/MainWindow.xaml b/CompactGUI/Views/MainWindow.xaml
@@ -1004,8 +1004,29 @@
 
                 <TextBlock x:Name="uiCurrentFileCompress" d:Text="/test/folder/gamefile.bin" Text="{Binding WorkingProgress.Item2, Mode=OneWay}" Margin="0,187,0,0" Foreground="#73808C" Opacity="0.4" FontSize="20" TextAlignment="Center" TextTrimming="CharacterEllipsis"/>
 
+        <StackPanel Orientation="Horizontal"
+                    Margin="0,240,0,0"
+                    VerticalAlignment="Top" HorizontalAlignment="Center">
+          <Button x:Name="btnPause"
+                  Content="{Binding PauseResumeStatus}"
+                  Background="#806B8399"
+                  Width="138"
+                  Height="48" Margin="20,0"
+                  Foreground="White"
+                  Style="{StaticResource RoundedButton}"
+                  Command="{Binding PauseCompressionCommand}" />
+          <Button x:Name="btnCancel"
+                  Content="{Binding CancelStatus, Mode=OneWay}"
+                  Background="#806B8399"
+                  Width="138"
+                  Margin="20,0"
+                  Height="48"
+                  Foreground="White"
+                  Style="{StaticResource RoundedButton}"
+                  Command="{Binding CancelCompressionCommand}" />
+        </StackPanel>
 
-            </Grid>
+      </Grid>
 
 
         </Grid>
