Initial commit

Author: jcrd

.gitignore

@@ -0,0 +1 @@
+auto-inhibit.1

LICENSE

@@ -0,0 +1,7 @@
+Copyright 2018 James Reed
+
+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.

Makefile

@@ -0,0 +1,33 @@
+VERSION := $(shell git describe --dirty --tags --always || cat VERSION)
+
+PREFIX ?= /usr/local
+BINPREFIX ?= $(PREFIX)/bin
+MANPREFIX ?= $(PREFIX)/share/man
+
+MANPAGE = auto-inhibit.1
+
+all: $(MANPAGE)
+
+$(MANPAGE): man/$(MANPAGE).pod
+	pod2man -n=auto-inhibit -c=auto-inhibit -r=$(VERSION) $< $(MANPAGE)
+
+install:
+	mkdir -p $(DESTDIR)$(BINPREFIX)
+	cp -p auto-inhibit $(DESTDIR)$(BINPREFIX)
+	mkdir -p $(DESTDIR)/etc
+	cp -p auto-inhibit.conf $(DESTDIR)/etc
+	mkdir -p $(DESTDIR)$(MANPREFIX)/man1
+	cp -p $(MANPAGE) $(DESTDIR)$(MANPREFIX)/man1
+
+uninstall:
+	rm -f $(DESTDIR)$(BINPREFIX)/auto-inhibit
+	rm -f $(DESTDIR)/etc/auto-inhibit.conf
+	rm -f $(DESTDIR)$(MANPREFIX)/man1/iniq.1
+
+clean:
+	rm -f $(MANPAGE)
+
+test:
+	$(MAKE) -C test
+
+.PHONY: all install uninstall clean test

README.md

@@ -0,0 +1,41 @@
+# auto-inhibit
+
+**auto-inhibit** manages symbolic links to itself named after programs to be run
+with an inhibition lock via **systemd-inhibit**.
+
+## Usage
+
+```
+usage: auto-inhibit [options] [command]
+
+options:
+  -h        Show help message
+  -d DIR    Operate on DIR
+
+commands:
+  list      List symlinks
+  generate  Create symlinks
+  check     Check symlinks
+  remove    Remove symlinks
+  status    List active inhibitors
+```
+
+## Configuration
+
+Options in the configuration file _/etc/auto-inhibit.conf_ are passed directly
+as flags to **systemd-inhibit**.
+
+Given _example.conf_:
+
+```
+[aria2c]
+why=Download in progress
+```
+
+Running `aria2c` via the symlink will result in:
+
+`systemd-inhibit --why='Download in progress' aria2c`
+
+## License
+
+This project is licensed under the MIT License (see [LICENSE](LICENSE)).

VERSION

@@ -0,0 +1 @@
+v0.1.0

auto-inhibit

