Refactor file handling to use SafeFileHandle in Compactor and Uncompactor, and separate NtfsInterop module

Author: Iridium-IO

CompactGUI.Core/Compactor.vb

@@ -2,6 +2,8 @@
 Imports System.Runtime.InteropServices
 Imports System.Threading
 
+Imports Microsoft.Win32.SafeHandles
+
 
 Public Class Compactor : Implements IDisposable, ICompressor
 
@@ -103,8 +105,8 @@ Public Class Compactor : Implements IDisposable, ICompressor
     Private Function WOFCompressFile(path As String) As Integer
 
         Try
-            Using fs As New FileStream(path, FileMode.Open)
-                Return WofSetFileDataLocation(fs.SafeFileHandle.DangerousGetHandle(), WOF_PROVIDER_FILE, compressionInfoPtr, compressionInfoSize)
+            Using fs As SafeFileHandle = File.OpenHandle(path)
+                Return WofSetFileDataLocation(fs, WOF_PROVIDER_FILE, compressionInfoPtr, compressionInfoSize)
             End Using
         Catch ex As Exception
             Debug.WriteLine(ex.Message)

CompactGUI.Core/Estimator.vb

@@ -200,7 +200,7 @@ Public Class Estimator
         Dim bytesReturned As Integer = 0
 
         Try
