From 721e227587e663bfecde1337f7d0f687dfd7b9bb Mon Sep 17 00:00:00 2001
From: Nicholas Clark <nick@ccl4.org>
Date: Mon, 25 Feb 2008 23:29:33 +0000
Subject: [PATCH] Also install perlbug as perlthanks, to make it easy for
 people to send their appreciation to perl-thanks@perl.org. It would be nice
 to get feedback other than bug reports.

p4raw-id: //depot/perl@33371
---
 utils.lst        |   2 +-
 utils/perlbug.PL | 133 +++++++++++++++++++++++++++++++++++++++++++------------
 2 files changed, 105 insertions(+), 30 deletions(-)

diff --git a/utils.lst b/utils.lst
index 4e88e43..b92c513 100644
--- a/utils.lst
+++ b/utils.lst
@@ -15,7 +15,7 @@ utils/h2ph
 utils/h2xs
 utils/instmodsh
 utils/libnetcfg
-utils/perlbug
+utils/perlbug	# link = utils/perlthanks
 utils/perldoc   # pod = pod/perldoc.pod
 utils/perlivp
 utils/piconv
diff --git a/utils/perlbug.PL b/utils/perlbug.PL
index 5190439..23e1e03 100644
--- a/utils/perlbug.PL
+++ b/utils/perlbug.PL
@@ -81,10 +81,11 @@ my \@patches = (
 
 print OUT <<'!NO!SUBS!';
 
+use strict;
 use Config;
 use File::Spec;		# keep perlbug Perl 5.005 compatible
 use Getopt::Std;
-use strict;
+use File::Basename 'basename';
 
 sub paraprint;
 
@@ -147,10 +148,10 @@ my $Version = "1.36";
 #       accounted for.
 #       - Test -b option
 
-my( $file, $usefile, $cc, $address, $perlbug, $testaddress, $filename, $messageid, $domain,
-    $subject, $from, $verbose, $ed, $outfile, $Is_MacOS, $category, $severity,
-    $fh, $me, $Is_MSWin32, $Is_Linux, $Is_VMS, $msg, $body, $andcc, %REP, $ok,
-    $Is_OpenBSD);
+my( $file, $usefile, $cc, $address, $bugaddress, $testaddress, $thanksaddress,
+    $filename, $messageid, $domain, $subject, $from, $verbose, $ed, $outfile,
+    $Is_MacOS, $category, $severity, $fh, $me, $Is_MSWin32, $Is_Linux, $Is_VMS,
+    $msg, $body, $andcc, %REP, $ok, $thanks, $Is_OpenBSD, $progname);
 
 my $perl_version = $^V ? sprintf("%vd", $^V) : $];
 
