commit d10b48d5a0526f207cc5505f2318a448d13b8896
Author: Zack Newman <zack@philomathiclife.com>
Date: Mon, 30 Oct 2023 23:37:35 -0600
init
Diffstat:
| A | .gitignore | | | 2 | ++ |
| A | Cargo.toml | | | 27 | +++++++++++++++++++++++++++ |
| A | LICENSE-APACHE | | | 177 | +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
| A | LICENSE-MIT | | | 20 | ++++++++++++++++++++ |
| A | README.md | | | 15 | +++++++++++++++ |
| A | src/args.rs | | | 84 | +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
| A | src/main.rs | | | 233 | +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
7 files changed, 558 insertions(+), 0 deletions(-)
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,2 @@
+Cargo.lock
+target/**
diff --git a/Cargo.toml b/Cargo.toml
@@ -0,0 +1,27 @@
+[package]
+authors = ["Zack Newman <zack@philomathiclife.com>"]
+categories = ["command-line-utilities"]
+description = "Invokes stagit-index by passing repos in descending chronological order by commit data."
+edition = "2021"
+keywords = ["git", "stagit"]
+license = "MIT OR Apache-2.0"
+name = "git_index"
+readme = "README.md"
+repository = "https://git.philomathiclife.com/repos/git_index/"
+version = "0.1.0"
+
+[[bin]]
+name = "git_index"
+path = "src/main.rs"
+
+[dependencies]
+priv_sep = { version = "0.8.0", default-features = false, features = ["openbsd"] }
+time = { version = "0.3.30", default-features = false, features = ["parsing"] }
+
+[badges]
+maintenance = { status = "actively-developed" }
+
+[profile.release]
+lto = true
+panic = 'abort'
+strip = true
diff --git a/LICENSE-APACHE b/LICENSE-APACHE
@@ -0,0 +1,177 @@
+
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
diff --git a/LICENSE-MIT b/LICENSE-MIT
@@ -0,0 +1,20 @@
+Copyright © 2023 Zack Newman
+
+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.
+
+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.
diff --git a/README.md b/README.md
@@ -0,0 +1,15 @@
+# git_index
+
+`git_index` invokes [`stagit-index`](https://codemadness.org/stagit.html) by passing in `git` repos in descending
+order by commit date. The absolute path to the parent directory containing `git` repos is passed via `-d`/`--dir`.
+
+### Status
+
+This package is self-serving. I host `git.philomathiclife.com` which serves my `git` repos in addition to an HTTPS
+front-end via [`httpd`](https://man.openbsd.org/OpenBSD-7.4/amd64/httpd.8) on OpenBSD-stable. The static HTML files
+are created with `stagit`, and the index file is created by `stagit-index`. `stagit-index` requires one to pass
+the directories via arguments. The order of the arguments dictates the order of the resulting entries in
+`index.html`. This program simply extracts the most recent commit from each repo via `git log` and writes the
+paths of the repos in descending order of commit date to `stdout`. One can use command substitution to pass this to
+`stagit-index`. There are several assumptions made in this program like `/usr/local/bin/git` exists and is
+the path to `git`, and every child directory of the passed directory is a valid `git` repo.
diff --git a/src/args.rs b/src/args.rs
@@ -0,0 +1,84 @@
+use core::convert::AsRef;
+use core::fmt::{self, Display, Formatter};
+use std::env::{self, Args};
+use std::error::Error;
+use std::path::{Path, PathBuf};
+/// Wrapper around an absolute [`PathBuf`] to a directory.
+#[derive(Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
+pub struct AbsDirPath {
+ /// The directory.
+ path: PathBuf,
+}
+impl AbsDirPath {
+ /// Returns an `AbsDirPath` iff `PathBuf::from(val).is_absolute()`.
+ ///
+ /// If `PathBuf::from(val).as_bytes().last().unwrap() != b'/'`, `val`
+ /// will have `/` appended to it.
+ #[allow(clippy::option_if_let_else)]
+ #[inline]
+ #[must_use]
+ pub fn from_string(val: String) -> Option<Self> {
+ match val.as_bytes().last() {
+ Some(byt) => {
+ let last = *byt;
+ let mut path = PathBuf::from(val);
+ path.is_absolute().then(|| {
+ if last != b'/' {
+ path.as_mut_os_string().push("/");
+ }
+ Self { path }
+ })
+ }
+ None => None,
+ }
+ }
+}
+impl AsRef<Path> for AbsDirPath {
+ #[inline]
+ fn as_ref(&self) -> &Path {
+ self.path.as_path()
+ }
+}
+/// Error returned when parsing arguments passed to the application.
+#[allow(clippy::exhaustive_enums, clippy::module_name_repetitions)]
+#[derive(Debug)]
+pub enum ArgsErr {
+ /// Error when no arguments were passed to the application.
+ NoArgs,
+ /// Error when an option was passed that was not an absolute file path to a directory.
+ InvalidDir,
+ /// Error when more than one option is passed.
+ MoreThanOneOption,
+}
+impl Display for ArgsErr {
+ #[inline]
+ fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
+ match *self {
+ Self::NoArgs => f.write_str("no arguments were passed, but the absolute path to the directory of git repos must be passed"),
+ Self::InvalidDir => f.write_str("an absolute path to the directory of git repos was not passed"),
+ Self::MoreThanOneOption => f.write_str("more than one argument was passed, but only the absolute path to the directory of git repos must be passed"),
+ }
+ }
+}
+impl Error for ArgsErr {}
+/// Returns `AbsDirPath` based on arguments passed to the application.
+#[allow(clippy::module_name_repetitions)]
+#[inline]
+pub fn from_env_args() -> Result<AbsDirPath, ArgsErr> {
+ /// Attempts to parse the next `Arg` into an absolute path to a directory.
+ #[allow(clippy::option_if_let_else)]
+ #[inline]
+ fn get_path(args: &mut Args) -> Result<AbsDirPath, ArgsErr> {
+ args.next()
+ .ok_or(ArgsErr::NoArgs)
+ .and_then(|path| AbsDirPath::from_string(path).ok_or(ArgsErr::InvalidDir))
+ }
+ let mut args = env::args();
+ let Some(_) = args.next() else {
+ return Err(ArgsErr::NoArgs);
+ };
+ get_path(&mut args).and_then(|path| {
+ args.next()
+ .map_or(Ok(path), |_| Err(ArgsErr::MoreThanOneOption))
+ })
+}
diff --git a/src/main.rs b/src/main.rs
@@ -0,0 +1,233 @@
+//! # `git_index`
+//!
+//! Consult [`README.md`](https://git.philomathiclife.com/git_index/file/README.md.html).
+#![deny(
+ unsafe_code,
+ unused,
+ warnings,
+ clippy::all,
+ clippy::cargo,
+ clippy::complexity,
+ clippy::correctness,
+ clippy::nursery,
+ clippy::pedantic,
+ clippy::perf,
+ clippy::restriction,
+ clippy::style,
+ clippy::suspicious
+)]
+#![allow(
+ clippy::blanket_clippy_restriction_lints,
+ clippy::implicit_return,
+ clippy::min_ident_chars,
+ clippy::missing_trait_methods,
+ clippy::question_mark_used,
+ clippy::ref_patterns,
+ clippy::single_call_fn
+)]
+extern crate alloc;
+/// Module that parsed passed options into the application.
+mod args;
+use alloc::collections::BTreeMap;
+use args::{AbsDirPath, ArgsErr};
+use core::fmt::{self, Display, Formatter};
+use core::str::{self, Utf8Error};
+use priv_sep::{Permissions, Promise, Promises, UnveilErr};
+use std::error;
+use std::ffi::OsString;
+use std::fs;
+use std::io::{self, Error, Write};
+use std::path::Path;
+use std::process::{Command, Stdio};
+use time::error::Parse;
+use time::format_description::well_known::Iso8601;
+use time::OffsetDateTime;
+/// Module for reading the options passed to the application.
+/// Error returned from the program.
+enum E {
+ /// Variant for errors due to incorrect arguments being passed.
+ Args(ArgsErr),
+ /// Variant for errors due to calls to `unveil`.
+ Unveil(UnveilErr),
+ /// Variant for IO errors.
+ Io(Error),
+ /// Variant when a git repo directory is not valid UTF-8.
+ NonUtf8Path(OsString),
+ /// Variant when git errors.
+ GitErr(Vec<u8>),
+ /// Variant when git output is not valid UTF-8.
+ Git(Utf8Error),
+ /// Variant when git output is not a valid ISO 8601 timestamp.
+ Time(Parse),
+}
+impl fmt::Debug for E {
+ #[inline]
+ fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
+ <Self as Display>::fmt(self, f)
+ }
+}
+impl Display for E {
+ #[allow(clippy::use_debug, clippy::ref_patterns)]
+ #[inline]
+ fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
+ match *self {
+ Self::Args(ref e) => e.fmt(f),
+ Self::Unveil(ref err) => write!(f, "unveil(2) failed with {err}"),
+ Self::Io(ref e) => e.fmt(f),
+ Self::NonUtf8Path(ref e) => write!(f, "{e:?} is not valid UTF-8"),
+ Self::GitErr(ref e) => match str::from_utf8(e.as_slice()) {
+ Ok(err) => write!(f, "git errored with: {err}"),
+ Err(err) => write!(f, "git errored with an invalid UTF-8 error: {err}"),
+ },
+ Self::Git(ref e) => write!(
+ f,
+ "git succeeded, but its output was not valid UTF-8: {e:?}"
+ ),
+ Self::Time(e) => write!(
+ f,
+ "git succeeded, but its output is not a valid ISO 8601 timestamp: {e}"
+ ),
+ }
+ }
+}
+impl error::Error for E {}
+impl From<ArgsErr> for E {
+ #[inline]
+ fn from(value: ArgsErr) -> Self {
+ Self::Args(value)
+ }
+}
+impl From<Error> for E {
+ #[inline]
+ fn from(value: Error) -> Self {
+ Self::Io(value)
+ }
+}
+impl From<UnveilErr> for E {
+ #[inline]
+ fn from(value: UnveilErr) -> Self {
+ Self::Unveil(value)
+ }
+}
+impl From<Utf8Error> for E {
+ #[inline]
+ fn from(value: Utf8Error) -> Self {
+ Self::Git(value)
+ }
+}
+impl From<OsString> for E {
+ #[inline]
+ fn from(value: OsString) -> Self {
+ Self::NonUtf8Path(value)
+ }
+}
+impl From<Parse> for E {
+ #[inline]
+ fn from(value: Parse) -> Self {
+ Self::Time(value)
+ }
+}
+/// Calls `pledge` with only the sys calls necessary for a minimal application
+/// to run. Specifically, the `Promise`s `Exec`, `Proc`, `Rpath`, `Stdio`, and `Unveil`
+/// are passed.
+#[inline]
+fn pledge_init() -> Result<Promises<5>, Error> {
+ let promises = Promises::new([
+ Promise::Exec,
+ Promise::Proc,
+ Promise::Rpath,
+ Promise::Stdio,
+ Promise::Unveil,
+ ]);
+ match promises.pledge() {
+ Ok(()) => Ok(promises),
+ Err(e) => Err(e),
+ }
+}
+/// Removes `Promise::Unveil`.
+#[inline]
+fn pledge_away_unveil(promises: &mut Promises<5>) -> Result<(), Error> {
+ promises.remove(Promise::Unveil);
+ promises.pledge()
+}
+/// Removes all `Promise`s except `Stdio`.
+#[inline]
+fn pledge_away_all_but_stdio(promises: &mut Promises<5>) -> Result<(), Error> {
+ promises.retain([Promise::Stdio]);
+ promises.pledge()
+}
+/// Calls `unveil_none` on `/`.
+#[inline]
+fn veil_all() -> Result<(), UnveilErr> {
+ Permissions::NONE.unveil("/")
+}
+/// Calls `unveil`_on `GIT` with `Permissions::EXECUTE`.
+#[inline]
+fn unveil_git() -> Result<(), UnveilErr> {
+ Permissions::EXECUTE.unveil(GIT)
+}
+/// Calls `unveil`_on `path` with `Permissions::READ`.
+#[inline]
+fn unveil_read<P: AsRef<Path>>(path: P) -> Result<(), UnveilErr> {
+ Permissions::READ.unveil(path)
+}
+/// For each entry in `dir`, `git` is forked and invoked with `-C <dir><entry_in_dir> log -1 --date=iso-strict --pretty=format:"%cd"`.
+#[inline]
+fn get_git_data(map: &mut BTreeMap<OffsetDateTime, Vec<String>>, dir: AbsDirPath) -> Result<(), E> {
+ let iso_format = Iso8601::DEFAULT;
+ for entry in fs::read_dir(dir)? {
+ let repo = entry?;
+ if repo.file_type()?.is_dir() {
+ let path = repo.path().into_os_string().into_string()?;
+ let output = Command::new(GIT)
+ .stderr(Stdio::piped())
+ .stdin(Stdio::null())
+ .stdout(Stdio::piped())
+ .args([
+ "-C",
+ path.as_str(),
+ "log",
+ "-1",
+ "--date=iso-strict",
+ "--pretty=format:%cd",
+ ])
+ .output()?;
+ if output.status.success() {
+ let value = str::from_utf8(output.stdout.as_slice())?;
+ OffsetDateTime::parse(value, &iso_format).map(|time| {
+ map.entry(time)
+ .or_insert_with(|| Vec::with_capacity(1))
+ .push(path);
+ })?;
+ } else {
+ return Err(E::GitErr(output.stderr));
+ }
+ }
+ }
+ Ok(())
+}
+/// Writes each `String` in each `Vec` to `stdout` with spaces in between in descending order
+/// of `map`.
+#[inline]
+fn write_results(map: BTreeMap<OffsetDateTime, Vec<String>>) -> Result<(), Error> {
+ let mut stdout = io::stdout().lock();
+ map.into_values().rev().try_fold((), |(), paths| {
+ paths
+ .into_iter()
+ .try_fold((), |(), path| write!(&mut stdout, "{path} "))
+ })
+}
+/// The absolute path to `git`.
+const GIT: &str = "/usr/local/bin/git";
+fn main() -> Result<(), E> {
+ let mut promises = pledge_init()?;
+ veil_all()?;
+ let git_dir = args::from_env_args()?;
+ unveil_read(git_dir.as_ref())?;
+ unveil_git()?;
+ pledge_away_unveil(&mut promises)?;
+ let mut map = BTreeMap::new();
+ get_git_data(&mut map, git_dir)?;
+ pledge_away_all_but_stdio(&mut promises)?;
+ write_results(map).map_err(E::Io)
+}
