[thirdparty/bash.git] / support / bashbug.sh

#!/bin/sh -
#
# bashbug - create a bug report and mail it to the bug address
#
# The bug address depends on the release status of the shell.  Versions
# with status `devel', `alpha', `beta', or `rc' mail bug reports to
# chet@cwru.edu and, optionally, to bash-testers@cwru.edu.
# Other versions send mail to bug-bash@gnu.org.
#
# Copyright (C) 1996-2020 Free Software Foundation, Inc.
#
#   This program is free software: you can redistribute it and/or modify
#   it under the terms of the GNU 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 General Public License for more details.
#
#   You should have received a copy of the GNU General Public License
#   along with this program.  If not, see <http://www.gnu.org/licenses/>.

#
# configuration section:
#	these variables are filled in by the make target in Makefile
#
MACHINE="!MACHINE!"
OS="!OS!"
CC="!CC!"
CFLAGS="!CFLAGS!"
RELEASE="!RELEASE!"
PATCHLEVEL="!PATCHLEVEL!"
RELSTATUS="!RELSTATUS!"
MACHTYPE="!MACHTYPE!"

PATH=/bin:/usr/bin:/usr/local/bin:$PATH
export PATH

# Check if TMPDIR is set, default to /tmp
: ${TMPDIR:=/tmp}

#Securely create a temporary directory for the temporary files
TEMPDIR=$TMPDIR/bbug.$$
(umask 077 && mkdir "$TEMPDIR") || {
	echo "$0: could not create temporary directory" >&2
	exit 1
}

TEMPFILE1=$TEMPDIR/bbug1
TEMPFILE2=$TEMPDIR/bbug2
        
USAGE="Usage: $0 [--help] [--version] [bug-report-email-address]"
VERSTR="GNU bashbug, version ${RELEASE}.${PATCHLEVEL}-${RELSTATUS}"

do_help= do_version=

while [ $# -gt 0 ]; do
	case "$1" in
	--help)		shift ; do_help=y ;;
	--version)	shift ; do_version=y ;;
	--)		shift ; break ;;
	-*)		echo "bashbug: ${1}: invalid option" >&2
			echo "$USAGE" >&2
			exit 2 ;;
	*)		break ;;
	esac
done

if [ -n "$do_version" ]; then
	echo "${VERSTR}"
	exit 0
fi

if [ -n "$do_help" ]; then
	echo "${VERSTR}"
	echo "${USAGE}"
	echo
	cat << HERE_EOF
Bashbug is used to send mail to the Bash maintainers
for when Bash doesn't behave like you'd like, or expect.

Bashbug will start up your editor (as defined by the shell's
EDITOR environment variable) with a preformatted bug report
template for you to fill in. The report will be mailed to the
bug-bash mailing list by default. See the manual for details.

If you invoke bashbug by accident, just quit your editor without
saving any changes to the template, and no bug report will be sent.
HERE_EOF
	exit 0
fi

# Figure out how to echo a string without a trailing newline
N=`echo 'hi there\c'`
case "$N" in
*c)	n=-n c= ;;
*)	n= c='\c' ;;
esac

BASHTESTERS="bash-testers@cwru.edu"

case "$RELSTATUS" in
alpha*|beta*|devel*|rc*)	BUGBASH=chet@cwru.edu ;;
*)				BUGBASH=bug-bash@gnu.org ;;
esac

case "$RELSTATUS" in
alpha*|beta*|devel*|rc*)
		echo "$0: This is a testing release.  Would you like your bug report"
		echo "$0: to be sent to the bash-testers mailing list?"
		echo $n "$0: Send to bash-testers? $c"
		read ans
		case "$ans" in
		y*|Y*)	BUGBASH="${BUGBASH},${BASHTESTERS}" ;;
		esac ;;
esac

BUGADDR="${1-$BUGBASH}"

