Moved the zip utility functions to static methods

shockpkg · Oct 2, 2023 · c742cd2 · c742cd2
1 parent 7a96680
commit c742cd2
Show file tree

Hide file tree

Showing 3 changed files with 61 additions and 99 deletions.
diff --git a/src/archive.spec.ts b/src/archive.spec.ts
@@ -16,8 +16,7 @@ import {
 	fsLutimesSupported,
 	modePermissionBits,
 	pathResourceFork,
-	streamToBuffer,
-	zipPathIsMacResource
+	streamToBuffer
 } from './util';
 
 // An option to disable mtime testing (for a CI that has issues).
@@ -298,10 +297,7 @@ export function testArchive(
 								strictEqual(entry.volumePath, entry.path);
 							}
 
-							strictEqual(
-								zipPathIsMacResource(entry.path),
-								false
-							);
+							ok(!entry.path.startsWith('__MACOSX'));
 
 							if (!safeToExtract(entry)) {
 								return;

diff --git a/src/archive/zip.ts b/src/archive/zip.ts
@@ -6,12 +6,7 @@ import yauzl from 'yauzl';
 
 import {Archive, Entry, IEntryInfo} from '../archive';
 import {PathType} from '../types';
-import {
-	streamToBuffer,
-	zipEfaToUnixMode,
-	zipPathIsMacResource,
-	zipPathTypeFromEfaAndPath
-} from '../util';
+import {modeToPathType, streamToBuffer} from '../util';
 
 /**
  * Read entry.
@@ -325,37 +320,6 @@ export class ArchiveZip extends Archive {
 		super(path);
 	}
 
-	/**
-	 * Get stat mode value from ZIP file external file attributes.
-	 *
-	 * @param value Attributes value.
-	 * @returns Stat mode or null.
-	 */
-	public zipEfaToUnixMode(value: number) {
-		return zipEfaToUnixMode(value);
-	}
-
-	/**
-	 * Get path type from mode and path value from ZIP file entry.
-	 *
-	 * @param mode Entry mode.
-	 * @param path Entry path.
-	 * @returns Path type.
-	 */
-	public zipPathTypeFromEfaAndPath(mode: number, path: string) {
-		return zipPathTypeFromEfaAndPath(mode, path);
-	}
-
-	/**
-	 * Check if path is a Mac resource fork related path.
-	 *
-	 * @param path Zip path.
-	 * @returns Boolean value.
-	 */
-	public zipPathIsMacResource(path: string) {
-		return zipPathIsMacResource(path);
-	}
-
 	/**
 	 * Read archive.
 	 * If the itter callback returns false, reading ends.
@@ -373,6 +337,8 @@ export class ArchiveZip extends Archive {
 	 * @param itter Async callback for each archive entry.
 	 */
 	protected async _read(itter: (entry: EntryZip) => Promise<unknown>) {
+		const Static = this.constructor as typeof ArchiveZip;
+
 		const zipfile = await new Promise<yauzl.ZipFile>((resolve, reject) => {
 			yauzl.open(this.path, {lazyEntries: true}, (err, zipfile) => {
 				if (err) {
@@ -405,7 +371,7 @@ export class ArchiveZip extends Archive {
 				versionNeededToExtract
 			} = yentry;
 
-			const type = this.zipPathTypeFromEfaAndPath(
+			const type = Static.efaOrPathToPathType(
 				externalFileAttributes,
 				fileName
 			);
@@ -415,12 +381,12 @@ export class ArchiveZip extends Archive {
 
 			// Mac resource fork paths currently unsupported, so skip.
 			// The actual file format is unknown.
-			const isMacResource = this.zipPathIsMacResource(fileName);
+			const isMacResource = Static.pathIsMacResource(fileName);
 			if (isMacResource) {
 				return false;
 			}
 
-			const mode = this.zipEfaToUnixMode(externalFileAttributes);
+			const mode = Static.efaToUnixMode(externalFileAttributes);
 			const lastModDate = yentry.getLastModDate();
 			const isCompressed = yentry.isCompressed();
 			const isEncrypted = yentry.isEncrypted();
@@ -499,4 +465,57 @@ export class ArchiveZip extends Archive {
 			next(null);
 		});
 	}
+
+	/**
+	 * Get Unix bits from the ZIP file external file attributes.
+	 *
+	 * @param attrs Attributes value.
+	 * @returns Unix bits or null.
+	 */
+	public static efaToUnix(attrs: number) {
+		// eslint-disable-next-line no-bitwise
+		return attrs >>> 16;
+	}
+
+	/**
+	 * Get stat mode value from ZIP file external file attributes, if present.
+	 *
+	 * @param attrs Attributes value.
+	 * @returns Stat mode or null.
+	 */
+	public static efaToUnixMode(attrs: number) {
+		const mode = this.efaToUnix(attrs);
+
+		// Check if type bits are present, else no Unix info.
+		// eslint-disable-next-line no-bitwise
+		return (mode >> 12) & 0b1111 ? mode : null;
+	}
+
+	/**
+	 * Get path type from attributes and path value from ZIP file entry.
+	 *
+	 * @param attrs Attributes value.
+	 * @param path Entry path.
+	 * @returns Path type.
+	 */
+	public static efaOrPathToPathType(attrs: number, path: string) {
+		// Check for Unix stat type information.
+		const mode = this.efaToUnixMode(attrs);
+		if (!mode) {
+			// No Unix type information, assume Windows info only.
+			// Only file or directory, with directory having a trailing slash.
+			return /[\\/]$/.test(path) ? PathType.DIRECTORY : PathType.FILE;
+		}
+		return modeToPathType(mode);
+	}
+
+	/**
+	 * Check if path is a Mac resource fork related path.
+	 *
+	 * @param path Zip path.
+	 * @returns Boolean value.
+	 */
+	public static pathIsMacResource(path: string) {
+		return /^__MACOSX(\\|\/|$)/.test(path);
+	}
 }
diff --git a/src/util.ts b/src/util.ts
@@ -111,59 +111,6 @@ export function bitwiseAndEqual(value: number, mask: number) {
 	return (value & mask) === mask;
 }
 
-/**
- * Get Unix bits from the ZIP file external file attributes.
- *
- * @param attrs Attributes value.
- * @returns Unix bits or null.
- */
-export function zipEfaToUnix(attrs: number) {
-	// eslint-disable-next-line no-bitwise
-	return attrs >>> 16;
-}
-
-/**
- * Get stat mode value from ZIP file external file attributes, if present.
- *
- * @param attrs Attributes value.
- * @returns Stat mode or null.
- */
-export function zipEfaToUnixMode(attrs: number) {
-	const mode = zipEfaToUnix(attrs);
-
-	// Check if type bits are present, else no Unix info.
-	// eslint-disable-next-line no-bitwise
-	return (mode >> 12) & 0b1111 ? mode : null;
-}
-
-/**
- * Get path type from attributes and path value from ZIP file entry.
- *
- * @param attrs Attributes value.
- * @param path Entry path.
- * @returns Path type.
- */
-export function zipPathTypeFromEfaAndPath(attrs: number, path: string) {
-	// Check for Unix stat type information.
-	const mode = zipEfaToUnixMode(attrs);
-	if (!mode) {
-		// No Unix type infromation, assume Windows info only.
-		// Only files and directories, with directores having a trailing slash.
-		return /[\\/]$/.test(path) ? PathType.DIRECTORY : PathType.FILE;
-	}
-	return modeToPathType(mode);
-}
-
-/**
- * Check if path is a Mac resource fork related path.
- *
- * @param path Zip path.
- * @returns Boolean value.
- */
-export function zipPathIsMacResource(path: string) {
-	return /^__MACOSX(\\|\/|$)/.test(path);
-}
-
 /**
  * Read a stream into a buffer.
  * Reading a stream into a buffer should be avoided where possible.