mirror of
https://github.com/darakian/ddh.git
synced 2026-09-10 07:06:21 -04:00
Compare commits
86 commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
aac9046fbf | ||
|
baeb5fdce8 | ||
|
|
a4c09f1d57 | ||
|
|
f47653df0a | ||
|
9d65837b6f | ||
|
|
bd48793d1a | ||
|
|
c4c3078959 | ||
|
|
18db05e14c | ||
|
abdb42efe6 | ||
|
|
35dd1fc967 | ||
|
|
ebc1de7706 | ||
|
|
df8e04c117 | ||
|
|
f54ba5d6f8 | ||
|
|
11ac86f882 | ||
|
|
e1fc3fb949 | ||
|
|
029b881f7e | ||
|
|
dda2b4d529 | ||
|
|
39f0c5f530 | ||
|
|
981d04b4e3 | ||
|
|
debf74859e | ||
|
|
73da6f76a6 | ||
|
|
4d71a84a05 | ||
|
|
98b1955538 | ||
|
|
166401766a | ||
|
|
e4c574ffd9 | ||
|
|
6c60d41d11 | ||
|
|
d893039975 | ||
|
|
f566fecf47 | ||
|
|
5e14d491ea | ||
|
|
2b5cce4dbc | ||
|
ea9778cabc | ||
|
|
1c7550d697 | ||
|
|
4961458f27 | ||
|
|
a037edc577 | ||
|
|
3a53f0c375 | ||
|
|
4c1a7a3118 | ||
|
|
c9abf2bca4 | ||
|
|
8789621cdf | ||
|
|
168f48c1e9 | ||
|
|
20834278af | ||
|
|
fd25477f1f | ||
|
|
cff206b817 | ||
|
|
85260e822a | ||
|
|
564ff78666 | ||
|
|
be232991e8 | ||
|
|
46c6e72abf | ||
|
|
513de13295 | ||
|
|
78cd7f284b | ||
|
|
26e645d88a | ||
|
|
c8478035ac | ||
|
|
89b2e8d439 | ||
|
|
cb44786864 | ||
|
|
7035276acd | ||
|
|
c147bac7b5 | ||
|
|
3636ebf424 | ||
|
|
806821e6cc | ||
|
|
4e7c67c926 | ||
|
|
c68d7640d5 | ||
|
|
ec63f1d9a7 | ||
|
|
2eed388ff9 | ||
|
|
2992e6c0fd | ||
|
|
dddf30caa1 | ||
|
|
92f2f62350 | ||
|
|
0e7ffbe699 | ||
|
|
5360ce1477 | ||
|
|
927d1bab3d | ||
|
|
4c8a32d73a | ||
|
|
3fcbe2a475 | ||
|
|
720de9111c | ||
|
|
98684c83f5 | ||
|
|
1630cb9dd0 | ||
|
|
031a5783aa | ||
|
|
d340ccac47 | ||
|
|
3e49650335 | ||
|
6e44732dda | ||
|
|
1d4f4922ba | ||
|
|
35b5e2e801 | ||
|
34a80ec233 | ||
|
|
fb1dc95010 | ||
|
|
052d35fc2a | ||
|
|
a55235e573 | ||
|
|
0048d5009b | ||
|
|
1fe72df294 | ||
|
|
701ef480b2 | ||
|
|
2c7ee5e83d | ||
|
|
0e31253de3 |
15
.github/workflows/rust.yml
vendored
Normal file
15
.github/workflows/rust.yml
vendored
Normal file
|
|
@ -0,0 +1,15 @@
|
|||
name: Rust
|
||||
|
||||
on: [pull_request]
|
||||
|
||||
jobs:
|
||||
build:
|
||||
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v1
|
||||
- name: Build
|
||||
run: cargo build --verbose
|
||||
- name: Run tests
|
||||
run: cargo test --verbose
|
||||
1
.gitignore
vendored
1
.gitignore
vendored
|
|
@ -1,4 +1,3 @@
|
|||
*.lock
|
||||
target/
|
||||
Results.txt
|
||||
.DS_Store
|
||||
|
|
|
|||
10
.travis.yml
10
.travis.yml
|
|
@ -1,10 +0,0 @@
|
|||
language: rust
|
||||
|
||||
rust:
|
||||
- stable
|
||||
script:
|
||||
- cargo build --verbose --all
|
||||
- cargo test --verbose --all
|
||||
- cargo clean
|
||||
- cargo build --release --all
|
||||
- cargo test --verbose --all
|
||||
371
Cargo.lock
generated
Normal file
371
Cargo.lock
generated
Normal file
|
|
@ -0,0 +1,371 @@
|
|||
# This file is automatically @generated by Cargo.
|
||||
# It is not intended for manual editing.
|
||||
version = 3
|
||||
|
||||
[[package]]
|
||||
name = "atty"
|
||||
version = "0.2.14"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "d9b39be18770d11421cdb1b9947a45dd3f37e93092cbf377614828a319d5fee8"
|
||||
dependencies = [
|
||||
"hermit-abi",
|
||||
"libc",
|
||||
"winapi",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "autocfg"
|
||||
version = "1.0.1"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "cdb031dd78e28731d87d56cc8ffef4a8f36ca26c38fe2de700543e627f8a464a"
|
||||
|
||||
[[package]]
|
||||
name = "bitflags"
|
||||
version = "1.3.2"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "bef38d45163c2f1dde094a7dfd33ccf595c92905c8f8f4fdc18d06fb1037718a"
|
||||
|
||||
[[package]]
|
||||
name = "cfg-if"
|
||||
version = "1.0.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "baf1de4339761588bc0619e3cbc0120ee582ebb74b53b4efbf79117bd2da40fd"
|
||||
|
||||
[[package]]
|
||||
name = "clap"
|
||||
version = "4.0.23"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "0eb41c13df48950b20eb4cd0eefa618819469df1bffc49d11e8487c4ba0037e5"
|
||||
dependencies = [
|
||||
"atty",
|
||||
"bitflags",
|
||||
"clap_derive",
|
||||
"clap_lex",
|
||||
"once_cell",
|
||||
"strsim",
|
||||
"termcolor",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "clap_derive"
|
||||
version = "4.0.21"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "0177313f9f02afc995627906bbd8967e2be069f5261954222dac78290c2b9014"
|
||||
dependencies = [
|
||||
"heck",
|
||||
"proc-macro-error",
|
||||
"proc-macro2",
|
||||
"quote",
|
||||
"syn",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "clap_lex"
|
||||
version = "0.3.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "0d4198f73e42b4936b35b5bb248d81d2b595ecb170da0bac7655c54eedfa8da8"
|
||||
dependencies = [
|
||||
"os_str_bytes",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "crossbeam-channel"
|
||||
version = "0.5.2"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "e54ea8bc3fb1ee042f5aace6e3c6e025d3874866da222930f70ce62aceba0bfa"
|
||||
dependencies = [
|
||||
"cfg-if",
|
||||
"crossbeam-utils",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "crossbeam-deque"
|
||||
version = "0.8.1"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "6455c0ca19f0d2fbf751b908d5c55c1f5cbc65e03c4225427254b46890bdde1e"
|
||||
dependencies = [
|
||||
"cfg-if",
|
||||
"crossbeam-epoch",
|
||||
"crossbeam-utils",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "crossbeam-epoch"
|
||||
version = "0.9.6"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "97242a70df9b89a65d0b6df3c4bf5b9ce03c5b7309019777fbde37e7537f8762"
|
||||
dependencies = [
|
||||
"cfg-if",
|
||||
"crossbeam-utils",
|
||||
"lazy_static",
|
||||
"memoffset",
|
||||
"scopeguard",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "crossbeam-utils"
|
||||
version = "0.8.12"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "edbafec5fa1f196ca66527c1b12c2ec4745ca14b50f1ad8f9f6f720b55d11fac"
|
||||
dependencies = [
|
||||
"cfg-if",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "ddh"
|
||||
version = "0.12.0"
|
||||
dependencies = [
|
||||
"clap",
|
||||
"nohash-hasher",
|
||||
"rayon",
|
||||
"serde",
|
||||
"serde_json",
|
||||
"siphasher",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "either"
|
||||
version = "1.6.1"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "e78d4f1cc4ae33bbfc157ed5d5a5ef3bc29227303d595861deb238fcec4e9457"
|
||||
|
||||
[[package]]
|
||||
name = "heck"
|
||||
version = "0.4.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "2540771e65fc8cb83cd6e8a237f70c319bd5c29f78ed1084ba5d50eeac86f7f9"
|
||||
|
||||
[[package]]
|
||||
name = "hermit-abi"
|
||||
version = "0.1.19"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "62b467343b94ba476dcb2500d242dadbb39557df889310ac77c5d99100aaac33"
|
||||
dependencies = [
|
||||
"libc",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "itoa"
|
||||
version = "1.0.1"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "1aab8fc367588b89dcee83ab0fd66b72b50b72fa1904d7095045ace2b0c81c35"
|
||||
|
||||
[[package]]
|
||||
name = "lazy_static"
|
||||
version = "1.4.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "e2abad23fbc42b3700f2f279844dc832adb2b2eb069b2df918f455c4e18cc646"
|
||||
|
||||
[[package]]
|
||||
name = "libc"
|
||||
version = "0.2.113"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "eef78b64d87775463c549fbd80e19249ef436ea3bf1de2a1eb7e717ec7fab1e9"
|
||||
|
||||
[[package]]
|
||||
name = "memoffset"
|
||||
version = "0.6.5"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "5aa361d4faea93603064a027415f07bd8e1d5c88c9fbf68bf56a285428fd79ce"
|
||||
dependencies = [
|
||||
"autocfg",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "nohash-hasher"
|
||||
version = "0.2.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "2bf50223579dc7cdcfb3bfcacf7069ff68243f8c363f62ffa99cf000a6b9c451"
|
||||
|
||||
[[package]]
|
||||
name = "num_cpus"
|
||||
version = "1.13.1"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "19e64526ebdee182341572e50e9ad03965aa510cd94427a4549448f285e957a1"
|
||||
dependencies = [
|
||||
"hermit-abi",
|
||||
"libc",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "once_cell"
|
||||
version = "1.16.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "86f0b0d4bf799edbc74508c1e8bf170ff5f41238e5f8225603ca7caaae2b7860"
|
||||
|
||||
[[package]]
|
||||
name = "os_str_bytes"
|
||||
version = "6.0.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "8e22443d1643a904602595ba1cd8f7d896afe56d26712531c5ff73a15b2fbf64"
|
||||
|
||||
[[package]]
|
||||
name = "proc-macro-error"
|
||||
version = "1.0.4"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "da25490ff9892aab3fcf7c36f08cfb902dd3e71ca0f9f9517bea02a73a5ce38c"
|
||||
dependencies = [
|
||||
"proc-macro-error-attr",
|
||||
"proc-macro2",
|
||||
"quote",
|
||||
"syn",
|
||||
"version_check",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "proc-macro-error-attr"
|
||||
version = "1.0.4"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "a1be40180e52ecc98ad80b184934baf3d0d29f979574e439af5a55274b35f869"
|
||||
dependencies = [
|
||||
"proc-macro2",
|
||||
"quote",
|
||||
"version_check",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "proc-macro2"
|
||||
version = "1.0.47"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "5ea3d908b0e36316caf9e9e2c4625cdde190a7e6f440d794667ed17a1855e725"
|
||||
dependencies = [
|
||||
"unicode-ident",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "quote"
|
||||
version = "1.0.21"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "bbe448f377a7d6961e30f5955f9b8d106c3f5e449d493ee1b125c1d43c2b5179"
|
||||
dependencies = [
|
||||
"proc-macro2",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "rayon"
|
||||
version = "1.5.1"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "c06aca804d41dbc8ba42dfd964f0d01334eceb64314b9ecf7c5fad5188a06d90"
|
||||
dependencies = [
|
||||
"autocfg",
|
||||
"crossbeam-deque",
|
||||
"either",
|
||||
"rayon-core",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "rayon-core"
|
||||
version = "1.9.1"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "d78120e2c850279833f1dd3582f730c4ab53ed95aeaaaa862a2a5c71b1656d8e"
|
||||
dependencies = [
|
||||
"crossbeam-channel",
|
||||
"crossbeam-deque",
|
||||
"crossbeam-utils",
|
||||
"lazy_static",
|
||||
"num_cpus",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "ryu"
|
||||
version = "1.0.9"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "73b4b750c782965c211b42f022f59af1fbceabdd026623714f104152f1ec149f"
|
||||
|
||||
[[package]]
|
||||
name = "scopeguard"
|
||||
version = "1.1.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "d29ab0c6d3fc0ee92fe66e2d99f700eab17a8d57d1c1d3b748380fb20baa78cd"
|
||||
|
||||
[[package]]
|
||||
name = "serde"
|
||||
version = "1.0.135"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "2cf9235533494ea2ddcdb794665461814781c53f19d87b76e571a1c35acbad2b"
|
||||
|
||||
[[package]]
|
||||
name = "serde_json"
|
||||
version = "1.0.78"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "d23c1ba4cf0efd44be32017709280b32d1cea5c3f1275c3b6d9e8bc54f758085"
|
||||
dependencies = [
|
||||
"itoa",
|
||||
"ryu",
|
||||
"serde",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "siphasher"
|
||||
version = "0.3.9"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "a86232ab60fa71287d7f2ddae4a7073f6b7aac33631c3015abb556f08c6d0a3e"
|
||||
|
||||
[[package]]
|
||||
name = "strsim"
|
||||
version = "0.10.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "73473c0e59e6d5812c5dfe2a064a6444949f089e20eec9a2e5506596494e4623"
|
||||
|
||||
[[package]]
|
||||
name = "syn"
|
||||
version = "1.0.103"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "a864042229133ada95abf3b54fdc62ef5ccabe9515b64717bcb9a1919e59445d"
|
||||
dependencies = [
|
||||
"proc-macro2",
|
||||
"quote",
|
||||
"unicode-ident",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "termcolor"
|
||||
version = "1.1.2"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "2dfed899f0eb03f32ee8c6a0aabdb8a7949659e3466561fc0adf54e26d88c5f4"
|
||||
dependencies = [
|
||||
"winapi-util",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "unicode-ident"
|
||||
version = "1.0.5"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "6ceab39d59e4c9499d4e5a8ee0e2735b891bb7308ac83dfb4e80cad195c9f6f3"
|
||||
|
||||
[[package]]
|
||||
name = "version_check"
|
||||
version = "0.9.4"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "49874b5167b65d7193b8aba1567f5c7d93d001cafc34600cee003eda787e483f"
|
||||
|
||||
[[package]]
|
||||
name = "winapi"
|
||||
version = "0.3.9"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "5c839a674fcd7a98952e593242ea400abe93992746761e38641405d28b00f419"
|
||||
dependencies = [
|
||||
"winapi-i686-pc-windows-gnu",
|
||||
"winapi-x86_64-pc-windows-gnu",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "winapi-i686-pc-windows-gnu"
|
||||
version = "0.4.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "ac3b87c63620426dd9b991e5ce0329eff545bccbbb34f3be09ff6fb6ab51b7b6"
|
||||
|
||||
[[package]]
|
||||
name = "winapi-util"
|
||||
version = "0.1.5"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "70ec6ce85bb158151cae5e5c87f95a8e97d2c0c4b001223f33a334e3ce5de178"
|
||||
dependencies = [
|
||||
"winapi",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "winapi-x86_64-pc-windows-gnu"
|
||||
version = "0.4.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "712e227841d057c1ee1cd2fb22fa7e5a5461ae8e48fa2ca79ec42cfc1931183f"
|
||||
12
Cargo.toml
12
Cargo.toml
|
|
@ -1,24 +1,24 @@
|
|||
[package]
|
||||
name = "ddh"
|
||||
version = "0.10.6"
|
||||
version = "0.13.0"
|
||||
authors = ["Jon Moroney <jmoroney@hawaii.edu>"]
|
||||
edition = "2018"
|
||||
description = "Compare and contrast directories"
|
||||
license = "MIT"
|
||||
license = "LGPL-3.0"
|
||||
homepage = "https://github.com/darakian/ddh"
|
||||
repository = "https://github.com/darakian/ddh"
|
||||
documentation = "https://docs.rs/ddh"
|
||||
readme = "README.md"
|
||||
|
||||
[dependencies]
|
||||
clap = "2.33.0"
|
||||
rayon = "1.1"
|
||||
clap = { version = "4.0.0", features = ["derive"] }
|
||||
rayon = "1.4"
|
||||
serde = "1.0"
|
||||
serde_json = "1.0"
|
||||
serde_derive = "1.0"
|
||||
siphasher = "0.3"
|
||||
nohash-hasher = "0.1.1"
|
||||
nohash-hasher = "0.2"
|
||||
|
||||
[profile.release]
|
||||
lto = true
|
||||
debug=false
|
||||
opt-level = 3
|
||||
|
|
|
|||
854
LICENSE
854
LICENSE
|
|
@ -1,21 +1,841 @@
|
|||
MIT License
|
||||
GNU LESSER GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright (c) 2018 Jon Moroney
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
This version of the GNU Lesser General Public License incorporates
|
||||
the terms and conditions of version 3 of the GNU General Public
|
||||
License, supplemented by the additional permissions listed below.
|
||||
|
||||
0. Additional Definitions.
|
||||
|
||||
As used herein, "this License" refers to version 3 of the GNU Lesser
|
||||
General Public License, and the "GNU GPL" refers to version 3 of the GNU
|
||||
General Public License.
|
||||
|
||||
"The Library" refers to a covered work governed by this License,
|
||||
other than an Application or a Combined Work as defined below.
|
||||
|
||||
An "Application" is any work that makes use of an interface provided
|
||||
by the Library, but which is not otherwise based on the Library.
|
||||
Defining a subclass of a class defined by the Library is deemed a mode
|
||||
of using an interface provided by the Library.
|
||||
|
||||
A "Combined Work" is a work produced by combining or linking an
|
||||
Application with the Library. The particular version of the Library
|
||||
with which the Combined Work was made is also called the "Linked
|
||||
Version".
|
||||
|
||||
The "Minimal Corresponding Source" for a Combined Work means the
|
||||
Corresponding Source for the Combined Work, excluding any source code
|
||||
for portions of the Combined Work that, considered in isolation, are
|
||||
based on the Application, and not on the Linked Version.
|
||||
|
||||
The "Corresponding Application Code" for a Combined Work means the
|
||||
object code and/or source code for the Application, including any data
|
||||
and utility programs needed for reproducing the Combined Work from the
|
||||
Application, but excluding the System Libraries of the Combined Work.
|
||||
|
||||
1. Exception to Section 3 of the GNU GPL.
|
||||
|
||||
You may convey a covered work under sections 3 and 4 of this License
|
||||
without being bound by section 3 of the GNU GPL.
|
||||
|
||||
2. Conveying Modified Versions.
|
||||
|
||||
If you modify a copy of the Library, and, in your modifications, a
|
||||
facility refers to a function or data to be supplied by an Application
|
||||
that uses the facility (other than as an argument passed when the
|
||||
facility is invoked), then you may convey a copy of the modified
|
||||
version:
|
||||
|
||||
a) under this License, provided that you make a good faith effort to
|
||||
ensure that, in the event an Application does not supply the
|
||||
function or data, the facility still operates, and performs
|
||||
whatever part of its purpose remains meaningful, or
|
||||
|
||||
b) under the GNU GPL, with none of the additional permissions of
|
||||
this License applicable to that copy.
|
||||
|
||||
3. Object Code Incorporating Material from Library Header Files.
|
||||
|
||||
The object code form of an Application may incorporate material from
|
||||
a header file that is part of the Library. You may convey such object
|
||||
code under terms of your choice, provided that, if the incorporated
|
||||
material is not limited to numerical parameters, data structure
|
||||
layouts and accessors, or small macros, inline functions and templates
|
||||
(ten or fewer lines in length), you do both of the following:
|
||||
|
||||
a) Give prominent notice with each copy of the object code that the
|
||||
Library is used in it and that the Library and its use are
|
||||
covered by this License.
|
||||
|
||||
b) Accompany the object code with a copy of the GNU GPL and this license
|
||||
document.
|
||||
|
||||
4. Combined Works.
|
||||
|
||||
You may convey a Combined Work under terms of your choice that,
|
||||
taken together, effectively do not restrict modification of the
|
||||
portions of the Library contained in the Combined Work and reverse
|
||||
engineering for debugging such modifications, if you also do each of
|
||||
the following:
|
||||
|
||||
a) Give prominent notice with each copy of the Combined Work that
|
||||
the Library is used in it and that the Library and its use are
|
||||
covered by this License.
|
||||
|
||||
b) Accompany the Combined Work with a copy of the GNU GPL and this license
|
||||
document.
|
||||
|
||||
c) For a Combined Work that displays copyright notices during
|
||||
execution, include the copyright notice for the Library among
|
||||
these notices, as well as a reference directing the user to the
|
||||
copies of the GNU GPL and this license document.
|
||||
|
||||
d) Do one of the following:
|
||||
|
||||
0) Convey the Minimal Corresponding Source under the terms of this
|
||||
License, and the Corresponding Application Code in a form
|
||||
suitable for, and under terms that permit, the user to
|
||||
recombine or relink the Application with a modified version of
|
||||
the Linked Version to produce a modified Combined Work, in the
|
||||
manner specified by section 6 of the GNU GPL for conveying
|
||||
Corresponding Source.
|
||||
|
||||
1) Use a suitable shared library mechanism for linking with the
|
||||
Library. A suitable mechanism is one that (a) uses at run time
|
||||
a copy of the Library already present on the user's computer
|
||||
system, and (b) will operate properly with a modified version
|
||||
of the Library that is interface-compatible with the Linked
|
||||
Version.
|
||||
|
||||
e) Provide Installation Information, but only if you would otherwise
|
||||
be required to provide such information under section 6 of the
|
||||
GNU GPL, and only to the extent that such information is
|
||||
necessary to install and execute a modified version of the
|
||||
Combined Work produced by recombining or relinking the
|
||||
Application with a modified version of the Linked Version. (If
|
||||
you use option 4d0, the Installation Information must accompany
|
||||
the Minimal Corresponding Source and Corresponding Application
|
||||
Code. If you use option 4d1, you must provide the Installation
|
||||
Information in the manner specified by section 6 of the GNU GPL
|
||||
for conveying Corresponding Source.)
|
||||
|
||||
5. Combined Libraries.
|
||||
|
||||
You may place library facilities that are a work based on the
|
||||
Library side by side in a single library together with other library
|
||||
facilities that are not Applications and are not covered by this
|
||||
License, and convey such a combined library under terms of your
|
||||
choice, if you do both of the following:
|
||||
|
||||
a) Accompany the combined library with a copy of the same work based
|
||||
on the Library, uncombined with any other library facilities,
|
||||
conveyed under the terms of this License.
|
||||
|
||||
b) Give prominent notice with the combined library that part of it
|
||||
is a work based on the Library, and explaining where to find the
|
||||
accompanying uncombined form of the same work.
|
||||
|
||||
6. Revised Versions of the GNU Lesser General Public License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions
|
||||
of the GNU Lesser 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
|
||||
Library as you received it specifies that a certain numbered version
|
||||
of the GNU Lesser General Public License "or any later version"
|
||||
applies to it, you have the option of following the terms and
|
||||
conditions either of that published version or of any later version
|
||||
published by the Free Software Foundation. If the Library as you
|
||||
received it does not specify a version number of the GNU Lesser
|
||||
General Public License, you may choose any version of the GNU Lesser
|
||||
General Public License ever published by the Free Software Foundation.
|
||||
|
||||
If the Library as you received it specifies that a proxy can decide
|
||||
whether future versions of the GNU Lesser General Public License shall
|
||||
apply, that proxy's public statement of acceptance of any version is
|
||||
permanent authorization for you to choose that version for the
|
||||
Library.
|
||||
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||
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.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
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 <https://www.gnu.org/licenses/>.
|
||||
|
||||
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:
|
||||
|
||||
<program> Copyright (C) <year> <name of author>
|
||||
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
|
||||
<https://www.gnu.org/licenses/>.
|
||||
|
||||
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
|
||||
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
|
|
|
|||
45
README.md
45
README.md
|
|
@ -1,8 +1,3 @@
|
|||
### Linux Build Status
|
||||
[](https://travis-ci.org/darakian/ddh)
|
||||
### Windows Build Status
|
||||
[](https://ci.appveyor.com/project/darakian/ddh)
|
||||
|
||||
# The **D**irectory **D**ifferential **h**Tool
|
||||
DDH traverses input directories and their subdirectories. It also hashes files as needed and reports findings.
|
||||
|
||||
|
|
@ -16,7 +11,7 @@ This tool is called DDH for two very good reasons.
|
|||
DDH is usable both as a library and as a stand alone CLI tool and aims to be simple to use in both cases.
|
||||
|
||||
## Library example
|
||||
```
|
||||
```rust
|
||||
let (files, errors): (Vec<Fileinfo>, Vec<(_, _)>) = ddh::deduplicate_dirs(dirs);
|
||||
let (shared, unique): (Vec<&Fileinfo>, Vec<&Fileinfo>) = files
|
||||
.par_iter()
|
||||
|
|
@ -37,25 +32,31 @@ DDH supports both a `standard` output for human comprehension and a parsable `js
|
|||
Directory Difference hTool
|
||||
Jon Moroney jmoroney@hawaii.edu
|
||||
Compare and contrast directories.
|
||||
Example invocation: ddh /home/jon/downloads /home/jon/documents -f duplicates
|
||||
Example pipe: ddh ~/Downloads/ -o no -v all -f json | someJsonParser.bin
|
||||
|
||||
USAGE:
|
||||
ddh [OPTIONS] <Directories>...
|
||||
Example invocation: ddh -v duplicates -d /home/jon/downloads /home/jon/documents
|
||||
Example pipe: ddh -o no -v all -f json -d ~/Downloads/ | someJsonParser.bin
|
||||
|
||||
FLAGS:
|
||||
-h, --help Prints help information
|
||||
-V, --version Prints version information
|
||||
Usage: ddh [OPTIONS]
|
||||
|
||||
OPTIONS:
|
||||
-b, --blocksize <Blocksize> Sets the display blocksize to Bytes, Kilobytes, Megabytes or Gigabytes. Default is
|
||||
Kilobytes. [possible values: B, K, M, G]
|
||||
-f, --format <Format> Sets output format. [possible values: standard, json, off]
|
||||
-o, --output <Output> Sets file to save all output. Use 'no' for no file output.
|
||||
-v, --verbosity <Verbosity> Sets verbosity for printed output. [possible values: quiet, duplicates, all]
|
||||
|
||||
ARGS:
|
||||
<Directories>... Directories to parse
|
||||
Options:
|
||||
-m, --minimum [<MIN_SIZE>]
|
||||
Minimum file size in bytes to consider [default: 0]
|
||||
-b, --blocksize [<BLOCKSIZE>]
|
||||
Set the display blocksize to Bytes, Kilobytes, Megabytes or Gigabytes [default: K] [possible values: B, K, M, G]
|
||||
-v, --verbosity [<VERBOSITY>]
|
||||
Set verbosity for printed output [default: quiet] [possible values: quiet, duplicates, all]
|
||||
-o, --output [<OUTPUT>]
|
||||
Set file to save all output. Use 'no' for no file output [default: Results.txt]
|
||||
-f, --format [<FMT>]
|
||||
Set output format [default: standard] [possible values: standard, json]
|
||||
-i, --ignore <IGNORE_DIRS>
|
||||
Directories to ignore (comma separated list)
|
||||
-d, --directories <DIRECTORIES>...
|
||||
Directories to parse
|
||||
-h, --help
|
||||
Print help information (use `--help` for more detail)
|
||||
-V, --version
|
||||
Print version information
|
||||
```
|
||||
## How Does DDH Work?
|
||||
DDH works by hashing files to determine their uniqueness and, as such, depends heavily on disk speeds for performance. The algorithmic choices in use are discussed [here](https://darakian.github.io/2018/04/02/how-many-bytes-does-it-take.html).
|
||||
|
|
|
|||
33
appveyor.yml
33
appveyor.yml
|
|
@ -1,33 +0,0 @@
|
|||
version: 9.6.{build}
|
||||
image: Visual Studio 2017
|
||||
install:
|
||||
- cmd: >-
|
||||
appveyor-retry appveyor DownloadFile https://win.rustup.rs/ -FileName rustup-init.exe
|
||||
|
||||
rustup-init.exe -y
|
||||
|
||||
set PATH=%PATH%;C:\Users\appveyor\.cargo\bin
|
||||
|
||||
rustc -V
|
||||
|
||||
cargo -V
|
||||
build_script:
|
||||
- cmd: cargo build --release
|
||||
after_test:
|
||||
- cmd: >-
|
||||
cargo build --verbose
|
||||
|
||||
cargo test
|
||||
artifacts:
|
||||
- path: target/release/ddh.exe
|
||||
name: ddh
|
||||
deploy:
|
||||
- provider: GitHub
|
||||
tag: win64-$(appveyor_build_version)
|
||||
description: DDH windows build
|
||||
auth_token:
|
||||
secure: WFr7LYW7Ios3cmmcG1YzM/etQ/xx1yGGlv37J3F9OhVcka5BdZCcTSdSo5MP08/k
|
||||
draft: false
|
||||
prerelease: false
|
||||
on:
|
||||
branch: release
|
||||
234
src/fileinfo.rs
Normal file
234
src/fileinfo.rs
Normal file
|
|
@ -0,0 +1,234 @@
|
|||
use serde::ser::{Serialize, SerializeStruct, Serializer};
|
||||
use siphasher::sip128::Hasher128;
|
||||
use std::cmp::Ordering;
|
||||
use std::fs::{self, Metadata};
|
||||
use std::hash::Hasher;
|
||||
use std::io::Read;
|
||||
use std::path::PathBuf;
|
||||
|
||||
const BLOCK_SIZE: usize = 4096;
|
||||
|
||||
#[derive(PartialEq)]
|
||||
pub enum HashMode {
|
||||
Full,
|
||||
Partial,
|
||||
}
|
||||
|
||||
/// Serializable struct containing entries for a specific file. These structs will identify individual files as a collection of paths and associated hash and length data.
|
||||
#[derive(Debug)]
|
||||
pub struct Fileinfo {
|
||||
full_hash: Option<u128>,
|
||||
partial_hash: Option<u128>,
|
||||
metadata: Metadata,
|
||||
pub(crate) file_paths: Vec<PathBuf>,
|
||||
}
|
||||
|
||||
impl Fileinfo {
|
||||
/// Creates a new Fileinfo collection struct.
|
||||
///
|
||||
/// # Examples
|
||||
/// ```no_run
|
||||
/// use std::path::Path;
|
||||
/// use ddh::fileinfo::Fileinfo;
|
||||
/// use std::fs;
|
||||
///
|
||||
/// fn main() -> std::io::Result<()> {
|
||||
/// Fileinfo::new(
|
||||
/// None,
|
||||
/// None,
|
||||
/// fs::metadata("./foo/bar.txt")?,
|
||||
/// Path::new("./foo/bar.txt").to_path_buf()
|
||||
/// );
|
||||
/// Ok(())
|
||||
/// }
|
||||
/// ```
|
||||
pub fn new(full: Option<u128>, partial: Option<u128>, meta: Metadata, path: PathBuf) -> Self {
|
||||
Fileinfo {
|
||||
full_hash: full,
|
||||
partial_hash: partial,
|
||||
metadata: meta,
|
||||
file_paths: vec![path],
|
||||
}
|
||||
}
|
||||
/// Gets the length of the files in the current collection.
|
||||
///
|
||||
/// # Examples
|
||||
/// ```no_run
|
||||
/// use std::path::Path;
|
||||
/// use ddh::fileinfo::Fileinfo;
|
||||
/// use std::fs;
|
||||
///
|
||||
/// fn main() -> std::io::Result<()> {
|
||||
/// let fi = Fileinfo::new(None, None, fs::metadata("./foo/bar.txt")?, Path::new("./foo/bar.txt").to_path_buf());
|
||||
/// let len = fi.get_length();
|
||||
/// assert_eq!(3, len);
|
||||
/// Ok(())
|
||||
/// }
|
||||
/// ```
|
||||
pub fn get_length(&self) -> u64 {
|
||||
self.metadata.len()
|
||||
}
|
||||
/// Gets the hash of the full file if available.
|
||||
///
|
||||
/// # Examples
|
||||
/// ```no_run
|
||||
/// use std::path::Path;
|
||||
/// use ddh::fileinfo::Fileinfo;
|
||||
/// use std::fs;
|
||||
///
|
||||
/// fn main() -> std::io::Result<()> {
|
||||
/// let fi = Fileinfo::new(Some(123), None, fs::metadata("./foo/bar.txt")?, Path::new("./foo/bar.txt").to_path_buf());
|
||||
/// let f_hash = fi.get_full_hash();
|
||||
/// assert_eq!(Some(123), f_hash);
|
||||
/// Ok(())
|
||||
/// }
|
||||
/// ```
|
||||
pub fn get_full_hash(&self) -> Option<u128> {
|
||||
self.full_hash
|
||||
}
|
||||
pub(crate) fn set_full_hash(&mut self, hash: Option<u128>) {
|
||||
self.full_hash = hash
|
||||
}
|
||||
/// Gets the hash of the partially read file if available.
|
||||
///
|
||||
/// # Examples
|
||||
/// ```no_run
|
||||
/// use std::path::Path;
|
||||
/// use ddh::fileinfo::Fileinfo;
|
||||
/// use std::fs;
|
||||
///
|
||||
/// fn main() -> std::io::Result<()> {
|
||||
/// let fi = Fileinfo::new(None, Some(123), fs::metadata("./foo/bar.txt")?, Path::new("./foo/bar.txt").to_path_buf());
|
||||
/// let p_hash = fi.get_partial_hash();
|
||||
/// assert_eq!(Some(123), p_hash);
|
||||
/// Ok(())
|
||||
/// }
|
||||
/// ```
|
||||
pub fn get_partial_hash(&self) -> Option<u128> {
|
||||
self.partial_hash
|
||||
}
|
||||
pub(crate) fn set_partial_hash(&mut self, hash: Option<u128>) {
|
||||
self.partial_hash = hash
|
||||
}
|
||||
/// Gets a candidate name. This will be the name of the first file inserted into the collection and so can vary.
|
||||
///
|
||||
/// # Examples
|
||||
/// ```no_run
|
||||
/// use std::path::Path;
|
||||
/// use ddh::fileinfo::Fileinfo;
|
||||
/// use std::fs;
|
||||
///
|
||||
/// fn main() -> std::io::Result<()> {
|
||||
/// let fi = Fileinfo::new(None, None, fs::metadata("./foo/bar.txt")?, Path::new("./foo/bar.txt").to_path_buf());
|
||||
/// let some_name = fi.get_candidate_name();
|
||||
/// assert_eq!("bar.txt", some_name);
|
||||
/// Ok(())
|
||||
/// }
|
||||
/// ```
|
||||
pub fn get_candidate_name(&self) -> &str {
|
||||
self.file_paths
|
||||
.get(0)
|
||||
.unwrap()
|
||||
.to_str()
|
||||
.unwrap()
|
||||
.rsplit('/')
|
||||
.next()
|
||||
.unwrap()
|
||||
}
|
||||
/// Gets all paths in the current collection. This can be used to get the names of each file with the string `rsplit("/")` method.
|
||||
///
|
||||
/// # Examples
|
||||
/// ```no_run
|
||||
/// use std::path::Path;
|
||||
/// use ddh::fileinfo::Fileinfo;
|
||||
/// use std::fs;
|
||||
///
|
||||
/// fn main() -> std::io::Result<()> {
|
||||
/// let fi = Fileinfo::new(None, None, fs::metadata("./foo/bar.txt")?, Path::new("./foo/bar.txt").to_path_buf());
|
||||
/// let all_files = fi.get_paths();
|
||||
/// assert_eq!(&vec![Path::new("./foo/bar.txt").to_path_buf()],
|
||||
/// all_files);
|
||||
/// Ok(())
|
||||
/// }
|
||||
/// ```
|
||||
pub fn get_paths(&self) -> &Vec<PathBuf> {
|
||||
&self.file_paths
|
||||
}
|
||||
|
||||
pub fn generate_hash(&mut self, mode: HashMode) -> Option<u128> {
|
||||
let mut hasher = siphasher::sip128::SipHasher::new();
|
||||
match fs::File::open(
|
||||
self.file_paths
|
||||
.get(0)
|
||||
.expect("Cannot read file path from struct"),
|
||||
) {
|
||||
Ok(mut f) => {
|
||||
/* We want a read call to be "large" for two reasons
|
||||
1) Force filesystem read ahead behavior
|
||||
2) Fewer system calls for a given file.
|
||||
Currently 16KB */
|
||||
let mut hash_buffer = [0; BLOCK_SIZE * 4];
|
||||
loop {
|
||||
match f.read(&mut hash_buffer) {
|
||||
Ok(n) if n > 0 => hasher.write(&hash_buffer),
|
||||
Ok(n) if n == 0 => break,
|
||||
Err(_e) => return None,
|
||||
_ => panic!("Negative length read in hashing"),
|
||||
}
|
||||
if mode == HashMode::Partial {
|
||||
return Some(hasher.finish128().into());
|
||||
}
|
||||
}
|
||||
Some(hasher.finish128().into())
|
||||
}
|
||||
Err(_e) => None,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl Serialize for Fileinfo {
|
||||
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
|
||||
where
|
||||
S: Serializer,
|
||||
{
|
||||
let mut state = serializer.serialize_struct("Fileinfo", 4)?;
|
||||
state.serialize_field("partial_hash", &self.partial_hash)?;
|
||||
state.serialize_field("full_hash", &self.full_hash)?;
|
||||
state.serialize_field("file_length", &self.get_length())?;
|
||||
state.serialize_field("file_paths", &self.file_paths)?;
|
||||
state.end()
|
||||
}
|
||||
}
|
||||
|
||||
impl PartialEq for Fileinfo {
|
||||
fn eq(&self, other: &Fileinfo) -> bool {
|
||||
(self.get_length() == other.get_length())
|
||||
&& (self.partial_hash == other.partial_hash)
|
||||
&& (self.full_hash == other.full_hash)
|
||||
}
|
||||
}
|
||||
impl Eq for Fileinfo {}
|
||||
|
||||
impl PartialOrd for Fileinfo {
|
||||
fn partial_cmp(&self, other: &Fileinfo) -> Option<Ordering> {
|
||||
if self.full_hash.is_some() && other.full_hash.is_some() {
|
||||
Some(self.full_hash.cmp(&other.full_hash))
|
||||
} else if self.partial_hash.is_some() && other.partial_hash.is_some() {
|
||||
Some(self.partial_hash.cmp(&other.partial_hash))
|
||||
} else {
|
||||
Some(self.get_length().cmp(&other.get_length()))
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl Ord for Fileinfo {
|
||||
fn cmp(&self, other: &Fileinfo) -> Ordering {
|
||||
if self.full_hash.is_some() && other.full_hash.is_some() {
|
||||
self.full_hash.cmp(&other.full_hash)
|
||||
} else if self.partial_hash.is_some() && other.partial_hash.is_some() {
|
||||
self.partial_hash.cmp(&other.partial_hash)
|
||||
} else {
|
||||
self.get_length().cmp(&other.get_length())
|
||||
}
|
||||
}
|
||||
}
|
||||
379
src/lib.rs
379
src/lib.rs
|
|
@ -2,299 +2,186 @@
|
|||
//!
|
||||
//! `ddh` is a collection of functions and structs to aid in analysing filesystem directories.
|
||||
|
||||
use std::hash::{Hasher};
|
||||
use std::fs::{self, DirEntry};
|
||||
use std::io::{Read, BufReader};
|
||||
use std::path::{PathBuf, Path};
|
||||
use std::cmp::Ordering;
|
||||
use serde_derive::{Serialize, Deserialize};
|
||||
use siphasher::sip128::Hasher128;
|
||||
use rayon::prelude::*;
|
||||
use std::sync::mpsc::{Sender, channel};
|
||||
use std::collections::hash_map::{HashMap, Entry};
|
||||
use std::io::{Error, ErrorKind};
|
||||
pub mod fileinfo;
|
||||
use fileinfo::{Fileinfo, HashMode};
|
||||
|
||||
use nohash_hasher::IntMap;
|
||||
use rayon::prelude::*;
|
||||
use std::collections::hash_map::{Entry, HashMap};
|
||||
use std::fs::{self, DirEntry};
|
||||
use std::path::{Path, PathBuf};
|
||||
use std::sync::mpsc::{channel, Sender};
|
||||
|
||||
#[derive(PartialEq)]
|
||||
enum HashMode{
|
||||
Full,
|
||||
Partial
|
||||
}
|
||||
|
||||
enum ChannelPackage{
|
||||
enum ChannelPackage {
|
||||
Success(Fileinfo),
|
||||
Fail(PathBuf, std::io::Error),
|
||||
}
|
||||
|
||||
/// Serializable struct containing entries for a specific file.
|
||||
#[derive(Debug, Serialize, Deserialize)]
|
||||
pub struct Fileinfo{
|
||||
full_hash: Option<u128>,
|
||||
partial_hash: Option<u128>,
|
||||
file_length: u64,
|
||||
file_paths: Vec<PathBuf>,
|
||||
}
|
||||
|
||||
impl Fileinfo{
|
||||
pub fn new(hash: Option<u128>, partial_hash: Option<u128>, length: u64, path: PathBuf) -> Self{
|
||||
Fileinfo{full_hash: hash, partial_hash: partial_hash, file_length: length, file_paths: vec![path]}
|
||||
}
|
||||
pub fn get_length(&self) -> u64{
|
||||
self.file_length
|
||||
}
|
||||
pub fn get_full_hash(&self) -> Option<u128>{
|
||||
self.full_hash
|
||||
}
|
||||
fn set_full_hash(&mut self, hash: Option<u128>) -> (){
|
||||
self.full_hash = hash
|
||||
}
|
||||
fn set_partial_hash(&mut self, hash: Option<u128>) -> (){
|
||||
self.partial_hash = hash
|
||||
}
|
||||
pub fn get_partial_hash(&self) -> Option<u128>{
|
||||
self.partial_hash
|
||||
}
|
||||
pub fn get_candidate_name(&self) -> &str{
|
||||
self.file_paths
|
||||
.iter()
|
||||
.next()
|
||||
.unwrap()
|
||||
.to_str()
|
||||
.unwrap()
|
||||
.rsplit("/")
|
||||
.next()
|
||||
.unwrap()
|
||||
}
|
||||
pub fn get_paths(&self) -> &Vec<PathBuf>{
|
||||
return &self.file_paths
|
||||
}
|
||||
|
||||
fn generate_hash(&mut self, mode: HashMode) -> Option<u128>{
|
||||
let mut hasher = siphasher::sip128::SipHasher::new();
|
||||
match fs::File::open(
|
||||
self.file_paths
|
||||
.iter()
|
||||
.next()
|
||||
.expect("Cannot read file path from struct")
|
||||
) {
|
||||
Ok(f) => {
|
||||
let mut buffer_reader = BufReader::new(f);
|
||||
let mut hash_buffer = [0;4096];
|
||||
loop {
|
||||
match buffer_reader.read(&mut hash_buffer) {
|
||||
Ok(n) if n>0 => hasher.write(&hash_buffer[0..]),
|
||||
Ok(n) if n==0 => break,
|
||||
Err(_e) => {
|
||||
return None
|
||||
},
|
||||
_ => panic!("Negative length read in hashing"),
|
||||
}
|
||||
if mode == HashMode::Partial{
|
||||
return Some(hasher.finish128().into());
|
||||
}
|
||||
}
|
||||
return Some(hasher.finish128().into());
|
||||
}
|
||||
Err(_e) => {
|
||||
return None
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl PartialEq for Fileinfo{
|
||||
fn eq(&self, other: &Fileinfo) -> bool {
|
||||
(self.file_length==other.file_length)&&
|
||||
(self.partial_hash==other.partial_hash)&&
|
||||
(self.full_hash==other.full_hash)
|
||||
}
|
||||
}
|
||||
impl Eq for Fileinfo{}
|
||||
|
||||
impl PartialOrd for Fileinfo{
|
||||
fn partial_cmp(&self, other: &Fileinfo) -> Option<Ordering>{
|
||||
if self.full_hash.is_some() && other.full_hash.is_some(){
|
||||
Some(self.full_hash.cmp(&other.full_hash))
|
||||
} else if self.partial_hash.is_some() && other.partial_hash.is_some(){
|
||||
Some(self.partial_hash.cmp(&other.partial_hash))
|
||||
} else {
|
||||
Some(self.file_length.cmp(&other.file_length))
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl Ord for Fileinfo{
|
||||
fn cmp(&self, other: &Fileinfo) -> Ordering {
|
||||
if self.full_hash.is_some() && other.full_hash.is_some(){
|
||||
self.full_hash.cmp(&other.full_hash)
|
||||
} else if self.partial_hash.is_some() && other.partial_hash.is_some(){
|
||||
self.partial_hash.cmp(&other.partial_hash)
|
||||
} else {
|
||||
self.file_length.cmp(&other.file_length)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// Constructs a list of unique files from a list of directories.
|
||||
///
|
||||
/// # Examples
|
||||
/// ```no_run
|
||||
/// let search_dirs = vec!["/home/jon", "/home/doe"];
|
||||
/// let ignore_dirs = vec!["/home/jon/.git", "/home/doe/scratch"];
|
||||
/// let min_size = 1024;
|
||||
/// let (files, errors) = ddh::deduplicate_dirs(search_dirs, ignore_dirs, min_size);
|
||||
/// ```
|
||||
/// let directories = vec!["/home/jon", "/home/doe"];
|
||||
/// let (files, errors) = ddh::deduplicate_dirs(directories);
|
||||
/// ```
|
||||
pub fn deduplicate_dirs(search_dirs: Vec<&str>) -> (Vec<Fileinfo>, Vec<(PathBuf, std::io::Error)>){
|
||||
|
||||
pub fn deduplicate_dirs<P: AsRef<Path> + Sync>(
|
||||
search_dirs: Vec<P>,
|
||||
ignore_dirs: Vec<P>,
|
||||
min_size: u64) -> (Vec<Fileinfo>, Vec<(PathBuf, std::io::Error)>) {
|
||||
let (sender, receiver) = channel();
|
||||
search_dirs.par_iter().for_each_with(sender, |s, search_dir| {
|
||||
traverse_and_spawn(Path::new(&search_dir), s.clone());
|
||||
});
|
||||
let ignore_paths = ignore_dirs.iter().map(|x| x.as_ref().canonicalize().unwrap()).collect();
|
||||
search_dirs
|
||||
.par_iter()
|
||||
.for_each_with(sender, |s, search_dir| {
|
||||
traverse_and_spawn(search_dir.as_ref(), &ignore_paths, s.clone(), min_size);
|
||||
});
|
||||
let mut files_of_lengths: IntMap<u64, Vec<Fileinfo>> = IntMap::default();
|
||||
let mut errors = Vec::new();
|
||||
for pkg in receiver.iter(){
|
||||
match pkg{
|
||||
ChannelPackage::Success(entry) => {
|
||||
match files_of_lengths.entry(entry.get_length()) {
|
||||
Entry::Vacant(e) => { e.insert(vec![entry]); },
|
||||
Entry::Occupied(mut e) => { e.get_mut().push(entry); }
|
||||
}
|
||||
},
|
||||
ChannelPackage::Fail(entry, error) => {
|
||||
errors.push((entry, error));
|
||||
},
|
||||
receiver.iter().for_each(|pkg| match pkg {
|
||||
ChannelPackage::Success(entry) => match files_of_lengths.entry(entry.get_length()) {
|
||||
Entry::Vacant(e) => {
|
||||
e.insert(vec![entry]);
|
||||
}
|
||||
Entry::Occupied(mut e) => {
|
||||
e.get_mut().push(entry);
|
||||
}
|
||||
},
|
||||
ChannelPackage::Fail(entry, error) => {
|
||||
errors.push((entry, error));
|
||||
}
|
||||
}
|
||||
let complete_files: Vec<Fileinfo> = files_of_lengths.into_par_iter()
|
||||
});
|
||||
let complete_files: Vec<Fileinfo> = files_of_lengths
|
||||
.into_par_iter()
|
||||
.map(|x| differentiate_and_consolidate(x.0, x.1))
|
||||
.flatten()
|
||||
.collect();
|
||||
(complete_files, errors)
|
||||
}
|
||||
|
||||
fn traverse_and_spawn(current_path: &Path, sender: Sender<ChannelPackage>) -> (){
|
||||
let current_path_metadata = match fs::metadata(current_path) {
|
||||
Err(e) =>{
|
||||
sender.send(
|
||||
ChannelPackage::Fail(current_path.to_path_buf(), e)
|
||||
).expect("Error sending new ChannelPackage::Fail");
|
||||
return
|
||||
},
|
||||
fn traverse_and_spawn(current_path: impl AsRef<Path>, ignore_dirs: &Vec<PathBuf>, sender: Sender<ChannelPackage>, min_size: u64) {
|
||||
if current_path.as_ref().canonicalize().is_ok() && ignore_dirs.iter().any(|x| current_path.as_ref().canonicalize().unwrap().starts_with(x)){
|
||||
return;
|
||||
}
|
||||
let current_path_metadata = match fs::symlink_metadata(¤t_path) {
|
||||
Err(e) => {
|
||||
sender
|
||||
.send(ChannelPackage::Fail(current_path.as_ref().to_path_buf(), e))
|
||||
.expect("Error sending new ChannelPackage::Fail");
|
||||
return;
|
||||
}
|
||||
Ok(meta) => meta,
|
||||
};
|
||||
|
||||
if current_path_metadata.file_type().is_symlink(){
|
||||
sender.send(
|
||||
ChannelPackage::Fail(current_path.to_path_buf(), Error::new(ErrorKind::Other, "Path is symlink"))
|
||||
).expect("Error sending new ChannelPackage::Fail");
|
||||
return
|
||||
}
|
||||
|
||||
if current_path_metadata.file_type().is_file(){
|
||||
sender.send(ChannelPackage::Success(
|
||||
Fileinfo::new(
|
||||
None,
|
||||
None,
|
||||
current_path.metadata().expect("Error reading path length").len(),
|
||||
current_path.to_path_buf()
|
||||
))
|
||||
).expect("Error sending new ChannelPackage::Success");
|
||||
return
|
||||
}
|
||||
|
||||
if current_path_metadata.file_type().is_dir(){
|
||||
match fs::read_dir(current_path) {
|
||||
Ok(read_dir_results) => {
|
||||
let good_entries: Vec<_> = read_dir_results
|
||||
let current_path = match fs::canonicalize(¤t_path) {
|
||||
Err(e) => {
|
||||
sender
|
||||
.send(ChannelPackage::Fail(current_path.as_ref().to_path_buf(), e))
|
||||
.expect("Error sending new ChannelPackage::Fail");
|
||||
return;
|
||||
}
|
||||
Ok(canonical_path) => canonical_path,
|
||||
};
|
||||
match current_path_metadata {
|
||||
meta if meta.is_file() && meta.len() >= min_size => {
|
||||
sender
|
||||
.send(ChannelPackage::Success(Fileinfo::new(
|
||||
None,
|
||||
None,
|
||||
meta,
|
||||
current_path,
|
||||
)))
|
||||
.expect("Error sending new ChannelPackage::Success");
|
||||
}
|
||||
meta if meta.is_dir() => match fs::read_dir(¤t_path) {
|
||||
Ok(read_dir_results) => {
|
||||
let good_entries: Vec<_> = read_dir_results
|
||||
.filter(|x| x.is_ok())
|
||||
.map(|x| x.unwrap())
|
||||
.collect();
|
||||
let (files, dirs): (Vec<&DirEntry>, Vec<&DirEntry>) = good_entries.par_iter().partition(|&x|
|
||||
x.path()
|
||||
.as_path()
|
||||
.symlink_metadata()
|
||||
.expect("Error reading Symlink Metadata")
|
||||
.file_type()
|
||||
.is_file()
|
||||
);
|
||||
files.par_iter().for_each_with(sender.clone(), |sender, x|
|
||||
sender.send(ChannelPackage::Success(
|
||||
Fileinfo::new(
|
||||
None,
|
||||
None,
|
||||
x.metadata().expect("Error reading path length").len(),
|
||||
x.path()))
|
||||
).expect("Error sending new ChannelPackage::Success")
|
||||
);
|
||||
dirs.into_par_iter()
|
||||
.for_each_with(sender, |sender, x| {
|
||||
traverse_and_spawn(x.path().as_path(), sender.clone());
|
||||
})
|
||||
},
|
||||
Err(e) => {
|
||||
sender.send(
|
||||
ChannelPackage::Fail(current_path.to_path_buf(), e)
|
||||
).expect("Error sending new ChannelPackage::Fail");
|
||||
},
|
||||
let (files, dirs): (Vec<&DirEntry>, Vec<&DirEntry>) =
|
||||
good_entries.par_iter().partition(|&x| {
|
||||
x.file_type()
|
||||
.expect("Error reading DirEntry file type")
|
||||
.is_file()
|
||||
});
|
||||
files.par_iter().for_each_with(sender.clone(), |sender, x| {
|
||||
traverse_and_spawn(&x.path(), ignore_dirs, sender.clone(), min_size)
|
||||
});
|
||||
dirs.into_par_iter().for_each_with(sender, |sender, x| {
|
||||
traverse_and_spawn(x.path().as_path(), ignore_dirs, sender.clone(), min_size);
|
||||
})
|
||||
}
|
||||
} else {}
|
||||
Err(e) => {
|
||||
sender
|
||||
.send(ChannelPackage::Fail(current_path, e))
|
||||
.expect("Error sending new ChannelPackage::Fail");
|
||||
}
|
||||
},
|
||||
_ => { /*Symlinks not yet handled*/ }
|
||||
}
|
||||
}
|
||||
|
||||
fn differentiate_and_consolidate(file_length: u64, mut files: Vec<Fileinfo>) -> Vec<Fileinfo>{
|
||||
if file_length==0{
|
||||
return files
|
||||
fn differentiate_and_consolidate(file_length: u64, mut files: Vec<Fileinfo>) -> Vec<Fileinfo> {
|
||||
if file_length == 0 || files.is_empty() {
|
||||
return files;
|
||||
}
|
||||
if files.len()<=0{
|
||||
panic!("Invalid length vector");
|
||||
}
|
||||
match files.len(){
|
||||
match files.len() {
|
||||
1 => return files,
|
||||
n if n>1 => {
|
||||
n if n > 1 => {
|
||||
files.par_iter_mut().for_each(|file_ref| {
|
||||
let hash = file_ref.generate_hash(HashMode::Partial);
|
||||
file_ref.set_partial_hash(hash);
|
||||
});
|
||||
if file_length<=4096{
|
||||
files.par_iter_mut().for_each(|x|{
|
||||
x.set_full_hash(x.get_partial_hash()) ;
|
||||
if file_length <= 4096 {
|
||||
files.par_iter_mut().for_each(|x| {
|
||||
x.set_full_hash(x.get_partial_hash());
|
||||
});
|
||||
return dedupe(files)
|
||||
}
|
||||
let mut partial_hashes: HashMap<u128, u64> = HashMap::new();
|
||||
for file in files.iter(){
|
||||
match partial_hashes.entry(file.get_partial_hash().unwrap()){
|
||||
Entry::Vacant(e) => { e.insert(0); },
|
||||
Entry::Occupied(mut e) => {*e.get_mut()+=1;}
|
||||
}
|
||||
return dedupe(files);
|
||||
}
|
||||
let mut partial_hashes: HashMap<Option<u128>, u64> = HashMap::new();
|
||||
files
|
||||
.iter()
|
||||
.for_each(|f| match partial_hashes.entry(f.get_partial_hash()) {
|
||||
Entry::Vacant(e) => {
|
||||
e.insert(0);
|
||||
}
|
||||
Entry::Occupied(mut e) => {
|
||||
*e.get_mut() += 1;
|
||||
}
|
||||
});
|
||||
let dedupe_hashes: Vec<_> = partial_hashes
|
||||
.into_iter()
|
||||
.filter(|x| x.1>0)
|
||||
.filter(|x| x.1 > 0)
|
||||
.map(|y| y.0)
|
||||
.collect();
|
||||
files.par_iter_mut().for_each(|x|
|
||||
if dedupe_hashes.contains(&x.get_partial_hash().unwrap()){
|
||||
files.par_iter_mut().for_each(|x| {
|
||||
if dedupe_hashes.contains(&x.get_partial_hash()) {
|
||||
let hash = x.generate_hash(HashMode::Full);
|
||||
x.set_full_hash(hash);
|
||||
}
|
||||
);
|
||||
},
|
||||
_ => {panic!("Somehow a vector of negative length was created. Please report this as a bug");}
|
||||
});
|
||||
}
|
||||
_ => {
|
||||
panic!("Somehow a vector of negative length was created. Please report this as a bug");
|
||||
}
|
||||
}
|
||||
dedupe(files)
|
||||
}
|
||||
|
||||
fn dedupe(mut files: Vec<Fileinfo>) -> Vec<Fileinfo>{
|
||||
fn dedupe(mut files: Vec<Fileinfo>) -> Vec<Fileinfo> {
|
||||
let mut cache: HashMap<(Option<u128>, Option<u128>), &mut Fileinfo> = HashMap::new();
|
||||
for file in files.iter_mut(){
|
||||
match cache.entry((file.get_partial_hash(), file.get_full_hash())){
|
||||
Entry::Vacant(e) => {
|
||||
e.insert(file);
|
||||
},
|
||||
Entry::Occupied(mut e) => {
|
||||
e.get_mut()
|
||||
.file_paths
|
||||
.append(&mut file.file_paths);
|
||||
}
|
||||
}
|
||||
}
|
||||
files.retain(|x| x.get_paths().len()>0);
|
||||
files.iter_mut().for_each(|file| {
|
||||
match cache.entry((file.get_partial_hash(), file.get_full_hash())) {
|
||||
Entry::Vacant(e) => {
|
||||
e.insert(file);
|
||||
}
|
||||
Entry::Occupied(mut e) => {
|
||||
e.get_mut().file_paths.append(&mut file.file_paths);
|
||||
}
|
||||
}
|
||||
});
|
||||
files.retain(|x| !x.get_paths().is_empty());
|
||||
files
|
||||
}
|
||||
|
|
|
|||
392
src/main.rs
392
src/main.rs
|
|
@ -1,199 +1,297 @@
|
|||
use std::io::{stdin};
|
||||
use clap::{Parser, ValueEnum};
|
||||
use ddh::fileinfo::Fileinfo;
|
||||
use rayon::prelude::*;
|
||||
use std::fs::{self};
|
||||
use std::io::prelude::*;
|
||||
use clap::{Arg, App};
|
||||
use rayon::prelude::*;
|
||||
use ddh::{Fileinfo};
|
||||
use std::path::{PathBuf};
|
||||
use std::io::stdin;
|
||||
use std::path::PathBuf;
|
||||
|
||||
#[derive(Debug, Copy, Clone)]
|
||||
pub enum PrintFmt{
|
||||
Standard,
|
||||
Json,
|
||||
Off,
|
||||
#[derive(Parser)]
|
||||
#[command(author, version, about, long_about=DDH_ABOUT)]
|
||||
struct Args {
|
||||
/// Minimum file size in bytes to consider
|
||||
#[arg(short, long("minimum"), num_args(0..=1), default_value_t = 0)]
|
||||
min_size: u64,
|
||||
/// Set the display blocksize to Bytes, Kilobytes, Megabytes or Gigabytes
|
||||
#[arg(long, short, ignore_case(true), value_enum, num_args(0..=1), default_value_t = Blocksize::Kilobytes)]
|
||||
blocksize: Blocksize,
|
||||
/// Set verbosity for printed output
|
||||
#[arg(long, short, ignore_case(true), value_enum, num_args(0..=1), default_value_t = Verbosity::Quiet)]
|
||||
verbosity: Verbosity,
|
||||
///Set file to save all output. Use 'no' for no file output
|
||||
#[arg(long, short, num_args(0..=1), default_value = "Results.txt")]
|
||||
output: String,
|
||||
/// Set output format
|
||||
#[arg(short('f'), long("format"), ignore_case(true), value_enum, num_args(0..=1), default_value_t = PrintFmt::Standard)]
|
||||
fmt: PrintFmt,
|
||||
/// Directories to ignore (comma separated list)
|
||||
#[arg(short, long("ignore"), value_delimiter(','))]
|
||||
ignore_dirs: Vec<String>,
|
||||
/// Directories to parse
|
||||
#[arg(short, long("directories"), value_delimiter(' '), num_args(1..), required = true)]
|
||||
directories: Vec<String>,
|
||||
}
|
||||
|
||||
pub enum Verbosity{
|
||||
#[derive(Debug, Copy, Clone, ValueEnum)]
|
||||
pub enum PrintFmt {
|
||||
Standard,
|
||||
Json,
|
||||
}
|
||||
|
||||
#[derive(Debug, Copy, Clone, ValueEnum)]
|
||||
pub enum Verbosity {
|
||||
Quiet,
|
||||
Duplicates,
|
||||
All,
|
||||
}
|
||||
|
||||
fn main() {
|
||||
let arguments = App::new("Directory Difference hTool")
|
||||
.version(env!("CARGO_PKG_VERSION"))
|
||||
.author(env!("CARGO_PKG_AUTHORS"))
|
||||
.about("Compare and contrast directories.\nExample invocation: ddh /home/jon/downloads /home/jon/documents -f duplicates\nExample pipe: ddh ~/Downloads/ -o no -v all -f json | someJsonParser.bin")
|
||||
.arg(Arg::with_name("directories")
|
||||
.short("d")
|
||||
.long("directories")
|
||||
.value_name("Directories")
|
||||
.help("Directories to parse")
|
||||
.min_values(1)
|
||||
.required(true)
|
||||
.takes_value(true)
|
||||
.index(1))
|
||||
.arg(Arg::with_name("Blocksize")
|
||||
.short("bs")
|
||||
.long("blocksize")
|
||||
.case_insensitive(true)
|
||||
.takes_value(true)
|
||||
.max_values(1)
|
||||
.possible_values(&["B", "K", "M", "G"])
|
||||
.help("Sets the display blocksize to Bytes, Kilobytes, Megabytes or Gigabytes. Default is Kilobytes."))
|
||||
.arg(Arg::with_name("Verbosity")
|
||||
.short("v")
|
||||
.long("verbosity")
|
||||
.possible_values(&["quiet", "duplicates", "all"])
|
||||
.case_insensitive(true)
|
||||
.takes_value(true)
|
||||
.help("Sets verbosity for printed output."))
|
||||
.arg(Arg::with_name("Output")
|
||||
.short("o")
|
||||
.long("output")
|
||||
.takes_value(true)
|
||||
.max_values(1)
|
||||
.help("Sets file to save all output. Use 'no' for no file output."))
|
||||
.arg(Arg::with_name("Format")
|
||||
.short("f")
|
||||
.long("format")
|
||||
.possible_values(&["standard", "json", "off"])
|
||||
.takes_value(true)
|
||||
.max_values(1)
|
||||
.help("Sets output format."))
|
||||
.get_matches();
|
||||
|
||||
//let (sender, receiver) = channel();
|
||||
let search_dirs: Vec<_> = arguments.values_of("directories").unwrap()
|
||||
.collect();
|
||||
|
||||
let (complete_files, read_errors): (Vec<Fileinfo>, Vec<(_, _)>) = ddh::deduplicate_dirs(search_dirs);
|
||||
let (shared_files, unique_files): (Vec<&Fileinfo>, Vec<&Fileinfo>) = complete_files.par_iter().partition(|&x| x.get_paths().len()>1);
|
||||
process_full_output(&shared_files, &unique_files, &complete_files, &read_errors, &arguments);
|
||||
#[derive(Debug, Copy, Clone, ValueEnum)]
|
||||
pub enum Blocksize {
|
||||
#[clap(name("B"), alias("Bytes"))]
|
||||
Bytes,
|
||||
#[clap(name("K"), alias("Kilobytes"))]
|
||||
Kilobytes,
|
||||
#[clap(name("M"), alias("Megabytes"))]
|
||||
Megabytes,
|
||||
#[clap(name("G"), alias("Gigabytes"))]
|
||||
Gigabytes,
|
||||
}
|
||||
|
||||
fn process_full_output(shared_files: &Vec<&Fileinfo>, unique_files: &Vec<&Fileinfo>, complete_files: &Vec<Fileinfo>, error_paths: &Vec<(PathBuf, std::io::Error)>, arguments: &clap::ArgMatches) ->(){
|
||||
let blocksize = match arguments.value_of("Blocksize").unwrap_or(""){"B" => "Bytes", "K" => "Kilobytes", "M" => "Megabytes", "G" => "Gigabytes", _ => "Megabytes"};
|
||||
let display_power = match blocksize{"Bytes" => 0, "Kilobytes" => 1, "Megabytes" => 2, "Gigabytes" => 3, _ => 2};
|
||||
let display_divisor = 1024u64.pow(display_power);
|
||||
let fmt = match arguments.value_of("Format").unwrap_or(""){
|
||||
"standard" => PrintFmt::Standard,
|
||||
"json" => PrintFmt::Json,
|
||||
_ => PrintFmt::Standard};
|
||||
let verbosity = match arguments.value_of("Verbosity").unwrap_or(""){
|
||||
"quiet" => Verbosity::Quiet,
|
||||
"duplicates" => Verbosity::Duplicates,
|
||||
"all" => Verbosity::All,
|
||||
_ => Verbosity::Quiet};
|
||||
static DDH_ABOUT: &str = "Compare and contrast directories.\nExample invocation: ddh -d /home/jon/downloads /home/jon/documents -v duplicates\nExample pipe: ddh -d ~/Downloads/ -o no -v all -f json | someJsonParser.bin";
|
||||
|
||||
println!("{} Total files (with duplicates): {} {}", complete_files.par_iter()
|
||||
.map(|x| x.get_paths().len() as u64)
|
||||
.sum::<u64>(),
|
||||
complete_files.par_iter()
|
||||
.map(|x| (x.get_paths().len() as u64)*x.get_length())
|
||||
.sum::<u64>()/(display_divisor),
|
||||
blocksize);
|
||||
println!("{} Total files (without duplicates): {} {}", complete_files.len(), complete_files.par_iter()
|
||||
.map(|x| x.get_length())
|
||||
.sum::<u64>()/(display_divisor),
|
||||
blocksize);
|
||||
println!("{} Single instance files: {} {}",unique_files.len(), unique_files.par_iter()
|
||||
.map(|x| x.get_length())
|
||||
.sum::<u64>()/(display_divisor),
|
||||
blocksize);
|
||||
println!("{} Shared instance files: {} {} ({} instances)", shared_files.len(), shared_files.par_iter()
|
||||
.map(|x| x.get_length())
|
||||
.sum::<u64>()/(display_divisor),
|
||||
blocksize, shared_files.par_iter()
|
||||
.map(|x| x.get_paths().len() as u64)
|
||||
.sum::<u64>());
|
||||
fn main() {
|
||||
|
||||
let arguments = Args::parse();
|
||||
|
||||
let (complete_files, read_errors): (Vec<Fileinfo>, Vec<(_, _)>) =
|
||||
ddh::deduplicate_dirs(arguments.directories, arguments.ignore_dirs, arguments.min_size);
|
||||
let (shared_files, unique_files): (Vec<&Fileinfo>, Vec<&Fileinfo>) = complete_files
|
||||
.par_iter()
|
||||
.partition(|&x| x.get_paths().len() > 1);
|
||||
process_full_output(
|
||||
&shared_files,
|
||||
&unique_files,
|
||||
&complete_files,
|
||||
&read_errors,
|
||||
arguments.output.as_str(),
|
||||
arguments.blocksize,
|
||||
arguments.fmt,
|
||||
arguments.verbosity,
|
||||
);
|
||||
}
|
||||
|
||||
fn process_full_output(
|
||||
shared_files: &[&Fileinfo],
|
||||
unique_files: &[&Fileinfo],
|
||||
complete_files: &[Fileinfo],
|
||||
error_paths: &[(PathBuf, std::io::Error)],
|
||||
output: &str,
|
||||
blocksize: Blocksize,
|
||||
fmt: PrintFmt,
|
||||
verbosity: Verbosity,
|
||||
) {
|
||||
let display_power = match blocksize {
|
||||
Blocksize::Bytes => 0,
|
||||
Blocksize::Kilobytes => 1,
|
||||
Blocksize::Megabytes => 2,
|
||||
Blocksize::Gigabytes => 3,
|
||||
};
|
||||
let display_divisor = 1024u64.pow(display_power);
|
||||
|
||||
println!(
|
||||
"{} Total files (with duplicates): {} {:?}",
|
||||
complete_files
|
||||
.par_iter()
|
||||
.map(|x| x.get_paths().len() as u64)
|
||||
.sum::<u64>(),
|
||||
complete_files
|
||||
.par_iter()
|
||||
.map(|x| (x.get_paths().len() as u64) * x.get_length())
|
||||
.sum::<u64>()
|
||||
/ (display_divisor),
|
||||
blocksize
|
||||
);
|
||||
println!(
|
||||
"{} Total files (without duplicates): {} {:?}",
|
||||
complete_files.len(),
|
||||
complete_files
|
||||
.par_iter()
|
||||
.map(|x| x.get_length())
|
||||
.sum::<u64>()
|
||||
/ (display_divisor),
|
||||
blocksize
|
||||
);
|
||||
println!(
|
||||
"{} Single instance files: {} {:?}",
|
||||
unique_files.len(),
|
||||
unique_files.par_iter().map(|x| x.get_length()).sum::<u64>() / (display_divisor),
|
||||
blocksize
|
||||
);
|
||||
println!(
|
||||
"{} Shared instance files: {} {:?} ({} instances)",
|
||||
shared_files.len(),
|
||||
shared_files.par_iter().map(|x| x.get_length()).sum::<u64>() / (display_divisor),
|
||||
blocksize,
|
||||
shared_files
|
||||
.par_iter()
|
||||
.map(|x| x.get_paths().len() as u64)
|
||||
.sum::<u64>()
|
||||
);
|
||||
|
||||
match (fmt, verbosity) {
|
||||
(_, Verbosity::Quiet) => {},
|
||||
(_, Verbosity::Quiet) => {}
|
||||
(PrintFmt::Standard, Verbosity::Duplicates) => {
|
||||
println!("Shared instance files and instance locations"); shared_files.iter().for_each(|x| {
|
||||
println!("instances of {} with file length {}:", x.get_candidate_name(), x.get_length());
|
||||
x.get_paths().par_iter().for_each(|y| println!("\t{}", y.canonicalize().unwrap().to_str().unwrap()));})
|
||||
},
|
||||
(PrintFmt::Standard, Verbosity::All) => {
|
||||
println!("Single instance files"); unique_files.par_iter()
|
||||
.for_each(|x| println!("{}", x.get_paths().iter().next().unwrap().canonicalize().unwrap().to_str().unwrap()));
|
||||
println!("Shared instance files and instance locations"); shared_files.iter().for_each(|x| {
|
||||
println!("instances of {} with file length {}:", x.get_candidate_name(), x.get_length());
|
||||
x.get_paths().par_iter().for_each(|y| println!("\t{}", y.canonicalize().unwrap().to_str().unwrap()));});
|
||||
error_paths.iter().for_each(|x|{
|
||||
println!("Could not process {:#?} due to error {:#?}", x.0, x.1.kind());
|
||||
println!("Shared instance files and instance locations");
|
||||
shared_files.iter().for_each(|x| {
|
||||
println!(
|
||||
"instances of {} with file length {}:",
|
||||
x.get_candidate_name(),
|
||||
x.get_length()
|
||||
);
|
||||
x.get_paths()
|
||||
.par_iter()
|
||||
.for_each(|y| println!("\t{}", y.canonicalize().unwrap().to_str().unwrap()));
|
||||
})
|
||||
},
|
||||
}
|
||||
(PrintFmt::Standard, Verbosity::All) => {
|
||||
println!("Single instance files");
|
||||
unique_files.par_iter().for_each(|x| {
|
||||
println!(
|
||||
"{}",
|
||||
x.get_paths()
|
||||
.iter()
|
||||
.next()
|
||||
.unwrap()
|
||||
.canonicalize()
|
||||
.unwrap()
|
||||
.to_str()
|
||||
.unwrap()
|
||||
)
|
||||
});
|
||||
println!("Shared instance files and instance locations");
|
||||
shared_files.iter().for_each(|x| {
|
||||
println!(
|
||||
"instances of {} with file length {}:",
|
||||
x.get_candidate_name(),
|
||||
x.get_length()
|
||||
);
|
||||
x.get_paths()
|
||||
.par_iter()
|
||||
.for_each(|y| println!("\t{}", y.canonicalize().unwrap().to_str().unwrap()));
|
||||
});
|
||||
error_paths.iter().for_each(|x| {
|
||||
println!(
|
||||
"Could not process {:#?} due to error {:#?}",
|
||||
x.0,
|
||||
x.1.kind()
|
||||
);
|
||||
})
|
||||
}
|
||||
(PrintFmt::Json, Verbosity::Duplicates) => {
|
||||
println!("{}", serde_json::to_string(shared_files).unwrap_or("".to_string()));
|
||||
},
|
||||
println!(
|
||||
"{}",
|
||||
serde_json::to_string(shared_files).unwrap_or_else(|_| "".to_string())
|
||||
);
|
||||
}
|
||||
(PrintFmt::Json, Verbosity::All) => {
|
||||
println!("{}", serde_json::to_string(complete_files).unwrap_or("".to_string()));
|
||||
},
|
||||
_ => {},
|
||||
println!(
|
||||
"{}",
|
||||
serde_json::to_string(complete_files).unwrap_or_else(|_| "".to_string())
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
match arguments.value_of("Output").unwrap_or("Results.txt"){
|
||||
"no" => {},
|
||||
match output {
|
||||
"no" => {}
|
||||
destination_string => {
|
||||
match fs::File::open(destination_string) {
|
||||
Ok(_f) => {
|
||||
Ok(_f) => {
|
||||
println!("---");
|
||||
println!("File {} already exists.", destination_string);
|
||||
println!("Overwrite? Y/N");
|
||||
let mut input = String::new();
|
||||
match stdin().read_line(&mut input) {
|
||||
Ok(_n) => {
|
||||
match input.chars().next().unwrap_or(' ') {
|
||||
'n' | 'N' => {println!("Exiting."); return;}
|
||||
'y' | 'Y' => {println!("Over writing {}", destination_string);}
|
||||
_ => {println!("Exiting."); return;}
|
||||
Ok(_n) => match input.chars().next().unwrap_or(' ') {
|
||||
'n' | 'N' => {
|
||||
println!("Exiting.");
|
||||
return;
|
||||
}
|
||||
}
|
||||
Err(_e) => {println!("Error encountered reading user input. Err: {}", _e);},
|
||||
}
|
||||
},
|
||||
Err(_e) => {
|
||||
match fs::File::create(destination_string) {
|
||||
Ok(_f) => {},
|
||||
'y' | 'Y' => {
|
||||
println!("Over writing {}", destination_string);
|
||||
}
|
||||
_ => {
|
||||
println!("Exiting.");
|
||||
return;
|
||||
}
|
||||
},
|
||||
Err(_e) => {
|
||||
println!("Error encountered opening file {}. Err: {}", destination_string, _e);
|
||||
println!("Exiting."); return;
|
||||
println!("Error encountered reading user input. Err: {}", _e);
|
||||
}
|
||||
}
|
||||
}
|
||||
Err(_e) => match fs::File::create(destination_string) {
|
||||
Ok(_f) => {}
|
||||
Err(_e) => {
|
||||
println!(
|
||||
"Error encountered opening file {}. Err: {}",
|
||||
destination_string, _e
|
||||
);
|
||||
println!("Exiting.");
|
||||
return;
|
||||
}
|
||||
},
|
||||
}
|
||||
write_results_to_file(fmt, &shared_files, &unique_files, &complete_files, destination_string);
|
||||
},
|
||||
write_results_to_file(
|
||||
fmt,
|
||||
shared_files,
|
||||
unique_files,
|
||||
complete_files,
|
||||
destination_string,
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
fn write_results_to_file(fmt: PrintFmt, shared_files: &Vec<&Fileinfo>, unique_files: &Vec<&Fileinfo>, complete_files: &Vec<Fileinfo>, file: &str) {
|
||||
fn write_results_to_file(
|
||||
fmt: PrintFmt,
|
||||
shared_files: &[&Fileinfo],
|
||||
unique_files: &[&Fileinfo],
|
||||
complete_files: &[Fileinfo],
|
||||
file: &str,
|
||||
) {
|
||||
let mut output = fs::File::create(file).expect("Error opening output file for writing");
|
||||
match fmt {
|
||||
PrintFmt::Standard => {
|
||||
output.write_fmt(format_args!("Duplicates:\n")).unwrap();
|
||||
for file in shared_files.into_iter(){
|
||||
let title = file.get_paths().get(0).unwrap().file_name().unwrap().to_str().unwrap();
|
||||
for file in shared_files.iter() {
|
||||
let title = file.get_candidate_name();
|
||||
output.write_fmt(format_args!("{}\n", title)).unwrap();
|
||||
for entry in file.get_paths().iter(){
|
||||
output.write_fmt(format_args!("\t{}\n", entry.as_path().to_str().unwrap())).unwrap();
|
||||
for entry in file.get_paths().iter() {
|
||||
output
|
||||
.write_fmt(format_args!("\t{}\n", entry.as_path().to_str().unwrap()))
|
||||
.unwrap();
|
||||
}
|
||||
}
|
||||
output.write_fmt(format_args!("Singletons:\n")).unwrap();
|
||||
for file in unique_files.into_iter(){
|
||||
let title = file.get_paths().get(0).unwrap().file_name().unwrap().to_str().unwrap();
|
||||
for file in unique_files.iter() {
|
||||
let title = file.get_candidate_name();
|
||||
output.write_fmt(format_args!("{}\n", title)).unwrap();
|
||||
for entry in file.get_paths().iter(){
|
||||
output.write_fmt(format_args!("\t{}\n", entry.as_path().to_str().unwrap())).unwrap();
|
||||
for entry in file.get_paths().iter() {
|
||||
output
|
||||
.write_fmt(format_args!("\t{}\n", entry.as_path().to_str().unwrap()))
|
||||
.unwrap();
|
||||
}
|
||||
}
|
||||
},
|
||||
}
|
||||
PrintFmt::Json => {
|
||||
output.write_fmt(format_args!("{}", serde_json::to_string(complete_files).unwrap_or("Error deserializing".to_string()))).unwrap();
|
||||
},
|
||||
PrintFmt::Off =>{return},
|
||||
output
|
||||
.write_fmt(format_args!(
|
||||
"{}",
|
||||
serde_json::to_string(complete_files)
|
||||
.unwrap_or_else(|_| "Error deserializing".to_string())
|
||||
))
|
||||
.unwrap();
|
||||
}
|
||||
}
|
||||
println!("{:#?} results written to {}", fmt, file);
|
||||
}
|
||||
|
|
|
|||
38
src/utils.rs
Normal file
38
src/utils.rs
Normal file
|
|
@ -0,0 +1,38 @@
|
|||
use std::fs::File;
|
||||
use std::io::{self, Read};
|
||||
|
||||
pub struct ChunkIter {
|
||||
f: File,
|
||||
chunk_len: usize,
|
||||
}
|
||||
|
||||
impl ChunkIter {
|
||||
pub fn new(f: File, len: usize) -> Self {
|
||||
ChunkIter {
|
||||
f: f,
|
||||
chunk_len: len,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl Iterator for ChunkIter {
|
||||
type Item = Result<Vec<u8>, io::Error>;
|
||||
fn next(&mut self) -> Option<Result<Vec<u8>, io::Error>> {
|
||||
let mut buffer = Vec::with_capacity(self.chunk_len);
|
||||
match self
|
||||
.f
|
||||
.by_ref()
|
||||
.take(self.chunk_len as u64)
|
||||
.read_to_end(&mut buffer)
|
||||
{
|
||||
Ok(i) => {
|
||||
if i == 0 {
|
||||
return None;
|
||||
} else {
|
||||
Some(Ok(buffer))
|
||||
}
|
||||
}
|
||||
Err(e) => Some(Err(e)),
|
||||
}
|
||||
}
|
||||
}
|
||||
Loading…
Reference in a new issue