Skip to content

FastZip.CreateZip crashes when used with certain buggy Directory enumeration on .NET 5 #676

Open
@lscorcia

Description

@lscorcia

Not really a bug, more like a feature suggestion.

Steps to reproduce

  1. In .net 5, directory enumeration has bugs with WebDav (.Net Core Directory.GetFiles() operates webDav path dotnet/runtime#46723 (comment)), not fixed in .net 6 and with no other immediate official solution in sight;
  2. This causes crashes when calling FastZip.CreateZip as the GetDirectories/GetFiles return invalid data;
  3. A workaround is available - use something like this on the GetDirectories-returned data:
public static string[] FixupNet5Enumeration(string[] items)
{
    return items
        .Select(t => t.TrimEnd('\0'))
        .Where(t => {
            var itemName = Path.GetFileName(t);
            return itemName != "." && itemName != "..";
        })
        .ToArray();
}
  1. SharpZipLib nicely wraps the Directory.GetDirectories call into the FileSystemScanner class. However it is not possible to supply custom FileSystemScanners to FastZip.CreateZip. It would be helpful in this case as I could just copy that class and insert the required fixup calls. It would be necessary to create an interface around FileSystemScanner and to change to public the method

private void CreateZip(Stream outputStream, string sourceDirectory, bool recurse, FileSystemScanner scanner, bool leaveOpen)

What do you think?

Expected behavior

FastZip.CreateZip should offer an override to specify custom FileSystemScanners.

Actual behavior

FastZip.CreateZip throws exception as the paths returned by Directory.GetDirectories are not valid paths.

Version of SharpZipLib

1.3.3

Obtained from (only keep the relevant lines)

  • Package installed using NuGet

Activity

piksel

piksel commented on Oct 22, 2021

@piksel
Member

In general it seems like a good idea to make it possible to extend SharpZipLib as much as possible for the consumers own purposes, so making the FileSystemScanner customizable seems like a good idea.

The only concern I have is encouraging the use of FastZip in the first place. The reason for that, is that the decisions about what is acceptable behaviour is done inside the library, with no information of what the actual use case is. This doesn't apply as much to CreateZip as it does to extracting though...

changed the title [-]FastZip.CreateZip - how to deal with buggy Directory enumeration on .net 5[/-] [+]FastZip.CreateZip crashes when used with certain buggy Directory enumeration on .NET 5[/+] on Oct 22, 2021
added
enhancementFeature request or other improvements of existing functionality
zipRelated to ZIP file format
on Oct 22, 2021
linked a pull request that will close this issue on Oct 22, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementFeature request or other improvements of existing functionalityzipRelated to ZIP file format

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Development

      Participants

      @piksel@lscorcia

      Issue actions

        FastZip.CreateZip crashes when used with certain buggy Directory enumeration on .NET 5 · Issue #676 · icsharpcode/SharpZipLib