Windows support and other various changes

.gitattributes

@@ -1 +1 @@
-Sources/Minizip/* linguist-vendored 
+Sources/CMinizip/* linguist-vendored 

.github/CODEOWNERS

@@ -0,0 +1 @@
+* @fpseverino

.github/workflows/test.yml

@@ -11,3 +11,43 @@ jobs:
     uses: vapor/ci/.github/workflows/run-unit-tests.yml@main
     secrets:
       CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+
+  windows-unit:
+    if: ${{ !(github.event.pull_request.draft || false) }}
+    strategy:
+      fail-fast: false
+      matrix:
+        swift-version:
+          - 5.8
+          - 5.9
+          - 5.10
+        include:
+          - { swift-version: 5.8, swift-branch: swift-5.8.1-release, swift-tag: 5.8.1-RELEASE }
+          - { swift-version: 5.9, swift-branch: swift-5.9.2-release, swift-tag: 5.9.2-RELEASE }
+          - { swift-version: 5.10, swift-branch: swift-5.10.1-release, swift-tag: 5.10.1-RELEASE }
+    runs-on: windows-latest
+    timeout-minutes: 60
+    steps:
+      - name: Install Windows Swift toolchain
+        uses: compnerd/gha-setup-swift@main
+        with:
+          branch: ${{ matrix.swift-branch }}
+          tag: ${{ matrix.swift-tag }}
+      - name: Download zlib
+        run: |
+          curl -L -o zlib.zip https://www.zlib.net/zlib131.zip
+          mkdir zlib-131
+          tar -xf zlib.zip -C zlib-131 --strip-components=1
+      - name: Build and install zlib
+        run: |
+          cd zlib-131
+          mkdir build
+          cd build
+          cmake ..
+          cmake --build . --config Release
+          cmake --install . --prefix ../install
+      - name: Check out code
+        uses: actions/checkout@v4
+      - name: Run unit tests
+        run: |
+          swift test -Xcc -I'C:/Program Files (x86)/zlib/include' -Xlinker -L'C:/Program Files (x86)/zlib/lib'

Package.swift

@@ -1,5 +1,6 @@
 // swift-tools-version:5.8
 import PackageDescription
+import Foundation
 
 let package = Package(
     name: "Zip",
@@ -8,23 +9,21 @@ let package = Package(
     ],
     targets: [
         .target(
-            name: "Minizip",
-            exclude: ["module"],
-            swiftSettings: [
-                .enableUpcomingFeature("ConciseMagicFile"),
+            name: "CMinizip",
+            cSettings: [
+                .define("_CRT_SECURE_NO_WARNINGS", .when(platforms: [.windows])),
             ],
-            linkerSettings: [
-                .linkedLibrary("z")
-            ]
+            swiftSettings: swiftSettings
         ),
         .target(
             name: "Zip",
             dependencies: [
-                .target(name: "Minizip"),
+                .target(name: "CMinizip"),
             ],
-            swiftSettings: [
-                .enableUpcomingFeature("ConciseMagicFile"),
-            ]
+            cSettings: [
+                .define("_CRT_SECURE_NO_WARNINGS", .when(platforms: [.windows])),
+            ],
+            swiftSettings: swiftSettings
         ),
         .testTarget(
             name: "ZipTests",
@@ -34,9 +33,26 @@ let package = Package(
             resources: [
                 .copy("Resources"),
             ],
-            swiftSettings: [
-                .enableUpcomingFeature("ConciseMagicFile"),
-            ]
+            swiftSettings: swiftSettings
         ),
     ]
 )
+
+var swiftSettings: [SwiftSetting] { [
+    .enableUpcomingFeature("ExistentialAny"),
+    .enableUpcomingFeature("ConciseMagicFile"),
+    .enableUpcomingFeature("ForwardTrailingClosures"),
+] }
+
+if let target = package.targets.filter({ $0.name == "CMinizip" }).first {
+#if os(Windows)
+    if ProcessInfo.processInfo.environment["ZIP_USE_DYNAMIC_ZLIB"] == nil {
+        target.cSettings?.append(contentsOf: [.define("ZLIB_STATIC")])
+        target.linkerSettings = [.linkedLibrary("zlibstatic")]
+    } else {
+        target.linkerSettings = [.linkedLibrary("zlib")]
+    }
+#else
+    target.linkerSettings = [.linkedLibrary("z")]
+#endif
+}

README.md

@@ -17,18 +17,26 @@
 </div>
 <br>
 
-A framework for zipping and unzipping files in Swift.
+📂 A framework for zipping and unzipping files in Swift.
 
 Simple and quick to use.
 Built on top of [Minizip 1.2](https://github.com/zlib-ng/minizip-ng/tree/1.2).
 
+## Overview
+
+### Getting Started
+
 Use the SPM string to easily include the dependendency in your `Package.swift` file.
 
 ```swift
 .package(url: "https://github.com/vapor-community/Zip.git", from: "2.2.0")
 ```
 
-## Usage
+and add it to your target's dependencies:
+
+```swift
+.product(name: "Zip", package: "zip")
+```
 
 ### Quick Functions
 
@@ -56,7 +64,7 @@ import Zip
 do {
   let filePath = Bundle.main.url(forResource: "file", withExtension: "zip")!
   let documentsDirectory = FileManager.default.urls(for: .documentDirectory, in: .userDomainMask)[0]
-  try Zip.unzipFile(filePath, destination: documentsDirectory, overwrite: true, password: "password") { progress in
+  try Zip.unzipFile(filePath, destination: documentsDirectory, password: "password") { progress in
     print(progress)
   }
 

Sources/CMinizip/include/CMinizip.h

@@ -0,0 +1,17 @@
+//
+//  CMinizip.h
+//  Zip
+//
+//  Created by Florian Friedrich on 3/27/19.
+//  Copyright © 2019 Roy Marmelstein. All rights reserved.
+//
+
+#ifndef CMinizip_h
+#define CMinizip_h
+
+#include "ioapi.h"
+#include "crypt.h"
+#include "unzip.h"
+#include "zip.h"
+
+#endif /* CMinizip_h */

