ZIP Previewer & File Downloader

haarli commented 2 years ago

ZIP Previewer

This PR adds a previewer which allows to see the structure of a zip file in Dataverse. It also allows to download and extract single files from the ZIP without the need to download the whole ZIP. HTTP range requests are used for both functionalities, only the necessary byte ranges are downloaded. Downloading and extracting works fully client-side, so there might be limitations dependent on the browser.

The ZIP Previewer works with local file storage and S3 direct download (needs some CORS rules configured, see below). S3 with indirect download does not work well yet, as it seems to download the complete ZIP file to a temporary storage before doing the range request.

Requirements:

Dataverse version which integrates https://github.com/IQSS/dataverse/pull/8727. (Presumably from v5.12 ?)
Local file storage or S3 with direct download configured
- When using S3 storage: Extended CORS rule settings for the S3 bucket (see also: https://guides.dataverse.org/en/latest/developers/big-data-support.html#s3-direct-upload-and-download)
```
{
"CORSRules": [
{
    "AllowedOrigins": ["*"],
    "AllowedHeaders": ["*"],
    "AllowedMethods": ["PUT", "GET", "HEAD"],
    "ExposeHeaders": ["ETag", "Accept-Ranges", "Content-Range", "Content-Encoding"]
}
]
}
```

Acknowledgements

The ZIP previewer uses the zip.js library from Gildas Lormeau (https://github.com/gildas-lormeau/zip.js) and the fancytree library (https://github.com/mar10/fancytree) for rendering the treeview.

Screenshot:

grafik

haarli commented 2 years ago

Thanks for reviewing and testing.

Code was added to the previewers/betatest path and a new PR is created (https://github.com/gdcc/dataverse-previewers/pull/9).

We weren't aware of zip files not including separate entries for directories, do not have any in our repository. But of course, that's not the behaviour it should be. I'm afraid we cannot fix this for now, but hopefully at a later stage.

haarli commented 1 year ago

Replaced by https://github.com/gdcc/dataverse-previewers/pull/9

gdcc / dataverse-previewers