@zip.js/zip.js 2.8.50 → 2.8.52

package/lib/core/zip-fs.js

@@ -26,7 +26,7 @@
  EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
-/* global WritableStream, AbortController */
+/* global WritableStream, AbortController, DOMException */
 // deno-lint-ignore-file no-this-alias
 
 import {
@@ -34,26 +34,31 @@ import {
 	Reader,
 	TextReader,
 	TextWriter,
+	getTextSize,
 	Data64URIReader,
 	Data64URIWriter,
 	Uint8ArrayReader,
 	Uint8ArrayWriter,
 	BlobReader,
 	BlobWriter,
-	HttpReader
+	HttpReader,
+	ownsWritable
 } from "./io.js";
 import {
 	ZipReader,
 	ERR_INVALID_PASSWORD
 } from "./zip-reader.js";
 import {
-	ZipWriter
+	ZipWriter,
+	getEntriesSize
 } from "./zip-writer.js";
 import {
 	Entry
 } from "./zip-entry.js";
+import { ProgressWatcherStream, callHandler } from "./codec-worker.js";
 import {
 	UNDEFINED_VALUE,
+	FUNCTION_TYPE,
 	EXTRAFIELD_TYPE_ZIP64,
 	EXTRAFIELD_TYPE_AES,
 	EXTRAFIELD_TYPE_NTFS,
@@ -71,7 +76,10 @@ import { toCompatibleReadable, toCompatibleWritable } from "./util/compatible-st
 
 const ERR_ENTRY_EXISTS = "Entry filename already exists";
 const ERR_READABLE_CONSUMED = "Readable stream already consumed";
+const ERR_INVALID_PASS_THROUGH = "Invalid passThrough option (use readerOptions.passThrough or set uncompressedSize for each entry)";
 const ERR_ABORT_EXPORT = "zipjs-abort-export";
+const ERR_ABORTED = "The operation was aborted";
+const ABORT_ERROR_NAME = "AbortError";
 const INFOZIP_EXTRA_FIELD_TYPE = "infozip";
 const INTERPRETED_EXTRA_FIELD_TYPES = new Set([
 	EXTRAFIELD_TYPE_ZIP64,
@@ -106,6 +114,7 @@ class ZipEntry {
 			parent,
 			children: [],
 			uncompressedSize: params.uncompressedSize || 0,
+			undeterminedSize: params.undeterminedSize || params.uncompressedSize === UNDEFINED_VALUE,
 			passThrough: params.passThrough
 		});
 		if (parent || !fs.root) {
@@ -173,16 +182,17 @@ class ZipFileEntry extends ZipEntry {
 
 	async getData(writer, options = {}) {
 		const zipEntry = this;
-		if (!writer || (writer.constructor == zipEntry.Writer && zipEntry.data)) {
+		if (!writer || (writer.constructor == zipEntry.Writer && zipEntry.data && keepsContentType(writer, zipEntry.data))) {
 			return zipEntry.data;
 		} else {
 			const reader = zipEntry.reader = createReader(zipEntry.Reader, zipEntry.data, options);
-			const uncompressedSize = zipEntry.data ? zipEntry.data.uncompressedSize : reader.size;
-			await Promise.all([initStream(reader), initStream(writer, uncompressedSize)]);
-			const { readable } = reader;
+			const dataSize = zipEntry.uncompressedSize || reader.size;
+			await Promise.all([initStream(reader), initStream(writer, dataSize)]);
 			const { signal } = options;
+			const readable = createProgressReadable(zipEntry, reader, options, signal);
+			const preventClose = !ownsWritable(writer) && Boolean(options.preventClose);
 			zipEntry.uncompressedSize = reader.size;
-			await toCompatibleReadable(readable).pipeTo(toCompatibleWritable(writer.writable), { signal });
+			await toCompatibleReadable(readable).pipeTo(toCompatibleWritable(writer.writable), { signal, preventClose, preventAbort: preventClose });
 			return writer.getData ? writer.getData() : writer.writable;
 		}
 	}
@@ -313,7 +323,7 @@ class ZipDirectoryEntry extends ZipEntry {
 			Reader: TextReader,
 			Writer: TextWriter,
 			options,
-			uncompressedSize: text.length
+			uncompressedSize: getTextSize(text)
 		});
 	}
 
@@ -442,10 +452,16 @@ class ZipDirectoryEntry extends ZipEntry {
 	}
 
 	async importZip(reader, options = {}) {
-		await initStream(reader);
-		const zipReader = new ZipReader(reader, options);
+		let zipReader;
+		if (reader && typeof reader.getEntries == FUNCTION_TYPE) {
+			zipReader = reader;
+			options = Object.assign({}, zipReader.options, options);
+		} else {
+			await initStream(reader);
+			zipReader = new ZipReader(reader, options);
+		}
 		const importedEntries = [];
-		const entries = await zipReader.getEntries();
+		const entries = await zipReader.getEntries(options);
 		for (const entry of entries) {
 			let parent = this;
 			try {
@@ -467,7 +483,7 @@ class ZipDirectoryEntry extends ZipEntry {
 					importedEntries.push(addChild(parent, name, {
 						data: entry,
 						Reader: getZipBlobReader(Object.assign({}, options)),
-						uncompressedSize: entry.uncompressedSize,
+						uncompressedSize: options.passThrough ? entry.compressedSize : entry.uncompressedSize,
 						passThrough: options.passThrough
 					}));
 				} else {
@@ -509,11 +525,25 @@ class ZipDirectoryEntry extends ZipEntry {
 		}
 		const [readers] = await Promise.all([initReaders(zipEntry, options.readerOptions), initStream(writer)]);
 		const zipWriter = new ZipWriter(writer, options);
-		await exportZip(zipWriter, zipEntry, getTotalSize([zipEntry], "uncompressedSize"), options, readers);
-		await zipWriter.close();
+		await exportZip(zipWriter, zipEntry, getTotalSize([zipEntry], getUncompressedSize), options, readers);
+		await zipWriter.close(options.globalComment);
 		return writer.getData ? writer.getData() : writer.writable;
 	}
 
+	getExportedSize(options = {}) {
+		const zipEntry = this;
+		options = Object.assign({}, options);
+		if (options.bufferedWrite === UNDEFINED_VALUE) {
+			options.bufferedWrite = true;
+		}
+		const writeOrderGuaranteed = !options.bufferedWrite ||
+			(options.keepOrder !== false && zipEntry.children.every(child => !child.children.length));
+		return getEntriesSize(options, Array.from(zipEntry.getChildren({ recursive: true }), child => {
+			const { name, entryOptions } = getChildEntryOptions(child, zipEntry, options);
+			return { name, size: child.directory ? 0 : getDeterminedSize(child, isPassThrough(child, options)), options: entryOptions };
+		}), writeOrderGuaranteed, options.globalComment);
+	}
+
 	getChildByName(name) {
 		const children = this.children;
 		for (let childIndex = 0; childIndex < children.length; childIndex++) {
@@ -524,6 +554,10 @@ class ZipDirectoryEntry extends ZipEntry {
 		}
 	}
 
+	getChildren(options = {}) {
+		return collectChildren(this, options.recursive);
+	}
+
 	isPasswordProtected() {
 		const children = this.children;
 		for (let childIndex = 0; childIndex < children.length; childIndex++) {
@@ -615,6 +649,10 @@ class FS {
 		return this.root.getChildByName(name);
 	}
 
+	getChildren(options) {
+		return this.root.getChildren(options);
+	}
+
 	addDirectory(name, options) {
 		return this.root.addDirectory(name, options);
 	}
@@ -713,6 +751,10 @@ class FS {
 		return this.root.exportZip(writer, options);
 	}
 
+	getExportedSize(options) {
+		return this.root.getExportedSize(options);
+	}
+
 	isPasswordProtected() {
 		return this.root.isPasswordProtected();
 	}
@@ -723,14 +765,14 @@ class FS {
 }
 
 const fs = { FS, ZipDirectoryEntry, ZipFileEntry };
-export { fs, ERR_ENTRY_EXISTS, ERR_READABLE_CONSUMED };
+export { fs, ERR_ENTRY_EXISTS, ERR_READABLE_CONSUMED, ERR_INVALID_PASS_THROUGH, ERR_ABORTED };
 
-function getTotalSize(entries, propertyName) {
+function getTotalSize(entries, getEntrySize) {
 	let size = 0;
 	const pendingEntries = Array.from(entries);
 	while (pendingEntries.length) {
 		const entry = pendingEntries.pop();
-		size += entry[propertyName] || 0;
+		size += getEntrySize(entry) || 0;
 		for (const child of entry.children) {
 			pendingEntries.push(child);
 		}
@@ -738,6 +780,15 @@ function getTotalSize(entries, propertyName) {
 	return size;
 }
 
+function getUncompressedSize(entry) {
+	return entry.uncompressedSize;
+}
+
+function getExtractedSize(entry, passThrough) {
+	const { data } = entry;
+	return passThrough && data instanceof Entry ? data.compressedSize : entry.uncompressedSize;
+}
+
 function getReadableReader(readable) {
 	let consumed;
 	return function () {
@@ -760,10 +811,17 @@ function getZipBlobReader(options) {
 
 		async init() {
 			const zipBlobReader = this;
-			zipBlobReader.size = zipBlobReader.entry.uncompressedSize;
-			const data = await zipBlobReader.entry.getData(new BlobWriter(), Object.assign({}, options, zipBlobReader.options));
+			const readerOptions = Object.assign({}, options, zipBlobReader.options);
+			const { checkOverlappingEntry, checkOverlappingEntryOnly } = readerOptions;
+			const data = await zipBlobReader.entry.getData(new BlobWriter(), Object.assign(readerOptions, {
+				checkPasswordOnly: false,
+				checkOverlappingEntry: checkOverlappingEntryOnly || checkOverlappingEntry,
+				checkOverlappingEntryOnly: false,
+				preventClose: false
+			}));
 			zipBlobReader.data = data;
 			zipBlobReader.blobReader = new BlobReader(data);
+			zipBlobReader.size = data.size;
 			super.init();
 		}
 
@@ -777,6 +835,30 @@ function createReader(Reader, data, options) {
 	return Reader.prototype ? new Reader(data, options) : Reader(data, options);
 }
 
+function keepsContentType(writer, data) {
+	const { contentType } = writer;
+	if (contentType === UNDEFINED_VALUE) {
+		return true;
+	} else if (writer.constructor == BlobWriter) {
+		return data.type == contentType;
+	} else if (writer.constructor == Data64URIWriter) {
+		return data.startsWith(writer.data);
+	} else {
+		return true;
+	}
+}
+
+function createProgressReadable(zipEntry, reader, options, signal) {
+	const { onstart, onprogress, onend } = options;
+	const { readable } = reader;
+	const coreReaderReportsProgress = zipEntry.data instanceof Entry;
+	if (coreReaderReportsProgress || (!onstart && !onprogress && !onend)) {
+		return readable;
+	} else {
+		return toCompatibleReadable(readable).pipeThrough(new ProgressWatcherStream({ onstart, onprogress, onend, size: reader.size }), { signal });
+	}
+}
+
 async function initReaders(entry, options) {
 	const fileEntries = [];
 	const pendingEntries = [entry];
@@ -809,6 +891,7 @@ async function initReaders(entry, options) {
 		}
 		if (reader.size !== UNDEFINED_VALUE) {
 			child.uncompressedSize = reader.size;
+			child.undeterminedSize = false;
 		}
 	}));
 	return readers;
@@ -858,6 +941,90 @@ function aggregateEntryErrors(errors) {
 	return error;
 }
 
+function getChildEntryOptions(child, selectedEntry, options) {
+	const name = options.relativePath ? child.getRelativeName(selectedEntry) : child.getFullname();
+	const childOptions = child.options || {};
+	let zipEntryMetadata = {};
+	let passThroughOptions = {};
+	if (child.data instanceof Entry) {
+		const {
+			externalFileAttributes,
+			versionMadeBy,
+			comment,
+			lastModDate,
+			creationDate,
+			lastAccessDate,
+			uncompressedSize,
+			encrypted,
+			zipCrypto,
+			crc32,
+			compressionMethod,
+			extraFieldAES,
+			internalFileAttributes,
+			extraField,
+			uid,
+			gid
+		} = child.data;
+		zipEntryMetadata = {
+			externalFileAttributes,
+			versionMadeBy,
+			comment,
+			lastModDate,
+			creationDate,
+			lastAccessDate,
+			internalFileAttributes
+		};
+		const userExtraField = getUserExtraField(extraField);
+		if (userExtraField) {
+			zipEntryMetadata.extraField = userExtraField;
+		}
+		if (uid !== UNDEFINED_VALUE || gid !== UNDEFINED_VALUE) {
+			Object.assign(zipEntryMetadata, {
+				uid,
+				gid,
+				unixExtraFieldType: INFOZIP_EXTRA_FIELD_TYPE
+			});
+		}
+		if (isPassThrough(child, options)) {
+			let level, encryptionStrength;
+			if (compressionMethod === 0) {
+				level = 0;
+			}
+			if (extraFieldAES) {
+				encryptionStrength = extraFieldAES.strength;
+			}
+			passThroughOptions = {
+				passThrough: true,
+				encrypted,
+				zipCrypto,
+				crc32,
+				uncompressedSize,
+				level,
+				encryptionStrength,
+				compressionMethod
+			};
+		}
+	}
+	const entryOptions = Object.assign({}, zipEntryMetadata, options, passThroughOptions, childOptions, { directory: child.directory });
+	if (!child.directory && entryOptions.passThrough && entryOptions.uncompressedSize === UNDEFINED_VALUE) {
+		throw new Error(ERR_INVALID_PASS_THROUGH);
+	}
+	return { name, entryOptions };
+}
+
+function getDeterminedSize(child, passThrough) {
+	const { reader } = child;
+	if (reader && reader.size !== UNDEFINED_VALUE) {
+		return reader.size;
+	}
+	return child.undeterminedSize ? UNDEFINED_VALUE : getExtractedSize(child, passThrough);
+}
+
+function isPassThrough(child, options) {
+	const { readerOptions } = options;
+	return Boolean(!child.directory && (child.passThrough || (readerOptions && readerOptions.passThrough)));
+}
+
 function getUserExtraField(extraField) {
 	if (extraField) {
 		const userExtraField = new Map();
@@ -873,104 +1040,53 @@ function getUserExtraField(extraField) {
 }
 
 async function exportZip(zipWriter, entry, totalSize, options, readers) {
+	const { onstart, onprogress, onend, onentryprogress } = options;
 	const selectedEntry = entry;
-	const entryOffsets = new Map();
-	await process(zipWriter, entry);
-
-	async function process(zipWriter, entry) {
-		await exportChild();
-
-		async function exportChild() {
-			if (options.bufferedWrite) {
-				const results = await Promise.allSettled(entry.children.map(processChild));
-				const errorResult = results.find(result => result.status == "rejected");
-				if (errorResult) {
-					throw errorResult.reason;
-				}
-			} else {
-				for (const child of entry.children) {
-					await processChild(child);
-				}
-			}
+	const totalEntries = getTotalSize(entry.children, () => 1);
+	let writtenSize = 0;
+	let writtenEntries = 0;
+	if (onstart) {
+		await callHandler(onstart, totalSize);
+	}
+	if (options.bufferedWrite) {
+		await processChildren(entry);
+	} else {
+		for (const child of entry.getChildren({ recursive: true })) {
+			await addChild(child);
 		}
+	}
+	if (onend) {
+		await callHandler(onend, writtenSize);
+	}
 
-		async function processChild(child) {
-			const name = options.relativePath ? child.getRelativeName(selectedEntry) : child.getFullname();
-			const childOptions = child.options || {};
-			let zipEntryOptions = {};
-			if (child.data instanceof Entry) {
-				const {
-					externalFileAttributes,
-					versionMadeBy,
-					comment,
-					lastModDate,
-					creationDate,
-					lastAccessDate,
-					uncompressedSize,
-					encrypted,
-					zipCrypto,
-					crc32,
-					compressionMethod,
-					extraFieldAES,
-					internalFileAttributes,
-					extraField,
-					uid,
-					gid
-				} = child.data;
-				zipEntryOptions = {
-					externalFileAttributes,
-					versionMadeBy,
-					comment,
-					lastModDate,
-					creationDate,
-					lastAccessDate,
-					internalFileAttributes
-				};
-				const userExtraField = getUserExtraField(extraField);
-				if (userExtraField) {
-					zipEntryOptions.extraField = userExtraField;
-				}
-				if (uid !== UNDEFINED_VALUE || gid !== UNDEFINED_VALUE) {
-					Object.assign(zipEntryOptions, {
-						uid,
-						gid,
-						unixExtraFieldType: options.unixExtraFieldType || INFOZIP_EXTRA_FIELD_TYPE
-					});
-				}
-				if (child.passThrough) {
-					let level, encryptionStrength;
-					if (compressionMethod === 0) {
-						level = 0;
-					}
-					if (extraFieldAES) {
-						encryptionStrength = extraFieldAES.strength;
-					}
-					zipEntryOptions = Object.assign(zipEntryOptions, {
-						passThrough: true,
-						encrypted,
-						zipCrypto,
-						crc32,
-						uncompressedSize,
-						level,
-						encryptionStrength,
-						compressionMethod
-					});
+	async function processChildren(entry) {
+		const results = await Promise.allSettled(entry.children.map(async child => {
+			await addChild(child);
+			await processChildren(child);
+		}));
+		const errorResult = results.find(result => result.status == "rejected");
+		if (errorResult) {
+			throw errorResult.reason;
+		}
+	}
+
+	async function addChild(child) {
+		const { name, entryOptions } = getChildEntryOptions(child, selectedEntry, options);
+		let entryWrittenSize = 0;
+		const entryMetadata = await zipWriter.add(name, readers.get(child), Object.assign(entryOptions, {
+			onstart: UNDEFINED_VALUE,
+			onend: UNDEFINED_VALUE,
+			onprogress: async indexProgress => {
+				writtenSize += indexProgress - entryWrittenSize;
+				entryWrittenSize = indexProgress;
+				if (onprogress) {
+					await callHandler(onprogress, writtenSize, totalSize);
 				}
 			}
-			await zipWriter.add(name, readers.get(child), Object.assign({}, options, zipEntryOptions, childOptions, {
-				directory: child.directory,
-				onprogress: async indexProgress => {
-					if (options.onprogress) {
-						entryOffsets.set(name, indexProgress);
-						try {
-							await options.onprogress(Array.from(entryOffsets.values()).reduce((previousValue, currentValue) => previousValue + currentValue), totalSize);
-						} catch {
-							// ignored
-						}
-					}
-				}
-			}));
-			await process(zipWriter, child);
+		}));
+		writtenEntries++;
+		if (onentryprogress) {
+			await callHandler(onentryprogress, writtenEntries, totalEntries, entryMetadata);
 		}
 	}
 }
@@ -999,7 +1115,7 @@ function addFileSystemHandle(zipEntry, handle, options) {
 						})
 					);
 				} else if (handle.kind == "directory") {
-					const directoryEntry = parentEntry.addDirectory(handle.name);
+					const directoryEntry = parentEntry.addDirectory(handle.name, options);
 					addedEntries.push(directoryEntry);
 					for await (const childHandle of handle.values()) {
 						await addFile(directoryEntry, childHandle, addedEntries, entryName);
@@ -1021,14 +1137,29 @@ function addFileSystemHandle(zipEntry, handle, options) {
 }
 
 async function exportFileSystemHandle(zipEntry, directoryHandle, options) {
-	const totalSize = getTotalSize([zipEntry], "uncompressedSize");
-	const writtenSizes = new Map();
+	const { onstart, onprogress, onend } = options;
 	const abortController = new AbortController();
 	const { signal } = abortController;
 	const releaseSignal = forwardAbort(options.signal, abortController);
+	const getDataOptions = Object.assign({}, options, options.readerOptions, {
+		signal,
+		onstart: UNDEFINED_VALUE,
+		onprogress: UNDEFINED_VALUE,
+		onend: UNDEFINED_VALUE,
+		preventClose: false
+	});
+	const totalSize = getTotalSize([zipEntry], entry => getExtractedSize(entry, getDataOptions.passThrough));
 	const exportedEntryNames = [];
+	let exportAborted = false;
+	let writtenSize = 0;
 	try {
+		if (onstart) {
+			await callHandler(onstart, totalSize);
+		}
 		await exportChildren(zipEntry, directoryHandle);
+		if (onend) {
+			await callHandler(onend, writtenSize);
+		}
 	} catch (error) {
 		try {
 			error.exportedEntryNames = exportedEntryNames;
@@ -1041,6 +1172,25 @@ async function exportFileSystemHandle(zipEntry, directoryHandle, options) {
 	}
 	return directoryHandle;
 
+	function createProgressWritable(writable) {
+		const writer = writable.getWriter();
+		return new WritableStream({
+			async write(chunk) {
+				await writer.write(chunk);
+				writtenSize += chunk.length;
+				if (onprogress) {
+					await callHandler(onprogress, writtenSize, totalSize);
+				}
+			},
+			close() {
+				return writer.close();
+			},
+			abort(reason) {
+				return writer.abort(reason);
+			}
+		});
+	}
+
 	async function exportChildren(entry, parentHandle) {
 		if (options.concurrent) {
 			const results = await Promise.allSettled(entry.children.map(child => exportChild(child, parentHandle)));
@@ -1059,10 +1209,10 @@ async function exportFileSystemHandle(zipEntry, directoryHandle, options) {
 
 	async function exportChild(child, parentHandle) {
 		if (signal.aborted) {
-			if (isExportAborted(signal.reason)) {
+			if (exportAborted || isExportAborted(signal.reason)) {
 				return;
 			}
-			throw signal.reason;
+			throw signal.reason === UNDEFINED_VALUE ? new DOMException(ERR_ABORTED, ABORT_ERROR_NAME) : signal.reason;
 		}
 		try {
 			if (child.directory) {
@@ -1071,22 +1221,15 @@ async function exportFileSystemHandle(zipEntry, directoryHandle, options) {
 			} else {
 				const fileHandle = await parentHandle.getFileHandle(child.name, { create: true });
 				const writable = await fileHandle.createWritable();
-				await child.getData({ writable }, Object.assign({}, options, {
-					signal,
-					onprogress: async progress => {
-						if (options.onprogress) {
-							writtenSizes.set(child.id, progress);
-							try {
-								await options.onprogress(Array.from(writtenSizes.values()).reduce((previousValue, currentValue) => previousValue + currentValue, 0), totalSize);
-							} catch {
-								// ignored
-							}
-						}
-					}
-				}));
+				try {
+					await child.getData({ writable: createProgressWritable(writable) }, getDataOptions);
+				} catch (error) {
+					throw exportAborted ? new Error(ERR_ABORT_EXPORT) : error;
+				}
 				exportedEntryNames.push(child.getRelativeName(zipEntry));
 			}
 		} catch (error) {
+			exportAborted = true;
 			abortController.abort(new Error(ERR_ABORT_EXPORT));
 			try {
 				if (error.entryName === UNDEFINED_VALUE) {
@@ -1158,6 +1301,21 @@ function resetFS(fs) {
 	fs.root = new ZipDirectoryEntry(fs);
 }
 
+function collectChildren(directory, recursive) {
+	const children = [];
+	const pendingDirectories = [directory];
+	let directoryIndex = 0;
+	while (directoryIndex < pendingDirectories.length) {
+		for (const child of pendingDirectories[directoryIndex++].children) {
+			children.push(child);
+			if (recursive) {
+				pendingDirectories.push(child);
+			}
+		}
+	}
+	return children;
+}
+
 function registerEntries(fs, entry) {
 	const pendingEntries = [entry];
 	while (pendingEntries.length) {