Sources/CMinizip/include/module.modulemap

@@ -0,0 +1,4 @@
+module CMinizip [system][extern_c] {
+    header "CMinizip.h"
+    export *
+}

Sources/Zip/ArchiveFile.swift

@@ -1,5 +1,5 @@
 import Foundation
-@_implementationOnly import Minizip
+@_implementationOnly import CMinizip
 
 /// Defines data saved in memory that will be archived as a file.
 public struct ArchiveFile {
@@ -55,8 +55,6 @@ extension Zip {
         compression: ZipCompression = .DefaultCompression,
         progress: ((_ progress: Double) -> ())? = nil
     ) throws {
-        let destinationPath = zipFilePath.path
-
         // Progress handler set up
         var currentPosition: Int = 0
         var totalSize: Int = 0
@@ -71,7 +69,7 @@ extension Zip {
         progressTracker.kind = ProgressKind.file
 
         // Begin Zipping
-        let zip = zipOpen(destinationPath, APPEND_STATUS_CREATE)
+        let zip = zipOpen(zipFilePath.path, APPEND_STATUS_CREATE)
 
         for archiveFile in archiveFiles {
             // Skip empty data
@@ -80,11 +78,7 @@ extension Zip {
             }
 
             // Setup the zip file info
-            var zipInfo = zip_fileinfo(
-                dos_date: 0,
-                internal_fa: 0,
-                external_fa: 0
-            )
+            var zipInfo = zip_fileinfo(dos_date: 0, internal_fa: 0, external_fa: 0)
 
             if let modifiedTime = archiveFile.modifiedTime {
                 zipInfo.dos_date = modifiedTime.dosDate
@@ -94,15 +88,8 @@ extension Zip {
             zipOpenNewFileInZip3(
                 zip, archiveFile.filename, &zipInfo,
                 nil, 0, nil, 0,
-                nil,
-                UInt16(Z_DEFLATED),
-                compression.minizipCompression,
-                0,
-                -MAX_WBITS,
-                DEF_MEM_LEVEL,
-                Z_DEFAULT_STRATEGY,
-                password,
-                0
+                nil, UInt16(Z_DEFLATED), compression.minizipCompression, 0, -MAX_WBITS, DEF_MEM_LEVEL, Z_DEFAULT_STRATEGY,
+                password, 0
             )
             let _ = archiveFile.data.withUnsafeBytes { (bytes: UnsafeRawBufferPointer) in
                 zipWriteInFileInZip(zip, bytes.baseAddress, UInt32(archiveFile.data.count))

Sources/Zip/QuickZip.swift

@@ -82,9 +82,6 @@ extension Zip {
         if !fileName.hasSuffix(".zip") {
             fileNameWithExtension += ".zip"
         }
-
-        print("fileNameWithExtension: \(fileNameWithExtension)")
-
         let destinationUrl = FileManager.default.temporaryDirectory.appendingPathComponent(fileNameWithExtension)
         try self.zipFiles(paths: paths, zipFilePath: destinationUrl, progress: progress)
         return destinationUrl

Sources/Zip/Zip.docc/Advanced.md

@@ -15,7 +15,7 @@ import Zip
 do {
   let filePath = Bundle.main.url(forResource: "file", withExtension: "zip")!
   let documentsDirectory = FileManager.default.urls(for: .documentDirectory, in: .userDomainMask)[0]
-  try Zip.unzipFile(filePath, destination: documentsDirectory, overwrite: true, password: "password") { progress in
+  try Zip.unzipFile(filePath, destination: documentsDirectory, password: "password") { progress in
     print(progress)
   }
 

Sources/Zip/Zip.docc/Documentation.md

@@ -15,12 +15,20 @@ A framework for zipping and unzipping files in Swift.
 Simple and quick to use.
 Built on top of [Minizip 1.2](https://github.com/zlib-ng/minizip-ng/tree/1.2).
 
+### Getting Started
+
 Use the SPM string to easily include the dependendency in your `Package.swift` file.
 
 ```swift
 .package(url: "https://github.com/vapor-community/Zip.git", from: "2.2.0")
 ```
 
+and add it to your target's dependencies:
+
+```swift
+.product(name: "Zip", package: "zip")
+```
+
 ## Topics
 
 ### Essentials