X-Git-Url: https://code.delx.au/gnu-emacs/blobdiff_plain/0d912b5849342547d16e8d6d7b6cf03fc549af95..e927088b531a2e7c4fcb77d1feed1b30083d52d0:/lisp/mail/emacsbug.el

diff --git a/lisp/mail/emacsbug.el b/lisp/mail/emacsbug.el
index d872a5d7a8..c4a52299d9 100644
--- a/lisp/mail/emacsbug.el
+++ b/lisp/mail/emacsbug.el
@@ -1,10 +1,11 @@
-;;; emacsbug.el --- command to report Emacs bugs to appropriate mailing list.
+;;; emacsbug.el --- command to report Emacs bugs to appropriate mailing list
 
-;; Copyright (C) 1985, 1994 Free Software Foundation, Inc.
+;; Copyright (C) 1985, 1994, 1997, 1998, 2000, 2001, 2002
+;; Free Software Foundation, Inc.
 
 ;; Author: K. Shane Hartman
 ;; Maintainer: FSF
-;; Keywords: maint
+;; Keywords: maint mail
 
 ;; Not fully installed because it can work only on Internet hosts.
 ;; This file is part of GNU Emacs.
@@ -20,12 +21,13 @@
 ;; GNU General Public License for more details.
 
 ;; You should have received a copy of the GNU General Public License
-;; along with GNU Emacs; see the file COPYING.  If not, write to
-;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
+;; along with GNU Emacs; see the file COPYING.  If not, write to the
+;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+;; Boston, MA 02111-1307, USA.
 
 ;;; Commentary:
 
-;; `M-x report-emacs-bug ' starts an email note to the Emacs maintainers
+;; `M-x report-emacs-bug' starts an email note to the Emacs maintainers
 ;; describing a problem.  Here's how it's done...
 
 ;;; Code:
@@ -36,41 +38,229 @@
 
 (require 'sendmail)
 
-(defvar bug-gnu-emacs "bug-gnu-emacs@prep.ai.mit.edu"
-  "Address of site maintaining mailing list for GNU Emacs bugs.")
+(defgroup emacsbug nil
+  "Sending Emacs bug reports."
+  :group 'maint
+  :group 'mail)
+
+(defcustom report-emacs-bug-address "bug-gnu-emacs@gnu.org"
+  "*Address of mailing list for GNU Emacs bugs."
+  :group 'emacsbug
+  :type 'string)
+
+(defcustom report-emacs-bug-pretest-address "emacs-pretest-bug@gnu.org"
+  "*Address of mailing list for GNU Emacs pretest bugs."
+  :group 'emacsbug
+  :type 'string)
 
 (defvar report-emacs-bug-orig-text nil
   "The automatically-created initial text of bug report.")
 
+(defvar report-emacs-bug-text-prompt nil
+  "The automatically-created initial prompt of bug report.")
+
+(defcustom report-emacs-bug-no-confirmation nil
+  "*If non-nil, suppress the confirmations asked for the sake of novice users."
+  :group 'emacsbug
+  :type 'boolean)
+
+(defcustom report-emacs-bug-no-explanations nil
+  "*If non-nil, suppress the explanations given for the sake of novice users."
+  :group 'emacsbug
+  :type 'boolean)
+
 ;;;###autoload
-(defun report-emacs-bug (topic)
+(defun report-emacs-bug (topic &optional recent-keys)
   "Report a bug in GNU Emacs.
 Prompts for bug subject.  Leaves you in a mail buffer."
-  (interactive "sBug Subject: ")
-  (mail nil bug-gnu-emacs topic)
-  (goto-char (point-min))
-  (re-search-forward (concat "^" (regexp-quote mail-header-separator) "\n"))
-  (insert "In " (emacs-version) "\n\n")
-  (message (substitute-command-keys "Type \\[mail-send-and-exit] to send bug report."))
-  ;; Make it less likely people will send empty messages.
-  (make-local-variable 'mail-send-hook)
-  (add-hook 'mail-send-hook 'report-emacs-bug-hook)
-  (save-excursion
-    (goto-char (point-max))
-    (skip-chars-backward " \t\n")
-    (make-local-variable 'report-emacs-bug-orig-text)
-    (setq report-emacs-bug-orig-text (buffer-substring (point-min) (point)))))
+  ;; This strange form ensures that (recent-keys) is the value before
+  ;; the bug subject string is read.
+  (interactive (reverse (list (recent-keys) (read-string "Bug Subject: "))))
+  ;; If there are four numbers in emacs-version, this is a pretest
+  ;; version.
+  (let ((pretest-p (string-match "\\..*\\..*\\." emacs-version))
+	user-point prompt-beg-point message-end-point)
+    (setq message-end-point
+	  (with-current-buffer (get-buffer-create "*Messages*")
+	    (point-max-marker)))
+    (compose-mail (if pretest-p
+		      report-emacs-bug-pretest-address
+		    report-emacs-bug-address)
+		  topic)
+    ;; The rest of this does not execute
+    ;; if the user was asked to confirm and said no.
+    (rfc822-goto-eoh)
+    (forward-line 1)
+
+    (let ((signature (buffer-substring (point) (point-max))))
+      (delete-region (point) (point-max))
+      (insert signature)
+      (backward-char (length signature)))
+    (setq prompt-beg-point (point))
+    (unless report-emacs-bug-no-explanations
+      ;; Insert warnings for novice users.
+      (insert "This bug report will be sent to the Free Software Foundation,\n")
+      (let ((pos (point)))
+	(insert "not to your local site managers!")
+	(put-text-property pos (point) 'face 'highlight))
+      (insert "\nPlease write in ")
+      (let ((pos (point)))
+	(insert "English")
+	(put-text-property pos (point) 'face 'highlight))
+      (insert " if possible, because the Emacs maintainers
+usually do not have translators to read other languages for them.\n\n")
+      (insert (format "Your bug report will be posted to the %s mailing list"
+		      (if pretest-p
+			  report-emacs-bug-pretest-address
+			report-emacs-bug-address)))
+      (if pretest-p
+	  (insert ".\n\n")
+	(insert ",\nand to the gnu.emacs.bug news group.\n\n")))
+
+    (insert "Please describe exactly what actions triggered the bug\n"
+	    "and the precise symptoms of the bug:")
+    (setq report-emacs-bug-text-prompt
+	  (buffer-substring prompt-beg-point (point)))
+
+    (insert "\n\n")
+    (setq user-point (point))
+    (insert "\n\n\n")
+
+    (insert "In " (emacs-version) "\n")
+    (if (and system-configuration-options
+	     (not (equal system-configuration-options "")))
+	(insert "configured using `configure "
+		system-configuration-options "'\n\n"))
+    (insert "Important settings:\n")
+    (mapcar
+     '(lambda (var)
+	(insert (format "  value of $%s: %s\n" var (getenv var))))
+     '("LC_ALL" "LC_COLLATE" "LC_CTYPE" "LC_MESSAGES"
+       "LC_MONETARY" "LC_NUMERIC" "LC_TIME" "LANG"))
+    (insert (format "  locale-coding-system: %s\n" locale-coding-system))
+    (insert (format "  default-enable-multibyte-characters: %s\n"
+		    default-enable-multibyte-characters))
+    (insert "\n")
+    (insert (format "Major mode: %s\n" mode-name))
+    (insert "\n")
+    (insert "Minor modes in effect:\n")
+    (dolist (mode minor-mode-list)
+      (and (boundp mode) (symbol-value mode)
+	   (insert (format "  %s: %s\n" mode (symbol-value mode)))))
+    (insert "\n")
+    (insert "Recent input:\n")
+    (let ((before-keys (point)))
+      (insert (mapconcat (lambda (key)
+			   (if (or (integerp key)
+				   (symbolp key)
+				   (listp key))
+			       (single-key-description key)
+			     (prin1-to-string key nil)))
+			 (or recent-keys (recent-keys))
+			 " "))
+      (save-restriction
+	(narrow-to-region before-keys (point))
+	(goto-char before-keys)
+	(while (progn (move-to-column 50) (not (eobp)))
+	  (search-forward " " nil t)
+	  (insert "\n"))))
+    (let ((message-buf (get-buffer "*Messages*")))
+      (if message-buf
+	  (let (beg-pos
+		(end-pos message-end-point))
+	    (with-current-buffer message-buf
+	      (goto-char end-pos)
+	      (forward-line -10)
+	      (setq beg-pos (point)))
+	    (insert "\n\nRecent messages:\n")
+	    (insert-buffer-substring message-buf beg-pos end-pos))))
+    ;; This is so the user has to type something
+    ;; in order to send easily.
+    (use-local-map (nconc (make-sparse-keymap) (current-local-map)))
+    (define-key (current-local-map) "\C-c\C-i" 'report-emacs-bug-info)
+    (unless report-emacs-bug-no-explanations
+      (with-output-to-temp-buffer "*Bug Help*"
+	(if (eq mail-user-agent 'sendmail-user-agent)
+	    (princ (substitute-command-keys
+		    "Type \\[mail-send-and-exit] to send the bug report.\n")))
+	(princ (substitute-command-keys
+		"Type \\[kill-buffer] RET to cancel (don't send it).\n"))
+	(terpri)
+	(princ (substitute-command-keys
+		"Type \\[report-emacs-bug-info] to visit in Info the Emacs Manual section
+about when and how to write a bug report,
+and what information to supply so that the bug can be fixed.
+Type SPC to scroll through this section and its subsections."))))
+    ;; Make it less likely people will send empty messages.
+    (make-local-variable 'mail-send-hook)
+    (add-hook 'mail-send-hook 'report-emacs-bug-hook)
+    (save-excursion
+      (goto-char (point-max))
+      (skip-chars-backward " \t\n")
+      (make-local-variable 'report-emacs-bug-orig-text)
+      (setq report-emacs-bug-orig-text (buffer-substring (point-min) (point))))
+    (goto-char user-point)))
+
+(defun report-emacs-bug-info ()
+  "Go to the Info node on reporting Emacs bugs."
+  (interactive)
+  (info)
+  (Info-directory)
+  (Info-menu "emacs")
+  (Info-goto-node "Bugs"))
 
 (defun report-emacs-bug-hook ()
   (save-excursion
-    (goto-char (point-max))
-    (skip-chars-backward " \t\n")
-    (if (and (= (- (point) (point-min))
-		(length report-emacs-bug-orig-text))
-	     (equal (buffer-substring (point-min) (point))
-		    report-emacs-bug-orig-text))
-	(error "No text entered in bug report"))))
+    (save-excursion
+      (goto-char (point-max))
+      (skip-chars-backward " \t\n")
+      (if (and (= (- (point) (point-min))
+		  (length report-emacs-bug-orig-text))
+	       (equal (buffer-substring (point-min) (point))
+		      report-emacs-bug-orig-text))
+	  (error "No text entered in bug report")))
+
+    ;; Check the buffer contents and reject non-English letters.
+    (save-excursion
+      (goto-char (point-min))
+      (skip-chars-forward "\0-\177")
+      (if (not (eobp))
+	  (if (or report-emacs-bug-no-confirmation
+		  (y-or-n-p "Convert non-ASCII letters to hexadecimal? "))
+	      (while (progn (skip-chars-forward "\0-\177")
+			    (not (eobp)))
+		(let ((ch (following-char)))
+		  (delete-char 1)
+		  (insert (format "=%02x" ch)))))))
+
+    ;; The last warning for novice users.
+    (if (or report-emacs-bug-no-confirmation
+	    (yes-or-no-p
+	     "Send this bug report to the Emacs maintainers? "))
+	;; Just send the current mail.
+	nil
+      (goto-char (point-min))
+      (if (search-forward "To: ")
+	  (let ((pos (point)))
+	    (end-of-line)
+	    (delete-region pos (point))))
+      (kill-local-variable 'mail-send-hook)
+      (with-output-to-temp-buffer "*Bug Help*"
+	(princ (substitute-command-keys "\
+You invoked the command M-x report-emacs-bug,
+but you decided not to mail the bug report to the Emacs maintainers.
+
+If you want to mail it to someone else instead,
+please insert the proper e-mail address after \"To: \",
+and send the mail again using \\[mail-send-and-exit].")))
+      (error "M-x report-emacs-bug was cancelled, please read *Bug Help* buffer"))
+
+    ;; Unclutter
+    (mail-text)
+    (if (looking-at report-emacs-bug-text-prompt)
+	(replace-match "Symptoms:"))))
 
 (provide 'emacsbug)
 
+;;; arch-tag: 248b6523-c3b5-4fec-9a3f-0411fafa7d49
 ;;; emacsbug.el ends here