[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@po.cwru.edu and, optionally, to bash-testers@po.cwru.edu.
# Other versions send mail to bug-bash@gnu.org.
#
# Copyright (C) 1996-2002 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 2, 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, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111 USA.

#
# 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

# If the OS supplies a program to make temp files with semi-random names,
# use it.
: ${TMPDIR:=/tmp}
rm_tmp1=false
rm_tmp2=false

# if we don't have mktemp or tempfile, we don't want to see error messages
# like `mktemp: not found', so temporarily redirect stderr using {...} while
# trying to run them.  this may fail using old versions of the bourne shell
# that run {...} blocks with redirections in subshells; in that case we're
# no worse off than previous versions

{ TEMPFILE1=`mktemp "$TMPDIR/bbug.XXXXXX" 2>/dev/null` ; } 2>/dev/null
if [ -z "$TEMPFILE1" ]; then
	{ TEMPFILE1=`tempfile --prefix bbug --mode 600 2>/dev/null`; } 2>/dev/null
fi
if [ -z "$TEMPFILE1" ]; then
	TEMPFILE1=$TMPDIR/bbug.$$
	rm_tmp1=true
fi
{ TEMPFILE2=`mktemp "$TMPDIR/bbug.XXXXXX" 2>/dev/null`; } 2>/dev/null
if [ -z "$TEMPFILE2" ]; then
	{ TEMPFILE2=`tempfile --prefix bbug --mode 600 2>/dev/null`; } 2>/dev/null
fi
if [ -z "$TEMPFILE2" ]; then
	TEMPFILE2="$TMPDIR/bbug.$$.x"
	rm_tmp2=true
fi

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
bash maintainers 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@po.cwru.edu"

case "$RELSTATUS" in
alpha*|beta*|devel*|rc*)	BUGBASH=chet@po.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/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 -f "$TEMPFILE1" "$TEMPFILE2"; exit 1' 1 2 3 13 15
trap 'rm -f "$TEMPFILE1" "$TEMPFILE2"' 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)]'

# this is raceable unless (hopefully) we used mktemp(1) or tempfile(1)
$rm_tmp1 && rm -f "$TEMPFILE1"

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

# this is still raceable unless (hopefully) we used mktemp(1) or tempfile(1)
$rm_tmp2 && rm -f "$TEMPFILE2"

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 -f "$TEMPFILE1" "$TEMPFILE2"; 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? [y/n] $c"
read ans
case "$ans" in
[Nn]*)	exit 0 ;;
esac

