ZIPReader

Overview ¶

This class implements a reader that can extract the content of individual files inside a ZIP archive. See also graphics.gd/classdb/ZIPPacker.

package main

import (
	"path/filepath"
	"strings"

	"graphics.gd/classdb/DirAccess"
	"graphics.gd/classdb/FileAccess"
	"graphics.gd/classdb/ZIPReader"
)

func ReadZipFile() []byte {
	var reader = ZIPReader.New()
	var err = reader.Open("user://archive.zip")
	if err != nil {
		return nil
	}
	var res = reader.ReadFile("hello.txt")
	reader.Close()
	return res
}

// Extract all files from a ZIP archive, preserving the directories within.
// This acts like the "Extract all" functionality from most archive managers.
func ExtractAllFromZip() {
	var reader = ZIPReader.New()
	reader.Open("res://archive.zip")

	// Destination directory for the extracted files (this folder must exist before extraction).
	// Not all ZIP archives put everything in a single root folder,
	// which means several files/folders may be created in `root_dir` after extraction.
	var rootDir = DirAccess.Open("user://")

	var files = reader.GetFiles()
	for _, filePath := range files {
		// If the current entry is a directory.
		if strings.HasSuffix(filePath, "/") {
			rootDir.MakeDirRecursive(filePath)
			continue
		}

		// Write file contents, creating folders automatically when needed.
		// Not all ZIP archives are strictly ordered, so we need to do this in case
		// the file entry comes before the folder entry.
		rootDir.MakeDirRecursive(filepath.Base(filepath.Join(rootDir.GetCurrentDir(), filePath)))
		var file = FileAccess.Open(filepath.Join(rootDir.GetCurrentDir(), filePath), FileAccess.Write)
		var buffer = reader.ReadFile(filePath)
		file.StoreBuffer(buffer)
	}
}