emacsbug.el 13.6 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 4
;; Copyright (C) 1985, 1994, 1997, 1998, 2000, 2001, 2002, 2003, 2004,
;;   2005, 2006, 2007, 2008, 2009  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
;; This file is part of GNU Emacs.

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

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

25 26
;;; Commentary:

27
;; `M-x report-emacs-bug' starts an email note to the Emacs maintainers
Glenn Morris's avatar
Glenn Morris committed
28 29 30
;; 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.
31

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

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

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

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

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

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

Glenn Morris's avatar
Glenn Morris committed
59 60 61 62
;; User options end here.


(defvar report-emacs-bug-orig-text nil
Glenn Morris's avatar
Glenn Morris committed
63 64 65 66 67 68 69 70 71
  "The automatically-created initial text of the bug report.")

(defvar report-emacs-bug-send-command nil
  "Name of the command to send the bug report, as a string.")
(make-variable-buffer-local 'report-emacs-bug-send-command)

(defvar report-emacs-bug-send-hook nil
  "Hook run before sending the bug report.")
(make-variable-buffer-local 'report-emacs-bug-send-hook)
Glenn Morris's avatar
Glenn Morris committed
72

73 74 75
(declare-function x-server-vendor "xfns.c" (&optional terminal))
(declare-function x-server-version "xfns.c" (&optional terminal))

Jim Blandy's avatar
Jim Blandy committed
76
;;;###autoload
77
(defun report-emacs-bug (topic &optional recent-keys)
Jim Blandy's avatar
Jim Blandy committed
78
  "Report a bug in GNU Emacs.
Joseph Arceneaux's avatar
Joseph Arceneaux committed
79
Prompts for bug subject.  Leaves you in a mail buffer."
80 81 82
  ;; 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: "))))
83 84
  ;; The syntax `version;' is preferred to `[version]' because the
  ;; latter could be mistakenly stripped by mailing software.
85 86 87 88 89 90 91 92 93 94
  (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))
95 96 97 98 99
	 (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.
Glenn Morris's avatar
Glenn Morris committed
100
	 ;; report-emacs-bug-hook deletes these regions before sending.
101 102 103 104
	 (prompt-properties '(field emacsbug-prompt
				    intangible but-helpful
				    rear-nonsticky t))
	 user-point message-end-point)
105
    (setq message-end-point
106
	  (with-current-buffer (get-buffer-create "*Messages*")
107
	    (point-max-marker)))
Glenn Morris's avatar
Glenn Morris committed
108
    (compose-mail reporting-address topic)
109 110
    ;; The rest of this does not execute
    ;; if the user was asked to confirm and said no.
111 112 113 114 115
    (rfc822-goto-eoh)
    (forward-line 1)

    (let ((signature (buffer-substring (point) (point-max))))
      (delete-region (point) (point-max))
116 117
      (insert signature)
      (backward-char (length signature)))