if [ -z "$DEFEDITOR" ] && [ -z "$EDITOR" ]; then
	if [ -x /usr/bin/editor ]; then
		DEFEDITOR=editor
	elif [ -x /usr/local/bin/ce ]; then
		DEFEDITOR=ce
	elif [ -x /usr/local/bin/emacs ]; then
		DEFEDITOR=emacs
	elif [ -x /usr/contrib/bin/emacs ]; then
		DEFEDITOR=emacs
	elif [ -x /usr/bin/emacs ]; then
		DEFEDITOR=emacs
	elif [ -x /usr/bin/xemacs ]; then
		DEFEDITOR=xemacs
	elif [ -x /usr/bin/nano ]; then
		DEFEDITOR=nano
	elif [ -x /usr/contrib/bin/jove ]; then
		DEFEDITOR=jove
	elif [ -x /usr/local/bin/jove ]; then
		DEFEDITOR=jove
	elif [ -x /usr/bin/vi ]; then
		DEFEDITOR=vi
	else
		echo "$0: No default editor found: attempting to use vi" >&2
		DEFEDITOR=vi
	fi
fi


: ${EDITOR=$DEFEDITOR}

: ${USER=${LOGNAME-`whoami`}}

trap 'rm -rf "$TEMPDIR"; exit 1' 1 2 3 13 15
trap 'rm -rf "$TEMPDIR"' 0

UN=
if (uname) >/dev/null 2>&1; then
	UN=`uname -a`
fi

if [ -f /usr/lib/sendmail ] ; then
	RMAIL="/usr/lib/sendmail"
	SMARGS="-i -t"
elif [ -f /usr/sbin/sendmail ] ; then
	RMAIL="/usr/sbin/sendmail"
	SMARGS="-i -t"
else
	RMAIL=rmail
	SMARGS="$BUGADDR"
fi

INITIAL_SUBJECT='[50 character or so descriptive subject here (for reference)]'

cat > "$TEMPFILE1" <<EOF
From: ${USER}
To: ${BUGADDR}
Subject: ${INITIAL_SUBJECT}

Configuration Information [Automatically generated, do not change]:
Machine: $MACHINE
OS: $OS
Compiler: $CC
Compilation CFLAGS: $CFLAGS
uname output: $UN
Machine Type: $MACHTYPE

Bash Version: $RELEASE
Patch Level: $PATCHLEVEL
Release Status: $RELSTATUS

Description:
	[Detailed description of the problem, suggestion, or complaint.]

Repeat-By:
	[Describe the sequence of events that causes the problem
	to occur.]

Fix:
	[Description of how to fix the problem.  If you don't know a
	fix for the problem, don't include this section.]
EOF

cp "$TEMPFILE1" "$TEMPFILE2"
chmod u+w "$TEMPFILE1"

trap '' 2		# ignore interrupts while in editor

edstat=1
while [ $edstat -ne 0 ]; do
	$EDITOR "$TEMPFILE1"
	edstat=$?

	if [ $edstat -ne 0 ]; then
		echo "$0: editor \`$EDITOR' exited with nonzero status."
		echo "$0: Perhaps it was interrupted."
		echo "$0: Type \`y' to give up, and lose your bug report;"
		echo "$0: type \`n' to re-enter the editor."
		echo $n "$0: Do you want to give up? $c"

		read ans
		case "$ans" in
		[Yy]*) exit 1 ;;
		esac

		continue
	fi

	# find the subject from the temp file and see if it's been changed
	CURR_SUB=`grep '^Subject: ' "$TEMPFILE1" | sed 's|^Subject:[ 	]*||' | sed 1q`

	case "$CURR_SUB" in
	"${INITIAL_SUBJECT}")
		echo
		echo "$0: You have not changed the subject from the default."
		echo "$0: Please use a more descriptive subject header."
		echo "$0: Type \`y' to give up, and lose your bug report;"
		echo "$0: type \`n' to re-enter the editor."
		echo $n "$0: Do you want to give up? $c"

		read ans
		case "$ans" in
		[Yy]*) exit 1 ;;
		esac

		echo "$0:  The editor will be restarted in five seconds."
		sleep 5
		edstat=1
		;;
	esac

done

trap 'rm -rf "$TEMPDIR"; exit 1' 2	# restore trap on SIGINT

if cmp -s "$TEMPFILE1" "$TEMPFILE2"
then
	echo "File not changed, no bug report submitted."
	exit
fi

echo $n "Send bug report to ${BUGADDR}? [y/n] $c"
read ans
case "$ans" in
[Nn]*)	exit 0 ;;
esac

${RMAIL} $SMARGS < "$TEMPFILE1" || {
	cat "$TEMPFILE1" >> $HOME/dead.bashbug
	echo "$0: mail to ${BUGADDR} failed: report saved in $HOME/dead.bashbug" >&2
	echo "$0: please send it manually to ${BUGADDR}" >&2
}