@@ -161,8 +162,8 @@ Init();
 if ($::opt_h) { Help(); exit; }
 if ($::opt_d) { Dump(*STDOUT); exit; }
 if (!-t STDIN && !($ok and not $::opt_n)) {
-    paraprint <<EOF;
-Please use perlbug interactively. If you want to
+    paraprint <<"EOF";
+Please use $progname interactively. If you want to
 include a file, you can use the -f switch.
 EOF
     die "\n";
@@ -181,18 +182,22 @@ sub ask_for_alternatives { # (category|severity)
 	'category' => {
 	    'default' => 'core',
 	    'ok'      => 'install',
+	    # Inevitably some of these will end up in RT whatever we do:
+	    'thanks'  => 'thanks',
 	    'opts'    => [qw(core docs install library utilities)], # patch, notabug
 	},
 	'severity' => {
 	    'default' => 'low',
 	    'ok'      => 'none',
+	    'ok'      => 'none',
 	    'opts'    => [qw(critical high medium low wishlist none)], # zero
 	},
     );
     die "Invalid alternative($name) requested\n" unless grep(/^$name$/, keys %alts);
     my $alt = "";
-    if ($ok) {
-	$alt = $alts{$name}{'ok'};
+    my $what = $ok || $thanks;
+    if ($what) {
+	$alt = $alts{$name}{$what};
     } else {
  	my @alts = @{$alts{$name}{'opts'}};
 	paraprint <<EOF;
@@ -230,7 +235,7 @@ sub Init {
         MacPerl::Ask('Provide command-line args here (-h for help):')
         if $Is_MacOS && $MacPerl::Version =~ /App/;
 
-    if (!getopts("Adhva:s:b:f:F:r:e:SCc:to:n:")) { Help(); exit; };
+    if (!getopts("Adhva:s:b:f:F:r:e:SCc:to:n:T")) { Help(); exit; };
 
     # This comment is needed to notify metaconfig that we are
     # using the $perladmin, $cf_by, and $cf_time definitions.
@@ -238,13 +243,28 @@ sub Init {
     # -------- Configuration ---------
 
     # perlbug address
-    $perlbug = 'perlbug@perl.org';
+    $bugaddress = 'perlbug@perl.org';
 
     # Test address
     $testaddress = 'perlbug-test@perl.org';
 
+    # Thanks address
+    $thanksaddress = 'perl-thanks@perl.org';
+
+    if (basename ($0) =~ /^perlthanks/i) {
+	# invoked as perlthanks
+	$::opt_T = 1;
+	$::opt_C = 1; # don't send a copy to the local admin
+    }
+
+    if ($::opt_T) {
+	$thanks = 'thanks';
+    }
+    
+    $progname = $thanks ? 'perlthanks' : 'perlbug';
     # Target address
-    $address = $::opt_a || ($::opt_t ? $testaddress : $perlbug);
+    $address = $::opt_a || ($::opt_t ? $testaddress
+			    : $thanks ? $thanksaddress : $bugaddress);
 
     # Users address, used in message and in Reply-To header
     $from = $::opt_r || "";
@@ -285,7 +305,7 @@ sub Init {
     }
 
     # OK - send "OK" report for build on this system
-    $ok = 0;
+    $ok = '';
     if ($::opt_o) {
 	if ($::opt_o eq 'k' or $::opt_o eq 'kay') {
 	    my $age = time - $patchlevel_date;
@@ -310,7 +330,7 @@ EOF
 	    $subject = ($::opt_n ? 'Not ' : '')
 		    . "OK: perl $perl_version ${patch_tags}on"
 		    ." $::Config{'archname'} $::Config{'osvers'} $subject";
-	    $ok = 1;
+	    $ok = 'ok';
 	} else {
 	    Help();
 	    exit();
@@ -354,7 +374,16 @@ EOF
 sub Query {
     # Explain what perlbug is
     unless ($ok) {
-	paraprint <<EOF;
+	if ($thanks) {
+	    paraprint <<'EOF';
+This program provides an easy way to send a thank-you message back to the
+authors and maintainers of perl.
+
+If you wish to submit a bug report, please run it without the -T flag
+(or run the program perlbug rather than perlthanks)
+EOF
+	} else {
+	    paraprint <<"EOF";
 This program provides an easy way to create a message reporting a bug
 in perl, and e-mail it to $address.  It is *NOT* intended for
 sending test messages or simply verifying that perl works, *NOR* is it
@@ -365,7 +394,11 @@ and any solutions to such problems, to the people who maintain perl.
 If you're just looking for help with perl, try posting to the Usenet
 newsgroup comp.lang.perl.misc.  If you're looking for help with using
 perl with CGI, try posting to comp.infosystems.www.programming.cgi.
+
+When invoked as perlthanks (or with the -T option) it can be used to
+send a thank-you message to $thanksaddress.
 EOF
+	}
     }
 
     # Prompt for subject of message, if needed
@@ -375,12 +408,16 @@ EOF
     }
 
     unless ($subject) {
-	paraprint <<EOF;
+	if ($thanks) {
+	    paraprint "First of all, please provide a subject for the message.\n";
+	} else {
+	    paraprint <<EOF;
 First of all, please provide a subject for the
 message. It should be a concise description of
 the bug or problem. "perl bug" or "perl problem"
 is not a concise description.
 EOF
+	}
 
 	my $err = 0;
 	do {
@@ -388,7 +425,11 @@ EOF
 	    $subject = <>;
 	    chomp $subject;
 	    if ($err++ == 5) {
-		die "Aborting.\n";
+		if ($thanks) {
+		    $subject = 'Thanks for Perl';
+		} else {
+		    die "Aborting.\n";
+		}
 	    }
 	} while (TrivialSubject($subject));
     }
@@ -472,7 +513,30 @@ EOF
     # Prompt for editor, if no override is given
 editor:
     unless ($::opt_e || $::opt_f || $::opt_b) {
-	paraprint <<EOF;
+	chomp (my $common_end = <<"EOF");
+
+You will probably want to use an editor to enter
+the report. If "$ed" is the editor you want
+to use, then just press Enter, otherwise type in
+the name of the editor you would like to use.
+
+If you would like to use a prepared file, type
+"file", and you will be asked for the filename.
+EOF
+
+	if ($thanks) {
+	    paraprint <<"EOF";
+Now you need to supply your thank-you message.
+
+Some information about your local perl configuration
+will automatically be included at the end of the message,
+because we're curious about the different ways that people
+build perl, but you're welcome to delete it if you wish.
+
+$common_end
+EOF
+	} else {
+	    paraprint <<"EOF";
 Now you need to supply the bug report. Try to make
 the report concise but descriptive. Include any
 relevant detail. If you are reporting something
@@ -486,14 +550,10 @@ at the end of the report. If you are using any
 unusual version of perl, please try and confirm
 exactly which versions are relevant.
 
-You will probably want to use an editor to enter
-the report. If "$ed" is the editor you want
-to use, then just press Enter, otherwise type in
-the name of the editor you would like to use.
-
-If you would like to use a prepared file, type
-"file", and you will be asked for the filename.
+$common_end
 EOF
+	}
+
 	print "Editor [$ed]: ";
 	my $entry =scalar <>;
 	chomp $entry;
@@ -506,7 +566,7 @@ EOF
 	}
     }
     my $report_about_module = '';
-    if ($::HaveCoreList && !$ok) {
+    if ($::HaveCoreList && !$ok && !$thanks) {
 	paraprint <<EOF;
 Is your report about a Perl module? If yes, enter its name. If not, skip.
 EOF
@@ -568,7 +628,8 @@ EOF
 
     # Generate report
     open(REP,">$filename") or die "Unable to create report file `$filename': $!\n";
-    my $reptype = !$ok ? "bug" : $::opt_n ? "build failure" : "success";
+    my $reptype = !$ok ? ($thanks ? 'thank-you' : 'bug')
+	: $::opt_n ? "build failure" : "success";
 
     print REP <<EOF;
 This is a $reptype report for perl from $from,
@@ -586,7 +647,19 @@ EOF
 	}
 	close(F) or die "Error closing `$file': $!";
     } else {
-	print REP <<EOF;
+	if ($thanks) {
+	    print REP <<'EOF';
+
+-----------------------------------------------------------------
+[Please enter your thank you message here]
+
+
+
+[You're welcome to delete anything below this line if you prefer]
+-----------------------------------------------------------------
+EOF
+	} else {
+	    print REP <<'EOF';
 
 -----------------------------------------------------------------
 [Please enter your report here]
@@ -596,6 +669,7 @@ EOF
 [Please do not change anything below this line]
 -----------------------------------------------------------------
 EOF
+	}
     }
     Dump(*REP);
     close(REP) or die "Error closing report file: $!";
@@ -777,7 +851,7 @@ EOF
 	    chomp $action;
 
 	    if ($action =~ /^(f|sa)/i) { # <F>ile/<Sa>ve
-		my $file_save = $outfile || "perlbug.rep";
+		my $file_save = $outfile || "$progname.rep";
 		print "\n\nName of file to save message in [$file_save]: ";
 		my $file = scalar <>;
 		chomp $file;
@@ -975,6 +1049,7 @@ Options:
         this if you don't give it here.
   -e    Editor to use.
   -t    Test mode. The target address defaults to `$testaddress'.
+  -T    Thank-you mode. The target address defaults to 
   -d    Data mode.  This prints out your configuration data, without mailing
         anything. You can use this with -v to get more complete data.
   -A    Don't send a bug received acknowledgement to the return address.
-- 
1.8.3.1