Richard M. Stallman's avatar
Richard M. Stallman committed
118 119
    (unless report-emacs-bug-no-explanations
      ;; Insert warnings for novice users.
Glenn Morris's avatar
Glenn Morris committed
120
      (when (string-match "@gnu\\.org$" reporting-address)
121 122 123
	(insert "This bug report will be sent to the Free Software Foundation,\n")
	(let ((pos (point)))
	  (insert "not to your local site managers!")
Glenn Morris's avatar
Glenn Morris committed
124
          (overlay-put (make-overlay pos (point)) 'face 'highlight)))
125
      (insert "\nPlease write in ")
Richard M. Stallman's avatar
Richard M. Stallman committed
126 127
      (let ((pos (point)))
	(insert "English")
Glenn Morris's avatar
Glenn Morris committed
128
        (overlay-put (make-overlay pos (point)) 'face 'highlight))
129 130
      (insert " if possible, because the Emacs maintainers
usually do not have translators to read other languages for them.\n\n")
131
      (insert (format "Your bug report will be posted to the %s mailing list"
132
		      reporting-address))
Glenn Morris's avatar
Glenn Morris committed
133 134 135
      ;; Nowadays all bug reports end up there.
;;;      (if pretest-p (insert ".\n\n")
	(insert ",\nand to the gnu.emacs.bug news group.\n\n"))
136

137
    (insert "Please describe exactly what actions triggered the bug\n"
138 139
	    "and the precise symptoms of the bug.  If you can, give\n"
	    "a recipe starting from `emacs -Q':\n\n")
Glenn Morris's avatar
Glenn Morris committed
140 141 142 143 144 145 146
    ;; Stop message-mode stealing the properties we are about to add.
    (if (boundp 'message-strip-special-text-properties)
        (set (make-local-variable 'message-strip-special-text-properties) nil))
    (add-text-properties (save-excursion
                           (rfc822-goto-eoh)
                           (line-beginning-position 2))
                         (point)
147
                         prompt-properties)
148
    (setq user-point (point))
149 150
    (insert "\n\n")

151
    (insert "If Emacs crashed, and you have the Emacs process in the gdb debugger,\n"
152 153 154 155 156
	    "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)
157 158
	  (insert "For information about debugging Emacs, please read the file\n"
		  debug-file ".\n")))
159
    (add-text-properties (1+ user-point) (point) prompt-properties)
160

161
    (insert "\n\nIn " (emacs-version) "\n")
162
    (if (fboundp 'x-server-vendor)
163
	(condition-case nil
164 165 166
            ;; This is used not only for X11 but also W32 and others.
	    (insert "Windowing system distributor `" (x-server-vendor)
                    "', version "
167 168
		    (mapconcat 'number-to-string (x-server-version) ".") "\n")
	  (error t)))
169 170 171
    (if (and system-configuration-options
	     (not (equal system-configuration-options "")))
	(insert "configured using `configure "
172
		system-configuration-options "'\n\n"))
173
    (insert "Important settings:\n")
174
    (mapc
175 176 177
     '(lambda (var)
	(insert (format "  value of $%s: %s\n" var (getenv var))))
     '("LC_ALL" "LC_COLLATE" "LC_CTYPE" "LC_MESSAGES"
178
       "LC_MONETARY" "LC_NUMERIC" "LC_TIME" "LANG" "XMODIFIERS"))
179
    (insert (format "  locale-coding-system: %s\n" locale-coding-system))
180 181
    (insert (format "  default enable-multibyte-characters: %s\n"
		    (default-value 'enable-multibyte-characters)))
182
    (insert "\n")
183
    (insert (format "Major mode: %s\n"
184 185 186
		    (format-mode-line
                     (buffer-local-value 'mode-name from-buffer)
                     nil nil from-buffer)))
187 188 189
    (insert "\n")
    (insert "Minor modes in effect:\n")
    (dolist (mode minor-mode-list)
190 191 192
      (and (boundp mode) (buffer-local-value mode from-buffer)
	   (insert (format "  %s: %s\n" mode
			   (buffer-local-value mode from-buffer)))))
193
    (insert "\n")
194
    (insert "Recent input:\n")
195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219
    (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))))
220 221 222 223 224 225 226 227 228 229 230 231
    ;; After Recent messages, to avoid the messages produced by
    ;; list-load-path-shadows.
    (unless (looking-back "\n")
      (insert "\n"))
    (insert "\n")
    (insert "Load-path shadows:\n")
    (message "Checking for load-path shadows...")
    (let ((shadows (list-load-path-shadows t)))
      (message "Checking for load-path shadows...done")
      (insert (if (zerop (length shadows))
                  "None found.\n"
                shadows)))
232 233 234
    (insert (format "\nFeatures:\n%s\n" features))
    (fill-region (line-beginning-position 0) (point))
    ;; This is so the user has to type something in order to send easily.
235 236
    (use-local-map (nconc (make-sparse-keymap) (current-local-map)))
    (define-key (current-local-map) "\C-c\C-i" 'report-emacs-bug-info)
Glenn Morris's avatar
Glenn Morris committed
237 238 239 240 241 242 243 244 245 246
    ;; Could test major-mode instead.
    (cond ((memq mail-user-agent '(message-user-agent gnus-user-agent))
           (setq report-emacs-bug-send-command "message-send-and-exit"
                 report-emacs-bug-send-hook 'message-send-hook))
          ((eq mail-user-agent 'sendmail-user-agent)
           (setq report-emacs-bug-send-command "mail-send-and-exit"
                 report-emacs-bug-send-hook 'mail-send-hook))
          ((eq mail-user-agent 'mh-e-user-agent)
           (setq report-emacs-bug-send-command "mh-send-letter"
                 report-emacs-bug-send-hook 'mh-before-send-letter-hook)))
247 248
    (unless report-emacs-bug-no-explanations
      (with-output-to-temp-buffer "*Bug Help*"
249
	(princ "While in the mail buffer:\n\n")
Glenn Morris's avatar
Glenn Morris committed
250
        (if report-emacs-bug-send-command
251
            (princ (substitute-command-keys
Glenn Morris's avatar
Glenn Morris committed
252 253
                    (format "  Type \\[%s] to send the bug report.\n"
                            report-emacs-bug-send-command))))
254
	(princ (substitute-command-keys
255
		"  Type \\[kill-buffer] RET to cancel (don't send it).\n"))
256 257
	(terpri)
	(princ (substitute-command-keys
258 259 260 261
		"  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 you should include to help fix the bug.")))
      (shrink-window-if-larger-than-buffer (get-buffer-window "*Bug Help*")))
262
    ;; Make it less likely people will send empty messages.
Glenn Morris's avatar
Glenn Morris committed
263 264
    (if report-emacs-bug-send-hook
        (add-hook report-emacs-bug-send-hook 'report-emacs-bug-hook nil t))
265 266 267 268
    (save-excursion
      (goto-char (point-max))
      (skip-chars-backward " \t\n")
      (make-local-variable 'report-emacs-bug-orig-text)
Glenn Morris's avatar
Glenn Morris committed
269 270
      (setq report-emacs-bug-orig-text
            (buffer-substring-no-properties (point-min) (point))))
271
    (goto-char user-point)))
272

273 274 275
(defun report-emacs-bug-info ()
  "Go to the Info node on reporting Emacs bugs."
  (interactive)
Glenn Morris's avatar
Glenn Morris committed
276
  (info "(emacs)Bugs"))
277

278
(defun report-emacs-bug-hook ()
Glenn Morris's avatar
Glenn Morris committed
279
  "Do some checking before sending a bug report."
280
  (save-excursion
Glenn Morris's avatar
Glenn Morris committed
281 282 283 284 285 286 287 288 289
    (goto-char (point-max))
    (skip-chars-backward " \t\n")
    ;; FIXME This check is defeated by message.el, which sorts the
    ;; headers (!) before running message-send-hook.
    (and (= (- (point) (point-min))
            (length report-emacs-bug-orig-text))
         (string-equal (buffer-substring-no-properties (point-min) (point))
                       report-emacs-bug-orig-text)
         (error "No text entered in bug report"))
290 291

    ;; Check the buffer contents and reject non-English letters.
Glenn Morris's avatar
Glenn Morris committed
292 293 294 295 296 297 298 299 300 301 302
    ;; FIXME message-mode probably does this anyway.
    (goto-char (point-min))
    (skip-chars-forward "\0-\177")
    (unless (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))))))
303 304

    ;; The last warning for novice users.
Glenn Morris's avatar
Glenn Morris committed
305 306 307
    (unless (or report-emacs-bug-no-confirmation
                (yes-or-no-p
                 "Send this bug report to the Emacs maintainers? "))
308 309
      (goto-char (point-min))
      (if (search-forward "To: ")
Glenn Morris's avatar
Glenn Morris committed
310 311 312
          (delete-region (point) (line-end-position)))
      (if report-emacs-bug-send-hook
          (kill-local-variable report-emacs-bug-send-hook))
313
      (with-output-to-temp-buffer "*Bug Help*"
Glenn Morris's avatar
Glenn Morris committed
314 315
	(princ (substitute-command-keys
                (format "\
316 317
You invoked the command M-x report-emacs-bug,
but you decided not to mail the bug report to the Emacs maintainers.
318

319 320
If you want to mail it to someone else instead,
please insert the proper e-mail address after \"To: \",
Glenn Morris's avatar
Glenn Morris committed
321 322 323 324 325
and send the mail again%s."
                        (if report-emacs-bug-send-command
                            (format " using \\[%s]"
                                    report-emacs-bug-send-command)
                          "")))))
326
      (error "M-x report-emacs-bug was cancelled, please read *Bug Help* buffer"))
327

Glenn Morris's avatar
Glenn Morris committed
328 329 330
    ;; Delete the uninteresting text that was just to help fill out the report.
    (rfc822-goto-eoh)
    (forward-line 1)
331 332 333 334
    (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
335

336 337
(provide 'emacsbug)

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