exit 0
Commit	Line	Data
726f6388 JA	1	#!/bin/sh -
726f6388 JA	2	#
ccc6cda3 JA	3	# bashbug - create a bug report and mail it to the bug address
	4	#
	5	# The bug address depends on the release status of the shell. Versions
f73dda09	6	# with status `devel', `alpha', `beta', or `rc' mail bug reports to
b80f6443	7	# chet@cwru.edu and, optionally, to bash-testers@cwru.edu.
cce855bc	8	# Other versions send mail to bug-bash@gnu.org.
7117c2d2	9	#
8868edaf	10	# Copyright (C) 1996-2020 Free Software Foundation, Inc.
7117c2d2	11	#
3185942a JA	12	# This program is free software: you can redistribute it and/or modify
	13	# it under the terms of the GNU General Public License as published by
	14	# the Free Software Foundation, either version 3 of the License, or
	15	# (at your option) any later version.
	16	#
	17	# This program is distributed in the hope that it will be useful,
	18	# but WITHOUT ANY WARRANTY; without even the implied warranty of
	19	# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	20	# GNU General Public License for more details.
	21	#
	22	# You should have received a copy of the GNU General Public License
	23	# along with this program. If not, see <http://www.gnu.org/licenses/>.
7117c2d2	24
726f6388 JA	25	#
726f6388 JA	26	# configuration section:
f73dda09	27	# these variables are filled in by the make target in Makefile
726f6388	28	#
ccc6cda3 JA	29	MACHINE="!MACHINE!"
	30	OS="!OS!"
	31	CC="!CC!"
	32	CFLAGS="!CFLAGS!"
	33	RELEASE="!RELEASE!"
	34	PATCHLEVEL="!PATCHLEVEL!"
	35	RELSTATUS="!RELSTATUS!"
	36	MACHTYPE="!MACHTYPE!"
	37
	38	PATH=/bin:/usr/bin:/usr/local/bin:$PATH
726f6388 JA	39	export PATH
726f6388 JA	40
b80f6443	41	# Check if TMPDIR is set, default to /tmp
f73dda09	42	: ${TMPDIR:=/tmp}
28ef6c31	43
b80f6443 JA	44	#Securely create a temporary directory for the temporary files
b80f6443 JA	45	TEMPDIR=$TMPDIR/bbug.$$
8868edaf	46	(umask 077 && mkdir "$TEMPDIR") \|\| {
b80f6443 JA	47	echo "$0: could not create temporary directory" >&2
	48	exit 1
	49	}
	50
	51	TEMPFILE1=$TEMPDIR/bbug1
	52	TEMPFILE2=$TEMPDIR/bbug2
	53
bb70624e JA	54	USAGE="Usage: $0 [--help] [--version] [bug-report-email-address]"
	55	VERSTR="GNU bashbug, version ${RELEASE}.${PATCHLEVEL}-${RELSTATUS}"
	56
	57	do_help= do_version=
	58
	59	while [ $# -gt 0 ]; do
	60	case "$1" in
	61	--help) shift ; do_help=y ;;
	62	--version) shift ; do_version=y ;;
	63	--) shift ; break ;;
	64	-*) echo "bashbug: ${1}: invalid option" >&2
a0c0a00f	65	echo "$USAGE" >&2
bb70624e JA	66	exit 2 ;;
	67	*) break ;;
	68	esac
	69	done
	70
	71	if [ -n "$do_version" ]; then
	72	echo "${VERSTR}"
	73	exit 0
	74	fi
	75
	76	if [ -n "$do_help" ]; then
	77	echo "${VERSTR}"
	78	echo "${USAGE}"
	79	echo
	80	cat << HERE_EOF
	81	Bashbug is used to send mail to the Bash maintainers
	82	for when Bash doesn't behave like you'd like, or expect.
	83
	84	Bashbug will start up your editor (as defined by the shell's
	85	EDITOR environment variable) with a preformatted bug report
	86	template for you to fill in. The report will be mailed to the
0001803f	87	bug-bash mailing list by default. See the manual for details.
bb70624e JA	88
	89	If you invoke bashbug by accident, just quit your editor without
	90	saving any changes to the template, and no bug report will be sent.
	91	HERE_EOF
	92	exit 0
	93	fi
