From 792a940123a52030e6327aefc16cafe609d73029 Mon Sep 17 00:00:00 2001 From: "Karl O. Pinc kop@karlpinc.com" Date: Fri, 20 Oct 2023 21:08:30 +0000 Subject: [PATCH] Move system-level commands from the sokwedb repo --- Makefile | 59 ++++++++++++++++++ bin/sokwedb-vpn-wait | 40 ++++++++++++ lib/git_email_hook.sh | 137 ++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 236 insertions(+) create mode 100644 bin/sokwedb-vpn-wait create mode 100755 lib/git_email_hook.sh diff --git a/Makefile b/Makefile index 42b0ddb..a38672d 100644 --- a/Makefile +++ b/Makefile @@ -125,3 +125,62 @@ destroy: ## ## The point of Python virtual environments is to be able to easily re-create ## them. So don't hesitate to destroy and re-create them. + +## +## +## ######################################################################## +## COMMAND LINE PROGRAM TARGETS +## +## The available targets for make (make TARGET) are: +## + +CMD_TARGETS := /usr/local/lib/git_email_hook.sh \ + /usr/local/bin/sokwedb-vpn-wait + +# Developers need permissions to install into the local directories +DEV_GROUP := wwwdev +LOCAL_DIRS := /usr/local/lib /usr/local/bin /usr/local/sbin + +CMD_DEPENDS := $(GENERIC_DEPENDS) + +## install-w-permissions +## Install the command line programs and libararies +## and assign them the necessary permissions +.PHONY: install-w-permissions +install-w-permissions: install-commands set-permissions + +## +## Lesser used targets are: +## + +## install-commands Install the command line programs and libraries +.PHONY: install-commands +install-commands: $(CMD_TARGETS) + +## set-permissions Set permissions in the file system needed for +## program execution +.PHONY: set-permissions +set-permissions: + for target in $(CMD_TARGETS) ; do \ + chgrp $(DEV_GROUP) $${target} ; \ + chmod a+x,g+wrx $${target} ; \ + done + +## set-install-permissions +## Set the permissions in the file system needed so +## developers can install programs +## THIS MUST BE RUN AS ROOT. +.PHONY: set-install-permissions +set-install-permissions: + for dir_name in $(LOCAL_DIRS) ; do \ + chgrp $(DEV_GROUP) $${dir_name} ; \ + chmod g+rwx $${dir_name} ; \ + done + +## /usr/local/bin/sowkedb-vpn-wait +## Tells user the VPN is up and does nothing +## /usr/local/lib/git_email_hook.sh +## A git post-receive hook which emails push summaries +# Install the actual files +$(CMD_TARGETS): /usr/local/% : % $(CMD_DEPENDS) + cp $< $@ diff --git a/bin/sokwedb-vpn-wait b/bin/sokwedb-vpn-wait new file mode 100644 index 0000000..8b82bf5 --- /dev/null +++ b/bin/sokwedb-vpn-wait @@ -0,0 +1,40 @@ +#!/bin/bash +# Copyright (C) 2023 The Meme Factory, Inc. http://www.meme.com/ +# +# 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 . +# +# Tell the user how to use the VPN, and wait for them to exit. +# +# Syntax: sokwedb-vpn-wait +# +# Karl O. Pinc + +printf '\n' +printf ' SokweDB VPN now ACTIVE\n' +printf '\n' +printf 'You may now connect directly to the SokweDB PostgreSQL server.\n' +printf '\n' +printf ' The "hostname" of the server is: localhost\n' +printf ' The "port" of the server is: 5432 (the default)\n' +printf '\n' +printf 'You will also need your PostgreSQL username and password.\n' +printf '\n' +printf 'You can directly connect to the SokweDB PostgreSQL server only as\n' +printf 'long as this VPN remains active. Closing this window or otherwise\n' +printf 'stopping this program disconnects you from the database.\n' +printf '\n' +printf 'Close this window or press any key to shut down the VPN: ' + +read -n 1 -s +printf '\n' diff --git a/lib/git_email_hook.sh b/lib/git_email_hook.sh new file mode 100755 index 0000000..8baab77 --- /dev/null +++ b/lib/git_email_hook.sh @@ -0,0 +1,137 @@ +#!/bin/sh +# Copyright (C) 2023 The Meme Factory, Inc. www.karlpinc.com +# +# 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 . +# +# A git post-receive hook that sends a single email when a push is received. +# +# Emails are sent to the address: git-push-email-recipients-$REPO_PATH +# $REPO_PATH is the canonical path to the git repo where the hook is +# installed. (Since $REPO_PATH is fully qualifed it begins with a +# "/". Even though the repo is a directory, it does not end with a "/".) +# +# DO NOT modify the email recepient. Instead see the SokweDB wiki's +# Unix/Linux Administration pages for how to control who receives +# emails. +# +# See `git receive-pack --help` +# +# Installation: +# +# Copy (or symlink) the executable into the .git/hooks/ (or in the case +# of a bare repository, the hooks/ directory) and give it the +# name: post-receive +# +# Notes: +# Turns out it's hard to find the name of the branch from which a ref +# branched. Instead we use awk to filter out the commits in the parent +# branch. (And give up on producing summary statistics for newly created +# branches.) +# +# Karl O. Pinc + +# Emails line break at 78 chars (IIRC) +STAT_WIDTH=77 +STANDARD_STAT_ARGS="--stat-width=${STAT_WIDTH} --compact-summary" + +REPO_PATH="$(git rev-parse --absolute-git-dir)" +EMAIL_RECIPIENTS="git-push-email-recipients-${REPO_PATH}" + +SUBJECT="Git push report from the repository at $(hostname):${REPO_PATH}" + +to_branch () { + # Filter out all `git log` output after the first branchpoint commit + awk 'BEGIN {past_first = 0; + branch_found = 0; + send_output = 1; }; + /^commit / {if (branch_found) + send_output = 0 }; + /^commit .*\(.*refs\/heads\/.+\)$/ {if (past_first) + branch_found = 1 + else + past_first = 1; }; + {if (send_output) + print; };' \ + | head -n -1 +} + +breakline='' +while read oval nval ref ; do + printf "${breakline}" + + rev_type="$(git cat-file -t ${nval} 2>/dev/null)" + deleted='n' + created='n' + filter='cat' + if expr " ${oval}" : ' 00*$' >/dev/null ; then + # All zeros means some sort of creation operation + created='y' + rev_range="${nval}" + # (At the time of this writing diffs don't work when pushing + # the first branch into a repo, so turn off stats in the log + # display.) + do_stat='n' + if [ $(git branch | wc -l) -eq 1 ] ; then + stat_args='--name-only' + else + stat_args="${STANDARD_STAT_ARGS}" + fi + filter='to_branch' + elif expr " ${nval}" : ' 00*$' > /dev/null ; then + # Zeros for a new value means deletion + rev_type="$(git cat-file -t ${oval} 2>/dev/null)" + deleted='y' + do_stat='n' + stat_args='--name-only' + else + rev_range="${oval}..${nval}" + do_stat='y' + stat_args="${STANDARD_STAT_ARGS}" + fi + + refname="$(basename ${ref})" + if [ "${rev_type}" = 'commit' ] ; then + if [ "${deleted}" = 'y' ] ; then + printf 'Branch deleted: %s' "${refname}" + fi + + git log --decorate=full ${stat_args} "${rev_range}" \ + | ${filter} + + if [ "${do_stat}" = 'y' ] ; then + printf '\n````````````````````````````````````````````````````\n' + printf '\nSummary of changes to the branch: %s\n' \ + "${refname}" + git diff --stat=${STAT_WIDTH} "${rev_range}" + else + printf '\n\n' + [ "${created}" = 'y' ] \ + && printf 'New branch: %s\n' "${refname}" + printf 'No summary statistics available.\n' + fi + else + printf 'Information on the push of a %s:\n' "${rev_type}" + if [ "${deleted}" = 'y' ] ; then + printf '\nDeleted: %s\n' "${refname}" + else + if [ "${created}" = 'y' ] ; then + printf '\nCreated: %s\n\n' "${refname}" + fi + git log --decorate=full --name-only --max-count=1 ${nval} + fi + fi + + breakline='\n====================================================\n' +done \ + | mail -s "$SUBJECT" "$EMAIL_RECIPIENTS" -- 2.34.1