iankelling.org Git - log-quiet/blob - logq-function

   1 #!/bin/bash
   2 # I, Ian Kelling, follow the GNU license recommendations at
   3 # https://www.gnu.org/licenses/license-recommendations.en.html. They
   4 # recommend that small programs, < 300 lines, be licensed under the
   5 # Apache License 2.0. This file contains or is part of one or more small
   6 # programs. If a small program grows beyond 300 lines, I plan to switch
   7 # its license to GPL.
   8
   9 # Copyright 2024 Ian Kelling
  10
  11 # Licensed under the Apache License, Version 2.0 (the "License");
  12 # you may not use this file except in compliance with the License.
  13 # You may obtain a copy of the License at
  14
  15 #     http://www.apache.org/licenses/LICENSE-2.0
  16
  17 # Unless required by applicable law or agreed to in writing, software
  18 # distributed under the License is distributed on an "AS IS" BASIS,
  19 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  20 # See the License for the specific language governing permissions and
  21 # limitations under the License.
  22
  23 logq () {
  24   local help="Usage: logq [-h|--help] COMMAND [ARG...]
  25
  26 Log Quietly. Run COMMAND with ARGs, log to temp file. Output return code,
  27 command, and log path. Tail log if there is a failure.
  28 Follows output format of logsave."
  29
  30   if [[ $1 == --help || $1 == -h ]]; then
  31     echo "$help"
  32     return
  33   fi
  34   if [[ $# == 0 ]]; then
  35     echo "error: need 1 or more arguments
  36 $help"
  37     return 1
  38   fi
  39
  40   # deliniate arguments, so spaces aren't ambiguous
  41   local index=0
  42   local x prettycommand
  43   for x in "$@"; do
  44     prettycommand+="[$index]$x "
  45     index=$(( index+1 ))
  46   done
  47
  48   local file="$*"
  49   file="$(mktemp -d)/${file//[[:space:]\/]/_}"
  50   # give us ~20 char filename max
  51   file="${file:0:40}"
  52
  53   printf "%s\n%s\n\n" "Log of $prettycommand" "$(date)" >"$file"
  54
  55   if [[ $- != *x* ]]; then
  56     echo "log $file = $@"
  57   fi
  58
  59   # we will propagate any errors
  60   local logq_ret=$(
  61     set +e
  62     trap ERR
  63     "$@" &>> "$file"
  64     echo $?
  65         )
  66   printf "\n%s\n%s\n" "$(date)" "----------------" >> "$file"
  67
  68   if [[ $logq_ret != 0 ]]; then
  69     x="tail -n 100 $file"
  70     if [[ $- != *x* ]]; then
  71       echo "logq failure. $x :"
  72     fi
  73     $x
  74   fi
  75   return $logq_ret
  76 }