${RMAIL} $SMARGS < "$TEMPFILE1" || {
	cat "$TEMPFILE1" >> $HOME/dead.bashbug
	echo "$0: mail failed: report saved in $HOME/dead.bashbug" >&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 JA	6	# with status `devel', `alpha', `beta', or `rc' mail bug reports to
f73dda09 JA	7	# chet@po.cwru.edu and, optionally, to bash-testers@po.cwru.edu.
cce855bc	8	# Other versions send mail to bug-bash@gnu.org.
7117c2d2 JA	9	#
	10	# Copyright (C) 1996-2002 Free Software Foundation, Inc.
	11	#
	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 2, or (at your option)
	15	# 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, write to the Free Software
	24	# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111 USA.
	25
726f6388 JA	26	#
726f6388 JA	27	# configuration section:
f73dda09	28	# these variables are filled in by the make target in Makefile
726f6388	29	#
ccc6cda3 JA	30	MACHINE="!MACHINE!"
	31	OS="!OS!"
	32	CC="!CC!"
	33	CFLAGS="!CFLAGS!"
	34	RELEASE="!RELEASE!"
	35	PATCHLEVEL="!PATCHLEVEL!"
	36	RELSTATUS="!RELSTATUS!"
	37	MACHTYPE="!MACHTYPE!"
	38
	39	PATH=/bin:/usr/bin:/usr/local/bin:$PATH
726f6388 JA	40	export PATH
726f6388 JA	41
28ef6c31 JA	42	# If the OS supplies a program to make temp files with semi-random names,
28ef6c31 JA	43	# use it.
f73dda09 JA	44	: ${TMPDIR:=/tmp}
	45	rm_tmp1=false
	46	rm_tmp2=false
	47
	48	# if we don't have mktemp or tempfile, we don't want to see error messages
	49	# like `mktemp: not found', so temporarily redirect stderr using {...} while
	50	# trying to run them. this may fail using old versions of the bourne shell
	51	# that run {...} blocks with redirections in subshells; in that case we're
	52	# no worse off than previous versions
	53
	54	{ TEMPFILE1=`mktemp "$TMPDIR/bbug.XXXXXX" 2>/dev/null` ; } 2>/dev/null
	55	if [ -z "$TEMPFILE1" ]; then
	56	{ TEMPFILE1=`tempfile --prefix bbug --mode 600 2>/dev/null`; } 2>/dev/null
	57	fi
	58	if [ -z "$TEMPFILE1" ]; then
	59	TEMPFILE1=$TMPDIR/bbug.$$
	60	rm_tmp1=true
	61	fi
	62	{ TEMPFILE2=`mktemp "$TMPDIR/bbug.XXXXXX" 2>/dev/null`; } 2>/dev/null
	63	if [ -z "$TEMPFILE2" ]; then
	64	{ TEMPFILE2=`tempfile --prefix bbug --mode 600 2>/dev/null`; } 2>/dev/null
	65	fi
	66	if [ -z "$TEMPFILE2" ]; then
	67	TEMPFILE2="$TMPDIR/bbug.$$.x"
	68	rm_tmp2=true
	69	fi
28ef6c31	70
bb70624e JA	71	USAGE="Usage: $0 [--help] [--version] [bug-report-email-address]"
	72	VERSTR="GNU bashbug, version ${RELEASE}.${PATCHLEVEL}-${RELSTATUS}"
	73
	74	do_help= do_version=
	75
	76	while [ $# -gt 0 ]; do
	77	case "$1" in
	78	--help) shift ; do_help=y ;;
	79	--version) shift ; do_version=y ;;
	80	--) shift ; break ;;
	81	-*) echo "bashbug: ${1}: invalid option" >&2
	82	echo "$USAGE" >& 2
	83	exit 2 ;;
	84	*) break ;;
	85	esac
	86	done
	87
	88	if [ -n "$do_version" ]; then
	89	echo "${VERSTR}"
	90	exit 0
	91	fi
	92
	93	if [ -n "$do_help" ]; then
	94	echo "${VERSTR}"
	95	echo "${USAGE}"
	96	echo
	97	cat << HERE_EOF
	98	Bashbug is used to send mail to the Bash maintainers
	99	for when Bash doesn't behave like you'd like, or expect.
	100
	101	Bashbug will start up your editor (as defined by the shell's
	102	EDITOR environment variable) with a preformatted bug report
	103	template for you to fill in. The report will be mailed to the
	104	bash maintainers by default. See the manual for details.
	105
	106	If you invoke bashbug by accident, just quit your editor without
	107	saving any changes to the template, and no bug report will be sent.
	108	HERE_EOF
	109	exit 0
	110	fi
d166f048 JA	111
	112	# Figure out how to echo a string without a trailing newline
	113	N=`echo 'hi there\c'`
	114	case "$N" in
	115	*c) n=-n c= ;;
	116	*) n= c='\c' ;;
	117	esac
	118
	119	BASHTESTERS="bash-testers@po.cwru.edu"
