emacsbug.el 13.7 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, 2004,
4 5
;;   2005, 2006, 2007, 2008, 2009, 2010
;;   Free Software Foundation, Inc.
Eric S. Raymond's avatar
Eric S. Raymond committed
6

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

Joseph Arceneaux's avatar
Joseph Arceneaux committed
11 12
;; 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

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

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

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

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

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

Glenn Morris's avatar
Glenn Morris committed
61 62 63 64
;; User options end here.


(defvar report-emacs-bug-orig-text nil
Glenn Morris's avatar
Glenn Morris committed
65 66 67 68 69 70 71 72 73
  "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
74

75 76
(declare-function x-server-vendor "xfns.c" (&optional terminal))
(declare-function x-server-version "xfns.c" (&optional terminal))
77
(declare-function message-sort-headers "message" ())
78

Jim Blandy's avatar
Jim Blandy committed
79
;;;###autoload
80
(defun report-emacs-bug (topic &optional recent-keys)
Jim Blandy's avatar
Jim Blandy committed
81
  "Report a bug in GNU Emacs.
Joseph Arceneaux's avatar
Joseph Arceneaux committed
82
Prompts for bug subject.  Leaves you in a mail buffer."
83 84 85
  ;; 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: "))))
86 87
  ;; The syntax `version;' is preferred to `[version]' because the
  ;; latter could be mistakenly stripped by mailing software.
88 89 90 91 92 93 94 95 96 97
  (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))
98 99 100 101 102
	 (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
103
	 ;; report-emacs-bug-hook deletes these regions before sending.
104 105 106 107
	 (prompt-properties '(field emacsbug-prompt
				    intangible but-helpful
				    rear-nonsticky t))
	 user-point message-end-point)
108
    (setq message-end-point
109
	  (with-current-buffer (get-buffer-create "*Messages*")
110
	    (point-max-marker)))
Glenn Morris's avatar
Glenn Morris committed
111
    (compose-mail reporting-address topic)
112 113 114 115 116 117
    ;; The rest of this does not execute if the user was asked to
    ;; confirm and said no.
    ;; Message-mode sorts the headers before sending.  We sort now so
    ;; that report-emacs-bug-orig-text remains valid.  (Bug#5178)
    (if (eq major-mode 'message-mode)
        (message-sort-headers))
118 119 120 121
    (rfc822-goto-eoh)
    (forward-line 1)
    (let ((signature (buffer-substring (point) (point-max))))
      (delete-region (point) (point-max))
122 123
      (insert signature)
      (backward-char (length signature)))
Richard M. Stallman's avatar
Richard M. Stallman committed
124 125
    (unless report-emacs-bug-no-explanations
      ;; Insert warnings for novice users.
Glenn Morris's avatar
Glenn Morris committed
126
      (when (string-match "@gnu\\.org$" reporting-address)
127 128 129
	(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
130
          (overlay-put (make-overlay pos (point)) 'face 'highlight)))
131
      (insert "\nPlease write in ")
Richard M. Stallman's avatar
Richard M. Stallman committed
132 133
      (let ((pos (point)))
	(insert "English")
Glenn Morris's avatar
Glenn Morris committed
134
        (overlay-put (make-overlay pos (point)) 'face 'highlight))
135 136
      (insert " if possible, because the Emacs maintainers
usually do not have translators to read other languages for them.\n\n")
137
      (insert (format "Your bug report will be posted to the %s mailing list"
138
		      reporting-address))
Glenn Morris's avatar
Glenn Morris committed
139 140 141
      ;; Nowadays all bug reports end up there.
;;;      (if pretest-p (insert ".\n\n")
	(insert ",\nand to the gnu.emacs.bug news group.\n\n"))
142

143
    (insert "Please describe exactly what actions triggered the bug\n"
144 145
	    "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
146 147 148 149 150 151 152
    ;; 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)
153
                         prompt-properties)
154
    (setq user-point (point))
155 156
    (insert "\n\n")

157
    (insert "If Emacs crashed, and you have the Emacs process in the gdb debugger,\n"
158 159 160 161 162
	    "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)
163 164
	  (insert "For information about debugging Emacs, please read the file\n"
		  debug-file ".\n")))
165
    (add-text-properties (1+ user-point) (point) prompt-properties)
166

167
    (insert "\n\nIn " (emacs-version) "\n")
168
    (if (fboundp 'x-server-vendor)
169
	(condition-case nil
170 171 172
            ;; This is used not only for X11 but also W32 and others.
	    (insert "Windowing system distributor `" (x-server-vendor)
                    "', version "
173 174
		    (mapconcat 'number-to-string (x-server-version) ".") "\n")
	  (error t)))
175 176 177
    (if (and system-configuration-options
	     (not (equal system-configuration-options "")))
	(insert "configured using `configure "
178
		system-configuration-options "'\n\n"))
179
    (insert "Important settings:\n")
180
    (mapc
181 182 183
     '(lambda (var)
	(insert (format "  value of $%s: %s\n" var (getenv var))))
     '("LC_ALL" "LC_COLLATE" "LC_CTYPE" "LC_MESSAGES"
184
       "LC_MONETARY" "LC_NUMERIC" "LC_TIME" "LANG" "XMODIFIERS"))
185
    (insert (format "  locale-coding-system: %s\n" locale-coding-system))
186 187
    (insert (format "  default enable-multibyte-characters: %s\n"
		    (default-value 'enable-multibyte-characters)))
188
    (insert "\n")
189
    (insert (format "Major mode: %s\n"
190 191 192
		    (format-mode-line
                     (buffer-local-value 'mode-name from-buffer)
                     nil nil from-buffer)))
193 194 195
    (insert "\n")
    (insert "Minor modes in effect:\n")
    (dolist (mode minor-mode-list)
196 197 198
      (and (boundp mode) (buffer-local-value mode from-buffer)
	   (insert (format "  %s: %s\n" mode
			   (buffer-local-value mode from-buffer)))))
199
    (insert "\n")
200
    (insert "Recent input:\n")
201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225
    (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))))
226 227 228 229 230 231 232 233 234 235 236 237
    ;; 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)))
238 239 240
    (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.
241 242
    (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
243 244 245 246 247 248 249 250 251 252
    ;; 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)))