@@ -0,0 +1,119 @@
+#!/bin/bash
+
+set -eu
+
+readonly CONFIG="${AUTO_INHIBIT_CONF:-/etc/auto-inhibit.conf}"
+readonly COMMAND="${AUTO_INHIBIT_CMD:-/usr/bin/systemd-inhibit}"
+readonly INHIBITOR="${AUTO_INHIBITOR:-/usr/bin/auto-inhibit}"
+
+is_inhibitor_link() {
+    [[ -L "$1" && "$(/usr/bin/readlink -f "$1")" == "$INHIBITOR" ]]
+}
+
+name="$(/usr/bin/basename "$0")"
+
+if [[ "$name" != 'auto-inhibit' ]]; then
+    bltin=false
+    path=''
+
+    for p in $(type -a "$name" 2> /dev/null | /usr/bin/awk '{print $NF}'); do
+        if [[ "$p" == 'builtin' ]]; then
+            bltin=true
+            continue
+        fi
+        if ! is_inhibitor_link "$p"; then
+            path="$p"
+            break
+        fi
+    done
+
+    if [[ -z "$path" ]]; then
+        $bltin && msg='is a builtin' || msg='not found'
+        echo "$name $msg" >&2
+        exit 1
+    fi
+
+    mapfile -t flags < <(/usr/bin/iniq -p "$name" -f '--%k=%v' "$CONFIG")
+
+    exec "$COMMAND" "${flags[@]}" "$path" "$@"
+fi
+
+symdir='/usr/local/bin'
+
+declare -a links=()
+
+usage() {
+    echo 'usage: auto-inhibit [options] [command]
+
+options:
+  -h        Show help message
+  -d DIR    Operate on DIR
+
+commands:
+  list      List symlinks
+  generate  Create symlinks
+  check     Check symlinks
+  remove    Remove symlinks
+  status    List active inhibitors'
+}
+
+get_links() {
+    for f in "$symdir"/*; do
+        is_inhibitor_link "$f" && links+=("$f")
+    done
+}
+
+status() {
+    /usr/bin/systemd-inhibit --list
+    exit $?
+}
+
+while getopts ':hd:' opt; do
+    case "$opt" in
+        h) usage; exit ;;
+        d) symdir="$OPTARG" ;;
+        *) usage >&2; exit 2
+    esac
+done
+
+shift $((OPTIND - 1))
+
+[[ $# -eq 0 ]] && status
+
+case "$1" in
+    list)
+        get_links
+        for f in "${links[@]}"; do
+            echo "${f##*/}"
+        done
+        ;;
+    generate)
+        for f in $(/usr/bin/iniq -d "$CONFIG"); do
+            /usr/bin/ln -vs "$INHIBITOR" "$symdir/$f"
+        done
+        ;;
+    check)
+        ret=0
+        for f in $(/usr/bin/iniq -d "$CONFIG"); do
+            err=''
+            if [[ ! -e "$symdir/$f" ]]; then
+                err="$f does not exist"
+            elif ! is_inhibitor_link "$symdir/$f"; then
+                err="$f is not a symlink to auto-inhibit"
+            fi
+            if [[ -n "$err" ]]; then
+                echo "$err" >&2
+                ret=$((ret+1))
+            fi
+        done
+        exit $ret
+        ;;
+    remove)
+        get_links
+        for f in "${links[@]}"; do
+            /usr/bin/rm -v "$f"
+        done
+        ;;
+    status) status ;;
+    *) usage >&2; exit 2
+esac

auto-inhibit.conf

@@ -0,0 +1,8 @@
+# [DEFAULT]
+# what=sleep
+
+# [aria2c]
+# why=Download in progress
+
+# [youtube-dl]
+# why=Download in progress

man/auto-inhibit.1.pod

@@ -0,0 +1,83 @@
+=head1 NAME
+
+auto-inhibit - automate use of systemd-inhibit
+
+=head1 SYNOPSIS
+
+B<auto-inhibit> [options] [command]
+
+=head1 DESCRIPTION
+
+auto-inhibit manages symbolic links to itself named after programs to be run
+with an inhibition lock via B<systemd-inhibit>.
+
+=head1 OPTIONS
+
+=over
+
+=item B<-h>
+
+Show help message.
+
+=item B<-d> I<DIRECTORY>
+
+Operate on I<DIRECTORY>.
+
+=back
+
+=head1 COMMANDS
+
+=over
+
+=item B<list>
+
+List existing symbolic links.
+
+=item B<generate>
+
+Create symbolic links based on configuration.
+
+=item B<check>
+
+Check that symlinks reflect the configuration.
+
+=item B<remove>
+
+Remove generated symbolic links.
+
+=item B<status>
+
+List active inhibitors.
+
+=back
+
+=head1 CONFIGURATION
+
+Options in the configuration file F</etc/auto-inhibit.conf> are passed directly
+as flags to B<systemd-inhibit>.
+
+Given F<example.conf>:
+
+ [aria2c]
+ why=Download in progress
+
+Running I<aria2c> via the symlink will result in:
+
+ systemd-inhibit --why='Download in progress' aria2c
+
+=head1 AUTHOR
+
+James Reed E<lt>[email protected]<gt>
+
+=head1 REPORTING BUGS
+
+Bugs and issues can be reported here:
+L<https://github.com/jcrd/auto-inhibit/issues>
+
+=head1 COPYRIGHT
+
+Copyright 2018 James Reed. auto-inhibit is licensed under the MIT License.
+
+=head1 SEE ALSO
+
+B<systemd-inhibit>(1)