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

3
;; Copyright (C) 1985, 1994, 1997, 1998, 2000, 2001, 2002, 2003,
4
;;   2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
Eric S. Raymond's avatar
Eric S. Raymond committed
5

Eric S. Raymond's avatar
Eric S. Raymond committed
6
;; Author: K. Shane Hartman
Eric S. Raymond's avatar
Eric S. Raymond committed
7
;; Maintainer: FSF
Richard M. Stallman's avatar
Richard M. Stallman committed
8
;; Keywords: maint mail
Eric S. Raymond's avatar
Eric S. Raymond committed
9

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

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

;; 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
24
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
Joseph Arceneaux's avatar
Joseph Arceneaux committed
25

26 27
;;; Commentary:

28
;; `M-x report-emacs-bug' starts an email note to the Emacs maintainers
Glenn Morris's avatar
Glenn Morris committed
29 30 31
;; describing a problem.  You need to be able to send mail from Emacs
;; to complete the process.  Alternatively, compose the bug report in
;; Emacs then paste it into your normal mail client.
32

Eric S. Raymond's avatar
Eric S. Raymond committed
33
;;; Code:
Joseph Arceneaux's avatar
Joseph Arceneaux committed
34

35 36
(require 'sendmail)

Richard M. Stallman's avatar
Richard M. Stallman committed
37 38 39 40 41
(defgroup emacsbug nil
  "Sending Emacs bug reports."
  :group 'maint
  :group 'mail)

42
(defcustom report-emacs-bug-address "bug-gnu-emacs@gnu.org"
Glenn Morris's avatar
Glenn Morris committed
43
  "Address of mailing list for GNU Emacs bugs."
44 45
  :group 'emacsbug
  :type 'string)
46

47
(defcustom report-emacs-bug-pretest-address "emacs-pretest-bug@gnu.org"
Glenn Morris's avatar
Glenn Morris committed
48
  "Address of mailing list for GNU Emacs pretest bugs."
49 50
  :group 'emacsbug
  :type 'string)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
51

Richard M. Stallman's avatar
Richard M. Stallman committed
52
(defcustom report-emacs-bug-no-confirmation nil
Glenn Morris's avatar
Glenn Morris committed
53
  "If non-nil, suppress the confirmations asked for the sake of novice users."
Richard M. Stallman's avatar
Richard M. Stallman committed
54 55 56 57
  :group 'emacsbug
  :type 'boolean)

(defcustom report-emacs-bug-no-explanations nil
Glenn Morris's avatar
Glenn Morris committed
58
  "If non-nil, suppress the explanations given for the sake of novice users."
Richard M. Stallman's avatar
Richard M. Stallman committed
59 60
  :group 'emacsbug
  :type 'boolean)
61

Glenn Morris's avatar
Glenn Morris committed
62 63 64 65 66 67
;; User options end here.


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

Jim Blandy's avatar
Jim Blandy committed
68
;;;###autoload
69
(defun report-emacs-bug (topic &optional recent-keys)
Jim Blandy's avatar
Jim Blandy committed
70
  "Report a bug in GNU Emacs.
Joseph Arceneaux's avatar
Joseph Arceneaux committed
71
Prompts for bug subject.  Leaves you in a mail buffer."
72 73 74
  ;; 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: "))))
75 76
  ;; The syntax `version;' is preferred to `[version]' because the
  ;; latter could be mistakenly stripped by mailing software.