253 254
    (unless report-emacs-bug-no-explanations
      (with-output-to-temp-buffer "*Bug Help*"
255
	(princ "While in the mail buffer:\n\n")
Glenn Morris's avatar
Glenn Morris committed
256
        (if report-emacs-bug-send-command
257
            (princ (substitute-command-keys
Glenn Morris's avatar
Glenn Morris committed
258 259
                    (format "  Type \\[%s] to send the bug report.\n"
                            report-emacs-bug-send-command))))
260
	(princ (substitute-command-keys
261
		"  Type \\[kill-buffer] RET to cancel (don't send it).\n"))
262 263
	(terpri)
	(princ (substitute-command-keys
264 265 266 267
		"  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*")))
268
    ;; Make it less likely people will send empty messages.
Glenn Morris's avatar
Glenn Morris committed
269 270
    (if report-emacs-bug-send-hook
        (add-hook report-emacs-bug-send-hook 'report-emacs-bug-hook nil t))
271 272 273 274 275
    (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-no-properties (point-min) (point)))
276
    (goto-char user-point)))
277

278 279 280
(defun report-emacs-bug-info ()
  "Go to the Info node on reporting Emacs bugs."
  (interactive)
Glenn Morris's avatar
Glenn Morris committed
281
  (info "(emacs)Bugs"))
282

283
(defun report-emacs-bug-hook ()
Glenn Morris's avatar
Glenn Morris committed
284
  "Do some checking before sending a bug report."
285
  (save-excursion
Glenn Morris's avatar
Glenn Morris committed
286 287 288 289 290 291 292
    (goto-char (point-max))
    (skip-chars-backward " \t\n")
    (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"))
293
    ;; Check the buffer contents and reject non-English letters.
Glenn Morris's avatar
Glenn Morris committed
294 295 296 297 298 299 300 301 302 303 304
    ;; 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))))))
305 306

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

321 322
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
323 324 325 326 327
and send the mail again%s."
                        (if report-emacs-bug-send-command
                            (format " using \\[%s]"
                                    report-emacs-bug-send-command)
                          "")))))
328
      (error "M-x report-emacs-bug was cancelled, please read *Bug Help* buffer"))
329

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

338 339
(provide 'emacsbug)

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