DiscFileSystem.RawStream implementation

LTRData · LTRData · commit 094ff8155bd3 · 2025-06-09T23:12:51.000+02:00
diff --git a/Library/DiscUtils.Btrfs/Context.cs b/Library/DiscUtils.Btrfs/Context.cs
@@ -42,7 +42,7 @@ public Context(BtrfsFileSystemOptions options)
 
     public BtrfsFileSystemOptions Options { get; private set; }
 
-    public Stream RawStream { get; set; }
+    public override Stream RawStream { get; set; }
 
     public SuperBlock SuperBlock { get; set; }
 
diff --git a/Library/DiscUtils.Core/DiscFileSystem.cs b/Library/DiscUtils.Core/DiscFileSystem.cs
@@ -76,6 +76,12 @@ protected DiscFileSystem(DiscFileSystemOptions defaultOptions)
     /// <returns>true if the file system is read-write.</returns>
     public abstract bool CanWrite { get; }
 
+    /// <summary>
+    /// Gets underlying raw volume stream, if available.
+    /// </summary>
+    /// <returns>Underlying raw volume stream, or null if not available.</returns>
+    public abstract Stream RawStream { get; }
+
     private DiscDirectoryInfo _root;
 
     /// <summary>
diff --git a/Library/DiscUtils.Core/FileSystemParameters.cs b/Library/DiscUtils.Core/FileSystemParameters.cs
@@ -20,6 +20,7 @@
 // DEALINGS IN THE SOFTWARE.
 //
 
+using System.Collections.Specialized;
 using System.Text;
 
 namespace DiscUtils;
@@ -45,4 +46,9 @@ public sealed class FileSystemParameters
     /// time (local time where the file system is authored) to UTC time.  This parameter determines
     /// the algorithm to use.</remarks>
     public TimeConverter TimeConverter { get; set; }
+
+    /// <summary>
+    /// Other string parameters for file systems.
+    /// </summary>
+    public StringDictionary Parameters { get; } = new();
 }
