3 # mail-wrapper -- Report results of a command by email
4 # Copyright (c)2017 Alexander Barton (alex@barton.de)
6 # This program is free software; you can redistribute it and/or modify
7 # it under the terms of the GNU General Public License as published by
8 # the Free Software Foundation; either version 2 of the License, or
9 # (at your option) any later version.
14 # Include "ax-common.sh":
16 for dir in "$HOME/lib" "$HOME/.ax" /usr/local /opt/ax /usr; do
17 [ -z "$ax_common_sourced" ] || break
18 ax_common="${dir}/lib/ax/ax-common.sh"
19 # shellcheck source=/usr/local/lib/ax/ax-common.sh
20 [ -r "$ax_common" ] && . "$ax_common"
22 if [ -z "$ax_common_sourced" ]; then
23 echo "Error ($NAME): \"ax-common.sh\" not found, aborting!" >&2
24 echo "Please install 'ax-unix', \"Alex' UNIX Tools & Scripts\", and try again."
27 unset dir ax_common ax_common_sourced
33 echo " $NAME [--help|--usage]"
34 echo " $NAME {parameters} [<command> [<arg> [<…>]]]"
36 echo " -C Use the \"C\" locale, no localized (error) messages."
37 echo " --errors|-e Generate email on errors only."
38 echo " --from|-f Email address of the sender of the email."
39 echo " --subject|-s <subject> Subject for the email."
40 echo " --to|-t <address> Email address to send the email to."
42 echo "When no <command> is given, $NAME reads from standard input."
49 ax_error -l "Syntax error!"
54 if [[ -z "$proc_fd_works" ]]; then
55 ax_debug "Cleaning temporary files ..."
56 [[ -n "$buffer_file" ]] && rm -f "$buffer_file"
57 [[ -n "$error_file" ]] && rm -f "$error_file"
69 # Initialize internal state.
71 host=$(hostname -f 2>/dev/null || hostname)
75 # Some defaults (can be adjusted by command line parameters).
78 from="${LOGNAME:-root} <${LOGNAME:-root}@$host>"
81 # Parse the command line ...
82 while [[ $# -gt 0 ]]; do
96 [[ $# -gt 0 ]] || syntax_error
104 [[ $# -gt 0 ]] || syntax_error
108 # Ignore this switch for compatibility with an other
109 # "mail-wrapper" script. This is the default anyway!
113 [[ $# -gt 0 ]] || syntax_error
120 # Command to execute follows in command line.
127 # Initialize the "buffer file" on file handle #3. This file will store all
128 # output, stdout and stderr combined. The file is immediately unliked so that
129 # we can't leak stale files. Afterwards this script accesses the "buffer file"
130 # by its file descriptor only.
131 buffer_file=$(mktemp) \
132 || ax_abort -l "Failed to create buffer file: \"$buffer_file\"!"
133 ax_debug "buffer_file=\"$buffer_file\""
134 exec 3>"$buffer_file" \
135 || ax_abort -l "Failed to redirect FD #3 to buffer file!"
136 if [[ -n "$proc_fd_works" ]]; then
138 || ax_error -l "Failed to delete buffer file: \"$buffer_file\"!"
139 buffer_file="/dev/fd/3"
142 if [[ $# -gt 0 ]]; then
143 # Execute command and save output in buffer file.
144 # Use a sub-shell to not pollute our name space!
145 error_file=$(mktemp) \
146 || ax_abort -l "Failed to create error buffer file: \"$error_file\"!"
147 ax_debug "error_file=\"$error_file\""
148 exec 4>"$error_file" \
149 || ax_abort -l "Failed to redirect FD #4 to error file!"
150 if [[ -n "$proc_fd_works" ]]; then
152 || ax_error -l "Failed to delete error buffer file: \"$error_file\"!"
153 error_file="/dev/fd/4"
158 ax_debug "Running command \"$*\" ..."
160 "$@" 2>&1 1>&3 | tee "$error_file" >&3
161 echo "${PIPESTATUS[0]}"
164 # Read from stdin and save it to the buffer file.
165 error_file="/dev/null"
168 ax_debug "Reading from stdin ..."
169 while read -r line; do
171 || ax_abort -l "Failed to write to buffer file!"
176 ax_debug "exit_code=$exit_code"
178 count_all=$(wc -l <"$buffer_file" || ax_abort -l "Failed to count buffer file!")
179 count_err=$(wc -l <"$error_file" || ax_abort -l "Failed to count error file!")
181 # Error or no error -- that's the question! An error is assumed when either the
182 # exit code of the command was non-zero or there was output to stderr.
183 [[ $count_err -gt 0 || $exit_code -ne 0 ]] && is_error=1
185 # Construct email subject ...
186 [[ -z "$subject" ]] && subject="$host: $job report"
187 [[ -n "$is_error" ]] && subject="$subject - ERROR!" || subject="$subject - success"
189 ax_debug "from=\"$from\""
190 ax_debug "to=\"$to\""
191 ax_debug "subject=$subject"
193 if [[ -n "$DEBUG" ]]; then
194 echo "--- stdout+stderr ---"
196 echo "--- stderr ---"
201 ax_debug "count_all=$count_all"
202 ax_debug "count_err=$count_err"
203 ax_debug "is_error=$is_error"
205 # No errors detected (exit code & stderr), and email should be sent on errors
206 # only: so exit early!
207 [[ -z "$is_error" && -n "$do_errors_only" ]] && exit $exit_code
209 # No error detected and no output at all: skip email, exit early:
210 [[ -z "$is_error" && $count_all -eq 0 ]] && exit $exit_code
212 # Build the report mail.
213 # Make sure to ignore all mail(1) configuration files, system wide /etc/mailrc
214 # (by using the "-n" option) as well as ~/.mailrc (by setting the MAILRC
215 # environment varialbe).
216 export MAILRC=/dev/null
220 echo " - Host: $host"
221 echo " - User: $(id -un)"
222 echo " - Exit code: $exit_code"
224 if [[ $# -gt 0 ]]; then
225 # A command name is known (not stdin), show it!
230 if [[ $count_err -gt 0 ]]; then
231 # Prefix mail with all error messages.
232 echo "Error summary:"
233 echo "-----------------------------------------------------------------------------"
235 || ax_abort -l "Failed to dump error file!"
236 echo "-----------------------------------------------------------------------------"
239 if [[ $count_all -ne $count_err ]]; then
240 # Show full output when different to "error output" only.
242 || ax_abort -l "Failed to dump buffer file!"
244 ) | mail -n -a "From: $from" -s "$subject" "$to" \
245 || ax_abort -l "Failed to send email to \"$to\"!"