726f6388	120
ccc6cda3	121	case "$RELSTATUS" in
f73dda09 JA	122	alpha\|beta\|devel\|rc) BUGBASH=chet@po.cwru.edu ;;
f73dda09 JA	123	*) BUGBASH=bug-bash@gnu.org ;;
ccc6cda3 JA	124	esac
ccc6cda3 JA	125
d166f048	126	case "$RELSTATUS" in
f73dda09	127	alpha\|beta\|devel\|rc)
bb70624e	128	echo "$0: This is a testing release. Would you like your bug report"
d166f048 JA	129	echo "$0: to be sent to the bash-testers mailing list?"
	130	echo $n "$0: Send to bash-testers? $c"
	131	read ans
	132	case "$ans" in
	133	y\|Y) BUGBASH="${BUGBASH},${BASHTESTERS}" ;;
	134	esac ;;
	135	esac
	136
	137	BUGADDR="${1-$BUGBASH}"
726f6388	138
bb70624e	139	if [ -z "$DEFEDITOR" ] && [ -z "$EDITOR" ]; then
28ef6c31 JA	140	if [ -x /usr/bin/editor ]; then
	141	DEFEDITOR=editor
	142	elif [ -x /usr/local/bin/ce ]; then
bb70624e JA	143	DEFEDITOR=ce
	144	elif [ -x /usr/local/bin/emacs ]; then
	145	DEFEDITOR=emacs
	146	elif [ -x /usr/contrib/bin/emacs ]; then
	147	DEFEDITOR=emacs
	148	elif [ -x /usr/bin/emacs ]; then
	149	DEFEDITOR=emacs
	150	elif [ -x /usr/bin/xemacs ]; then
	151	DEFEDITOR=xemacs
	152	elif [ -x /usr/contrib/bin/jove ]; then
	153	DEFEDITOR=jove
	154	elif [ -x /usr/local/bin/jove ]; then
	155	DEFEDITOR=jove
	156	elif [ -x /usr/bin/vi ]; then
	157	DEFEDITOR=vi
	158	else
	159	echo "$0: No default editor found: attempting to use vi" >&2
	160	DEFEDITOR=vi
	161	fi
	162	fi
	163
	164
	165	: ${EDITOR=$DEFEDITOR}
726f6388	166
ccc6cda3 JA	167	: ${USER=${LOGNAME-`whoami`}}
ccc6cda3 JA	168
f73dda09 JA	169	trap 'rm -f "$TEMPFILE1" "$TEMPFILE2"; exit 1' 1 2 3 13 15
f73dda09 JA	170	trap 'rm -f "$TEMPFILE1" "$TEMPFILE2"' 0
726f6388 JA	171
	172	UN=
	173	if (uname) >/dev/null 2>&1; then
	174	UN=`uname -a`
	175	fi
	176
	177	if [ -f /usr/lib/sendmail ] ; then
	178	RMAIL="/usr/lib/sendmail"
bb70624e	179	SMARGS="-i -t"
726f6388 JA	180	elif [ -f /usr/sbin/sendmail ] ; then
726f6388 JA	181	RMAIL="/usr/sbin/sendmail"
bb70624e	182	SMARGS="-i -t"
726f6388 JA	183	else
726f6388 JA	184	RMAIL=rmail
bb70624e	185	SMARGS="$BUGADDR"
726f6388 JA	186	fi
726f6388 JA	187
f73dda09 JA	188	INITIAL_SUBJECT='[50 character or so descriptive subject here (for reference)]'
	189
	190	# this is raceable unless (hopefully) we used mktemp(1) or tempfile(1)
	191	$rm_tmp1 && rm -f "$TEMPFILE1"
cce855bc	192
f73dda09	193	cat > "$TEMPFILE1" <<EOF
726f6388 JA	194	From: ${USER}
726f6388 JA	195	To: ${BUGADDR}
f73dda09	196	Subject: ${INITIAL_SUBJECT}
726f6388 JA	197
	198	Configuration Information [Automatically generated, do not change]:
	199	Machine: $MACHINE
	200	OS: $OS
	201	Compiler: $CC
	202	Compilation CFLAGS: $CFLAGS
	203	uname output: $UN
ccc6cda3	204	Machine Type: $MACHTYPE
726f6388 JA	205
	206	Bash Version: $RELEASE
	207	Patch Level: $PATCHLEVEL