diff --git a/Library/DiscUtils.Core/NativeFileSystem.cs b/Library/DiscUtils.Core/NativeFileSystem.cs
@@ -39,6 +39,8 @@ public class NativeFileSystem : DiscFileSystem
 {
     private readonly bool _readOnly;
 
+    public override Stream RawStream { get; }
+
     /// <summary>
     /// Initializes a new instance of the NativeFileSystem class.
     /// </summary>
diff --git a/Library/DiscUtils.Core/Vfs/VfsContext.cs b/Library/DiscUtils.Core/Vfs/VfsContext.cs
@@ -20,9 +20,14 @@
 // DEALINGS IN THE SOFTWARE.
 //
 
+using System.IO;
+
 namespace DiscUtils.Vfs;
 
 /// <summary>
 /// Base class for a context object that holds global state for file system implementations.
 /// </summary>
-public abstract class VfsContext {}
+public abstract class VfsContext
+{
+    public abstract Stream RawStream { get; set; }
+}
diff --git a/Library/DiscUtils.Core/Vfs/VfsFileSystem.cs b/Library/DiscUtils.Core/Vfs/VfsFileSystem.cs
@@ -20,13 +20,14 @@
 // DEALINGS IN THE SOFTWARE.
 //
 
+using DiscUtils.Internal;
+using DiscUtils.Streams;
 using System;
 using System.Collections.Generic;
 using System.Diagnostics;
+using System.Drawing;
 using System.IO;
 using System.Linq;
-using DiscUtils.Internal;
-using DiscUtils.Streams;
 
 namespace DiscUtils.Vfs;
 
@@ -72,6 +73,8 @@ protected VfsFileSystem(DiscFileSystemOptions defaultOptions)
     /// </summary>
     public abstract override string VolumeLabel { get; }
 
+    public override Stream RawStream => Context.RawStream;
+
     /// <summary>
     /// Copies a file - not supported on read-only file systems.
     /// </summary>
diff --git a/Library/DiscUtils.Core/Vfs/VfsFileSystemFacade.cs b/Library/DiscUtils.Core/Vfs/VfsFileSystemFacade.cs
@@ -20,10 +20,10 @@
 // DEALINGS IN THE SOFTWARE.
 //
 
+using DiscUtils.Streams;
 using System;
 using System.Collections.Generic;
 using System.IO;
-using DiscUtils.Streams;
 
 namespace DiscUtils.Vfs;
 
@@ -38,6 +38,8 @@ public abstract class VfsFileSystemFacade : DiscFileSystem
 {
     private readonly DiscFileSystem _wrapped;
 
+    public override Stream RawStream => _wrapped.RawStream;
+
     /// <summary>
     /// Initializes a new instance of the VfsFileSystemFacade class.
     /// </summary>
diff --git a/Library/DiscUtils.Ext/Context.cs b/Library/DiscUtils.Ext/Context.cs
@@ -29,7 +29,7 @@ internal class Context : VfsContext
 {
     public ExtFileSystemOptions Options { get; set; }
 
-    public Stream RawStream { get; set; }
+    public override Stream RawStream { get; set; }
 
     public SuperBlock SuperBlock { get; set; }
 
diff --git a/Library/DiscUtils.Fat/FatFileSystem.cs b/Library/DiscUtils.Fat/FatFileSystem.cs
@@ -164,6 +164,8 @@ public FatFileSystem(Stream data, Ownership ownsData, FileSystemParameters param
         _ownsData = ownsData;
     }
 
+    public override Stream RawStream => _data;
+
     /// <summary>
     /// Gets the active FAT (zero-based index).
     /// </summary>
diff --git a/Library/DiscUtils.HfsPlus/Context.cs b/Library/DiscUtils.HfsPlus/Context.cs
@@ -34,5 +34,6 @@ internal sealed class Context : VfsContext
     public BTree<ExtentKey> ExtentsOverflow { get; set; }
 
     public VolumeHeader VolumeHeader { get; set; }
-    public Stream VolumeStream { get; set; }
+
+    public override Stream RawStream { get; set; }
 }
diff --git a/Library/DiscUtils.HfsPlus/FileBuffer.cs b/Library/DiscUtils.HfsPlus/FileBuffer.cs
@@ -103,7 +103,7 @@ public override int Read(long pos, byte[] buffer, int offset, int count)
                 break;
             }
 
-            var volStream = _context.VolumeStream;
+            var volStream = _context.RawStream;
             volStream.Position = extentStreamStart + extentOffset;
             var numRead = volStream.Read(buffer, offset + totalRead, toRead);
 
@@ -135,7 +135,7 @@ public override async ValueTask<int> ReadAsync(long pos, Memory<byte> buffer, Ca
                 break;
             }
 
-            var volStream = _context.VolumeStream;
+            var volStream = _context.RawStream;
             volStream.Position = extentStreamStart + extentOffset;
             var numRead = await volStream.ReadAsync(buffer.Slice(totalRead, toRead), cancellationToken).ConfigureAwait(false);
 
@@ -167,7 +167,7 @@ public override int Read(long pos, Span<byte> buffer)
                 break;
             }
 
-            var volStream = _context.VolumeStream;
+            var volStream = _context.RawStream;
             volStream.Position = extentStreamStart + extentOffset;
             var numRead = volStream.Read(buffer.Slice(totalRead, toRead));
 
diff --git a/Library/DiscUtils.HfsPlus/HfsPlusFileSystemImpl.cs b/Library/DiscUtils.HfsPlus/HfsPlusFileSystemImpl.cs
@@ -46,7 +46,7 @@ public HfsPlusFileSystemImpl(Stream s)
 
         Context = new Context
         {
-            VolumeStream = s,
+            RawStream = s,
             VolumeHeader = hdr
         };
 
diff --git a/Library/DiscUtils.Iso9660/File.cs b/Library/DiscUtils.Iso9660/File.cs
@@ -110,7 +110,7 @@ public IBuffer FileContent
             if (_dirEntry.RecordExtents is [var extent])
             {
                 return new StreamBuffer(
-                    new ExtentStream(_context.DataStream, extent.LocationOfExtent, extent.DataLength, extent.FileUnitSize, extent.InterleaveGapSize),
+                    new ExtentStream(_context.RawStream, extent.LocationOfExtent, extent.DataLength, extent.FileUnitSize, extent.InterleaveGapSize),
                     Ownership.Dispose
                 );
             }
@@ -120,7 +120,7 @@ public IBuffer FileContent
                     Ownership.Dispose,
                     _dirEntry.RecordExtents.Select(
                         e => SparseStream.FromStream(
-                            new ExtentStream(_context.DataStream, e.LocationOfExtent, e.DataLength, e.FileUnitSize, e.InterleaveGapSize),
+                            new ExtentStream(_context.RawStream, e.LocationOfExtent, e.DataLength, e.FileUnitSize, e.InterleaveGapSize),
                             Ownership.Dispose
                         )
                     )
