Source

net-utils / emacsbug.el

Diff from to

emacsbug.el

 ;;; 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 Free Software Foundation, Inc.
 
 ;; Author: K. Shane Hartman
-;; Maintainer: FSF
-;; Keywords: maint
+;; Maintainer: XEmacs Development Team
+;; Keywords: maint mail
 
 ;; Not fully installed because it can work only on Internet hosts.
 ;; This file is part of XEmacs.
 
-;; XEmacs is free software; you can redistribute it and/or modify it
-;; under the terms of the GNU General Public License as published by
+;; XEmacs 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.
 
-;; XEmacs 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.
+;; XEmacs 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 XEmacs; see the file COPYING.  If not, write to the Free
-;; Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
-;; 02111-1307, USA.
+;; along with XEmacs; see the file COPYING.  If not, write to the
+;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+;; Boston, MA 02111-1307, USA.
 
-;;; Synched up with: FSF 19.34.
- 
+;;; Synched up with: FSF 20.2.
+
 ;;; Commentary:
 
 ;; `M-x report-emacs-bug ' starts an email note to the Emacs maintainers
 
 (require 'sendmail)
 
-;; XEmacs:  Screen for whether a beta version is running and redirect
-;; reports to the beta list instead of the newsgroup.
-(defvar report-emacs-bug-pretest-address "xemacs-beta@xemacs.org"
-  "Address of mailing list for XEmacs beta bugs.")
+(defgroup emacsbug nil
+  "Sending Emacs bug reports."
+  :group 'maint
+  :group 'mail)
 
-(defvar bug-gnu-emacs "xemacs@xemacs.org"
-  "Address of site maintaining mailing list for XEmacs bugs.")
+;; XEmacs: changed address
+(defcustom report-emacs-bug-address "xemacs@xemacs.org"
+  "*Address of mailing list for XEmacs bugs."
+  :group 'emacsbug
+  :type 'string)
+
+;; XEmacs: changed variable name
+(defcustom report-emacs-bug-beta-address "xemacs-beta@xemacs.org"
+  "*Address of mailing list for XEmacs beta bugs."
+  :group 'emacsbug
+  :type 'string)
 
 (defvar report-emacs-bug-orig-text nil
   "The automatically-created initial text 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)
+
+;; Lots of changes for XEmacs.
+
 ;;;###autoload
-(defun report-xemacs-bug (topic)
+(defun report-emacs-bug (topic &optional recent-keys)
   "Report a bug in XEmacs.
 Prompts for bug subject.  Leaves you in a mail buffer."
-  (interactive "sBug Subject: ")
-  (if (mail nil
-	    (if (string-match "\(beta[0-9]+\)" emacs-version)
-		;; If there are four numbers in emacs-version,
-		;; this is a pretest version.
-		report-emacs-bug-pretest-address
-	      bug-gnu-emacs)
-	    topic)
-      (let (user-point)
-	;; The rest of this does not execute
-	;; if the user was asked to confirm and said no.
-	(goto-char (point-min))
-	(re-search-forward (concat "^" (regexp-quote mail-header-separator) "\n"))
-	(insert "In " (emacs-version) "\n")
-	(if (and system-configuration-options
-		 (not (equal system-configuration-options "")))
-	    (insert "configured using `configure "
-		    system-configuration-options "'\n"))
-	(insert "\n")
-	(insert "Please describe exactly what actions triggered the bug\n"
-		"and the precise symptoms of the bug:\n\n") 
-	(setq user-point (point))
-	(insert "\n\n\n"
-		"Recent input:\n")
-	(let ((before-keys (point)))
-	  ;; XEmacs:
-	  (insert (key-description (recent-keys)))
-;	  (insert (mapconcat (lambda (key)
-;			       (if (or (integerp key)
-;				       (symbolp key)
-;				       (listp key))
-;				   (single-key-description key)
-;				 (prin1-to-string key nil)))
-;			     (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-create " *Message-Log*")))
-	  (if message-buf
-	      (progn
-		(insert "\n\nRecent messages:\n")
-		(insert-buffer-substring message-buf
-					 (save-excursion
-					   (set-buffer message-buf)
-					   (goto-char (point-max))
-					   (forward-line -10)
-					   (point))
-					 (save-excursion
-					   (set-buffer message-buf)
-					   (point-max))))))
-	;; This is so the user has to type something
-	;; in order to send easily.
-	;; XEmacs:  FSF non-abstraction of data?
-	;; (use-local-map (nconc (make-sparse-keymap) (current-local-map)))
-	;; Ghod intended it this way:
-	(use-local-map (let ((map (make-sparse-keymap)))
-			 (set-keymap-parents map (list (current-local-map)))
-			 map))
-	(define-key (current-local-map) "\C-c\C-i" 'report-emacs-bug-info)
-	(with-output-to-temp-buffer "*Bug Help*"
-	  (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 `\\[delete-other-windows]' to remove this window.")))
-	;; 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))))
+  ;; 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: "))))
+  (let (user-point)
+    (compose-mail (if (string-match "(beta[0-9]+)" emacs-version)
+		      report-emacs-bug-beta-address
+		    report-emacs-bug-address)
+		  topic)
+    ;; The rest of this does not execute
+    ;; if the user was asked to confirm and said no.
+    ;; #### FSF
+    ;(rfc822-goto-eoh)
+    (goto-char (point-min))
+    (re-search-forward (concat "^" (regexp-quote mail-header-separator) "$"))
+    (forward-line 1)
 
-;; ;;;###autoload
-;; (defalias 'report-emacs-bug 'report-xemacs-bug)
+    ;; FSF has weird code to delete the user's signature, and reinsert
+    ;; it without multibyte characters, to "discourage users to write
+    ;; non-English text."  I don't want to use that.
+    (unless report-emacs-bug-no-explanations
+      ;; Insert warnings for novice users.
+      (insert "This bug report will be sent to the XEmacs Development Team,\n")
+      (insert-face " not to your local site managers!!" 'italic)
+      (insert "\nPlease write in ")
+      (insert-face "English" 'italic)
+      (insert ", because the XEmacs maintainers do not have
+translators to read other languages for them.\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"))
+    (insert "\n")
+    (insert "Please describe exactly what actions triggered the bug\n"
+	    "and the precise symptoms of the bug:\n\n") 
+    (setq user-point (point))
+    (insert "\n\n\n"
+	    "Recent keystrokes:\n\n")
+    (let ((before-keys (point)))
+      (insert (key-description 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"))))
+    (insert "\n\n\nRecent messages (most recent first):\n\n")
+    (let ((standard-output (current-buffer)))
+      (print-recent-messages 10))
+    ;; This is so the user has to type something
+    ;; in order to send easily.
+    (use-local-map (let ((map (make-sparse-keymap)))
+		     (set-keymap-parents map (current-local-map))
+		     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 XEmacs 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)))
+
+;; XEmacs: for backwards compatibility
+(defalias 'report-xemacs-bug 'report-emacs-bug)
 
 (defun report-emacs-bug-info ()
   "Go to the Info node on reporting Emacs bugs."
   (interactive)
-  (info)
-  (Info-directory)
-  (Info-menu "xemacs")
-  (Info-goto-node "Bugs"))
+  (Info-goto-node "(xemacs)Top"))
 
 (defun report-emacs-bug-hook ()
   (save-excursion
 		(length report-emacs-bug-orig-text))
 	     (equal (buffer-substring (point-min) (point))
 		    report-emacs-bug-orig-text))
-	(error "No text entered in bug report"))))
+	(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"))
+    ))
 
 (provide 'emacsbug)