ccc6cda3	208	Release Status: $RELSTATUS
726f6388 JA	209
726f6388 JA	210	Description:
ccc6cda3	211	[Detailed description of the problem, suggestion, or complaint.]
726f6388 JA	212
726f6388 JA	213	Repeat-By:
ccc6cda3 JA	214	[Describe the sequence of events that causes the problem
ccc6cda3 JA	215	to occur.]
726f6388 JA	216
726f6388 JA	217	Fix:
ccc6cda3 JA	218	[Description of how to fix the problem. If you don't know a
ccc6cda3 JA	219	fix for the problem, don't include this section.]
726f6388 JA	220	EOF
726f6388 JA	221
f73dda09 JA	222	# this is still raceable unless (hopefully) we used mktemp(1) or tempfile(1)
	223	$rm_tmp2 && rm -f "$TEMPFILE2"
	224
	225	cp "$TEMPFILE1" "$TEMPFILE2"
	226	chmod u+w "$TEMPFILE1"
726f6388	227
ccc6cda3 JA	228	trap '' 2 # ignore interrupts while in editor
ccc6cda3 JA	229
f73dda09 JA	230	edstat=1
	231	while [ $edstat -ne 0 ]; do
	232	$EDITOR "$TEMPFILE1"
	233	edstat=$?
	234
	235	if [ $edstat -ne 0 ]; then
	236	echo "$0: editor \`$EDITOR' exited with nonzero status."
	237	echo "$0: Perhaps it was interrupted."
	238	echo "$0: Type \`y' to give up, and lose your bug report;"
	239	echo "$0: type \`n' to re-enter the editor."
	240	echo $n "$0: Do you want to give up? $c"
	241
	242	read ans
	243	case "$ans" in
	244	[Yy]*) exit 1 ;;
	245	esac
	246
	247	continue
	248	fi
	249
	250	# find the subject from the temp file and see if it's been changed
	251	CURR_SUB=`grep '^Subject: ' "$TEMPFILE1" \| sed 's\|^Subject:[ ]*\|\|' \| sed 1q`
ccc6cda3	252
f73dda09 JA	253	case "$CURR_SUB" in
	254	"${INITIAL_SUBJECT}")
	255	echo
	256	echo "$0: You have not changed the subject from the default."
	257	echo "$0: Please use a more descriptive subject header."
	258	echo "$0: Type \`y' to give up, and lose your bug report;"
	259	echo "$0: type \`n' to re-enter the editor."
	260	echo $n "$0: Do you want to give up? $c"
	261
	262	read ans
	263	case "$ans" in
	264	[Yy]*) exit 1 ;;
	265	esac
	266
	267	echo "$0: The editor will be restarted in five seconds."
	268	sleep 5
	269	edstat=1
	270	;;
ccc6cda3	271	esac
f73dda09	272
ccc6cda3 JA	273	done
ccc6cda3 JA	274
f73dda09	275	trap 'rm -f "$TEMPFILE1" "$TEMPFILE2"; exit 1' 2 # restore trap on SIGINT
ccc6cda3	276
f73dda09	277	if cmp -s "$TEMPFILE1" "$TEMPFILE2"
726f6388	278	then
ccc6cda3 JA	279	echo "File not changed, no bug report submitted."
ccc6cda3 JA	280	exit
726f6388 JA	281	fi
726f6388 JA	282
d166f048 JA	283	echo $n "Send bug report? [y/n] $c"
	284	read ans
	285	case "$ans" in
	286	[Nn]*) exit 0 ;;
	287	esac
	288
f73dda09 JA	289	${RMAIL} $SMARGS < "$TEMPFILE1" \|\| {
f73dda09 JA	290	cat "$TEMPFILE1" >> $HOME/dead.bashbug
ccc6cda3 JA	291	echo "$0: mail failed: report saved in $HOME/dead.bashbug" >&2
	292	}
	293
726f6388	294	exit 0