77 78 79 80 81 82 83 84 85 86
  (if (eq system-type 'ms-dos)
      (setq topic (concat emacs-version "; " topic))
    (when (string-match "^\\(\\([.0-9]+\\)*\\)\\.[0-9]+$" emacs-version)
      (setq topic (concat (match-string 1 emacs-version) "; " topic))))
  ;; If there are four numbers in emacs-version (three for MS-DOS),
  ;; this is a pretest version.
  (let* ((pretest-p (string-match (if (eq system-type 'ms-dos)
				      "\\..*\\."
				    "\\..*\\..*\\.")
				  emacs-version))
87 88 89 90 91 92 93 94 95
	 (from-buffer (current-buffer))
	 (reporting-address (if pretest-p
				report-emacs-bug-pretest-address
			      report-emacs-bug-address))
	 ;; Put these properties on semantically-void text.
	 (prompt-properties '(field emacsbug-prompt
				    intangible but-helpful
				    rear-nonsticky t))
	 user-point message-end-point)
96
    (setq message-end-point
97
	  (with-current-buffer (get-buffer-create "*Messages*")
98
	    (point-max-marker)))
99
    (compose-mail reporting-address
100 101 102
		  topic)
    ;; The rest of this does not execute
    ;; if the user was asked to confirm and said no.
103 104 105 106 107
    (rfc822-goto-eoh)
    (forward-line 1)

    (let ((signature (buffer-substring (point) (point-max))))
      (delete-region (point) (point-max))
108 109
      (insert signature)
      (backward-char (length signature)))
Richard M. Stallman's avatar
Richard M. Stallman committed
110 111
    (unless report-emacs-bug-no-explanations
      ;; Insert warnings for novice users.
112 113 114 115 116
      (when (string-match "@gnu\\.org^" reporting-address)
	(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)))
117
      (insert "\nPlease write in ")
Richard M. Stallman's avatar
Richard M. Stallman committed
118 119 120
      (let ((pos (point)))
	(insert "English")
	(put-text-property pos (point) 'face 'highlight))
121 122
      (insert " if possible, because the Emacs maintainers
usually do not have translators to read other languages for them.\n\n")
123
      (insert (format "Your bug report will be posted to the %s mailing list"
124
		      reporting-address))
125 126 127
      (if pretest-p
	  (insert ".\n\n")
	(insert ",\nand to the gnu.emacs.bug news group.\n\n")))
128

129
    (insert "Please describe exactly what actions triggered the bug\n"
130 131 132
	    "and the precise symptoms of the bug:\n\n")
    (add-text-properties (point) (save-excursion (mail-text) (point))
                         prompt-properties)
133 134

    (setq user-point (point))
135 136
    (insert "\n\n")

137
    (insert "If Emacs crashed, and you have the Emacs process in the gdb debugger,\n"
138 139 140 141 142
	    "please include the output from the following gdb commands:\n"
	    "    `bt full' and `xbacktrace'.\n")

    (let ((debug-file (expand-file-name "DEBUG" data-directory)))
      (if (file-readable-p debug-file)
143 144
	  (insert "If you would like to further debug the crash, please read the file\n"
		  debug-file " for instructions.\n")))
145
    (add-text-properties (1+ user-point) (point) prompt-properties)
146

147
    (insert "\n\nIn " (emacs-version) "\n")
148
    (if (fboundp 'x-server-vendor)
149
	(condition-case nil
150 151 152
            ;; This is used not only for X11 but also W32 and others.
	    (insert "Windowing system distributor `" (x-server-vendor)
                    "', version "
153 154
		    (mapconcat 'number-to-string (x-server-version) ".") "\n")
	  (error t)))
155 156 157
    (if (and system-configuration-options
	     (not (equal system-configuration-options "")))
	(insert "configured using `configure "
158
		system-configuration-options "'\n\n"))
159
    (insert "Important settings:\n")
160
    (mapc
161 162 163
     '(lambda (var)
	(insert (format "  value of $%s: %s\n" var (getenv var))))
     '("LC_ALL" "LC_COLLATE" "LC_CTYPE" "LC_MESSAGES"
164
       "LC_MONETARY" "LC_NUMERIC" "LC_TIME" "LANG" "XMODIFIERS"))
165 166 167
    (insert (format "  locale-coding-system: %s\n" locale-coding-system))
    (insert (format "  default-enable-multibyte-characters: %s\n"
		    default-enable-multibyte-characters))
168
    (insert "\n")
169
    (insert (format "Major mode: %s\n"
170 171 172
		    (format-mode-line
                     (buffer-local-value 'mode-name from-buffer)
                     nil nil from-buffer)))
173 174 175
    (insert "\n")
    (insert "Minor modes in effect:\n")
    (dolist (mode minor-mode-list)
176 177 178
      (and (boundp mode) (buffer-local-value mode from-buffer)
	   (insert (format "  %s: %s\n" mode
			   (buffer-local-value mode from-buffer)))))
179
    (insert "\n")
180
    (insert "Recent input:\n")
181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209
    (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)
210 211 212 213 214 215 216 217 218 219
    (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
220 221
about when and how to write a bug report,
and what information to supply so that the bug can be fixed.
222
Type SPC to scroll through this section and its subsections."))))
223 224 225 226 227 228 229 230 231
    ;; 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)))
232

233 234 235
(defun report-emacs-bug-info ()
  "Go to the Info node on reporting Emacs bugs."
  (interactive)
Glenn Morris's avatar
Glenn Morris committed
236
  (info "(emacs)Bugs"))
237

238 239
(defun report-emacs-bug-hook ()
  (save-excursion
240 241 242 243 244 245 246 247
    (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")))
248 249

    ;; Check the buffer contents and reject non-English letters.
250 251 252 253
    (save-excursion
      (goto-char (point-min))
      (skip-chars-forward "\0-\177")
      (if (not (eobp))
Richard M. Stallman's avatar
Richard M. Stallman committed
254
	  (if (or report-emacs-bug-no-confirmation
255
		  (y-or-n-p "Convert non-ASCII letters to hexadecimal? "))
256 257 258 259
	      (while (progn (skip-chars-forward "\0-\177")
			    (not (eobp)))
		(let ((ch (following-char)))
		  (delete-char 1)
260
		  (insert (format "=%02x" ch)))))))
261 262

    ;; The last warning for novice users.
Richard M. Stallman's avatar
Richard M. Stallman committed
263
    (if (or report-emacs-bug-no-confirmation
264
	    (yes-or-no-p
265
	     "Send this bug report to the Emacs maintainers? "))
266 267 268 269 270 271 272 273 274 275
	;; 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 "\
276 277
You invoked the command M-x report-emacs-bug,
but you decided not to mail the bug report to the Emacs maintainers.
278

279 280 281 282
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"))
283 284 285

    ;; Unclutter
    (mail-text)
286 287 288 289
    (let ((pos (1- (point))))
      (while (setq pos (text-property-any pos (point-max)
                                          'field 'emacsbug-prompt))
        (delete-region pos (field-end (1+ pos)))))))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
290

291 292
(provide 'emacsbug)

293
;; arch-tag: 248b6523-c3b5-4fec-9a3f-0411fafa7d49
Eric S. Raymond's avatar
Eric S. Raymond committed
294
;;; emacsbug.el ends here