From aaede781ae5c5da3354689df4ca55fe5fa0e49b2 Mon Sep 17 00:00:00 2001
From: "Karl O. Pinc kop@karlpinc.com" <kop@karlpinc.com>
Date: Mon, 23 Oct 2023 00:25:59 +0000
Subject: [PATCH] New program to report when Python venv packages need updates

---
 Makefile                |  4 +++
 bin/sokwedb-venv-report | 67 +++++++++++++++++++++++++++++++++++++++++
 2 files changed, 71 insertions(+)
 create mode 100644 bin/sokwedb-venv-report

diff --git a/Makefile b/Makefile
index 6cfdb6f..745ccf3 100644
--- a/Makefile
+++ b/Makefile
@@ -135,6 +135,7 @@ destroy:
 ##
 
 CMD_TARGETS := /usr/local/lib/git_email_hook.sh \
+               /usr/local/bin/sokwedb-venv-report \
                /usr/local/bin/sokwedb-vpn-wait
 
 # Developers need permissions to install into the local directories
@@ -177,6 +178,9 @@ set-install-permissions:
 	  chmod g+rwx $${dir_name} ; \
 	done
 
+##   /usr/local/bin/sokwedb-venv-report
+##                      Reports the upgrades the server's Python virtual
+##                      environments need
 ##   /usr/local/bin/sokwedb-vpn-wait
 ##                      Tells user the VPN is up and does nothing
 ##   /usr/local/lib/git_email_hook.sh
diff --git a/bin/sokwedb-venv-report b/bin/sokwedb-venv-report
new file mode 100644
index 0000000..9595626
--- /dev/null
+++ b/bin/sokwedb-venv-report
@@ -0,0 +1,67 @@
+#!/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 <https://www.gnu.org/licenses/>.
+#
+# Reports the upgrades the server's Python virtual environments need.
+#
+# Syntax: sokwedb-venv-report
+#
+# Emails are sent to the address: sokwedb-venv-email-recipients
+#
+# DO NOT modify the email recepient.  Instead see the SokweDB wiki's
+# Unix/Linux Administration pages for how to control who receives
+# emails.
+#
+# Bugs:
+#   Everything is hardcoded because different environments have different
+#   upgrade requirements.
+#
+# Karl O. Pinc <kop@karlpinc.com>
+
+TO_ADDR=sokwedb-venv-email-recipients
+SUBJECT="$(hostname) outdated Python package report"
+
+export VENV_PATH=/srv/venvs
+export TMPF=$(mktemp)
+export TMP_MSG=$(mktemp)
+
+cleanup () {
+  rm -rf ${TMPF} ${TMP_MSG}
+}
+
+trap cleanup EXIT
+
+report () {
+  local project_path=${VENV_PATH}/$1
+
+  ${project_path}/bin/pip list --outdated
+}
+
+# pgadmin4
+report pgadmin4 | grep '^pgadmin4 ' > ${TMPF}
+if [ -s ${TMPF} ] ; then
+  printf 'Updates available for %s:\n' \
+         ${VENV_PATH}/pgadmin4 \
+    >> ${TMP_MSG}
+  cat - < ${TMPF} >> ${TMP_MSG}
+fi
+
+# Send email
+if [ -s ${TMP_MSG} ] ; then
+  { printf "The following python virtual environments have newer packages\n"
+    printf "available.\n\n"
+    cat ${TMP_MSG}
+  } | mail -s "${SUBJECT}" ${TO_ADDR}
+fi
\ No newline at end of file
-- 
2.34.1