51 commits

Author	SHA1	Message	Date
Erica Marigold	834b750794	refactor: use btest instead of band and ~= ... Seriously did not know that this existed. Can potentially allow for perf optimizations on Luau's ends.	2025-03-11 16:38:22 +00:00
Erica Marigold	a53580c9f9	style: apply stylua formatter	2025-02-24 07:42:44 +00:00
Erica Marigold	ee4d0e1a8d	fix: relax size checks and move test to edge case ... Relaxed size checks to not error for empty ZIP files in other test cases, and only validate that the number of entries is 0 for our test case, moving it to the edge cases suite instead.	2025-02-24 07:39:35 +00:00
Erica Marigold	39009b734c	fix: improve validation and and fix regression in tests ... Previous EoCD detection performance improvement changes in https://github.com/0x5eal/luau-unzip/commit/b710e296 inadvertently fixed some bugs to do with max size ZIP reads, which caused a regression in the `invalid_cde_number_of_files_allocation_greater_offset.zip` test, which used to error as expected due to out-of-bounds buffer reads. This commit fixes this by improving size validations present in the methods `ZipReader:parseEocdRecord` and `ZipReader:parseCentralDirectory`.	2025-02-24 07:20:40 +00:00
Erica Marigold	db819fdd61	refactor: remove debug print from ZipReader:parseEocdRecord	2025-02-23 20:13:25 +00:00
Erica Marigold	bd30a000ef	fix: use proper byte count corresponding to 64 KB	2025-02-23 20:03:18 +00:00
Erica Marigold	a5bb7166ad	fix: max comment size is 64 KB, not 64 KiB ... This was caught in the new test case for max length comments, where the comment would partially get cut off due us to using the wrong size units in `ZipReader:findEocdPosition`.	2025-02-23 19:21:40 +00:00
Erica Marigold	3f5e5c17cd	style: apply stylua formatter	2025-02-23 18:53:57 +00:00
Erica Marigold	4f99477caf	style: convert indentation to tabs	2025-02-23 18:53:24 +00:00
Erica Marigold	b710e2963c	perf: improve EoCD offset detection algorithm	2025-02-23 18:51:11 +00:00
Erica Marigold	f5ec183853	docs: use GitHub's supported markdown callout syntax	2025-02-21 19:14:23 +00:00
Erica Marigold	e8be46864a	docs: add @field annotations for ZipEntryProperties	2025-02-21 18:44:37 +00:00
Erica Marigold	4ad9806ccc	docs: fix grammar mistakes in comments ... Also uses `ZIP` instead of `zip` in some places.	2025-02-20 13:12:11 +00:00
Erica Marigold	8269686f86	docs: add missed indentation for moonwave doc comment	2025-02-19 18:49:37 +00:00
Erica Marigold	3e6de07545	style: apply stylua formatter	2025-02-19 18:28:49 +00:00
Erica Marigold	5fb55268f4	fix: address errors in moonwave comments and convert indentation	2025-02-19 18:28:00 +00:00
Erica Marigold	9ee7c1af0c	feat: add moonwave doc comments and small type corrections	2025-02-19 18:11:59 +00:00
Erica Marigold	6182e65756	feat: simplify path construction logic ... Simplies logic to just use nearest parent as the base instead of traversing downwards. This reduces some redundancy, however fixes a bug with repeated components in the constructed path and also improves performance by skipping a loop altogether. Also fixes recursive extraction tests failing `pandoc_soft_links.zip`.	2025-02-13 16:54:29 +00:00
Erica Marigold	54d46ff9cc	style: convert all indentention to spaces	2025-02-13 16:39:13 +00:00
Erica Marigold	83f847eabc	style: add missed line after method decl	2025-01-12 08:02:18 +00:00
Erica Marigold	d834b35278	fix: correctly error on mismatch with EoCD file count	2025-01-10 08:03:54 +00:00
Erica Marigold	3d2e3697fb	feat: add extraction version validation to ZipReader:extract	2025-01-10 07:38:40 +00:00
Erica Marigold	0400a3b05c	fix: set isText field instead of isAscii	2025-01-09 16:19:46 +00:00
Erica Marigold	ecace02e7f	feat: add ZipEntry:unixMode() to get unix mode values as octals ... Updates tests, and makes the `tour` example display the perms instead of the raw external attributes.	2025-01-09 16:16:38 +00:00
Erica Marigold	6c1f517b75	feat: add compressedSize and :compressionEfficiency() ... Adds a field for getting the compressed size of a zip entry and a method to get the compression efficiency as a percentage.	2025-01-09 15:11:18 +00:00
Erica Marigold	d93f1f2383	feat: add path safety and sanitization methods to ZipEntry ... * Added `ZipEntry:getSafePath` which returns the path of the entry if it was safe, or nil * Added `ZipEntry:sanitizePath` which converts a potentially unsafe path to a safe one, although it can change the meaning of the paths * Updated path utility with functions `isSafe` and `sanitize` * Path utility now always uses `/` as a path separator, converting `\\` to `/` when needed * Included tests for path utility	2025-01-09 07:25:59 +00:00
Erica Marigold	1db315c943	feat: add versionMadeBy to ZipEntry ... Also updates the metadata test suite to test for this.	2025-01-08 18:11:13 +00:00
Erica Marigold	bf7f51bebc	fix: remove table.freeze to fix decomp routine types not being inferred	2025-01-08 16:28:55 +00:00
Erica Marigold	d88091ea5a	feat: rename extraction option field isString->type	2025-01-08 16:21:27 +00:00
Erica Marigold	0c4ee0fffa	refactor: add another TODO comment for future note	2025-01-08 16:01:49 +00:00
Erica Marigold	8db960d064	refactor: add TODO comment for future note	2025-01-08 14:18:46 +00:00
Erica Marigold	03320fe090	style: apply stylua formatter	2025-01-08 14:14:30 +00:00
Erica Marigold	9d3c815fbb	refactor: small restructure and move utils outside main	2025-01-08 14:13:46 +00:00
Erica Marigold	9b6216c0a7	fix: entry metadata not including method ... Also updates metadata tests to test for correct method detection.	2025-01-07 18:55:50 +00:00
Erica Marigold	d329a3f273	feat: support following symlinks ... * Added new extraction option: `followSymlinks` * Added method for querying whether an entry is a symlink using `ZipEntry:isSymlink` * Include tests for symlinks	2025-01-07 18:45:06 +00:00
Erica Marigold	98c23ece3e	fix: correctly parse EoCD for misaligned comment sizes ... Also adds a test case for the same.	2025-01-07 13:29:39 +00:00
Erica Marigold	ecb63a0e2d	style: apply stylua formatter	2025-01-06 06:19:29 +00:00
Erica Marigold	1078fd249c	feat: add method field to ZipEntry ... Contains information about the compression method for the entry.	2025-01-06 06:05:43 +00:00
Erica Marigold	121869ad3d	fix: handle skipping in options correctly	2025-01-06 05:55:02 +00:00
Erica Marigold	3e9b3a3d94	refactor: small improvements ... * Fix return type for `ZipReader:findEntry` to return an optional `ZipEntry` * Update structuring comments and read bitflags for future use	2025-01-06 05:49:09 +00:00
Erica Marigold	06b1f1a640	fix: deflate decompression failing for files with high compression ratio	2025-01-02 06:07:53 +00:00
Erica Marigold	efe8360ba3	refactor: remove debugging print	2024-12-31 17:42:31 +00:00
Erica Marigold	ccc7228278	fix: avoid duplicate directory entries with trailing slash ... Fixed a bug in the directory tree builder where for directories there would be two entries, where one would have a trailing slash, and the other wouldn't. The directory without the trailing slash would get linked to its children in the entries lookup table, while the one with the trailing slash would exist as a "ghost directory" with no children. The fix involved sorting the entries to first handle directories, and linking to the existing parent directory entries for children.	2024-12-31 12:46:45 +00:00
Erica Marigold	7724af0467	refactor: removing debugging prints lol	2024-12-31 06:12:30 +00:00
Erica Marigold	ba82ad4af3	fix: correctly check bitflag for "streaming" zips	2024-12-31 06:11:45 +00:00
Erica Marigold	3a3a0e9aed	feat: add "streaming" zip support ... Adds support for ZIP files with the `0x08` bit of the general purpose bitflags set, i.e, those which do not include file sizes and crc checksums in the local file header	2024-12-30 18:24:00 +00:00
Erica Marigold	10a399c91f	refactor: minor sylistic changes ... Swaps places with the pattern: ```luau x = x + 1 ``` to use: ```luau x += 1 ```	2024-12-30 11:26:22 +00:00
Erica Marigold	c2e638cbec	style: apply stylua formatter	2024-12-30 11:13:57 +00:00
Erica Marigold	681b9ce1bf	feat: implement decompression and extraction ... * Implements a decompression step for extraction, currently supporting `DEFLATE` and `STORED` * Moved testing file to `examples/` * Added validation step to `ZipReader:extract` with options to optionally skip it (matches checksum and uncompressed size)	2024-12-30 11:09:48 +00:00
Erica Marigold	df134c31e0	refactor: include code comments	2024-12-28 18:01:17 +00:00