d166f048 JA	94
	95	# Figure out how to echo a string without a trailing newline
	96	N=`echo 'hi there\c'`
	97	case "$N" in
	98	*c) n=-n c= ;;
	99	*) n= c='\c' ;;
	100	esac
	101
b80f6443	102	BASHTESTERS="bash-testers@cwru.edu"
726f6388	103
ccc6cda3	104	case "$RELSTATUS" in
b80f6443	105	alpha\|beta\|devel\|rc) BUGBASH=chet@cwru.edu ;;
f73dda09	106	*) BUGBASH=bug-bash@gnu.org ;;
ccc6cda3 JA	107	esac
ccc6cda3 JA	108
d166f048	109	case "$RELSTATUS" in
f73dda09	110	alpha\|beta\|devel\|rc)
bb70624e	111	echo "$0: This is a testing release. Would you like your bug report"
d166f048 JA	112	echo "$0: to be sent to the bash-testers mailing list?"
	113	echo $n "$0: Send to bash-testers? $c"
	114	read ans
	115	case "$ans" in
	116	y\|Y) BUGBASH="${BUGBASH},${BASHTESTERS}" ;;
	117	esac ;;
	118	esac
	119
	120	BUGADDR="${1-$BUGBASH}"
726f6388	121
bb70624e	122	if [ -z "$DEFEDITOR" ] && [ -z "$EDITOR" ]; then
28ef6c31 JA	123	if [ -x /usr/bin/editor ]; then
	124	DEFEDITOR=editor
	125	elif [ -x /usr/local/bin/ce ]; then
bb70624e JA	126	DEFEDITOR=ce
	127	elif [ -x /usr/local/bin/emacs ]; then
	128	DEFEDITOR=emacs
	129	elif [ -x /usr/contrib/bin/emacs ]; then
	130	DEFEDITOR=emacs
	131	elif [ -x /usr/bin/emacs ]; then
	132	DEFEDITOR=emacs
	133	elif [ -x /usr/bin/xemacs ]; then
	134	DEFEDITOR=xemacs
8868edaf CR	135	elif [ -x /usr/bin/nano ]; then
8868edaf CR	136	DEFEDITOR=nano
bb70624e JA	137	elif [ -x /usr/contrib/bin/jove ]; then
	138	DEFEDITOR=jove
	139	elif [ -x /usr/local/bin/jove ]; then
	140	DEFEDITOR=jove
	141	elif [ -x /usr/bin/vi ]; then
	142	DEFEDITOR=vi
	143	else
	144	echo "$0: No default editor found: attempting to use vi" >&2
	145	DEFEDITOR=vi
	146	fi
	147	fi
	148
	149
	150	: ${EDITOR=$DEFEDITOR}
726f6388	151
ccc6cda3 JA	152	: ${USER=${LOGNAME-`whoami`}}
ccc6cda3 JA	153
b80f6443 JA	154	trap 'rm -rf "$TEMPDIR"; exit 1' 1 2 3 13 15
b80f6443 JA	155	trap 'rm -rf "$TEMPDIR"' 0
726f6388 JA	156
	157	UN=
	158	if (uname) >/dev/null 2>&1; then
	159	UN=`uname -a`
	160	fi
	161
	162	if [ -f /usr/lib/sendmail ] ; then
	163	RMAIL="/usr/lib/sendmail"
bb70624e	164	SMARGS="-i -t"
726f6388 JA	165	elif [ -f /usr/sbin/sendmail ] ; then
726f6388 JA	166	RMAIL="/usr/sbin/sendmail"
bb70624e	167	SMARGS="-i -t"
726f6388 JA	168	else
726f6388 JA	169	RMAIL=rmail
bb70624e	170	SMARGS="$BUGADDR"
726f6388 JA	171	fi
726f6388 JA	172
f73dda09 JA	173	INITIAL_SUBJECT='[50 character or so descriptive subject here (for reference)]'
f73dda09 JA	174
f73dda09	175	cat > "$TEMPFILE1" <<EOF
726f6388 JA	176	From: ${USER}
726f6388 JA	177	To: ${BUGADDR}
f73dda09	178	Subject: ${INITIAL_SUBJECT}
726f6388 JA	179
	180	Configuration Information [Automatically generated, do not change]:
	181	Machine: $MACHINE
	182	OS: $OS
	183	Compiler: $CC
	184	Compilation CFLAGS: $CFLAGS
	185	uname output: $UN