diff --git a/Library/DiscUtils.Iso9660/IsoContext.cs b/Library/DiscUtils.Iso9660/IsoContext.cs
@@ -28,7 +28,7 @@ namespace DiscUtils.Iso9660;
 
 internal class IsoContext : VfsContext
 {
-    public Stream DataStream { get; set; }
+    public override Stream RawStream { get; set; }
 
     public string RockRidgeIdentifier { get; set; }
 
diff --git a/Library/DiscUtils.Iso9660/ReaderDirEntry.cs b/Library/DiscUtils.Iso9660/ReaderDirEntry.cs
@@ -72,12 +72,12 @@ public ReaderDirEntry(IsoContext context, DirectoryRecord dirRecord)
             var clEntry = SuspRecords.GetEntry<ChildLinkSystemUseEntry>(_context.RockRidgeIdentifier, "CL");
             if (clEntry != null)
             {
-                _context.DataStream.Position = clEntry.ChildDirLocation * _context.VolumeDescriptor.LogicalBlockSize;
+                _context.RawStream.Position = clEntry.ChildDirLocation * _context.VolumeDescriptor.LogicalBlockSize;
 
                 var firstSector = ArrayPool<byte>.Shared.Rent(_context.VolumeDescriptor.LogicalBlockSize);
                 try
                 {
-                    _context.DataStream.ReadExactly(firstSector, 0, _context.VolumeDescriptor.LogicalBlockSize);
+                    _context.RawStream.ReadExactly(firstSector, 0, _context.VolumeDescriptor.LogicalBlockSize);
 
                     DirectoryRecord.ReadFrom(firstSector, _context.VolumeDescriptor.CharacterEncoding, out dirRecord);
                     if (dirRecord.SystemUseData != null)
diff --git a/Library/DiscUtils.Iso9660/ReaderDirectory.cs b/Library/DiscUtils.Iso9660/ReaderDirectory.cs
@@ -47,7 +47,7 @@ public ReaderDirectory(IsoContext context, ReaderDirEntry dirEntry)
             }
 
             Array.Clear(buffer, 0, buffer.Length);
-            Stream extent = new ExtentStream(_context.DataStream, dirExtent.LocationOfExtent, uint.MaxValue, 0, 0);
+            Stream extent = new ExtentStream(_context.RawStream, dirExtent.LocationOfExtent, uint.MaxValue, 0, 0);
 
             _records = new(StringComparer.OrdinalIgnoreCase, entry => entry.FileName);
 
diff --git a/Library/DiscUtils.Iso9660/Susp/SuspRecords.cs b/Library/DiscUtils.Iso9660/Susp/SuspRecords.cs
@@ -37,10 +37,10 @@ public SuspRecords(IsoContext context, ReadOnlySpan<byte> data)
         var contEntry = Parse(context, data.Slice(context.SuspSkipBytes));
         while (contEntry != null)
         {
-            context.DataStream.Position = contEntry.Block * (long)context.VolumeDescriptor.LogicalBlockSize +
+            context.RawStream.Position = contEntry.Block * (long)context.VolumeDescriptor.LogicalBlockSize +
                                           contEntry.BlockOffset;
             
-            var contData = context.DataStream.ReadExactly((int)contEntry.Length);
+            var contData = context.RawStream.ReadExactly((int)contEntry.Length);
 
             contEntry = Parse(context, contData);
         }
diff --git a/Library/DiscUtils.Iso9660/VfsCDReader.cs b/Library/DiscUtils.Iso9660/VfsCDReader.cs
@@ -144,7 +144,7 @@ public VfsCDReader(Stream data, Iso9660Variant[] variantPriorities, bool hideVer
                         data.ReadExactly(buffer, 0, IsoUtilities.SectorSize);
                         var volDesc = new SupplementaryVolumeDescriptor(buffer);
 
-                        Context = new IsoContext { VolumeDescriptor = volDesc, DataStream = _data };
+                        Context = new IsoContext { VolumeDescriptor = volDesc, RawStream = _data };
                         RootDirectory = new ReaderDirectory(Context,
                             new ReaderDirEntry(Context, volDesc.RootDirectory));
                         ActiveVariant = Iso9660Variant.Joliet;
@@ -160,7 +160,7 @@ public VfsCDReader(Stream data, Iso9660Variant[] variantPriorities, bool hideVer
                         data.ReadExactly(buffer, 0, IsoUtilities.SectorSize);
                         var volDesc = new PrimaryVolumeDescriptor(buffer);
 
-                        var context = new IsoContext { VolumeDescriptor = volDesc, DataStream = _data };
+                        var context = new IsoContext { VolumeDescriptor = volDesc, RawStream = _data };
                         var rootSelfRecord = ReadRootSelfRecord(context);
 
                         InitializeSusp(context, rootSelfRecord);
@@ -619,13 +619,13 @@ private static void InitializeSusp(IsoContext context, DirectoryRecord rootSelfR
 
     private static DirectoryRecord ReadRootSelfRecord(IsoContext context)
     {
-        context.DataStream.Position = context.VolumeDescriptor.RootDirectory.LocationOfExtent *
+        context.RawStream.Position = context.VolumeDescriptor.RootDirectory.LocationOfExtent *
                                       context.VolumeDescriptor.LogicalBlockSize;
         
         var firstSector = ArrayPool<byte>.Shared.Rent(context.VolumeDescriptor.LogicalBlockSize);
         try
         {
-            context.DataStream.ReadExactly(firstSector, 0, context.VolumeDescriptor.LogicalBlockSize);
+            context.RawStream.ReadExactly(firstSector, 0, context.VolumeDescriptor.LogicalBlockSize);
 
             DirectoryRecord.ReadFrom(firstSector, context.VolumeDescriptor.CharacterEncoding, out var rootSelfRecord);
             return rootSelfRecord;
diff --git a/Library/DiscUtils.Nfs/NfsFileSystem.cs b/Library/DiscUtils.Nfs/NfsFileSystem.cs
@@ -65,6 +65,8 @@ public NfsFileSystem(string address, RpcCredentials credentials, string mountPoi
         _client = new Nfs3Client(address, credentials, mountPoint);
     }
 
+    public override Stream RawStream => null;
+
     /// <summary>
     /// Gets whether this file system supports modification (true for NFS).
     /// </summary>
diff --git a/Library/DiscUtils.Ntfs/NtfsFileSystem.cs b/Library/DiscUtils.Ntfs/NtfsFileSystem.cs
@@ -37,10 +37,11 @@
 using DiscUtils.Ntfs.Internals;
 
 namespace DiscUtils.Ntfs;
+
 /// <summary>
 /// Class for accessing NTFS file systems.
 /// </summary>
-public sealed class NtfsFileSystem : DiscFileSystem, IClusterBasedFileSystem,
+public class NtfsFileSystem : DiscFileSystem, IClusterBasedFileSystem,
     IFileSystemWithClusterMap, IWindowsFileSystem, IDiagnosticTraceable
 {
     private const FileAttributes NonSettableFileAttributes =
@@ -55,6 +56,8 @@ public sealed class NtfsFileSystem : DiscFileSystem, IClusterBasedFileSystem,
     
     public VolumeInformation VolumeInfo { get; }
 
+    public override Stream RawStream => _context.RawStream;
+
     /// <summary>
     /// Initializes a new instance of the NtfsFileSystem class.
     /// </summary>
diff --git a/Library/DiscUtils.SquashFs/Context.cs b/Library/DiscUtils.SquashFs/Context.cs
@@ -33,7 +33,7 @@ internal class Context : VfsContext
 
     public MetablockReader InodeReader { get; set; }
 
-    public Stream RawStream { get; set; }
+    public override Stream RawStream { get; set; }
 
     public ReadBlock ReadBlock { get; set; }
 
diff --git a/Library/DiscUtils.Swap/SwapContext.cs b/Library/DiscUtils.Swap/SwapContext.cs
@@ -21,10 +21,13 @@
 //
 
 using DiscUtils.Vfs;
+using System.IO;
 
 namespace DiscUtils.Swap;
 
-public class SwapContext:VfsContext
+public class SwapContext : VfsContext
 {
+    public override Stream RawStream { get; set; }
+
     public SwapHeader Header { get; set; }
 }
diff --git a/Library/DiscUtils.Swap/SwapFileSystem.cs b/Library/DiscUtils.Swap/SwapFileSystem.cs
@@ -38,10 +38,11 @@ public sealed class SwapFileSystem : VfsReadOnlyFileSystem<VfsDirEntry, IVfsFile
     /// Initializes a new instance of the SwapFileSystem class.
     /// </summary>
     /// <param name="stream">The stream containing the file system.</param>
-    public SwapFileSystem(Stream stream):base(new DiscFileSystemOptions())
+    public SwapFileSystem(Stream stream) : base(new DiscFileSystemOptions())
     {
         Context = new SwapContext
         {
+            RawStream = stream,
             Header = ReadSwapHeader(stream)
         };
         if (Context.Header == null)
diff --git a/Library/DiscUtils.Udf/UdfContext.cs b/Library/DiscUtils.Udf/UdfContext.cs
@@ -20,13 +20,33 @@
 // DEALINGS IN THE SOFTWARE.
 //
 
-using System.Collections.Generic;
+using DiscUtils.Streams;
 using DiscUtils.Vfs;
+using System;
+using System.Collections.Generic;
+using System.IO;
+using System.Linq;
 
 namespace DiscUtils.Udf;
 
 internal class UdfContext : VfsContext
 {
+    public override Stream RawStream
+    {
+        get
+        {
+            if (LogicalPartitions.FirstOrDefault()?.Content is { } content)
+            {
+                return new BufferStream(content, FileAccess.Read);
+            }
+
+            return null;
+        }
+        set
+        {
+            throw new NotSupportedException();
+        }
+    }
     public List<LogicalPartition> LogicalPartitions;
     public Dictionary<ushort, PhysicalPartition> PhysicalPartitions;
     public int PhysicalSectorSize;
diff --git a/Library/DiscUtils.VirtualFileSystem/VirtualFileSystem.cs b/Library/DiscUtils.VirtualFileSystem/VirtualFileSystem.cs
@@ -75,6 +75,8 @@ public VirtualFileSystem(VirtualFileSystemOptions options)
 
     public event EventHandler<CreateFileEventArgs> CreateFile;
 
+    public override Stream RawStream => null;
+
     public new VirtualFileSystemOptions Options => (VirtualFileSystemOptions)base.Options;
 
     public override bool CanWrite => Options.CanWrite;
diff --git a/Library/DiscUtils.Wim/WimFile.cs b/Library/DiscUtils.Wim/WimFile.cs
diff --git a/Library/DiscUtils.Wim/WimFileSystem.cs b/Library/DiscUtils.Wim/WimFileSystem.cs
diff --git a/Library/DiscUtils.Xfs/Context.cs b/Library/DiscUtils.Xfs/Context.cs
diff --git a/Tests/LibraryTests/DiskBuilderFileSystem.cs b/Tests/LibraryTests/DiskBuilderFileSystem.cs
diff --git a/Tests/LibraryTests/InMemoryFileSystem.cs b/Tests/LibraryTests/InMemoryFileSystem.cs
diff --git a/Utilities/DiscUtils.Diagnostics/ValidatingFileSystem.cs b/Utilities/DiscUtils.Diagnostics/ValidatingFileSystem.cs
diff --git a/Utilities/ExternalFileSystem/Program.cs b/Utilities/ExternalFileSystem/Program.cs

Original file line number	Diff line number	Diff line change
`@@ -39,6 +39,8 @@ public class NativeFileSystem : DiscFileSystem`
`39`	`39`	`{`
`40`	`40`	`private readonly bool _readOnly;`
`41`	`41`
	`42`	`+ public override Stream RawStream { get; }`
	`43`	`+`
`42`	`44`	`/// <summary>`
`43`	`45`	`/// Initializes a new instance of the NativeFileSystem class.`
`44`	`46`	`/// </summary>`
Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@ internal class Context : VfsContext`
`29`	`29`	`{`
`30`	`30`	`public ExtFileSystemOptions Options { get; set; }`
`31`	`31`
`32`		`- public Stream RawStream { get; set; }`
	`32`	`+ public override Stream RawStream { get; set; }`
`33`	`33`
`34`	`34`	`public SuperBlock SuperBlock { get; set; }`
`35`	`35`
Original file line number	Diff line number	Diff line change
`@@ -164,6 +164,8 @@ public FatFileSystem(Stream data, Ownership ownsData, FileSystemParameters param`
`164`	`164`	`_ownsData = ownsData;`
`165`	`165`	`}`
`166`	`166`
	`167`	`+ public override Stream RawStream => _data;`
	`168`	`+`
`167`	`169`	`/// <summary>`
`168`	`170`	`/// Gets the active FAT (zero-based index).`
`169`	`171`	`/// </summary>`
Original file line number	Diff line number	Diff line change
`@@ -34,5 +34,6 @@ internal sealed class Context : VfsContext`
`34`	`34`	`public BTree<ExtentKey> ExtentsOverflow { get; set; }`
`35`	`35`
`36`	`36`	`public VolumeHeader VolumeHeader { get; set; }`
`37`		`- public Stream VolumeStream { get; set; }`
	`37`	`+`
	`38`	`+ public override Stream RawStream { get; set; }`
`38`	`39`	`}`