emacsbug.el 7.54 KB
Newer Older
Eric S. Raymond's avatar
Eric S. Raymond committed
1 2
;;; emacsbug.el --- command to report Emacs bugs to appropriate mailing list.

Richard M. Stallman's avatar
Richard M. Stallman committed
3
;; Copyright (C) 1985, 1994, 1997 Free Software Foundation, Inc.
Eric S. Raymond's avatar
Eric S. Raymond committed
4

Eric S. Raymond's avatar
Eric S. Raymond committed
5
;; Author: K. Shane Hartman
Eric S. Raymond's avatar
Eric S. Raymond committed
6
;; Maintainer: FSF
Eric S. Raymond's avatar
Eric S. Raymond committed
7
;; Keywords: maint
Eric S. Raymond's avatar
Eric S. Raymond committed
8

Joseph Arceneaux's avatar
Joseph Arceneaux committed
9 10 11 12 13
;; Not fully installed because it can work only on Internet hosts.
;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
Eric S. Raymond's avatar
Eric S. Raymond committed
14
;; the Free Software Foundation; either version 2, or (at your option)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
15 16 17 18 19 20 21 22
;; any later version.

;; GNU Emacs 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
Erik Naggum's avatar
Erik Naggum committed
23 24 25
;; 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.
Joseph Arceneaux's avatar
Joseph Arceneaux committed
26

27 28 29 30 31
;;; Commentary:

;; `M-x report-emacs-bug ' starts an email note to the Emacs maintainers
;; describing a problem.  Here's how it's done...

Eric S. Raymond's avatar
Eric S. Raymond committed
32
;;; Code:
Joseph Arceneaux's avatar
Joseph Arceneaux committed
33 34 35 36 37

;; >> This should be an address which is accessible to your machine,
;; >> otherwise you can't use this file.  It will only work on the
;; >> internet with this address.

38 39
(require 'sendmail)

Joseph Arceneaux's avatar
Joseph Arceneaux committed
40
(defvar bug-gnu-emacs "bug-gnu-emacs@prep.ai.mit.edu"
41 42 43 44
  "Address of mailing list for GNU Emacs bugs.")

(defvar report-emacs-bug-pretest-address "emacs-pretest-bug@gnu.ai.mit.edu"
  "Address of mailing list for GNU Emacs pretest bugs.")
Joseph Arceneaux's avatar
Joseph Arceneaux committed
45

46 47 48
(defvar report-emacs-bug-orig-text nil
  "The automatically-created initial text of bug report.")

49 50 51 52
;;;###autoload
(defvar report-emacs-bug-run-tersely nil
  "*If non-nil, suppress confirmations for novice users.")

Jim Blandy's avatar
Jim Blandy committed
53
;;;###autoload
54
(defun report-emacs-bug (topic &optional recent-keys)
Jim Blandy's avatar
Jim Blandy committed
55
  "Report a bug in GNU Emacs.
Joseph Arceneaux's avatar
Joseph Arceneaux committed
56
Prompts for bug subject.  Leaves you in a mail buffer."
57 58 59
  ;; 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: "))))
60
  (condition-case nil
61 62 63 64
      (let (user-point message-end-point)
	(setq message-end-point
	      (with-current-buffer (get-buffer "*Messages*")
		(point-max-marker)))
65 66 67 68 69 70
	(compose-mail (if (string-match "\\..*\\..*\\." emacs-version)
			  ;; If there are four numbers in emacs-version,
			  ;; this is a pretest version.
			  report-emacs-bug-pretest-address
			bug-gnu-emacs)
		      topic)
71 72 73 74
	;; 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"))
75
	;; Insert warnings for novice users.
76
	(insert "This bug report will be sent to the Free Software Foundation,\n")
77
	(let ((pos (point)))
78
	  (insert " not to your local site managers!!")
79 80 81
	  (put-text-property pos (point) 'face 'highlight))
	(insert "\nPlease write in ")
	(let ((pos (point)))
82
	  (insert "English")
83
	  (put-text-property pos (point) 'face 'highlight))
84 85
	(insert ", because the Emacs maintainers do not have
translators to read other languages for them.\n\n")
86

87 88 89 90 91 92 93 94 95 96 97 98
	(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)))
99 100 101 102 103 104
	  (insert (mapconcat (lambda (key)
			       (if (or (integerp key)
				       (symbolp key)
				       (listp key))
				   (single-key-description key)
				 (prin1-to-string key nil)))
105
			     (or recent-keys (recent-keys))
106
			     " "))
107 108 109 110 111 112
	  (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"))))
113 114
	(let ((message-buf (get-buffer "*Messages*")))
	  (if message-buf
115 116 117 118 119 120
	      (let (beg-pos
		    (end-pos message-end-point))
		(with-current-buffer message-buf
		  (goto-char end-pos)
		  (forward-line -10)
		  (setq beg-pos (point)))
121
		(insert "\n\nRecent messages:\n")
122
		(insert-buffer-substring message-buf beg-pos end-pos))))
123 124 125 126 127
	;; 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)
	(with-output-to-temp-buffer "*Bug Help*"
Richard M. Stallman's avatar
Richard M. Stallman committed
128
	  (if (eq mail-user-agent 'sendmail-user-agent)
129 130
	      (princ (substitute-command-keys
		      "Type \\[mail-send-and-exit] to send the bug report.\n")))
131 132 133 134 135
	  (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
136 137 138
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.")))
139 140 141
	;; Make it less likely people will send empty messages.
	(make-local-variable 'mail-send-hook)
	(add-hook 'mail-send-hook 'report-emacs-bug-hook)
142 143
	;; Discourage users to write non-English text.
	(setq enable-multibyte-characters nil)
144 145 146 147 148
	(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))))
149 150
	(goto-char user-point))
    (error nil)))
151

152 153 154 155 156 157 158 159
(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"))

160 161 162 163 164 165 166 167
(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))
168 169 170 171 172 173 174
	(error "No text entered in bug report"))

    ;; Check the buffer contents and reject non-English letters.
    (let ((charsets (delq 'ascii
			  (find-charset-region (point-min) (point-max)))))
      (if charsets
	  (if (or report-emacs-bug-run-tersely
175
		  (y-or-n-p "Convert non-ASCII letters to hexadecimal? "))
176 177 178 179 180 181 182 183 184
	      (save-excursion
		(goto-char (point-min))
		(let ((enable-multibyte-characters nil)
		      (pattern (format "[%c-%c]" 128 255))
		      ch)
		  (while (re-search-forward pattern nil t)
		    (setq ch (preceding-char))
		    (delete-char -1)
		    (insert (format "=%02x" ch)))))
185
	    (error "Please convert non-ASCII characters to something else"))))
186 187 188 189

    ;; The last warning for novice users.
    (if (or report-emacs-bug-run-tersely
	    (yes-or-no-p
190
	     "Send this bug report to the Emacs maintainers? "))
191 192 193 194 195 196 197 198 199 200
	;; 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 "\
201 202
You invoked the command M-x report-emacs-bug,
but you decided not to mail the bug report to the Emacs maintainers.
203

204 205 206 207
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"))
208
    ))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
209

210 211
(provide 'emacsbug)

Eric S. Raymond's avatar
Eric S. Raymond committed
212
;;; emacsbug.el ends here