From 17202353447f1de32f9a0758cdfcc0ccd6ba765a Mon Sep 17 00:00:00 2001 From: Ales Katona Date: Wed, 13 Jul 2022 12:55:12 -0700 Subject: [PATCH] initial commit --- .gitignore | 2 + Cargo.lock | 653 ++++++++++++++++++++++++++++++++++++++++ Cargo.toml | 20 ++ LICENSE | 661 +++++++++++++++++++++++++++++++++++++++++ README.md | 3 + src/main.rs | 42 +++ src/vcs.rs | 344 +++++++++++++++++++++ src/vcs/cli.rs | 46 +++ src/vcs/colors.rs | 9 + src/vcs/error.rs | 88 ++++++ src/vcs/project.rs | 167 +++++++++++ src/vcs/systems.rs | 15 + src/vcs/systems/git.rs | 148 +++++++++ 13 files changed, 2198 insertions(+) create mode 100644 .gitignore create mode 100644 Cargo.lock create mode 100644 Cargo.toml create mode 100644 LICENSE create mode 100644 README.md create mode 100644 src/main.rs create mode 100644 src/vcs.rs create mode 100644 src/vcs/cli.rs create mode 100644 src/vcs/colors.rs create mode 100644 src/vcs/error.rs create mode 100644 src/vcs/project.rs create mode 100644 src/vcs/systems.rs create mode 100644 src/vcs/systems/git.rs diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..03f0fa2 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +/target +.githooks diff --git a/Cargo.lock b/Cargo.lock new file mode 100644 index 0000000..9ba4f2e --- /dev/null +++ b/Cargo.lock @@ -0,0 +1,653 @@ +# 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.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d468802bab17cbc0cc575e9b053f41e72aa36bfa6b7f55e3529ffa43161b97fa" + +[[package]] +name = "bitflags" +version = "1.3.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bef38d45163c2f1dde094a7dfd33ccf595c92905c8f8f4fdc18d06fb1037718a" + +[[package]] +name = "cargo-vcs" +version = "0.1.0" +dependencies = [ + "clap", + "crossterm", + "git2", + "machine-uid", + "semver", + "termtree", + "toml", +] + +[[package]] +name = "cc" +version = "1.0.73" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2fff2a6927b3bb87f9595d67196a70493f627687a71d87a0d692242c33f58c11" +dependencies = [ + "jobserver", +] + +[[package]] +name = "cfg-if" +version = "1.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "baf1de4339761588bc0619e3cbc0120ee582ebb74b53b4efbf79117bd2da40fd" + +[[package]] +name = "clap" +version = "3.2.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5b7b16274bb247b45177db843202209b12191b631a14a9d06e41b3777d6ecf14" +dependencies = [ + "atty", + "bitflags", + "clap_derive", + "clap_lex", + "indexmap", + "once_cell", + "strsim", + "termcolor", + "textwrap", +] + +[[package]] +name = "clap_derive" +version = "3.2.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "759bf187376e1afa7b85b959e6a664a3e7a95203415dba952ad19139e798f902" +dependencies = [ + "heck", + "proc-macro-error", + "proc-macro2", + "quote", + "syn", +] + +[[package]] +name = "clap_lex" +version = "0.2.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2850f2f5a82cbf437dd5af4d49848fbdfc27c157c3d010345776f952765261c5" +dependencies = [ + "os_str_bytes", +] + +[[package]] +name = "crossterm" +version = "0.24.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ab9f7409c70a38a56216480fba371ee460207dd8926ccf5b4160591759559170" +dependencies = [ + "bitflags", + "crossterm_winapi", + "libc", + "mio", + "parking_lot", + "signal-hook", + "signal-hook-mio", + "winapi", +] + +[[package]] +name = "crossterm_winapi" +version = "0.9.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2ae1b35a484aa10e07fe0638d02301c5ad24de82d310ccbd2f3693da5f09bf1c" +dependencies = [ + "winapi", +] + +[[package]] +name = "form_urlencoded" +version = "1.0.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5fc25a87fa4fd2094bffb06925852034d90a17f0d1e05197d4956d3555752191" +dependencies = [ + "matches", + "percent-encoding", +] + +[[package]] +name = "git2" +version = "0.14.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d0155506aab710a86160ddb504a480d2964d7ab5b9e62419be69e0032bc5931c" +dependencies = [ + "bitflags", + "libc", + "libgit2-sys", + "log", + "openssl-probe", + "openssl-sys", + "url", +] + +[[package]] +name = "hashbrown" +version = "0.12.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "db0d4cf898abf0081f964436dc980e96670a0f36863e4b83aaacdb65c9d7ccc3" + +[[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 = "idna" +version = "0.2.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "418a0a6fab821475f634efe3ccc45c013f742efe03d853e8d3355d5cb850ecf8" +dependencies = [ + "matches", + "unicode-bidi", + "unicode-normalization", +] + +[[package]] +name = "indexmap" +version = "1.9.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "10a35a97730320ffe8e2d410b5d3b69279b98d2c14bdb8b70ea89ecf7888d41e" +dependencies = [ + "autocfg", + "hashbrown", +] + +[[package]] +name = "jobserver" +version = "0.1.24" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "af25a77299a7f711a01975c35a6a424eb6862092cc2d6c72c4ed6cbc56dfc1fa" +dependencies = [ + "libc", +] + +[[package]] +name = "libc" +version = "0.2.126" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "349d5a591cd28b49e1d1037471617a32ddcda5731b99419008085f72d5a53836" + +[[package]] +name = "libgit2-sys" +version = "0.13.4+1.4.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d0fa6563431ede25f5cc7f6d803c6afbc1c5d3ad3d4925d12c882bf2b526f5d1" +dependencies = [ + "cc", + "libc", + "libssh2-sys", + "libz-sys", + "openssl-sys", + "pkg-config", +] + +[[package]] +name = "libssh2-sys" +version = "0.2.23" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b094a36eb4b8b8c8a7b4b8ae43b2944502be3e59cd87687595cf6b0a71b3f4ca" +dependencies = [ + "cc", + "libc", + "libz-sys", + "openssl-sys", + "pkg-config", + "vcpkg", +] + +[[package]] +name = "libz-sys" +version = "1.1.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9702761c3935f8cc2f101793272e202c72b99da8f4224a19ddcf1279a6450bbf" +dependencies = [ + "cc", + "libc", + "pkg-config", + "vcpkg", +] + +[[package]] +name = "lock_api" +version = "0.4.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "327fa5b6a6940e4699ec49a9beae1ea4845c6bab9314e4f84ac68742139d8c53" +dependencies = [ + "autocfg", + "scopeguard", +] + +[[package]] +name = "log" +version = "0.4.17" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "abb12e687cfb44aa40f41fc3978ef76448f9b6038cad6aef4259d3c095a2382e" +dependencies = [ + "cfg-if", +] + +[[package]] +name = "machine-uid" +version = "0.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1f1595709b0a7386bcd56ba34d250d626e5503917d05d32cdccddcd68603e212" +dependencies = [ + "winreg", +] + +[[package]] +name = "matches" +version = "0.1.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a3e378b66a060d48947b590737b30a1be76706c8dd7b8ba0f2fe3989c68a853f" + +[[package]] +name = "mio" +version = "0.8.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "57ee1c23c7c63b0c9250c339ffdc69255f110b298b901b9f6c82547b7b87caaf" +dependencies = [ + "libc", + "log", + "wasi", + "windows-sys", +] + +[[package]] +name = "once_cell" +version = "1.12.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7709cef83f0c1f58f666e746a08b21e0085f7440fa6a29cc194d68aac97a4225" + +[[package]] +name = "openssl-probe" +version = "0.1.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ff011a302c396a5197692431fc1948019154afc178baf7d8e37367442a4601cf" + +[[package]] +name = "openssl-sys" +version = "0.9.74" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "835363342df5fba8354c5b453325b110ffd54044e588c539cf2f20a8014e4cb1" +dependencies = [ + "autocfg", + "cc", + "libc", + "pkg-config", + "vcpkg", +] + +[[package]] +name = "os_str_bytes" +version = "6.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "21326818e99cfe6ce1e524c2a805c189a99b5ae555a35d19f9a284b427d86afa" + +[[package]] +name = "parking_lot" +version = "0.12.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3742b2c103b9f06bc9fff0a37ff4912935851bee6d36f3c02bcc755bcfec228f" +dependencies = [ + "lock_api", + "parking_lot_core", +] + +[[package]] +name = "parking_lot_core" +version = "0.9.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "09a279cbf25cb0757810394fbc1e359949b59e348145c643a939a525692e6929" +dependencies = [ + "cfg-if", + "libc", + "redox_syscall", + "smallvec", + "windows-sys", +] + +[[package]] +name = "percent-encoding" +version = "2.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d4fd5641d01c8f18a23da7b6fe29298ff4b55afcccdf78973b24cf3175fee32e" + +[[package]] +name = "pkg-config" +version = "0.3.25" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1df8c4ec4b0627e53bdf214615ad287367e482558cf84b109250b37464dc03ae" + +[[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.40" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "dd96a1e8ed2596c337f8eae5f24924ec83f5ad5ab21ea8e455d3566c69fbcaf7" +dependencies = [ + "unicode-ident", +] + +[[package]] +name = "quote" +version = "1.0.20" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3bcdf212e9776fbcb2d23ab029360416bb1706b1aea2d1a5ba002727cbcab804" +dependencies = [ + "proc-macro2", +] + +[[package]] +name = "redox_syscall" +version = "0.2.13" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "62f25bc4c7e55e0b0b7a1d43fb893f4fa1361d0abe38b9ce4f323c2adfe6ef42" +dependencies = [ + "bitflags", +] + +[[package]] +name = "scopeguard" +version = "1.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d29ab0c6d3fc0ee92fe66e2d99f700eab17a8d57d1c1d3b748380fb20baa78cd" + +[[package]] +name = "semver" +version = "1.0.12" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a2333e6df6d6598f2b1974829f853c2b4c5f4a6e503c10af918081aa6f8564e1" + +[[package]] +name = "serde" +version = "1.0.137" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "61ea8d54c77f8315140a05f4c7237403bf38b72704d031543aa1d16abbf517d1" + +[[package]] +name = "signal-hook" +version = "0.3.14" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a253b5e89e2698464fc26b545c9edceb338e18a89effeeecfea192c3025be29d" +dependencies = [ + "libc", + "signal-hook-registry", +] + +[[package]] +name = "signal-hook-mio" +version = "0.2.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "29ad2e15f37ec9a6cc544097b78a1ec90001e9f71b81338ca39f430adaca99af" +dependencies = [ + "libc", + "mio", + "signal-hook", +] + +[[package]] +name = "signal-hook-registry" +version = "1.4.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e51e73328dc4ac0c7ccbda3a494dfa03df1de2f46018127f60c693f2648455b0" +dependencies = [ + "libc", +] + +[[package]] +name = "smallvec" +version = "1.9.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2fd0db749597d91ff862fd1d55ea87f7855a744a8425a64695b6fca237d1dad1" + +[[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.98" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c50aef8a904de4c23c788f104b7dddc7d6f79c647c7c8ce4cc8f73eb0ca773dd" +dependencies = [ + "proc-macro2", + "quote", + "unicode-ident", +] + +[[package]] +name = "termcolor" +version = "1.1.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bab24d30b911b2376f3a13cc2cd443142f0c81dda04c118693e35b3835757755" +dependencies = [ + "winapi-util", +] + +[[package]] +name = "termtree" +version = "0.4.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "95059e91184749cb66be6dc994f67f182b6d897cb3df74a5bf66b5e709295fd8" + +[[package]] +name = "textwrap" +version = "0.15.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b1141d4d61095b28419e22cb0bbf02755f5e54e0526f97f1e3d1d160e60885fb" + +[[package]] +name = "tinyvec" +version = "1.6.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "87cc5ceb3875bb20c2890005a4e226a4651264a5c75edb2421b52861a0a0cb50" +dependencies = [ + "tinyvec_macros", +] + +[[package]] +name = "tinyvec_macros" +version = "0.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cda74da7e1a664f795bb1f8a87ec406fb89a02522cf6e50620d016add6dbbf5c" + +[[package]] +name = "toml" +version = "0.5.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8d82e1a7758622a465f8cee077614c73484dac5b836c02ff6a40d5d1010324d7" +dependencies = [ + "serde", +] + +[[package]] +name = "unicode-bidi" +version = "0.3.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "099b7128301d285f79ddd55b9a83d5e6b9e97c92e0ea0daebee7263e932de992" + +[[package]] +name = "unicode-ident" +version = "1.0.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5bd2fe26506023ed7b5e1e315add59d6f584c621d037f9368fea9cfb988f368c" + +[[package]] +name = "unicode-normalization" +version = "0.1.20" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "81dee68f85cab8cf68dec42158baf3a79a1cdc065a8b103025965d6ccb7f6cbd" +dependencies = [ + "tinyvec", +] + +[[package]] +name = "url" +version = "2.2.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a507c383b2d33b5fc35d1861e77e6b383d158b2da5e14fe51b83dfedf6fd578c" +dependencies = [ + "form_urlencoded", + "idna", + "matches", + "percent-encoding", +] + +[[package]] +name = "vcpkg" +version = "0.2.15" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "accd4ea62f7bb7a82fe23066fb0957d48ef677f6eeb8215f372f52e48bb32426" + +[[package]] +name = "version_check" +version = "0.9.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "49874b5167b65d7193b8aba1567f5c7d93d001cafc34600cee003eda787e483f" + +[[package]] +name = "wasi" +version = "0.11.0+wasi-snapshot-preview1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9c8d87e72b64a3b4db28d11ce29237c246188f4f51057d65a7eab63b7987e423" + +[[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" + +[[package]] +name = "windows-sys" +version = "0.36.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ea04155a16a59f9eab786fe12a4a450e75cdb175f9e0d80da1e17db09f55b8d2" +dependencies = [ + "windows_aarch64_msvc", + "windows_i686_gnu", + "windows_i686_msvc", + "windows_x86_64_gnu", + "windows_x86_64_msvc", +] + +[[package]] +name = "windows_aarch64_msvc" +version = "0.36.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9bb8c3fd39ade2d67e9874ac4f3db21f0d710bee00fe7cab16949ec184eeaa47" + +[[package]] +name = "windows_i686_gnu" +version = "0.36.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "180e6ccf01daf4c426b846dfc66db1fc518f074baa793aa7d9b9aaeffad6a3b6" + +[[package]] +name = "windows_i686_msvc" +version = "0.36.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e2e7917148b2812d1eeafaeb22a97e4813dfa60a3f8f78ebe204bcc88f12f024" + +[[package]] +name = "windows_x86_64_gnu" +version = "0.36.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4dcd171b8776c41b97521e5da127a2d86ad280114807d0b2ab1e462bc764d9e1" + +[[package]] +name = "windows_x86_64_msvc" +version = "0.36.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c811ca4a8c853ef420abd8592ba53ddbbac90410fab6903b3e79972a631f7680" + +[[package]] +name = "winreg" +version = "0.6.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b2986deb581c4fe11b621998a5e53361efe6b48a151178d0cd9eeffa4dc6acc9" +dependencies = [ + "winapi", +] diff --git a/Cargo.toml b/Cargo.toml new file mode 100644 index 0000000..3dc92b3 --- /dev/null +++ b/Cargo.toml @@ -0,0 +1,20 @@ +[package] +name = "cargo-vcs" +version = "0.1.0" +description = "Cargo Version Control System helper" +edition = "2021" +license = "AGPL-3.0-only" +authors = ["Aleš Katona "] +rust-version = "1.59" +readme = "README.md" +keywords = ["cargo", "git", "versioning", "workspace"] +categories = ["development-tools::cargo-plugins", "command-line-utilities"] + +[dependencies] +clap = { version = "3.2", features = ["derive"] } +crossterm = "0.24" +git2 = "0.14" +machine-uid = "0.2" +semver = "1.0" +termtree = "0.4" +toml = "0.5" diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..bae94e1 --- /dev/null +++ b/LICENSE @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are 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. + + 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. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + 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 Affero 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. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + 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 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 work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero 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 Affero 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 Affero 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 Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero 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 Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + 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 AGPL, see +. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..21b57e0 --- /dev/null +++ b/README.md @@ -0,0 +1,3 @@ +# Cargo Version Control System extension + +Cargo-vcs is a Cargo extension that adds version control helpers to help manage workspaces. \ No newline at end of file diff --git a/src/main.rs b/src/main.rs new file mode 100644 index 0000000..b8becf8 --- /dev/null +++ b/src/main.rs @@ -0,0 +1,42 @@ +use clap::Parser; + +mod vcs; + +use vcs::cli::*; + +fn main() { + let args = Cli::parse(); + + let work_dir = args + .path + .unwrap_or_else(|| std::env::current_dir().expect("Unable to obtain current_dir")); + let mut vcs = match vcs::Vcs::new(work_dir) { + Ok(val) => val, + Err(err) => { + eprintln!("{}", err); + std::process::exit(err.exit_code()); + } + }; + + match args.command { + Commands::Branch(BranchCommand::Set { branch }) => { + vcs.set_branch(&branch) + .expect("Error setting branch on projects"); + } + Commands::Profile(ProfileCommand::Save { profile }) => { + vcs.save_profile(&profile) + .expect("Error saving vcs profile"); + } + Commands::Profile(ProfileCommand::Set { profile }) => { + vcs.set_profile(&profile) + .expect("Error setting vcs profile"); + } + Commands::Status { verbose } => { + if verbose { + vcs.list(); + } else { + vcs.info().expect("Error summarizing info"); + } + } + } +} diff --git a/src/vcs.rs b/src/vcs.rs new file mode 100644 index 0000000..aea32ff --- /dev/null +++ b/src/vcs.rs @@ -0,0 +1,344 @@ +use crossterm::style::Stylize; +use std::{ + collections::HashMap, + fs, + path::{Path, PathBuf}, +}; + +use toml::{ + value::{Map, Table}, + Value, +}; + +pub mod cli; +mod colors; +mod error; +mod project; +mod systems; + +use colors::*; + +pub use error::*; +pub use project::*; + +pub struct Vcs { + work_dir: PathBuf, + profiles: Vec, + projects: Vec, +} + +impl Vcs { + pub fn new(work_dir: PathBuf) -> Result { + // find Cargo.toml recursively from given path + let toml_path = Self::search(&work_dir)?; + // set work_dir to Cargo.toml parent folder + let work_dir = toml_path + .parent() + .ok_or_else(|| { + Error::input_error( + "Invalid work_dir found", + toml_path.to_str().expect("Invalid UTF-8 in path"), + ) + })? + .to_path_buf(); + + if !toml_path.exists() { + return Err(Error::input_error( + "work_dir invalid", + &work_dir.display().to_string(), + )); + } + + if !toml_path.exists() { + return Err(Error::input_error( + "Unable to find Cargo.toml", + &toml_path.display().to_string(), + )); + } + + let workspace = Self::get_workspace_toml(&toml_path)?; + + let members = workspace + .get("members") + .ok_or_else(|| Error::cargo_error("Cargo.toml missing [members] array"))? + .as_array() + .ok_or_else(|| Error::cargo_error("Cargo.toml [members] is not an array"))? + .to_owned(); + + let vcs_path = work_dir.join("Cargo_vcs.toml"); + let profiles_map = if vcs_path.exists() { + let vcs_contents = fs::read_to_string(vcs_path)?; + let vcs: toml::Value = toml::from_str(&vcs_contents)?; + let vcs_main = vcs + .as_table() + .ok_or_else(|| Error::cargo_error("Cargo_vcs.toml is not a yaml table"))? + .to_owned(); + Self::find_profiles(&vcs_main)? + } else { + HashMap::new() + }; + + let profiles = profiles_map.keys().cloned().collect(); + let projects = Self::process_repos(&work_dir, &members, &profiles_map)?; + + Ok(Self { + work_dir, + profiles, + projects, + }) + } + + pub fn list(&self) { + for project in self.projects() { + println!("{}", project); + } + } + + pub fn info(&self) -> Result<(), Error> { + if let Some(profile_name) = self.current_profile()? { + println!( + "{}{} [{}]", + "Workspace is set to profile: ".with(SUCCESS_COLOR), + profile_name.bold().with(PROFILE_COLOR), + format!("{}", self.work_dir.display()).italic(), + ); + } else { + println!("{}", "Mismatching projects and profiles".with(ERROR_COLOR)); + self.list(); + } + + Ok(()) + } + + pub fn projects(&self) -> Projects<'_> { + self.projects.iter() + } + + pub fn save_profile(&self, profile_name: &str) -> Result<(), Error> { + let vcs_path = self.work_dir.join("Cargo_vcs.toml"); + let vcs = match fs::read_to_string(&vcs_path) { + Ok(val) => toml::from_str(&val)?, + Err(_) => Value::Table(Map::new()), + }; + let mut vcs_main = vcs + .as_table() + .ok_or_else(|| Error::cargo_error("Cargo_vcs.toml is not a yaml table"))? + .to_owned(); + + let value = self.current_profile_toml_value()?; + if let Some(vcs_section) = vcs_main.get_mut("vcs") { + if let Some(section) = vcs_section.as_table_mut() { + section.insert(profile_name.into(), value); + } else { + return Err(Error::Upstream(Box::new(toml::ser::Error::Custom( + "Existing vcs section not a table".into(), + )))); + } + } else { + let mut section = Table::new(); + section.insert(profile_name.into(), value); + vcs_main.insert("vcs".into(), Value::Table(section)); + } + + let new_contents = toml::to_string(&vcs_main)?; + fs::write(vcs_path, new_contents)?; + + println!( + "{}{}", + "Workspace state saved as ".with(SUCCESS_COLOR), + profile_name.with(PROFILE_COLOR), + ); + + Ok(()) + } + + pub fn set_profile(&mut self, profile_name: &str) -> Result<(), Error> { + if !self.profiles.contains(&String::from(profile_name)) { + eprintln!( + "{}{}", + "Profile not found: ".with(ERROR_COLOR), + profile_name.with(PROFILE_COLOR) + ); + return Ok(()); + } + + let current_profile = self.current_profile()?; + + for project in &mut self.projects { + let mut stashed_changes = false; + if let Some(current_profile_name) = ¤t_profile { + stashed_changes = project.repo.stash_changes(current_profile_name)?; + } + + let ref_name = project.switch_to_profile(profile_name)?; + let unstashed_changes = project.repo.unstash_changes(profile_name)?; + + println!( + "{} set to {} {}{}", + project.name().bold().with(PROJECT_COLOR), + ref_name.with(REFS_COLOR), + if stashed_changes { + "«".cyan() + } else { + "".bold() + }, + if unstashed_changes { + "»".dark_blue() + } else { + "".bold() + }, + ); + } + + Ok(()) + } + + pub fn set_branch(&self, branch_name: &str) -> Result<(), Error> { + for project in &self.projects { + project.repo.checkout(branch_name)?; + println!( + "{}{}{}", + project.name().with(PROJECT_COLOR), + " is set to branch: ".with(SUCCESS_COLOR), + branch_name.bold().with(REFS_COLOR), + ); + } + Ok(()) + } + + fn current_profile_toml_value(&self) -> Result { + let mut table = Table::new(); + + for project in &self.projects { + let head_ref_name = project.repo.current_ref()?; + table.insert(project.name().into(), Value::String(head_ref_name)); + } + + Ok(Value::Table(table)) + } + + fn current_profile(&self) -> Result, Error> { + let mut found_profile = None; + for project in &self.projects { + match project.current_profile()? { + None => return Ok(None), // gap + Some(project_profile) => match &mut found_profile { + Some(previous) => { + if previous != &project_profile { + return Ok(None); // mismatch + } + } + None => { + found_profile.replace(project_profile); + } + }, + } + } + + Ok(found_profile) + } + + fn find_profiles( + vcs_main: &Map, + ) -> Result>, Error> { + let mut result = HashMap::new(); + + if let Some(vcs_section) = vcs_main.get("vcs") { + if let Some(vcs) = vcs_section.as_table() { + for profile in vcs { + if let Some(repo_to_branch) = profile.1.as_table() { + let mut names = HashMap::new(); + for rtb in repo_to_branch { + let project_name = rtb.0.clone(); + let branch_name = rtb.1.as_str().ok_or_else(|| { + Error::project_error("Invalid UTF-8 in branch name") + })?; + names.insert(project_name, branch_name.to_owned()); + } + + let profile_name = profile.0.clone(); + result.insert(profile_name, names); + } + } + } + } + + Ok(result) + } + + fn process_repos( + work_dir: &Path, + members: &Vec, + profiles: &HashMap>, + ) -> Result, Error> { + let mut projects = Vec::new(); + for member in members { + let repo_postfix = member + .as_str() + .ok_or_else(|| Error::project_error("Repo not a string"))?; + let repo_path = work_dir.join(repo_postfix); + + let repo_basename = Path::new(repo_postfix) + .components() + .last() + .ok_or_else(|| Error::project_error("Repo basename not found"))? + .as_os_str() + .to_str() + .ok_or_else(|| Error::project_error("Repo basename not valid UTF-8"))?; + + let mut profile_map = HashMap::new(); + + for profile in profiles { + if let Some(branch_name) = profile.1.get(repo_basename) { + profile_map.insert(profile.0.clone(), branch_name.clone()); + } + } + + projects.push(Project::new(repo_path, profile_map)?); + } + + Ok(projects) + } + + fn search(path: &Path) -> Result { + let path_str = path.to_str().expect("Invalid UTF-8 in path"); + if !path.exists() { + return Err(Error::input_error("Search path not found", path_str)); + } + + if !path.is_dir() { + return Err(Error::input_error("Search path not a directory", path_str)); + } + + let mut path = path; + loop { + let try_cargo = path.join("Cargo.toml"); + if try_cargo.exists() && Self::get_workspace_toml(&try_cargo).is_ok() { + return Ok(try_cargo); + } else { + path = path + .parent() + .ok_or_else(|| Error::input_error("Workspace not found", path_str))?; + } + } + } + + fn get_workspace_toml(path: &Path) -> Result, Error> { + let toml_contents = fs::read_to_string(path)?; + let cargo: toml::Value = toml::from_str(&toml_contents)?; + + let cargo_main = cargo + .as_table() + .ok_or_else(|| Error::cargo_error("Cargo.toml is not a yaml table"))? + .to_owned(); + + let workspace = cargo_main + .get("workspace") + .ok_or_else(|| Error::cargo_error("Cargo.toml is not a workspace"))? + .as_table() + .ok_or_else(|| Error::cargo_error("Cargo.toml [workspace] is not a table"))? + .to_owned(); + + Ok(workspace) + } +} diff --git a/src/vcs/cli.rs b/src/vcs/cli.rs new file mode 100644 index 0000000..4847a17 --- /dev/null +++ b/src/vcs/cli.rs @@ -0,0 +1,46 @@ +use clap::Parser; +use std::path::PathBuf; + +/// A fictional versioning CLI +#[derive(Debug, Parser)] +#[clap(name = "cargo-vcs")] +#[clap(about = "Version control helper for Cargo", long_about = None)] +pub struct Cli { + #[clap(subcommand)] + pub command: Commands, + /// Path to workspace folder, defaults to CWD + #[clap(short = 'p')] + pub path: Option, +} + +#[derive(Debug, Parser)] +pub enum Commands { + /// Show workspace status + Status { + #[clap(short = 'v')] + verbose: bool, + }, + /// Set or save profiles + #[clap(subcommand)] + Profile(ProfileCommand), + /// Set branch globally on workspace + #[clap(subcommand)] + Branch(BranchCommand), +} + +#[derive(Debug, Parser)] +pub enum ProfileCommand { + /// Save the current workspace VCS state to Cargo_vcs.toml under given profile name + #[clap(arg_required_else_help = true)] + Save { profile: String }, + /// Switch workspace to given profile + #[clap(arg_required_else_help = true)] + Set { profile: String }, +} + +#[derive(Debug, Parser)] +pub enum BranchCommand { + /// Switch all projects in workspace to given branch + #[clap(arg_required_else_help = true)] + Set { branch: String }, +} diff --git a/src/vcs/colors.rs b/src/vcs/colors.rs new file mode 100644 index 0000000..e7c2c00 --- /dev/null +++ b/src/vcs/colors.rs @@ -0,0 +1,9 @@ +use crossterm::style::Color; + +pub const PROJECT_COLOR: Color = Color::Red; +pub const PROFILE_COLOR: Color = Color::Blue; +pub const SUCCESS_COLOR: Color = Color::Green; +pub const ERROR_COLOR: Color = Color::DarkRed; +pub const CHANGES_COLOR: Color = Color::Cyan; +pub const REFS_COLOR: Color = Color::DarkYellow; +pub const MSRV_COLOR: Color = Color::DarkCyan; diff --git a/src/vcs/error.rs b/src/vcs/error.rs new file mode 100644 index 0000000..47a1e69 --- /dev/null +++ b/src/vcs/error.rs @@ -0,0 +1,88 @@ +use crossterm::style::{StyledContent, Stylize}; +use std::fmt::Display; + +#[derive(Debug)] +pub enum Error { + /// Any upstream library error + Upstream(Box), + /// Cargo.toml specific logical errors + Cargo(String), + /// Project/repo status logical errors + Project(String), + /// Input selection errors (e.g. bad profile name) + Input(String), +} + +impl From for Error { + fn from(ge: git2::Error) -> Self { + Error::Upstream(Box::new(ge)) + } +} + +impl From for Error { + fn from(ie: std::io::Error) -> Self { + Error::Upstream(Box::new(ie)) + } +} + +impl From for Error { + fn from(tde: toml::de::Error) -> Self { + Error::Upstream(Box::new(tde)) + } +} + +impl From for Error { + fn from(tse: toml::ser::Error) -> Self { + Error::Upstream(Box::new(tse)) + } +} + +impl From for Error { + fn from(se: semver::Error) -> Self { + Error::Upstream(Box::new(se)) + } +} + +impl From> for Error { + fn from(other: Box) -> Self { + Error::Upstream(other) + } +} + +impl Error { + pub fn cargo_error(line: &str) -> Self { + Error::Cargo(line.into()) + } + + pub fn input_error(line: &str, value: &str) -> Self { + Error::Input(format!("{}: {}", line, value)) + } + + pub fn project_error(line: &str) -> Self { + Error::Project(line.into()) + } + + pub fn exit_code(&self) -> i32 { + match self { + Self::Upstream(_) => 10, + Self::Cargo(_) => 11, + Self::Project(_) => 12, + Self::Input(_) => 13, + } + } + + fn to_styled(&self) -> StyledContent { + match self { + Self::Upstream(e) => e.to_string().red(), + Self::Cargo(e) => e.to_string().cyan(), + Self::Project(e) => e.to_string().yellow(), + Self::Input(e) => e.to_string().dark_red(), + } + } +} + +impl Display for Error { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + write!(f, "{}", self.to_styled()) + } +} diff --git a/src/vcs/project.rs b/src/vcs/project.rs new file mode 100644 index 0000000..7af5591 --- /dev/null +++ b/src/vcs/project.rs @@ -0,0 +1,167 @@ +use std::{ + collections::HashMap, + fmt::Display, + path::{Path, PathBuf}, +}; + +use crossterm::style::Stylize; +use semver::Version; +use termtree::Tree; + +use super::colors::*; +use super::error::Error; +use super::systems::{git::GitRepository, Repository}; + +pub struct Project { + path: PathBuf, + name: String, + msrv: Option, + pub repo: Box, + profile_map: HashMap, // vcs profile name to branch names +} + +pub type Projects<'origin> = std::slice::Iter<'origin, Project>; + +impl Project { + pub fn new(path: PathBuf, profile_map: HashMap) -> Result { + let name = path + .components() + .last() + .ok_or_else(|| Error::project_error("Unable to get project name"))? + .as_os_str() + .to_str() + .ok_or_else(|| Error::project_error("Project path contains invalid UTF-8"))? + .to_owned(); + + let repo = GitRepository::open(&path)?; + let msrv = Self::parse_msrv(&path)?; + + Ok(Self { + path, + name, + msrv, + repo, + profile_map, + }) + } + + pub fn name(&self) -> &str { + &self.name + } + + pub fn path(&self) -> &Path { + &self.path + } + + pub fn current_profile(&self) -> Result, Error> { + let current_ref = self.repo.current_ref()?; + if let Some(val) = self.profile_map.iter().find(|v| v.1 == ¤t_ref) { + return Ok(Some(val.0.clone())); + } + + Ok(None) + } + + pub fn switch_to_profile(&self, profile_name: &str) -> Result { + if let Some(ref_name) = self.profile_map.get(profile_name) { + self.repo.checkout(ref_name)?; + Ok(ref_name.into()) + } else { + Err(Error::input_error( + "Unable to find profile for branch", + self.name(), + )) + } + } + + fn parse_msrv(path: &Path) -> Result, Error> { + let toml_path = path.join("Cargo.toml"); + let toml_contents = std::fs::read_to_string(toml_path)?; + + let cargo: toml::Value = toml::from_str(&toml_contents)?; + + if let Some(pkg) = cargo.get("package") { + if let Some(value) = pkg.get("rust-version") { + if value.is_str() { + let mut ver_str = value + .as_str() + .ok_or_else(|| Error::cargo_error("Unparsable rust-version in Cargo.toml"))? + .to_owned(); + let dots = ver_str.chars().filter(|c| *c == '.').count(); + if !(1..=2).contains(&dots) { + return Err(Error::cargo_error("Invalid rust-version in Cargo.toml")); + } + // TODO: figure out if we can un-hack this + if dots == 1 { + ver_str += ".0"; // make 1.59 -> 1.59.0 for semver comparisons + } + let ver_req = Version::parse(&ver_str)?; + + return Ok(Some(ver_req)); + } + } + } + + Ok(None) + } + + pub fn display(&self, profiles: bool, changes: bool) -> Result, Error> { + let title = format!( + "{}: {} [{}]", + self.name().bold().with(PROJECT_COLOR), + self.repo.current_ref()?.with(REFS_COLOR), + format!("{}", self.path().display()).italic(), + ); + let mut root = Tree::new(title); + + if profiles { + let mut profiles_tree = Tree::new("[PROFILES]".with(PROFILE_COLOR).to_string()); + for (profile_name, branch_name) in &self.profile_map { + let leaf = Tree::new(format!( + "{} -> {}", + profile_name.as_str().with(PROFILE_COLOR), + branch_name.as_str().with(REFS_COLOR) + )); + profiles_tree.push(leaf); + } + + root.push(profiles_tree); + } + if changes { + let statuses = self.repo.uncommitted_changes()?; + let uncommitted = statuses + .iter() + .map(|path| Tree::::new(path.as_str().with(CHANGES_COLOR).to_string())); + let mut changes_tree = Tree::new("[CHANGES]".with(CHANGES_COLOR).to_string()); + let mut change_count = 0; + for change in uncommitted { + change_count += 1; + changes_tree.push(change); + } + + if change_count > 0 { + root.push(changes_tree); + } + } + + if let Some(msrv) = &self.msrv { + let leaf = Tree::new(msrv.to_string().with(MSRV_COLOR).to_string()); + let mut msrv_tree = Tree::new("[MSRV]".with(MSRV_COLOR).to_string()); + msrv_tree.push(leaf); + + root.push(msrv_tree); + } + + Ok(root) + } +} + +impl Display for Project { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + write!( + f, + "{}", + self.display(true, true).map_err(|_| std::fmt::Error)? + ) + } +} diff --git a/src/vcs/systems.rs b/src/vcs/systems.rs new file mode 100644 index 0000000..5437936 --- /dev/null +++ b/src/vcs/systems.rs @@ -0,0 +1,15 @@ +pub mod git; + +use super::Error; + +pub trait Repository { + fn current_ref(&self) -> Result; + + fn checkout(&self, ref_name: &str) -> Result<(), Error>; + + fn stash_changes(&mut self, profile_name: &str) -> Result; + + fn unstash_changes(&mut self, profile_name: &str) -> Result; + + fn uncommitted_changes(&self) -> Result, Error>; +} diff --git a/src/vcs/systems/git.rs b/src/vcs/systems/git.rs new file mode 100644 index 0000000..196959f --- /dev/null +++ b/src/vcs/systems/git.rs @@ -0,0 +1,148 @@ +use std::path::Path; + +use super::{Error, Repository}; + +pub struct GitRepository { + repo: git2::Repository, + machine_id: String, +} + +impl Repository for GitRepository { + fn current_ref(&self) -> Result { + if self.repo.head_detached()? { + self.match_tag() + } else { + let head_ref = self.repo.head()?; + let name = head_ref + .name() + .ok_or_else(|| Error::project_error("Unable to retreive HEAD reference"))? + .into(); + + Ok(name) + } + } + + fn checkout(&self, name: &str) -> Result<(), Error> { + let target_ref = self.repo.resolve_reference_from_short_name(name)?; + let ref_name = target_ref + .name() + .ok_or_else(|| Error::project_error("Invalid UTF-8 in git reference"))?; + + self.checkout_ref(ref_name)?; + self.repo.set_head(ref_name)?; + + Ok(()) + } + + fn stash_changes(&mut self, profile_name: &str) -> Result { + if self.uncommitted_changes()?.is_empty() { + return Ok(false); + } + + let repo_signature = self.repo.signature()?; + let stash_name = self.stash_name(profile_name); + self.repo.stash_save(&repo_signature, &stash_name, None)?; + + Ok(true) + } + + fn unstash_changes(&mut self, profile_name: &str) -> Result { + let mut found_stash = None; + let stash_name = self.stash_name(profile_name); + + self.repo.stash_foreach(|idx, name, _| { + if name.contains(&stash_name) { + if found_stash.is_none() { + found_stash.replace(Ok(idx)); + } else { + found_stash + .replace(Err(Error::project_error("Multiple stashed changes found"))); + } + } + true + })?; + + match found_stash { + Some(Ok(idx)) => { + self.repo.stash_apply(idx, None)?; + self.repo.stash_drop(idx)?; + Ok(true) + } + Some(Err(err)) => Err(err), + None => Ok(false), + } + } + + fn uncommitted_changes(&self) -> Result, Error> { + if self.repo.state() != git2::RepositoryState::Clean { + let err = format!( + "{} repository not in clean state", + self.repo.path().display() + ); + return Err(Error::Project(err)); + } + + let mut status_options = git2::StatusOptions::new(); + status_options.include_ignored(false); + status_options.include_untracked(false); + + let iter = self + .repo + .statuses(Some(&mut status_options))? + .iter() + .map(|s| s.path().unwrap().to_string()) // TODO: bubble this up + .collect(); + + Ok(iter) + } +} + +impl GitRepository { + pub fn open(path: &Path) -> Result, Error> { + let repo = git2::Repository::open(path)?; + + Ok(Box::new(Self { + repo, + machine_id: machine_uid::get()?, + })) + } + + fn checkout_ref(&self, ref_name: &str) -> Result<(), Error> { + let ref_val = self.repo.find_reference(ref_name)?; + let commit = self.repo.reference_to_annotated_commit(&ref_val)?; + let tree = self.repo.find_object(commit.id(), None)?; + self.repo.checkout_tree(&tree, None)?; + + Ok(()) + } + + fn stash_name(&mut self, profile_name: &str) -> String { + format!("cargo-vcs_{}_{}", self.machine_id, profile_name) + } + + fn match_tag(&self) -> Result { + let head_ref = self.repo.head()?; + + let commit = head_ref.peel_to_commit()?; + let mut tag_data = Vec::new(); + self.repo.tag_foreach(|oid, name_u8| { + tag_data.push((oid, Vec::from(name_u8))); + true + })?; + + for raw in tag_data { + let oid = raw.0; + let name = std::str::from_utf8(&raw.1) + .map_err(|_| Error::project_error("Invalid UTF-8 in tag name"))?; + + if let Ok(tag) = self.repo.find_tag(oid) { + let peeled = tag.peel()?; + if peeled.id() == commit.id() { + return Ok(name.into()); + } + } + } + + Err(Error::project_error("Tag not found")) + } +}