diff --git a/.gitea/workflows/linux.yml b/.gitea/workflows/linux.yml index 5c72148..c1a2bbe 100644 --- a/.gitea/workflows/linux.yml +++ b/.gitea/workflows/linux.yml @@ -3,10 +3,10 @@ name: Sized Linux checks on: push: branches: [main, sizequeen-scan-hardening] - paths: ['Cargo.toml', 'Cargo.lock', 'src/**', 'tests/**', 'benches/**', 'scripts/**', '.gitea/workflows/**'] + paths: ['Cargo.toml', 'Cargo.lock', 'CORE-SNAPSHOT.json', 'crates/**', 'src/**', 'tests/**', 'benches/**', 'scripts/**', '.gitea/workflows/**'] pull_request: branches: [main] - paths: ['Cargo.toml', 'Cargo.lock', 'src/**', 'tests/**', 'benches/**', 'scripts/**', '.gitea/workflows/**'] + paths: ['Cargo.toml', 'Cargo.lock', 'CORE-SNAPSHOT.json', 'crates/**', 'src/**', 'tests/**', 'benches/**', 'scripts/**', '.gitea/workflows/**'] workflow_dispatch: permissions: diff --git a/CHANGELOG.md b/CHANGELOG.md index c431669..cbb3a50 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,7 +5,15 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -## [Unreleased] +## [2.0.0] - 2026-10-10 + +### Changed +- Use the exact shared core revision also pinned by SizeQueen, with a public + source snapshot and offline build inputs; the upstream forge stays private. +- Public Rust API and incomplete-scan exit-status changes are documented in + `docs/UPGRADING-2.md`. No private Git dependency is required. +- Distribute full dependency notices and matching vendored source alongside + platform-labelled packages. Mac delivery uses a signed, notarized disk image. ### Fixed - Include the executable before creating release archives. Use explicit host diff --git a/CORE-SNAPSHOT.json b/CORE-SNAPSHOT.json new file mode 100644 index 0000000..7989a36 --- /dev/null +++ b/CORE-SNAPSHOT.json @@ -0,0 +1,15 @@ +{ + "repository": "https://gitea.speelman.ca/gamertan/sized-core", + "revision": "fb63e96266dcb8ffbca53b73c6c0f738ac3e827d", + "files": { + "Cargo.toml": "c89c209b3a6cf08dd72eb9f80fabcd1f5686fecb457eecfc010db56f681bf645", + "LICENSE": "3972dc9744f6499f0f9b2dbf76696f2ae7ad8af9b23dde66d6af86c9dfb36986", + "README.md": "367d86ac8e21b7730d144d99fbf0e9f23c1050c40643e8be6e4cb5e59edf0b64", + "PROVENANCE.md": "0e640275d75ad33cadc2302245843fdfce6be17116110892a135089ea061ba15", + "examples/scan.rs": "33fb0c6ba090a0430c997229174482f261ffef64908f285f165307191a2b0a16", + "src/lib.rs": "b9cb7d71fb74f1005b61cf2e8dca0c3e9c97bc725ddb9d2c85b8b4dc912ed6c6", + "src/scan.rs": "a134f8f40bd0994f6ea332325e2b43ff47d558c42106135a951f2f8aa46be4ce", + "tests/linux_mount.rs": "e22bcc99a0b3bfe93ea9ab200e6312eb33390735e3b3b413aa904f45e6f8268a", + "tests/scanning.rs": "5fdb6ff3197aa24ceb2699f5787298b00ede69a87af07d7ca4fbdb911125a292" + } +} diff --git a/Cargo.lock b/Cargo.lock index 16b90fa..cf0393a 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -1182,7 +1182,7 @@ checksum = "e3a9fe34e3e7a50316060351f37187a3f546bce95496156754b601a5fa71b76e" [[package]] name = "sized" -version = "1.0.0" +version = "2.0.0" dependencies = [ "assert_cmd", "byte-unit", @@ -1193,16 +1193,24 @@ dependencies = [ "comfy-table", "criterion", "csv", - "ignore", "predicates", - "rayon", - "serde", "serde_json", + "sized-core", "strum", "tempfile", "time", ] +[[package]] +name = "sized-core" +version = "0.0.0" +dependencies = [ + "ignore", + "rayon", + "serde", + "tempfile", +] + [[package]] name = "smallvec" version = "1.15.1" diff --git a/Cargo.toml b/Cargo.toml index ec8a6c8..794c9f8 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,7 +1,8 @@ [package] name = "sized" -version = "1.0.0" +version = "2.0.0" edition = "2021" +rust-version = "1.88" description = "A modern, fast, and concurrent disk usage analyzer" license = "GPL-3.0-only" repository = "https://gitea.speelman.ca/gamertan/sized" @@ -31,13 +32,11 @@ assets = [ [dependencies] clap = { version = "4.4", features = ["derive"] } -rayon = "1.8" +scanner-core = { package = "sized-core", path = "crates/sized-core", version = "=0.0.0" } colored = "2.0" comfy-table = "7.0" byte-unit = "5.0" strum = { version = "0.25", features = ["derive"] } -ignore = "0.4" -serde = { version = "1.0", features = ["derive"] } serde_json = "1.0" csv = "1.3" time = { version = "0.3", features = ["macros", "formatting"] } @@ -54,3 +53,6 @@ criterion = "0.5" name = "benchmark" harness = false +[workspace] +members = ["crates/sized-core"] +resolver = "2" diff --git a/MANUAL.md b/MANUAL.md index 92e0170..337db06 100644 --- a/MANUAL.md +++ b/MANUAL.md @@ -16,27 +16,21 @@ ## Installation -### From source +See the [README](README.md#installation) for signed Apple silicon Mac downloads, +Linux archives, checksums and source builds. The offline source archive includes +the exact shared core and registry dependencies, with no private forge login. -The following installs the current review branch, including scanner hardening -not present in the published v1.0.0 release: +Rust 1.88 or newer and a C linker/toolchain are required for source builds: -```bash -git clone --branch sizequeen-scan-hardening https://gitea.speelman.ca/gamertan/sized.git +```sh +git clone --branch v2.0.0 https://gitea.speelman.ca/gamertan/sized.git cd sized cargo install --locked --path . ``` -Cargo installs to `~/.cargo/bin`. For the published source instead, check out -`v1.0.0` before installing. `make install PREFIX="$HOME/.local"` additionally -installs the man page without requiring administrator privileges. - -### Existing release files - -The [v1.0.0 release](https://gitea.speelman.ca/gamertan/sized/releases/tag/v1.0.0) -has source archives, a macOS arm64 executable, a man page and completions. -It has no Linux binary, architecture-labelled binary archive or `.deb` attachment. -See the [README](README.md#installation) for current installation guidance. +Cargo installs into `~/.cargo/bin`. To install the binary and man page together, +use `make install PREFIX="$HOME/.local"`. See [2.0 migration notes](docs/UPGRADING-2.md) +for changed exit statuses, accounting and public Rust APIs. ## Basic Usage diff --git a/README.md b/README.md index 59cad2d..e33a627 100644 --- a/README.md +++ b/README.md @@ -7,9 +7,9 @@ folders, filter the noise, and export reports for your own scripts. [Project page](https://gamertan.com/projects/sized/) ยท [Prefer a visual map? Meet SizeQueen](https://gamertan.com/projects/sizequeen/). -This branch contains scanner hardening under review. The published **v1.0.0** -release predates the hard-link, partial-scan and filesystem-boundary changes -below. No new release is implied by a branch build. +**Version 2.0.0** shares the pinned Sized core used by SizeQueen. Hard links, +partial scans and filesystem boundaries have explicit accounting and status. +See [upgrading from 1.0](docs/UPGRADING-2.md) for CLI and Rust API changes. ## Features @@ -27,39 +27,48 @@ below. No new release is implied by a branch build. ## Installation -### Build the current review branch +### Official downloads -With a Rust toolchain and Git installed: +Use the [Sized project page](https://gamertan.com/projects/sized/) or +[v2.0.0 release](https://gitea.speelman.ca/gamertan/sized/releases/tag/v2.0.0). +Choose the archive for your CPU and OS. The Apple silicon download is a signed, +notarized DMG; Linux archives target glibc 2.36 or newer. Matching offline source, +full dependency notices and SHA-256 checksums accompany the downloads. -```bash -git clone --branch sizequeen-scan-hardening https://gitea.speelman.ca/gamertan/sized.git +Open the Mac disk image, or extract the Linux archive. From its directory, install +without administrator privileges: + +```sh +mkdir -p "$HOME/.local/bin" "$HOME/.local/share/man/man1" +install -m 755 sized "$HOME/.local/bin/sized" +install -m 644 sized.1 "$HOME/.local/share/man/man1/sized.1" +"$HOME/.local/bin/sized" --version +``` + +Include `~/.local/bin` in your `PATH`. On a Mac, the mounted directory is +`/Volumes/Sized 2.0.0`; this is a Terminal tool rather than an application icon. +The archive also includes Bash, Zsh and Fish completions. No Homebrew tap or +Debian package is currently published. Intel Mac and Windows binaries are not +part of this release. + +### Build from source + +With Rust 1.88 or newer and a C linker/toolchain installed: + +```sh +git clone --branch v2.0.0 https://gitea.speelman.ca/gamertan/sized.git cd sized cargo install --locked --path . sized --help ``` -Cargo installs into `~/.cargo/bin`; include it in your `PATH`. For the published -source instead, check out `v1.0.0` before the install command. Source builds run -locally; they are separate from SizeQueen's signed and notarized Mac app. - -To install the binary and man page together without administrator privileges: - -```bash -make install PREFIX="$HOME/.local" -``` - -This uses `~/.local/bin` and `~/.local/share/man/man1`; configure `PATH` and your -manual-page search path as needed. - -### Existing release downloads - -The [v1.0.0 release](https://gitea.speelman.ca/gamertan/sized/releases/tag/v1.0.0) -contains source, one legacy executable named `sized`, a man page and shell -completions. The executable was inspected as macOS arm64 (Apple silicon); it is not a Linux download. -There are currently no attached architecture-labelled archives or `.deb` -packages, and no verified Homebrew tap. Build from source for the current -review changes. Platform-labelled archives will be advertised after a new -release is reviewed and published. +The public checkout includes the exact core snapshot; no private credentials are +needed. The matching source archive additionally includes registry dependencies: +from its root, `cargo build --locked --offline --release` works without Cargo +network access. Source builds are unsigned unless you sign them yourself. +`make install PREFIX="$HOME/.local"` installs the binary and man page together. +Historical [v1.0.0 files](https://gitea.speelman.ca/gamertan/sized/releases/tag/v1.0.0) +remain available unchanged. ## Documentation - **[Manual](MANUAL.md)**: Detailed explanations of all flags and features. @@ -144,7 +153,7 @@ a convenience helper, while `scan_tree` retains structured diagnostics. ## Development checks -Run `cargo test --locked` locally as an unprivileged user. For Linux build, +Run `cargo test --locked --workspace` locally as an unprivileged user. For Linux build, permission, filesystem-boundary and release smoke checks with Docker: ```bash @@ -180,9 +189,10 @@ See [source review and release process](SHIPMENT.md) and the [live queue](TODO.m Sized began as terminal tooling. Its filesystem scanner was extracted into `sized-core`, which SizeQueen now uses directly beneath its native Mac interface. SizeQueen adds the treemap and desktop interactions; it does not run the CLI. -Sized currently retains its own scanner copy while shared-core adoption is -reviewed. A public checkout of Sized does not need access to the private core -repository. SizeQueen's matching source download includes its pinned core. +Sized 2.0 uses the same pinned core revision through the exact public snapshot +in `crates/sized-core`. `CORE-SNAPSHOT.json` records its provenance and hashes. +The upstream core repository remains private; public Sized and both products' +matching source downloads build without access to it. ## License diff --git a/SHIPMENT.md b/SHIPMENT.md index 1de4050..44206aa 100644 --- a/SHIPMENT.md +++ b/SHIPMENT.md @@ -7,8 +7,9 @@ This document defines the process for versioning and distributing the `sized` pr Use a named branch from `main` and keep a pull request focused on one outcome. The `sizequeen-scan-hardening` branch corrects accounting/error handling and adds the scan controls needed by SizeQueen; the scanner has also been -extracted into private `sized-core` for SizeQueen. Sized retains its own copy -until adoption preserves public source access. +extracted into private `sized-core` for SizeQueen. Sized 2.0 includes its exact +pinned source snapshot as a path dependency. Verify `CORE-SNAPSHOT.json` before +packaging; no private Git fetch is part of a public build. 1. Run local locked tests and strict Clippy as an unprivileged user. Run `./scripts/check-linux.sh linux/arm64` and @@ -70,7 +71,7 @@ The project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html 2. Update `CHANGELOG.md` with the release notes. 3. Commit and create a git tag: ```bash - git tag -a v1.0.0 -m "Release v1.0.0" + git tag -a v2.0.0 -m "Release Sized 2.0.0" ``` ## 2. Asset generation and verification @@ -84,7 +85,7 @@ The project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html It packages the executable **before** creating the archive, together with the man page, Bash/Zsh/Fish completions, licence, README, manual and build metadata. Outputs are `dist/sized-v--/`, a sibling `.tar.gz` -and `.tar.gz.sha256`. Existing outputs are never replaced. Use +and `.tar.gz.sha256`, including complete dependency notices. Existing outputs are never replaced. Use `--output-dir /absolute/new/path` for an explicitly named local candidate. `CARGO_TARGET_DIR` is respected. The script does not sign, upload, tag or publish. @@ -100,6 +101,35 @@ against the original checkout. Retain matching source and complete dependency licences with any public binary distribution. A host build is unsigned; do not advertise it as notarized or as a Mac App Store application. +### Matching source and Mac delivery + +From a clean committed source checkpoint, run: + +```sh +scripts/package-source.sh /absolute/new/release-directory +``` + +This exports tracked source, includes all locked registry dependencies, verifies +an empty-cache offline build, and retains the exact source archive. Build the +binaries from that exported `sized-source` directory with +`CARGO_NET_OFFLINE=true` and `SIZED_SOURCE_REVISION` set to `SOURCE-REVISION.txt`. +Linux release checks can retain an archive when `SIZED_RELEASE_DIR` names a +writable output mount. Run on the architecture being released; keep both tmpfs +boundary mounts and UID 65532. This does not publish files. + +For Mac, use `scripts/notarize-macos.sh PACKAGE_DIRECTORY NEW_DMG_PATH` with an +explicit `SIZED_SIGN_IDENTITY`. It signs the CLI and disk image, submits through +`SIZED_NOTARY_PROFILE` (default `sizequeen-notary`), staples and validates the +DMG. The notarization receipt stays with private build evidence. Distribute the +DMG; a raw command-line executable cannot carry a stapled ticket. Compute final +checksums only after signing/stapling, then exercise the mounted signed CLI and +verify the downloaded files. See Apple's +[custom workflow guidance](https://developer.apple.com/documentation/security/customizing-the-notarization-workflow). + +Publish versioned files on the Gitea release and link them from the existing +Gamertan CMS project. Keep forge privacy settings unchanged. Retain the exact +matching source and never overwrite a published asset with different bytes. + ## 3. Distribution channels The existing public Gitea v1.0.0 release contains a macOS arm64 executable, diff --git a/TODO.md b/TODO.md index 25f99f1..f0dad4c 100644 --- a/TODO.md +++ b/TODO.md @@ -43,18 +43,25 @@ on SizeQueen. Website delivery is tracked in that repository's existing queue. record the public CMS delivery. PR #2 is open; no new version, release assets or merge. Historical v1.0.0 notes are corrected and asset bytes preserved. -## Deferred / next release +## Approved Sized 2.0.0 release -SizeQueen now pins the extracted private `sized-core`; Sized retains its own -scanner copy. Adoption must keep public builds independently fetchable. -Review scanner/API/status changes before merging the existing branch. Select a -new release version, verify target-specific installation and package complete -corresponding source/dependency notices before publishing fresh binary assets. -Do not replace historical v1.0.0 files. Windows allocation and very-large/deep -scan tuning remain separate work. See `SHIPMENT.md` for the release process. +The owner authorizes pinned core adoption, the public source snapshot while +keeping the core forge private, and merge/push/publication after checks pass. + +- [ ] Replace the local scanner with the exact SizeQueen core pin, verify snapshot + hashes and review the CLI/API migration and 2.0 compatibility notes. +- [ ] Verify Mac arm64 and Linux binaries, source rebuilds without forge access, + dependency notices, package contents and installation. Sign/notarize the Mac DMG. +- [ ] Merge PR #2, tag 2.0.0, publish immutable binary/source assets and update the + shared CMS project. Verify downloaded bytes and record release evidence. + +Windows, additional features and package-manager registries remain deferred. ## Resume note +Current: preparing the approved 2.0.0 migration and release above. No 2.0.0 +assets or tag have been published yet. Previous delivery evidence follows. + The approved Sized project page and release cleanup are delivered. Source checkpoint `77b11a8c29b5ca3435fdd962717f8e8285abe972` is pushed on `sizequeen-scan-hardening`; [PR #2](https://gitea.speelman.ca/gamertan/sized/pulls/2) diff --git a/crates/sized-core/Cargo.toml b/crates/sized-core/Cargo.toml new file mode 100644 index 0000000..cca8396 --- /dev/null +++ b/crates/sized-core/Cargo.toml @@ -0,0 +1,22 @@ +[package] +name = "sized-core" +version = "0.0.0" +edition = "2021" +rust-version = "1.88" +description = "Shared Unix filesystem scanner for Sized and SizeQueen" +license = "GPL-3.0-only" +repository = "https://gitea.speelman.ca/gamertan/sized-core" +readme = "README.md" +publish = false + +# Preserve the existing import name used by the included SizeQueen snapshot. +[lib] +name = "sized" + +[dependencies] +ignore = "0.4.25" +rayon = "1.11" +serde = { version = "1.0.228", features = ["derive"] } + +[dev-dependencies] +tempfile = "=3.24.0" diff --git a/crates/sized-core/LICENSE b/crates/sized-core/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/crates/sized-core/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/crates/sized-core/PROVENANCE.md b/crates/sized-core/PROVENANCE.md new file mode 100644 index 0000000..371580c --- /dev/null +++ b/crates/sized-core/PROVENANCE.md @@ -0,0 +1,30 @@ +# Source provenance + +This initial extraction retains the existing GPL-3.0-only licence and credits +Cole Speelman / Gamertan's Sized scanner. Repository privacy does not change +the source licence. No new licensing or contributor agreement is introduced. + +- `src/scan.rs`: byte-identical to Sized at + `9fd4e905b00ad23cea06bfaa1cc6a9608032266c` on `sizequeen-scan-hardening`. + Scanner behaviour was introduced in `8b177e2`; `988aad9` changed one Display + format string without changing behaviour. + SHA-256: `a134f8f40bd0994f6ea332325e2b43ff47d558c42106135a951f2f8aa46be4ce`. +- `src/lib.rs`: byte-identical to SizeQueen's included core at + `e17ef84` on `experiment/macos-native`, preserving its public re-exports and + legacy `build_tree` compatibility helper. +- `tests/scanning.rs`: copied unchanged from Sized. SHA-256: + `5fdb6ff3197aa24ceb2699f5787298b00ede69a87af07d7ca4fbdb911125a292`. +- `tests/linux_mount.rs`: Sized's real-mount regression adapted to test the + library independently; the original Sized test also checks CLI JSON output. +- Linux check scripts and pinned runtime: adapted from the checked Sized branch, + replacing the CLI smoke with a release-built library example. + +SizeQueen's older scanner snapshot differs only in the equivalent Display +format string. It remains unchanged until a deliberate consumer migration. +The scanner's original baseline was Sized +`9c8d1d43fdb5f4f540d4bea14275bc51ef69f92c`. + +The treemap layout and native bridge remain in SizeQueen. They are not part of +this extraction. Detailed accounting findings remain in SizeQueen's +`research/SIZED-AUDIT.md`; Sized's review and CI evidence remain in its +`TODO.md` and `SHIPMENT.md`. diff --git a/crates/sized-core/README.md b/crates/sized-core/README.md new file mode 100644 index 0000000..4cb5371 --- /dev/null +++ b/crates/sized-core/README.md @@ -0,0 +1,75 @@ +# Sized core + +Shared Rust filesystem scanning for [Sized](https://gitea.speelman.ca/gamertan/sized) +and [SizeQueen](https://gitea.speelman.ca/gamertan/sizequeen), by Gamertan. +This is a private extraction experiment. The existing applications still use +their current scanner copies; adopting this repository is a separate change. + +The library reports apparent bytes and allocated 512-byte blocks, counts hard +links deterministically, preserves partial-scan issues, and supports cancellation, +progress, per-scan worker selection, ignore rules and filesystem boundaries. +It contains no desktop, terminal formatting, web or Swift dependencies. +Linux and macOS are supported; Windows allocation is not implemented. + +## Use + +The Cargo package is `sized-core`; its library import remains `sized` for +compatibility with the current SizeQueen snapshot. Pin a reviewed Git revision +when adopting it. Private Git dependencies require access to this repository. + +```rust +use sized::{scan_tree, ScanControl, ScanError, ScanOptions, ScanReport}; +use std::path::Path; + +fn scan_chosen_path(path: &Path) -> Result { + scan_tree(path, &ScanOptions::default(), &ScanControl::default()) +} +// Inspect report.issues and report.root.complete before calling a scan complete. +``` + +Use `scan_tree` for new consumers. The legacy `build_tree` helper converts a +failed scan to an unavailable node and does not preserve diagnostics. +Cancellation is cooperative between filesystem calls. Allocated blocks do not +predict recoverable space on filesystems with shared extents or snapshots. + +## Check + +Run tests as an ordinary user; permission regressions intentionally fail as root. + +```sh +cargo fmt --all -- --check +cargo test --locked +cargo clippy --locked --all-targets -- -D warnings +./scripts/check-linux.sh linux/arm64 +./scripts/check-linux.sh linux/amd64 +``` + +The Linux script pins Rust 1.88.0, runs as UID 65532 with capabilities dropped, +creates two actual tmpfs devices, and checks a release-built example against an +owned fixture. The mount test is ignored in normal Cargo runs and explicitly +enabled by the script. +The example requires an explicit path: `cargo run --locked --example scan -- PATH`. + +### Gitea CI + +`.gitea/workflows/linux.yml` runs the same checks on the existing cliff-mads +runner's `himesan-node24` label with a pinned Rust/Node job image. The image +pre-owns `/workspace/gamertan/sized-core` for UID 65532, including checkout. +Jobs have no Docker socket or privileged mode; the runner mounts the two tmpfs +devices. No runner configuration, labels or unrelated jobs are changed. + +Rebuild the local image intentionally with: + +```sh +ssh cliff-mads 'docker build --platform linux/amd64 --tag local/gamertan-ci:sized-core-rust188 -' < scripts/gitea-linux.Dockerfile +ssh cliff-mads 'docker image inspect local/gamertan-ci:sized-core-rust188 --format "{{.Id}}"' +``` + +Review and update the workflow image ID after a rebuild. It stays local to +cliff-mads. Repository Actions must be enabled. Checks cover owner-triggered, +same-repository pushes on main/review branches and PRs to main; manual dispatch +is available. Documentation-only pushes skip builds. No package or release is +published. `TODO.md` records the actual provider result and tested source commit. + +Source provenance and licence are in [PROVENANCE.md](PROVENANCE.md) and +[LICENSE](LICENSE). The live iteration queue is [TODO.md](TODO.md). diff --git a/crates/sized-core/examples/scan.rs b/crates/sized-core/examples/scan.rs new file mode 100644 index 0000000..6e8e394 --- /dev/null +++ b/crates/sized-core/examples/scan.rs @@ -0,0 +1,25 @@ +use sized::{scan_tree, ScanControl, ScanOptions}; +use std::{error::Error, path::PathBuf}; + +fn main() -> Result<(), Box> { + let Some(path) = std::env::args_os().nth(1).map(PathBuf::from) else { + eprintln!("Usage: scan PATH"); + std::process::exit(2); + }; + let report = scan_tree(&path, &ScanOptions::default(), &ScanControl::default())?; + println!( + "apparent={} allocated={} entries={} complete={} issues={}", + report.root.size_bytes, + report.root.blocks * 512, + report.entries_scanned, + report.root.complete, + report.issues.len() + ); + if !report.root.complete { + for issue in report.issues { + eprintln!("{}: {}", issue.path.display(), issue.message); + } + std::process::exit(1); + } + Ok(()) +} diff --git a/crates/sized-core/src/lib.rs b/crates/sized-core/src/lib.rs new file mode 100644 index 0000000..f54205a --- /dev/null +++ b/crates/sized-core/src/lib.rs @@ -0,0 +1,20 @@ +//! Sized's scanner without its command-line presentation dependencies. +pub mod scan; +pub use scan::*; + +use std::path::Path; + +/// Compatibility entry point for the original accounting probes. +pub fn build_tree(path: &Path, ignore: bool, compare: bool) -> Node { + scan_tree( + path, + &ScanOptions { + respect_ignore: ignore, + compare_ignore: compare, + ..ScanOptions::default() + }, + &ScanControl::default(), + ) + .map(|report| report.root) + .unwrap_or_else(|_| Node::unavailable(path)) +} diff --git a/src/scan.rs b/crates/sized-core/src/scan.rs similarity index 100% rename from src/scan.rs rename to crates/sized-core/src/scan.rs diff --git a/crates/sized-core/tests/linux_mount.rs b/crates/sized-core/tests/linux_mount.rs new file mode 100644 index 0000000..aab2a80 --- /dev/null +++ b/crates/sized-core/tests/linux_mount.rs @@ -0,0 +1,69 @@ +#![cfg(target_os = "linux")] + +use sized::{scan_tree, ScanControl, ScanOptions}; +use std::{fs, io::Write, os::unix::fs::MetadataExt, path::PathBuf}; +use tempfile::NamedTempFile; + +#[test] +#[ignore = "requires the two owned tmpfs mounts from scripts/check-linux.sh"] +fn real_mount_boundary_is_respected_by_scanner() { + let root = PathBuf::from( + std::env::var_os("SIZED_TEST_MOUNT_ROOT").expect("missing mounted Linux fixture"), + ); + let foreign = root.join("foreign"); + let root_metadata = fs::metadata(&root).unwrap(); + let foreign_metadata = fs::metadata(&foreign).unwrap(); + assert_ne!( + root_metadata.dev(), + foreign_metadata.dev(), + "not a real boundary" + ); + let mut local_file = NamedTempFile::new_in(&root).unwrap(); + let mut mounted_file = NamedTempFile::new_in(&foreign).unwrap(); + local_file.write_all(b"local allocation").unwrap(); + mounted_file.write_all(&[7; 8192]).unwrap(); + local_file.as_file().sync_all().unwrap(); + mounted_file.as_file().sync_all().unwrap(); + + for bounded in [false, true] { + let report = scan_tree( + &root, + &ScanOptions { + stay_on_filesystem: bounded, + threads: Some(2), + ..ScanOptions::default() + }, + &ScanControl::default(), + ) + .unwrap(); + assert!(report.root.complete); + assert!(report.issues.is_empty()); + let mount = report + .root + .children + .iter() + .find(|n| n.path == foreign) + .unwrap(); + assert_eq!(mount.identity.unwrap().device, foreign_metadata.dev()); + assert_eq!(mount.skipped_mount, bounded); + assert_eq!(report.entries_scanned, if bounded { 3 } else { 4 }); + let expected_blocks = + root_metadata.blocks() + local_file.as_file().metadata().unwrap().blocks(); + if bounded { + assert!(mount.children.is_empty()); + assert_eq!(mount.blocks, 0); + assert_eq!(mount.size_bytes, 0); + assert_eq!(report.root.blocks, expected_blocks); + } else { + assert_eq!(mount.children.len(), 1); + assert_eq!(mount.children[0].path, mounted_file.path()); + assert_eq!(mount.children[0].size_bytes, 8192); + assert_eq!( + report.root.blocks, + expected_blocks + + foreign_metadata.blocks() + + mounted_file.as_file().metadata().unwrap().blocks() + ); + } + } +} diff --git a/crates/sized-core/tests/scanning.rs b/crates/sized-core/tests/scanning.rs new file mode 100644 index 0000000..5b62750 --- /dev/null +++ b/crates/sized-core/tests/scanning.rs @@ -0,0 +1,254 @@ +#![cfg(unix)] +use sized::{build_tree, scan_tree, EntryType, ScanControl, ScanError, ScanOptions}; +use std::{ + fs, + io::Write, + os::unix::fs::{symlink, MetadataExt, PermissionsExt}, +}; +use tempfile::tempdir; + +fn scan(path: &std::path::Path) -> sized::ScanReport { + scan_tree(path, &ScanOptions::default(), &ScanControl::default()).unwrap() +} + +#[test] +fn hard_links_count_allocation_once_but_keep_apparent_sizes() { + let dir = tempdir().unwrap(); + let original = dir.path().join("a-original"); + fs::write(&original, [9; 65536]).unwrap(); + fs::hard_link(&original, dir.path().join("z-alias")).unwrap(); + let expected = + fs::metadata(&original).unwrap().blocks() + fs::metadata(dir.path()).unwrap().blocks(); + for threads in [1, 4] { + let report = scan_tree( + dir.path(), + &ScanOptions { + threads: Some(threads), + ..ScanOptions::default() + }, + &ScanControl::default(), + ) + .unwrap(); + assert_eq!(report.root.blocks, expected); + assert_eq!(report.root.children[0].size_bytes, 65536); + assert_eq!(report.root.children[1].size_bytes, 65536); + assert!(!report.root.children[0].hard_link_duplicate); + assert!(report.root.children[1].hard_link_duplicate); + assert_eq!(report.root.children[1].blocks, 0); + assert_eq!(report.entries_scanned, 3); + assert!(report.root.complete); + } +} + +#[test] +fn ignored_hard_link_does_not_steal_filtered_allocation() { + let dir = tempdir().unwrap(); + fs::write(dir.path().join(".ignore"), "a-ignored\n").unwrap(); + let original = dir.path().join("a-ignored"); + fs::write(&original, [9; 65536]).unwrap(); + fs::hard_link(&original, dir.path().join("z-included")).unwrap(); + let report = scan_tree( + dir.path(), + &ScanOptions { + compare_ignore: true, + ..ScanOptions::default() + }, + &ScanControl::default(), + ) + .unwrap(); + let expected = fs::metadata(&original).unwrap().blocks() + + fs::metadata(dir.path()).unwrap().blocks() + + fs::metadata(dir.path().join(".ignore")).unwrap().blocks(); + assert_eq!(report.root.blocks, expected); + assert_eq!(report.root.blocks_filtered, expected); + assert_eq!(report.root.children.last().unwrap().blocks, 0); + assert!(report.root.children.last().unwrap().blocks_filtered > 0); +} + +#[test] +fn hidden_files_are_counted_without_ignore_filtering() { + let dir = tempdir().unwrap(); + fs::write(dir.path().join(".hidden"), b"hidden").unwrap(); + fs::write(dir.path().join(".ignore"), "build\n").unwrap(); + fs::write(dir.path().join("build"), b"build").unwrap(); + assert_eq!(scan(dir.path()).root.children.len(), 3); + let report = scan_tree( + dir.path(), + &ScanOptions { + respect_ignore: true, + ..ScanOptions::default() + }, + &ScanControl::default(), + ) + .unwrap(); + assert_eq!(report.root.children.len(), 2); + assert!(report + .root + .children + .iter() + .any(|n| n.path.ends_with(".hidden"))); +} + +#[test] +fn ignore_rules_are_inherited_by_nested_directories() { + let dir = tempdir().unwrap(); + fs::write(dir.path().join(".ignore"), "*.tmp\n").unwrap(); + let nested = dir.path().join("nested"); + fs::create_dir(&nested).unwrap(); + fs::write(nested.join("skip.tmp"), b"ignored").unwrap(); + fs::write(nested.join("keep.bin"), b"included").unwrap(); + let report = scan_tree( + dir.path(), + &ScanOptions { + respect_ignore: true, + ..ScanOptions::default() + }, + &ScanControl::default(), + ) + .unwrap(); + let children = &report + .root + .children + .iter() + .find(|n| n.path == nested) + .unwrap() + .children; + assert_eq!(children.len(), 1); + assert!(children[0].path.ends_with("keep.bin")); + let compared = scan_tree( + dir.path(), + &ScanOptions { + compare_ignore: true, + ..ScanOptions::default() + }, + &ScanControl::default(), + ) + .unwrap(); + assert_eq!(compared.root.size_bytes_filtered, report.root.size_bytes); + assert_eq!(compared.root.blocks_filtered, report.root.blocks); +} + +#[test] +fn sparse_file_reports_blocks_and_logical_length_separately() { + let dir = tempdir().unwrap(); + let path = dir.path().join("sparse"); + let mut file = fs::File::create(&path).unwrap(); + file.write_all(&[7; 4096]).unwrap(); + file.set_len(128 * 1024 * 1024).unwrap(); + file.sync_all().unwrap(); + let node = scan(&path).root; + assert_eq!(node.size_bytes, 128 * 1024 * 1024); + assert_eq!(node.blocks, fs::metadata(path).unwrap().blocks()); + assert!(node.blocks * 512 < node.size_bytes); +} + +#[test] +fn symlinks_including_loop_and_dangling_link_are_leaves() { + let dir = tempdir().unwrap(); + symlink(dir.path(), dir.path().join("loop")).unwrap(); + symlink(dir.path().join("missing"), dir.path().join("dangling")).unwrap(); + let report = scan(dir.path()); + assert_eq!(report.root.children.len(), 2); + for node in report.root.children { + assert!(node.symlink); + assert!(node.children.is_empty()); + assert!(node.complete); + } +} + +#[test] +fn missing_root_returns_error_and_legacy_helper_marks_unavailable() { + let dir = tempdir().unwrap(); + let path = dir.path().join("vanished"); + assert!( + matches!(scan_tree(&path, &ScanOptions::default(), &ScanControl::default()), + Err(ScanError::Root { source, .. }) if source.kind() == std::io::ErrorKind::NotFound) + ); + let node = build_tree(&path, false, false); + assert_eq!(node.entry_type, EntryType::Unknown); + assert!(!node.accessible); + assert!(!node.complete); +} + +#[test] +fn permission_error_propagates_incomplete_status_to_root() { + let dir = tempdir().unwrap(); + let blocked = dir.path().join("blocked"); + fs::create_dir(&blocked).unwrap(); + fs::write(blocked.join("unreadable"), b"data").unwrap(); + fs::set_permissions(&blocked, fs::Permissions::from_mode(0o000)).unwrap(); + let result = std::panic::catch_unwind(|| { + assert!( + fs::read_dir(&blocked).is_err(), + "permission tests require an unprivileged user" + ); + let report = scan(dir.path()); + assert!(report.root.accessible); + assert!(!report.root.complete); + assert!(!report.root.children[0].accessible); + assert_eq!(report.issues.len(), 1); + assert_eq!(report.issues[0].path, blocked); + assert_eq!(report.issues[0].kind, std::io::ErrorKind::PermissionDenied); + }); + fs::set_permissions(blocked, fs::Permissions::from_mode(0o700)).unwrap(); + result.unwrap(); +} + +#[test] +fn cancelled_scan_never_returns_completed_tree() { + let dir = tempdir().unwrap(); + let control = ScanControl::default(); + control.cancel(); + assert!(matches!( + scan_tree(dir.path(), &ScanOptions::default(), &control), + Err(ScanError::Cancelled) + )); + assert_eq!(control.entries_scanned(), 0); +} + +#[test] +fn cancellation_and_progress_work_during_scan() { + let dir = tempdir().unwrap(); + for i in 0..2000 { + fs::write(dir.path().join(format!("file-{i}")), b"x").unwrap(); + } + let control = ScanControl::default(); + let watcher = control.clone(); + let cancel = std::thread::spawn(move || { + let deadline = std::time::Instant::now() + std::time::Duration::from_secs(5); + while watcher.entries_scanned() < 10 { + assert!( + std::time::Instant::now() < deadline, + "scan made no progress" + ); + std::thread::yield_now(); + } + watcher.cancel(); + }); + let result = scan_tree( + dir.path(), + &ScanOptions { + threads: Some(1), + ..ScanOptions::default() + }, + &control, + ); + cancel.join().unwrap(); + assert!(matches!(result, Err(ScanError::Cancelled))); + assert!(control.entries_scanned() >= 10); +} + +#[test] +fn special_file_is_not_treated_as_directory() { + let dir = tempdir().unwrap(); + let path = dir.path().join("fifo"); + assert!(std::process::Command::new("mkfifo") + .arg(&path) + .status() + .unwrap() + .success()); + let node = scan(&path).root; + assert_eq!(node.entry_type, EntryType::Special); + assert!(node.children.is_empty()); + assert!(node.complete); +} diff --git a/docs/RELEASE-LICENSING.md b/docs/RELEASE-LICENSING.md new file mode 100644 index 0000000..90226e8 --- /dev/null +++ b/docs/RELEASE-LICENSING.md @@ -0,0 +1,38 @@ +# Sized 2.0 source and dependency notices + +Sized and the exact public core snapshot retain GPL-3.0-only. The owner confirmed +that the first-party code was developed by Cole Speelman with Codex assistance. +The core forge remains private; `crates/sized-core` includes the required source +at `fb63e96266dcb8ffbca53b73c6c0f738ac3e827d`. `CORE-SNAPSHOT.json` records the +upstream revision and exact file hashes; `scripts/check-core.py` checks them. +The snapshot preserves upstream README/provenance as historical source records. + +Each binary download is accompanied by its exact source archive, including +Cargo.lock, all registry dependencies, core source, build scripts and original +notices. Recipients need no forge credentials. The archive is checked with an +empty Cargo cache and offline mode. Preserve it as long as the binaries remain +available. Source-only development dependencies retain their original bundled +notices and package licence metadata in the vendor directory. + +`scripts/package-notices.py` uses Cargo's normal/build tree for the target and +locked metadata to produce `DEPENDENCIES.json` and complete `LICENCES.txt`. +Development-only and inactive optional dependencies are excluded from the binary +inventory. Missing notices and new licence expressions stop packaging. Where a +choice is offered, this distribution uses MIT, or Apache-2.0 when MIT is absent; +all bundled alternative licence texts and copyright notices are preserved. +Unicode-3.0 notices are retained along with MIT/Apache notices where required. +No third-party licence is replaced by the first-party licence. + +The existing `colored` 2.2.0 dependency is MPL-2.0. Its sources and notices are +unmodified; inspection found no Exhibit B declaration in its source files or +README. The generic Exhibit B in the MPL licence text itself is not an applied +declaration. Under MPL section 3.3, colored is additionally distributed under +GPL-3.0-only as part of this Larger Work. Its original MPL rights and notices +remain available to recipients. This notice accompanies both binary and source. +See Mozilla's [MPL/GPL guidance](https://www.mozilla.org/en-US/MPL/2.0/combining-mpl-and-gpl/) +and [MPL FAQ](https://www.mozilla.org/en-US/MPL/2.0/FAQ/#q14-may-i-combine-mpl-licensed-code-and-lgpl-licensed-code-in-the-same-executable-program). + +The Mac CLI links Apple's system libraries; Linux dynamically links system +libraries including glibc. Each target's requirements and linked libraries are +recorded with its release verification. A new dependency, target or licence +expression requires reviewing the affected notices before distribution. diff --git a/docs/UPGRADING-2.md b/docs/UPGRADING-2.md new file mode 100644 index 0000000..2ece1dc --- /dev/null +++ b/docs/UPGRADING-2.md @@ -0,0 +1,31 @@ +# Moving from Sized 1.0 to 2.0 + +The existing flags and table/CSV/NDJSON workflows remain. Update automation to +handle incomplete scans: exit 0 means a complete result; exit 1 means a missing +root, an incomplete scan or another operation failure. CLI argument errors use +Clap's exit 2. An incomplete scan may still produce useful output. Diagnostics +go to stderr, and each JSON report includes `complete`. + +Hard-linked files now contribute allocated blocks once, owned by the first path +in deterministic traversal order. Apparent sizes remain per pathname. Totals +may be lower than 1.0 for this reason. Ignore rules inherit through directories; +`--one-file-system` explicitly skips other mounted filesystems. Allocation is +filesystem-reported blocks, not guaranteed recoverable space. + +## Rust consumers + +The CLI package is version 2.0.0. Its scanner is the exact `sized-core` revision +recorded in `CORE-SNAPSHOT.json`, also used by SizeQueen. The core snapshot's +internal package version remains 0.0.0; the full Git revision and file hashes +identify it. It is an included path dependency, so no private forge access or +separate core installation is required. + +Public scanner types and `sized::scan` are re-exported from that dependency. +`EntryType` adds `Special` and `Unknown`; update exhaustive matches. `Node` has +additional accounting/status fields and internal state; obtain nodes through +`scan_tree` instead of struct literals. `Args` adds `one_file_system`, and +`run` returns scan completeness as a boolean. `build_tree` remains a compatibility +helper, but use `scan_tree` to retain structured errors and diagnostics. + +Use a fresh `ScanControl` per scan. Cancellation is cooperative between +filesystem calls. SizeQueen does not launch the CLI; both use the core in process. diff --git a/scripts/check-core.py b/scripts/check-core.py new file mode 100755 index 0000000..47208db --- /dev/null +++ b/scripts/check-core.py @@ -0,0 +1,14 @@ +#!/usr/bin/env python3 +"""Verify the exact public core snapshot without contacting its private forge.""" +import hashlib +import json +from pathlib import Path + +root = Path(__file__).resolve().parent.parent +pin = json.loads((root / 'CORE-SNAPSHOT.json').read_text()) +snapshot = root / 'crates/sized-core' +actual = {str(p.relative_to(snapshot)): hashlib.sha256(p.read_bytes()).hexdigest() + for p in snapshot.rglob('*') if p.is_file()} +if actual != pin['files']: + raise SystemExit('Core snapshot differs from CORE-SNAPSHOT.json; review the upstream pin and every changed file.') +print(f"Core snapshot verified: {pin['revision']} ({len(actual)} files)") diff --git a/scripts/check-linux-container.sh b/scripts/check-linux-container.sh index 13de280..5aa540f 100755 --- a/scripts/check-linux-container.sh +++ b/scripts/check-linux-container.sh @@ -12,16 +12,22 @@ cargo --version check_root=$(mktemp -d /tmp/sized-check.XXXXXX) source_root=${SIZED_TEST_SOURCE:-/source} cp "$source_root/Cargo.toml" "$source_root/Cargo.lock" "$check_root/" -cp -R "$source_root/src" "$source_root/tests" "$source_root/benches" "$check_root/" +cp -R "$source_root/src" "$source_root/tests" "$source_root/benches" "$source_root/crates" "$source_root/docs" "$check_root/" +cp "$source_root/CORE-SNAPSHOT.json" "$check_root/" +if [[ -d "$source_root/vendor" ]]; then + cp -R "$source_root/vendor" "$source_root/.cargo" "$check_root/" + export CARGO_NET_OFFLINE=true +fi cp "$source_root/LICENSE" "$source_root/README.md" "$source_root/MANUAL.md" "$check_root/" mkdir "$check_root/scripts" -cp "$source_root/scripts/release.sh" "$source_root/scripts/check-release.sh" "$check_root/scripts/" -export SIZED_SOURCE_REVISION="$(git -C "$source_root" rev-parse HEAD 2>/dev/null || printf unknown)" +cp "$source_root"/scripts/{release.sh,check-release.sh,check-core.py,package-notices.py} "$check_root/scripts/" +export SIZED_SOURCE_REVISION="${SIZED_SOURCE_REVISION:-$(git -C "$source_root" rev-parse HEAD 2>/dev/null || printf unknown)}" cd "$check_root" +python3 scripts/check-core.py cargo fmt --all -- --check -cargo test --locked -cargo test --locked --test linux_mount -- --ignored -cargo clippy --locked --all-targets -- -D warnings +cargo test --locked --workspace +cargo test --locked --workspace --test linux_mount -- --ignored +cargo clippy --locked --workspace --all-targets -- -D warnings cargo build --locked --release fixture_root=$(mktemp -d /tmp/sized-release.XXXXXX) @@ -29,4 +35,7 @@ printf 'Linux release smoke test\n' > "$fixture_root/payload" ./target/release/sized --version ./target/release/sized "$fixture_root" --threads 2 --one-file-system --apparent --format json ./scripts/check-release.sh +if [[ -n ${SIZED_RELEASE_DIR:-} ]]; then + ./scripts/release.sh --output-dir "$SIZED_RELEASE_DIR/sized-v2.0.0-$(rustc -vV | sed -n 's/^host: //p')" +fi printf 'Linux checks passed.\n' diff --git a/scripts/check-release.sh b/scripts/check-release.sh index 71b6fa2..07fe2df 100755 --- a/scripts/check-release.sh +++ b/scripts/check-release.sh @@ -7,7 +7,7 @@ trap 'rm -rf "$check_root"' EXIT "$repo_root/scripts/release.sh" --output-dir "$check_root/bundle" mkdir "$check_root/extracted" "$check_root/fixture" tar -xzf "$check_root/bundle.tar.gz" -C "$check_root/extracted" -for required in sized sized.1 sized.bash _sized sized.fish LICENSE README.md MANUAL.md BUILD-INFO.txt; do +for required in sized sized.1 sized.bash _sized sized.fish LICENSE README.md MANUAL.md BUILD-INFO.txt LICENCES.txt DEPENDENCIES.json CORE-SNAPSHOT.json docs/UPGRADING-2.md docs/RELEASE-LICENSING.md; do test -s "$check_root/extracted/$required" done test -x "$check_root/extracted/sized" diff --git a/scripts/notarize-macos.sh b/scripts/notarize-macos.sh new file mode 100755 index 0000000..efca59d --- /dev/null +++ b/scripts/notarize-macos.sh @@ -0,0 +1,18 @@ +#!/usr/bin/env bash +set -euo pipefail +[[ $# == 2 ]] || { echo 'Usage: scripts/notarize-macos.sh PACKAGE_DIRECTORY NEW_DMG_PATH' >&2; exit 2; } +: "${SIZED_SIGN_IDENTITY:?Set a Developer ID Application identity.}" +package=$1 +dmg=$2 +[[ ! -e $dmg && ! -L $dmg ]] || { echo 'Refusing existing DMG.' >&2; exit 1; } +codesign --force --sign "$SIZED_SIGN_IDENTITY" --identifier com.gamertan.sized --options runtime --timestamp "$package/sized" +codesign --verify --strict --verbose=2 "$package/sized" +printf '\nMac distribution: Developer ID signed; see the notarized, stapled DMG.\n' >> "$package/BUILD-INFO.txt" +hdiutil create -quiet -volname 'Sized 2.0.0' -srcfolder "$package" -format UDZO "$dmg" +codesign --sign "$SIZED_SIGN_IDENTITY" --timestamp "$dmg" +xcrun notarytool submit "$dmg" --keychain-profile "${SIZED_NOTARY_PROFILE:-sizequeen-notary}" --wait --output-format json > "$dmg.notarization.json" +test "$(plutil -extract status raw "$dmg.notarization.json")" = Accepted +xcrun stapler staple "$dmg" +xcrun stapler validate "$dmg" +spctl --assess --type open --context context:primary-signature --verbose=2 "$dmg" +echo 'Signed, notarized and stapled disk image verified.' diff --git a/scripts/package-notices.py b/scripts/package-notices.py new file mode 100755 index 0000000..1c5a51f --- /dev/null +++ b/scripts/package-notices.py @@ -0,0 +1,60 @@ +#!/usr/bin/env python3 +"""Preserve complete notices for the actual locked runtime/build crate graph.""" +import argparse +import hashlib +import json +from pathlib import Path +import re +import subprocess + +REVIEWED = {'GPL-3.0-only', 'MIT', 'MIT OR Apache-2.0', 'Apache-2.0 OR MIT', + 'MIT/Apache-2.0', 'Unlicense OR MIT', 'Unlicense/MIT', 'MPL-2.0', + 'Apache-2.0', 'Apache-2.0 OR BSL-1.0', + 'Apache-2.0 WITH LLVM-exception OR Apache-2.0 OR MIT', + 'BSD-2-Clause OR Apache-2.0 OR MIT', + 'Zlib OR Apache-2.0 OR MIT', 'MIT OR Apache-2.0 OR Zlib', + '(MIT OR Apache-2.0) AND Unicode-3.0'} +NOTICE_NAME = re.compile(r'^(licen[cs]e|copying|notice|unlicense|copyright)([-.]|$)', re.I) +p = argparse.ArgumentParser(description=__doc__) +p.add_argument('destination', type=Path) +p.add_argument('--revision', required=True) +a = p.parse_args() +root = Path(__file__).resolve().parent.parent +host = next(x[6:] for x in subprocess.check_output(['rustc', '-vV'], text=True).splitlines() if x.startswith('host: ')) +metadata = json.loads(subprocess.check_output(['cargo', 'metadata', '--locked', '--format-version', '1', '--filter-platform', host], cwd=root, text=True)) +# Cargo metadata includes dev-unified/optional edges; use Cargo's actual normal +# and build tree to select the shipped graph instead of guessing feature edges. +tree = subprocess.check_output(['cargo', 'tree', '--locked', '-p', 'sized', '--target', host, '--edges', 'normal,build', '--prefix', 'none', '--format', '{p}'], cwd=root, text=True) +selected = {tuple(re.match(r'^(\S+) v(\S+)', line).groups()) for line in tree.splitlines()} +packages = sorted([x for x in metadata['packages'] if (x['name'], x['version']) in selected], key=lambda x: (x['name'], x['version'])) +assert len(packages) == len(selected), 'Ambiguous or missing package identity' +texts, inventory = {}, [] +for package in packages: + if package['license'] not in REVIEWED: + raise ValueError(f"Unreviewed licence: {package['name']} {package['license']}") + directory = Path(package['manifest_path']).parent + files = sorted(f for f in directory.iterdir() if f.is_file() and NOTICE_NAME.match(f.name)) + if not files: + raise ValueError(f"Missing licence text: {package['name']}") + notices = [] + for f in files: + data = f.read_bytes(); text = data.decode('utf-8'); assert text.strip() + digest = hashlib.sha256(data).hexdigest() + texts.setdefault(digest, {'labels': [], 'text': text})['labels'].append(f"{package['name']} {package['version']} / {f.name}") + notices.append({'file': f.name, 'sha256': digest}) + inventory.append({'name': package['name'], 'version': package['version'], 'license': package['license'], 'notices': notices}) +header = ['Sized - Licences and credits', '', f'Source revision: {a.revision}', + f'Target: {host}', '', 'Sized and its core are GPL-3.0-only, without warranty.', + 'Matching source, including the pinned core and dependency sources, is available at:', + 'https://gamertan.com/projects/sized/ and the matching Gitea release.', + 'The colored 2.2.0 source remains under MPL-2.0 and is additionally distributed', + 'under GPL-3.0-only as part of this Larger Work under MPL section 3.3.', + 'All original notices are preserved. See docs/RELEASE-LICENSING.md in the source.', '', + 'Runtime and build dependencies (development-only dependencies are excluded):'] +header += [f" {x['name']} {x['version']} - {x['license']}" for x in inventory] +for x in texts.values(): + header += ['', '='*72, '\n'.join(x['labels']), '='*72, x['text']] +a.destination.mkdir(parents=True, exist_ok=True) +(a.destination/'LICENCES.txt').write_text('\n'.join(header)+'\n') +(a.destination/'DEPENDENCIES.json').write_text(json.dumps({'revision': a.revision, 'target': host, 'packages': inventory}, indent=2)+'\n') +print(f'Packaged complete notices for {len(inventory)} runtime/build crates ({host}).') diff --git a/scripts/package-source.sh b/scripts/package-source.sh new file mode 100755 index 0000000..2e8110b --- /dev/null +++ b/scripts/package-source.sh @@ -0,0 +1,31 @@ +#!/usr/bin/env bash +set -euo pipefail +repo_root=$(cd "$(dirname "$0")/.." && pwd) +cd "$repo_root" +[[ $# == 1 && $1 == /* ]] || { echo 'Usage: scripts/package-source.sh ABSOLUTE_NEW_DIRECTORY' >&2; exit 2; } +destination=$1 +[[ ! -e $destination && ! -L $destination ]] || { echo 'Refusing existing source output.' >&2; exit 1; } +git diff --quiet HEAD -- || { echo 'Commit tracked changes before packaging.' >&2; exit 1; } +revision=$(git rev-parse HEAD) +mkdir -p "$destination" +source_dir="$destination/sized-source" +mkdir "$source_dir" +git archive "$revision" | tar -x -C "$source_dir" +mkdir -p "$source_dir/.cargo" +cargo vendor --locked --versioned-dirs --manifest-path "$source_dir/Cargo.toml" "$source_dir/vendor" > "$destination/vendor-config" +sed 's|directory = ".*"|directory = "vendor"|' "$destination/vendor-config" > "$source_dir/.cargo/config.toml" +printf '%s\n' "$revision" > "$source_dir/SOURCE-REVISION.txt" +cat > "$source_dir/BUILD-OFFLINE.txt" < "$destination/SOURCE-REVISION.txt" +echo "Verified offline source: $destination/sized-v2.0.0-source.tar.gz" diff --git a/scripts/release.sh b/scripts/release.sh index 93c9f0a..ee19eb0 100755 --- a/scripts/release.sh +++ b/scripts/release.sh @@ -21,6 +21,7 @@ done target_dir=${CARGO_TARGET_DIR:-"$repo_root/target"} [[ $target_dir == /* ]] || target_dir="$repo_root/$target_dir" +python3 scripts/check-core.py cargo build --locked --release --target "$target" --target-dir "$target_dir" binary="$target_dir/$target/release/sized" mkdir -p "$destination" @@ -29,11 +30,13 @@ install -m 755 "$binary" "$destination/sized" "$binary" --completions bash > "$destination/sized.bash" "$binary" --completions zsh > "$destination/_sized" "$binary" --completions fish > "$destination/sized.fish" -cp LICENSE README.md MANUAL.md "$destination/" +cp LICENSE README.md MANUAL.md CORE-SNAPSHOT.json "$destination/" +cp -R docs "$destination/" +python3 scripts/package-notices.py "$destination" --revision "$revision" { printf 'Version: %s\nTarget: %s\nSource revision: %s\n' "$version" "$target" "$revision" printf 'Source worktree: ' - if git rev-parse --is-inside-work-tree >/dev/null 2>&1; then + if [[ $(git rev-parse --show-toplevel 2>/dev/null || true) == "$repo_root" ]]; then if git diff --quiet HEAD --; then printf 'clean tracked files\n'; else printf 'modified tracked files\n'; fi else printf 'exported source; verify against supplied revision\n' diff --git a/sized.1 b/sized.1 index 77cfaf0..de6db2b 100644 --- a/sized.1 +++ b/sized.1 @@ -1,6 +1,6 @@ .ie \n(.g .ds Aq \(aq .el .ds Aq ' -.TH sized 1 "sized 1.0.0" +.TH sized 1 "sized 2.0.0" .SH NAME sized \- A modern, fast, and concurrent disk usage analyzer .SH SYNOPSIS @@ -78,4 +78,4 @@ Print help [\fIPATH\fR] [default: .] Directory to analyze .SH VERSION -v1.0.0 +v2.0.0 diff --git a/src/lib.rs b/src/lib.rs index 8f921ab..376fba3 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -8,11 +8,11 @@ use comfy_table::{Attribute, Cell, CellAlignment, Color, ContentArrangement, Tab use csv::WriterBuilder; use std::cmp::Ordering; use std::io::Write; -use std::path::{Path, PathBuf}; +use std::path::PathBuf; use std::str::FromStr; -pub mod scan; -pub use scan::{ +pub use scanner_core::{build_tree, scan}; +pub use scanner_core::{ scan_tree, EntryType, FileIdentity, Node, ScanControl, ScanError, ScanIssue, ScanOptions, ScanReport, }; @@ -238,21 +238,6 @@ pub fn run(args: Args, mut writer: &mut dyn Write) -> bool { root_node.complete } -pub fn build_tree(path: &Path, ignore: bool, compare: bool) -> Node { - // Compatibility helper; callers needing diagnostics should use scan_tree. - scan_tree( - path, - &ScanOptions { - respect_ignore: ignore, - compare_ignore: compare, - ..ScanOptions::default() - }, - &ScanControl::default(), - ) - .map(|report| report.root) - .unwrap_or_else(|_| Node::unavailable(path)) -} - fn process_node_recursive( writer: &mut dyn Write, node: &Node, diff --git a/tests/cli.rs b/tests/cli.rs index a2b6381..254f91f 100644 --- a/tests/cli.rs +++ b/tests/cli.rs @@ -11,7 +11,7 @@ fn test_basic_cli_run() { cmd.arg("--version") .assert() .success() - .stdout(predicate::str::contains("sized 1.0.0")); + .stdout(predicate::str::contains("sized 2.0.0")); } #[test]