Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/buh/zippinch
Remote access to files inside a ZIP file for macOS, iOS and watchOS.
https://github.com/buh/zippinch
ios ipados macos msdos spm swift urlsession watchos zip
Last synced: 3 months ago
JSON representation
Remote access to files inside a ZIP file for macOS, iOS and watchOS.
- Host: GitHub
- URL: https://github.com/buh/zippinch
- Owner: buh
- License: mit
- Created: 2014-12-11T11:15:25.000Z (about 10 years ago)
- Default Branch: main
- Last Pushed: 2024-09-13T13:11:05.000Z (5 months ago)
- Last Synced: 2024-11-16T15:46:20.810Z (3 months ago)
- Topics: ios, ipados, macos, msdos, spm, swift, urlsession, watchos, zip
- Language: Swift
- Homepage:
- Size: 187 KB
- Stars: 11
- Watchers: 3
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
`ZipPinch` is an extension for `URLSession` to work with zip files remotely. It reads the contents of a zip file without downloading it itself and decompresses the desired files.
Imagine that you need remote access to several files (different kinds of assets: pictures, fonts, etc.). And these files can be changed and added to. Perhaps these files are grouped, for example, by locale and your app needs assets for a particular locale. In a good way you need a server solution that returns some JSON with a description of available resources. For example, you can use any PaaS, but `ZipPinch` offers a much simpler solution.
It makes a request to a remote ZIP archive and returns its structure with the file size and date of file modification. Free hosting for your zip files is not hard to find. Files in an uncompressed archive will essentially be downloaded as is and no time will be spent on unzipping.
*Screenshots from the Demo app: Hubble*
# Requirements
- Swift 5.6+
- macOS 12+
- iOS 15+
- watchOS 8+
# Installation
1. In Xcode go to `File` ⟩ `Add Packages...`
2. Search for the link below and click `Add Package`
```
https://github.com/buh/ZipPinch.git
```
3. Select to which target you want to add it and select `Add Package`
# Usage
## Getting started
1. First you need to create an instance of `URLSession`. Then make a request for the contents via a direct `URL` to your ZIP file.
```swift
let urlSession = URLSession(configuration: .default)
let entries = try await urlSession.zipEntries(from: url)
```
> [!NOTE]
> You can also add a `URLSessionTaskDelegate` or use a customised `URLRequest`.
2. Download the data of an entry:
```swift
let data = try await urlSession.zipEntryData(entry, from: url)
```
3. Use the data to initiate an image or other types.
Check out the Hubble demo app to view selected images from the archive taken by [The Hubble Space Telescope](https://esahubble.org).
## Download with progress
To download with showing the progress, a `ZIPProgress` object must be specified:
```swift
let data = try await urlSession.zipEntryData(entry, from: url, progress: .init() { progressValue in
Task { @MainActor in
self.progress = progressValue
}
})
```
## Download folder
1. Converting entries to a tree hierarchy with folders and enrties:
```swift
let entries = try await urlSession.zipEntries(from: url)
let rootFolder = entries.rootFolder()
```
2. Recursively load folder and subfolder entries:
```swift
// folderData: [(entry: ZIPEntry, data: Data)]
let folderData = try await urlSession.zipFolderData(folder, from: url)
```
3. The same, but with the overall progress:
```swift
// folderData: [(entry: ZIPEntry, data: Data)]
let folderData = try await urlSession.zipFolderData(folder, from: url, progress: .init() { progressValue in
Task { @MainActor in
self.progress = progressValue
}
})
```
# Features
- [x] Custom `URLRequest`
- [x] Task management with `URLSessionTaskDelegate`
- [x] Support for a custom decompressor
- [x] ZIP 64-bit support
- [x] Tracking the downloading progress
- [x] Demo for iPhone/iPad/macOS.
- [x] ZIP entries as a tree of Folders/Files.
- [x] Dowload a folder.
# ZIP file format specification sources
- [Wikipedia](http://en.wikipedia.org/wiki/ZIP_(file_format)#File_headers)
- [PKWARE ZIP File Format Specification](https://pkware.cachefly.net/webdocs/APPNOTE/APPNOTE-6.3.9.TXT)
- [Fossies](https://fossies.org/linux/unzip/proginfo/extrafld.txt)
# Support
You can buy me a coffee [here](https://www.buymeacoffee.com/bukhtin) ☕️
# License
`ZipPinch` is available under the [MIT license](https://github.com/buh/ZipPinch/blob/main/LICENSE)