-            Dim result = NtfsInterop.DeviceIoControl(
+            Dim result = WOFHelper.DeviceIoControl(
                 handle,
                 NtfsInterop.FSCTL_GET_RETRIEVAL_POINTERS,
                 inBufferPtr,
@@ -211,6 +211,8 @@ Public Class Estimator
                 IntPtr.Zero
             )
 
+
+
             'Probably errors because the file is empty
             If Not result Then Return Long.MaxValue
 
@@ -228,56 +230,3 @@ Public Class Estimator
     End Function
 
 End Class
-
-Friend Module NtfsInterop
-    Public Const FSCTL_GET_RETRIEVAL_POINTERS As UInteger = &H90073
-    Public Const OPEN_EXISTING As Integer = 3
-    Public Const FILE_FLAG_BACKUP_SEMANTICS As Integer = &H2000000
-    Public Const FILE_SHARE_READ As Integer = 1
-    Public Const FILE_SHARE_WRITE As Integer = 2
-    Public Const GENERIC_READ As Integer = &H80000000
-
-    <DllImport("kernel32.dll", SetLastError:=True, CharSet:=CharSet.Unicode)>
-    Public Function CreateFile(
-        lpFileName As String,
-        dwDesiredAccess As Integer,
-        dwShareMode As Integer,
-        lpSecurityAttributes As IntPtr,
-        dwCreationDisposition As Integer,
-        dwFlagsAndAttributes As Integer,
-        hTemplateFile As IntPtr
-    ) As SafeFileHandle
-    End Function
-
-    <DllImport("kernel32.dll", SetLastError:=True)>
-    Public Function DeviceIoControl(
-        hDevice As SafeFileHandle,
-        dwIoControlCode As UInteger,
-        lpInBuffer As IntPtr,
-        nInBufferSize As Integer,
-        lpOutBuffer As IntPtr,
-        nOutBufferSize As Integer,
-        ByRef lpBytesReturned As Integer,
-        lpOverlapped As IntPtr
-    ) As Boolean
-    End Function
-
-
-    <StructLayout(LayoutKind.Sequential)>
-    Public Structure STARTING_VCN_INPUT_BUFFER
-        Public StartingVcn As Long
-    End Structure
-
-    <StructLayout(LayoutKind.Sequential)>
-    Public Structure RETRIEVAL_POINTERS_BUFFER
-        Public ExtentCount As Integer
-        Public StartingVcn As Long
-        Public Extents As LCN_EXTENT ' This is actually an array, but we only need the first
-    End Structure
-
-    <StructLayout(LayoutKind.Sequential)>
-    Public Structure LCN_EXTENT
-        Public NextVcn As Long
-        Public Lcn As Long
-    End Structure
-End Module

CompactGUI.Core/NtfsInterop.vb

@@ -0,0 +1,42 @@
+Imports System.Runtime.InteropServices
+
+Imports Microsoft.Win32.SafeHandles
+
+Friend Module NtfsInterop
+    Public Const FSCTL_GET_RETRIEVAL_POINTERS As UInteger = &H90073
+    Public Const OPEN_EXISTING As Integer = 3
+    Public Const FILE_FLAG_BACKUP_SEMANTICS As Integer = &H2000000
+    Public Const FILE_SHARE_READ As Integer = 1
+    Public Const FILE_SHARE_WRITE As Integer = 2
+    Public Const GENERIC_READ As Integer = &H80000000
+
+    <DllImport("kernel32.dll", SetLastError:=True, CharSet:=CharSet.Unicode)>
+    Public Function CreateFile(
+        lpFileName As String,
+        dwDesiredAccess As Integer,
+        dwShareMode As Integer,
+        lpSecurityAttributes As IntPtr,
+        dwCreationDisposition As Integer,
+        dwFlagsAndAttributes As Integer,
+        hTemplateFile As IntPtr
+    ) As SafeFileHandle
+    End Function
+
+    <StructLayout(LayoutKind.Sequential)>
+    Public Structure STARTING_VCN_INPUT_BUFFER
+        Public StartingVcn As Long
+    End Structure
+
+    <StructLayout(LayoutKind.Sequential)>
+    Public Structure RETRIEVAL_POINTERS_BUFFER
+        Public ExtentCount As Integer
+        Public StartingVcn As Long
+        Public Extents As LCN_EXTENT ' This is actually an array, but we only need the first. ?Perhaps I should get the LCN of the middle cluster in future?
+    End Structure
+
+    <StructLayout(LayoutKind.Sequential)>
+    Public Structure LCN_EXTENT
+        Public NextVcn As Long
+        Public Lcn As Long
+    End Structure
+End Module

CompactGUI.Core/Uncompactor.vb

@@ -1,6 +1,8 @@
 Imports System.IO
 Imports System.Threading
 
+Imports Microsoft.Win32.SafeHandles
+
 Public Class Uncompactor : Implements ICompressor, IDisposable
 
 
@@ -52,9 +54,8 @@ Public Class Uncompactor : Implements ICompressor, IDisposable
     Private Function WOFDecompressFile(path As String)
 
         Try
-            Using fs As FileStream = New FileStream(path, FileMode.Open)
-                Dim hDevice = fs.SafeFileHandle.DangerousGetHandle
-                Dim res = WOFHelper.DeviceIoControl(hDevice, FSCTL_DELETE_EXTERNAL_BACKING, IntPtr.Zero, 0, IntPtr.Zero, 0, IntPtr.Zero, IntPtr.Zero)
+            Using fs As SafeFileHandle = File.OpenHandle(path)
+                Dim res = WOFHelper.DeviceIoControl(fs, FSCTL_DELETE_EXTERNAL_BACKING, IntPtr.Zero, 0, IntPtr.Zero, 0, IntPtr.Zero, IntPtr.Zero)
                 Return res
             End Using
         Catch ex As Exception

CompactGUI.Core/WOFHelper.vb

@@ -1,5 +1,7 @@
 Imports System.Runtime.InteropServices
 
+Imports Microsoft.Win32.SafeHandles
+
 Public Module WOFHelper
 
     Public Const WOF_PROVIDER_FILE As ULong = 2
@@ -40,6 +42,7 @@ Public Module WOFHelper
 
     End Function
 
+    <StructLayout(LayoutKind.Sequential)>
     Public Structure WOF_FILE_COMPRESSION_INFO_V1
         Public Algorithm As UInteger
         Public Flags As UInteger
@@ -57,7 +60,7 @@ Public Module WOFHelper
 
     <DllImport("WofUtil.dll")>
     Friend Function WofSetFileDataLocation(
-        FileHandle As IntPtr,
+        FileHandle As SafeFileHandle,
         Provider As ULong,
         ExternalFileInfo As IntPtr,
         Length As ULong) As Integer
@@ -66,14 +69,14 @@ Public Module WOFHelper
     'Most of these should be optional if MS Docs are to be believed -.-
     <DllImport("kernel32.dll")>
     Friend Function DeviceIoControl(
-        hDevice As IntPtr,
+        hDevice As SafeFileHandle,
         dwIoControlCode As UInteger,
         lpInBuffer As IntPtr,
         nInBufferSize As UInteger,
         lpOutBuffer As IntPtr,
         nOutBufferSize As UInteger,
-        <Out> lpBytesReturned As IntPtr,
-        <Out> lpOverlapped As IntPtr) As Integer
+        <Out> ByRef lpBytesReturned As IntPtr,
+        <Out> lpOverlapped As IntPtr) As Boolean
 
     End Function