2 # Submit a problem report to a GNATS site.
3 # Copyright (C) 1993 Free Software Foundation, Inc.
4 # Contributed by Brendan Kehoe (brendan@cygnus.com), based on a
5 # version written by Heinz G. Seidl (hgs@ide.com).
7 # This file is part of GNU GNATS.
8 # Modified by Berliner for CVS.
10 # GNU GNATS is free software; you can redistribute it and/or modify
11 # it under the terms of the GNU General Public License as published by
12 # the Free Software Foundation; either version 2, or (at your option)
15 # GNU GNATS is distributed in the hope that it will be useful,
16 # but WITHOUT ANY WARRANTY; without even the implied warranty of
17 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 # GNU General Public License for more details.
20 # The version of this send-pr.
23 # The submitter-id for your site.
26 ## # Where the GNATS directory lives, if at all.
27 ## [ -z "$GNATS_ROOT" ] &&
28 ## GNATS_ROOT=/usr/local/lib/gnats/gnats-db
30 # The default mail address for PR submissions.
31 GNATS_ADDR=@PACKAGE_BUGREPORT@
33 ## # Where the gnats category tree lives.
34 ## DATADIR=/usr/local/lib
36 ## # If we've been moved around, try using GCC_EXEC_PREFIX.
37 ## [ ! -d $DATADIR/gnats -a -d "$GCC_EXEC_PREFIX" ] && DATADIR=${GCC_EXEC_PREFIX}..
39 # The default release for this host.
40 DEFAULT_RELEASE="@VERSION@"
42 # The default organization.
43 DEFAULT_ORGANIZATION="net"
45 ## # The default site to look for.
48 ## # Newer config information?
49 ## [ -f ${GNATS_ROOT}/gnats-adm/config ] && . ${GNATS_ROOT}/gnats-adm/config
51 # Hack mktemp on systems that don't have it.
55 # What mailer to use. This must come after the config file, since it is
58 MAIL_AGENT="$SENDMAIL -oi -t"
59 MAILER=`echo $MAIL_AGENT | sed -e 's, .*,,'`
60 if [ ! -f "$MAILER" ] ; then
61 echo "$COMMAND: Cannot find mail program \"$MAILER\"."
62 echo "$COMMAND: Please fix the MAIL_AGENT entry in the $COMMAND file."
66 if test "`echo -n foo`" = foo ; then
68 elif test "`echo 'foo\c'`" = foo ; then
74 if [ $ECHON = bsd ] ; then
77 elif [ $ECHON = sysv ] ; then
87 [ -z "$TMPDIR" ] && TMPDIR=/tmp
89 TEMP="`$MKTEMP $TMPDIR/p.XXXXXX`"
90 BAD="`$MKTEMP $TMPDIR/pbad.XXXXXX`"
91 REF="`$MKTEMP $TMPDIR/pf.XXXXXX`"
93 if [ -z "$LOGNAME" -a -n "$USER" ]; then
100 # Find out the name of the originator of this PR.
101 if [ -n "$NAME" ]; then
103 elif [ -f $HOME/.fullname ]; then
104 ORIGINATOR="`sed -e '1q' $HOME/.fullname`"
105 elif [ -f /bin/domainname ]; then
106 if [ "`/bin/domainname`" != "" -a -f /usr/bin/ypcat ]; then
107 # Must use temp file due to incompatibilities in quoting behavior
108 # and to protect shell metacharacters in the expansion of $LOGNAME
109 /usr/bin/ypcat passwd 2>/dev/null | cat - /etc/passwd | grep "^$LOGNAME:" |
110 cut -f5 -d':' | sed -e 's/,.*//' > $TEMP
111 ORIGINATOR="`cat $TEMP`"
116 if [ "$ORIGINATOR" = "" ]; then
117 grep "^$LOGNAME:" /etc/passwd | cut -f5 -d':' | sed -e 's/,.*//' > $TEMP
118 ORIGINATOR="`cat $TEMP`"
122 if [ -n "$ORGANIZATION" ]; then
123 if [ -f "$ORGANIZATION" ]; then
124 ORGANIZATION="`cat $ORGANIZATION`"
127 if [ -n "$DEFAULT_ORGANIZATION" ]; then
128 ORGANIZATION="$DEFAULT_ORGANIZATION"
129 elif [ -f $HOME/.organization ]; then
130 ORGANIZATION="`cat $HOME/.organization`"
131 elif [ -f $HOME/.signature ]; then
132 ORGANIZATION="`cat $HOME/.signature`"
136 # If they don't have a preferred editor set, then use
137 if [ -z "$VISUAL" ]; then
138 if [ -z "$EDITOR" ]; then
147 # Find out some information.
148 SYSTEM=`( [ -f /bin/uname ] && /bin/uname -a ) || \
149 ( [ -f /usr/bin/uname ] && /usr/bin/uname -a ) || echo ""`
150 ARCH=`[ -f /bin/arch ] && /bin/arch`
151 MACHINE=`[ -f /bin/machine ] && /bin/machine`
153 COMMAND=`echo $0 | sed -e 's,.*/,,'`
154 ## USAGE="Usage: $COMMAND [-PVL] [-t address] [-f filename] [--request-id]
155 USAGE="Usage: $COMMAND [-PVL]
160 while [ $# -gt 0 ]; do
162 -r) ;; # Ignore for backward compat.
163 ## -t | --to) if [ $# -eq 1 ]; then echo "$USAGE"; exit 1; fi
164 ## shift ; GNATS_ADDR="$1"
165 ## EXPLICIT_GNATS_ADDR=true
167 ## -f | --file) if [ $# -eq 1 ]; then echo "$USAGE"; exit 1; fi
168 ## shift ; IN_FILE="$1"
169 ## if [ "$IN_FILE" != "-" -a ! -r "$IN_FILE" ]; then
170 ## echo "$COMMAND: cannot read $IN_FILE"
174 -b | --batch) BATCH=true ;;
175 -p | -P | --print) PRINT=true ;;
176 -L | --list) FORMAT=norm ;;
177 -l | -CL | --lisp) FORMAT=lisp ;;
178 ## --request-id) REQUEST_ID=true ;;
179 -h | --help) echo "$USAGE"; exit 0 ;;
180 -V | --version) echo "$VERSION"; exit 0 ;;
181 -*) echo "$USAGE" ; exit 1 ;;
182 *) echo "$USAGE" ; exit 1
183 ## if [ -z "$USER_GNATS_SITE" ]; then
184 ## if [ ! -r "$DATADIR/gnats/$1" ]; then
185 ## echo "$COMMAND: the GNATS site $1 does not have a categories list."
188 ## # The site name is the alias they'll have to have created.
189 ## USER_GNATS_SITE=$1
192 ## echo "$USAGE" ; exit 1
199 if [ -n "$USER_GNATS_SITE" ]; then
200 GNATS_SITE=$USER_GNATS_SITE
201 GNATS_ADDR=$USER_GNATS_SITE-gnats
204 if [ "$SUBMITTER" = "unknown" -a -z "$REQUEST_ID" -a -z "$IN_FILE" ]; then
206 It seems that send-pr is not installed with your unique submitter-id.
211 where YOUR-SID is the identification code you received with `send-pr'.
212 `send-pr' will automatically insert this value into the template field
213 `>Submitter-Id'. If you've downloaded `send-pr' from the Net, use `net'
214 for this value. If you do not know your id, run `send-pr --request-id' to
215 get one from your support site.
220 ## if [ -r "$DATADIR/gnats/$GNATS_SITE" ]; then
221 ## CATEGORIES=`grep -v '^#' $DATADIR/gnats/$GNATS_SITE | sort`
223 ## echo "$COMMAND: could not read $DATADIR/gnats/$GNATS_SITE for categories list."
226 CATEGORIES="contrib cvs doc pcl-cvs portability"
228 if [ -z "$CATEGORIES" ]; then
229 echo "$COMMAND: the categories list for $GNATS_SITE was empty!"
234 lisp) echo "$CATEGORIES" | \
235 awk 'BEGIN {printf "( "}
236 {printf "(\"%s\") ",$0}
240 norm) l=`echo "$CATEGORIES" | \
241 awk 'BEGIN {max = 0; }
242 { if (length($0) > max) { max = length($0); } }
243 END {print max + 1;}'`
245 if [ $c -eq 0 ]; then c=1; fi
246 echo "$CATEGORIES" | \
247 awk 'BEGIN {print "Known categories:"; i = 0 }
248 { printf ("%-'$l'.'$l's", $0); if ((++i % '$c') == 0) { print "" } }
254 ORIGINATOR_C='<name of the PR author (one line)>'
255 ORGANIZATION_C='<organization of PR author (multiple lines)>'
256 CONFIDENTIAL_C='<[ yes | no ] (one line)>'
257 SYNOPSIS_C='<synopsis of the problem (one line)>'
258 SEVERITY_C='<[ non-critical | serious | critical ] (one line)>'
259 PRIORITY_C='<[ low | medium | high ] (one line)>'
260 CATEGORY_C='<name of the product (one line)>'
261 CLASS_C='<[ sw-bug | doc-bug | change-request | support ] (one line)>'
262 RELEASE_C='<release number or tag (one line)>'
263 ENVIRONMENT_C='<machine, os, target, libraries (multiple lines)>'
264 DESCRIPTION_C='<precise description of the problem (multiple lines)>'
265 HOW_TO_REPEAT_C='<code/input/activities to reproduce the problem (multiple lines)>'
266 FIX_C='<how to correct or work around the problem, if known (multiple lines)>'
268 # Catch some signals. ($xs kludge needed by Sun /bin/sh)
270 trap 'rm -f $REF $TEMP; exit $xs' 0
271 trap 'echo "$COMMAND: Aborting ..."; rm -f $REF $TEMP; xs=1; exit' 1 2 3 13 15
273 # If they told us to use a specific file, then do so.
274 if [ -n "$IN_FILE" ]; then
275 if [ "$IN_FILE" = "-" ]; then
276 # The PR is coming from the standard input.
277 if [ -n "$EXPLICIT_GNATS_ADDR" ]; then
278 sed -e "s;^[Tt][Oo]:.*;To: $GNATS_ADDR;" > $TEMP
283 # Use the file they named.
284 if [ -n "$EXPLICIT_GNATS_ADDR" ]; then
285 sed -e "s;^[Tt][Oo]:.*;To: $GNATS_ADDR;" $IN_FILE > $TEMP
292 if [ -n "$PR_FORM" -a -z "$PRINT_INTERN" ]; then
293 # If their PR_FORM points to a bogus entry, then bail.
294 if [ ! -f "$PR_FORM" -o ! -r "$PR_FORM" -o ! -s "$PR_FORM" ]; then
295 echo "$COMMAND: can't seem to read your template file (\`$PR_FORM'), ignoring PR_FORM"
297 PRINT_INTERN=bad_prform
301 if [ -n "$PR_FORM" -a -z "$PRINT_INTERN" ]; then
303 ( echo "$COMMAND: could not copy $PR_FORM" ; xs=1; exit )
305 for file in $TEMP $REF ; do
306 cat > $file << '__EOF__'
307 SEND-PR: -*- send-pr -*-
308 SEND-PR: Lines starting with `SEND-PR' will be removed automatically, as
309 SEND-PR: will all comments (text enclosed in `<' and `>').
311 SEND-PR: Choose from the following categories:
315 # Format the categories so they fit onto lines.
316 l=`echo "$CATEGORIES" | \
317 awk 'BEGIN {max = 0; }
318 { if (length($0) > max) { max = length($0); } }
319 END {print max + 1;}'`
321 if [ $c -eq 0 ]; then c=1; fi
322 echo "$CATEGORIES" | \
323 awk 'BEGIN {printf "SEND-PR: "; i = 0 }
324 { printf ("%-'$l'.'$l's", $0);
325 if ((++i % '$c') == 0) { printf "\nSEND-PR: " } }
326 END { printf "\nSEND-PR:\n"; }' >> $file
328 cat >> $file << __EOF__
333 X-send-pr-version: $VERSION
336 >Submitter-Id: $SUBMITTER
337 >Originator: $ORIGINATOR
339 ${ORGANIZATION-$ORGANIZATION_C}
340 >Confidential: $CONFIDENTIAL_C
341 >Synopsis: $SYNOPSIS_C
342 >Severity: $SEVERITY_C
343 >Priority: $PRIORITY_C
344 >Category: $CATEGORY_C
346 >Release: ${DEFAULT_RELEASE-$RELEASE_C}
349 `[ -n "$SYSTEM" ] && echo System: $SYSTEM`
350 `[ -n "$ARCH" ] && echo Architecture: $ARCH`
351 `[ -n "$MACHINE" ] && echo Machine: $MACHINE`
362 if [ "$PRINT" = true -o "$PRINT_INTERN" = true ]; then
368 if [ -z "$REQUEST_ID" ]; then
371 ed -s $TEMP << '__EOF__'
372 /^Subject/s/^Subject:.*/Subject: request for a customer id/
373 /^>Category/s/^>Category:.*/>Category: send-pr/
379 if cmp -s $REF $TEMP ; then
380 echo "$COMMAND: problem report not filled out, therefore not sent"
386 # Check the enumeration fields
388 # This is a "sed-subroutine" with one keyword parameter
389 # (with workaround for Sun sed bug)
402 while [ -z "$REQUEST_ID" ]; do
407 PATTERN=">Confidential:"
408 CONFIDENTIAL=`eval sed -n -e "\"$SED_CMD\"" $TEMP`
409 case "$CONFIDENTIAL" in
410 ""|yes|no) CNT=`expr $CNT + 1` ;;
411 *) echo "$COMMAND: \`$CONFIDENTIAL' is not a valid value for \`Confidential'." ;;
417 SEVERITY=`eval sed -n -e "\"$SED_CMD\"" $TEMP`
419 ""|non-critical|serious|critical) CNT=`expr $CNT + 1` ;;
420 *) echo "$COMMAND: \`$SEVERITY' is not a valid value for \`Severity'."
426 PRIORITY=`eval sed -n -e "\"$SED_CMD\"" $TEMP`
428 ""|low|medium|high) CNT=`expr $CNT + 1` ;;
429 *) echo "$COMMAND: \`$PRIORITY' is not a valid value for \`Priority'."
435 CATEGORY=`eval sed -n -e "\"$SED_CMD\"" $TEMP`
439 if [ "$C" = "$CATEGORY" ]; then FOUND=true ; break ; fi
441 if [ -n "$FOUND" ]; then
444 if [ -z "$CATEGORY" ]; then
445 echo "$COMMAND: you must include a Category: field in your report."
447 echo "$COMMAND: \`$CATEGORY' is not a known category."
454 CLASS=`eval sed -n -e "\"$SED_CMD\"" $TEMP`
456 ""|sw-bug|doc-bug|change-request|support) CNT=`expr $CNT + 1` ;;
457 *) echo "$COMMAND: \`$CLASS' is not a valid value for \`Class'."
460 [ $CNT -lt 5 -a -z "$BATCH" ] &&
461 echo "Errors were found with the problem report."
464 if [ -z "$BATCH" ]; then
465 $ECHON1 "a)bort, e)dit or s)end? $ECHON2"
468 if [ $CNT -eq 5 ]; then
476 if [ -z "$BATCH" ]; then
477 echo "$COMMAND: the problem report remains in $BAD and is not sent."
480 echo "$COMMAND: the problem report is not sent."
495 # Remove comments and send the problem report
496 # (we have to use patterns, where the comment contains regex chars)
498 # /^>Originator:/s;$ORIGINATOR;;
501 /^>Organization:/,/^>[A-Za-z-]*:/s;$ORGANIZATION_C;;
502 /^>Confidential:/s;<.*>;;
503 /^>Synopsis:/s;$SYNOPSIS_C;;
504 /^>Severity:/s;<.*>;;
505 /^>Priority:/s;<.*>;;
506 /^>Category:/s;$CATEGORY_C;;
508 /^>Release:/,/^>[A-Za-z-]*:/s;$RELEASE_C;;
509 /^>Environment:/,/^>[A-Za-z-]*:/s;$ENVIRONMENT_C;;
510 /^>Description:/,/^>[A-Za-z-]*:/s;$DESCRIPTION_C;;
511 /^>How-To-Repeat:/,/^>[A-Za-z-]*:/s;$HOW_TO_REPEAT_C;;
512 /^>Fix:/,/^>[A-Za-z-]*:/s;$FIX_C;;
515 if $MAIL_AGENT < $REF; then
516 echo "$COMMAND: problem report sent"
519 echo "$COMMAND: mysterious mail failure."
520 if [ -z "$BATCH" ]; then
521 echo "$COMMAND: the problem report remains in $BAD and is not sent."
524 echo "$COMMAND: the problem report is not sent."