ccc6cda3	186	Machine Type: $MACHTYPE
726f6388 JA	187
	188	Bash Version: $RELEASE
	189	Patch Level: $PATCHLEVEL
ccc6cda3	190	Release Status: $RELSTATUS
726f6388 JA	191
726f6388 JA	192	Description:
ccc6cda3	193	[Detailed description of the problem, suggestion, or complaint.]
726f6388 JA	194
726f6388 JA	195	Repeat-By:
ccc6cda3 JA	196	[Describe the sequence of events that causes the problem
ccc6cda3 JA	197	to occur.]
726f6388 JA	198
726f6388 JA	199	Fix:
ccc6cda3 JA	200	[Description of how to fix the problem. If you don't know a
ccc6cda3 JA	201	fix for the problem, don't include this section.]
726f6388 JA	202	EOF
726f6388 JA	203
f73dda09 JA	204	cp "$TEMPFILE1" "$TEMPFILE2"
f73dda09 JA	205	chmod u+w "$TEMPFILE1"
726f6388	206
ccc6cda3 JA	207	trap '' 2 # ignore interrupts while in editor
ccc6cda3 JA	208
f73dda09 JA	209	edstat=1
	210	while [ $edstat -ne 0 ]; do
	211	$EDITOR "$TEMPFILE1"
	212	edstat=$?
	213
	214	if [ $edstat -ne 0 ]; then
	215	echo "$0: editor \`$EDITOR' exited with nonzero status."
	216	echo "$0: Perhaps it was interrupted."
	217	echo "$0: Type \`y' to give up, and lose your bug report;"
	218	echo "$0: type \`n' to re-enter the editor."
	219	echo $n "$0: Do you want to give up? $c"
	220
	221	read ans
	222	case "$ans" in
	223	[Yy]*) exit 1 ;;
	224	esac
	225
	226	continue
	227	fi
	228
	229	# find the subject from the temp file and see if it's been changed
	230	CURR_SUB=`grep '^Subject: ' "$TEMPFILE1" \| sed 's\|^Subject:[ ]*\|\|' \| sed 1q`
ccc6cda3	231
f73dda09 JA	232	case "$CURR_SUB" in
	233	"${INITIAL_SUBJECT}")
	234	echo
	235	echo "$0: You have not changed the subject from the default."
	236	echo "$0: Please use a more descriptive subject header."
	237	echo "$0: Type \`y' to give up, and lose your bug report;"
	238	echo "$0: type \`n' to re-enter the editor."
	239	echo $n "$0: Do you want to give up? $c"
	240
	241	read ans
	242	case "$ans" in
	243	[Yy]*) exit 1 ;;
	244	esac
	245
	246	echo "$0: The editor will be restarted in five seconds."
	247	sleep 5
	248	edstat=1
	249	;;
ccc6cda3	250	esac
f73dda09	251
ccc6cda3 JA	252	done
ccc6cda3 JA	253
b80f6443	254	trap 'rm -rf "$TEMPDIR"; exit 1' 2 # restore trap on SIGINT
ccc6cda3	255
f73dda09	256	if cmp -s "$TEMPFILE1" "$TEMPFILE2"
726f6388	257	then
ccc6cda3 JA	258	echo "File not changed, no bug report submitted."
ccc6cda3 JA	259	exit
726f6388 JA	260	fi
726f6388 JA	261
0001803f	262	echo $n "Send bug report to ${BUGADDR}? [y/n] $c"
d166f048 JA	263	read ans
	264	case "$ans" in
	265	[Nn]*) exit 0 ;;
	266	esac
	267
f73dda09 JA	268	${RMAIL} $SMARGS < "$TEMPFILE1" \|\| {
f73dda09 JA	269	cat "$TEMPFILE1" >> $HOME/dead.bashbug
a0c0a00f CR	270	echo "$0: mail to ${BUGADDR} failed: report saved in $HOME/dead.bashbug" >&2
a0c0a00f CR	271	echo "$0: please send it manually to ${BUGADDR}" >&2
ccc6cda3 JA	272	}
ccc6cda3 JA	273
726f6388	274	exit 0