emacsbug.el 15 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 41 42
(define-obsolete-variable-alias 'report-emacs-bug-pretest-address
  'report-emacs-bug-address "24.1")

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

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

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

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


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

72 73
(declare-function x-server-vendor "xfns.c" (&optional terminal))
(declare-function x-server-version "xfns.c" (&optional terminal))
74
(declare-function message-sort-headers "message" ())
75
(defvar message-strip-special-text-properties)
76

77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122
(defun report-emacs-bug-can-use-xdg-email ()
  "Check if xdg-email can be used, i.e. we are on Gnome, KDE or xfce4."
  (and (getenv "DISPLAY")
       (executable-find "xdg-email")
       (or (getenv "GNOME_DESKTOP_SESSION_ID")
	   ;; GNOME_DESKTOP_SESSION_ID is deprecated, check on Dbus also.
	   (condition-case nil
	       (eq 0 (call-process
		      "dbus-send" nil nil nil
				  "--dest=org.gnome.SessionManager"
				  "--print-reply"
				  "/org/gnome/SessionManager"
				  "org.gnome.SessionManager.CanShutdown"))
	     (error nil))
	   (equal (getenv "KDE_FULL_SESSION") "true")
	   (condition-case nil
	       (eq 0 (call-process
		      "/bin/sh" nil nil nil
		      "-c"
		      "xprop -root _DT_SAVE_MODE|grep xfce4"))
	     (error nil)))))

(defun report-emacs-bug-insert-to-mailer ()
  (interactive)
  (save-excursion
    (let* ((to (progn
		 (goto-char (point-min))
		 (forward-line)
		 (and (looking-at "^To: \\(.*\\)")
		      (match-string-no-properties 1))))
	   (subject (progn
		      (forward-line)
		      (and (looking-at "^Subject: \\(.*\\)")
			   (match-string-no-properties 1))))
	   (body (progn
		   (forward-line 2)
		   (if (> (point-max) (point))
		       (buffer-substring-no-properties (point) (point-max))))))
      (if (and to subject body)
	  (start-process "xdg-email" nil "xdg-email"
			 "--subject" subject
			 "--body" body
			 (concat "mailto:" to))
	(error "Subject, To or body not found")))))

 
Jim Blandy's avatar
Jim Blandy committed
123
;;;###autoload
124
(defun report-emacs-bug (topic &optional recent-keys)
Jim Blandy's avatar
Jim Blandy committed
125
  "Report a bug in GNU Emacs.
Joseph Arceneaux's avatar
Joseph Arceneaux committed
126
Prompts for bug subject.  Leaves you in a mail buffer."
127 128 129
  ;; 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: "))))
130 131
  ;; The syntax `version;' is preferred to `[version]' because the
  ;; latter could be mistakenly stripped by mailing software.
132 133 134 135
  (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))))
136 137 138 139 140 141
  (let ((from-buffer (current-buffer))
        ;; Put these properties on semantically-void text.
        ;; report-emacs-bug-hook deletes these regions before sending.
        (prompt-properties '(field emacsbug-prompt
                                   intangible but-helpful
                                   rear-nonsticky t))
142
	(can-xdg-email (report-emacs-bug-can-use-xdg-email))
143
        user-point message-end-point)
144
    (setq message-end-point
145
	  (with-current-buffer (get-buffer-create "*Messages*")
146
	    (point-max-marker)))
147
    (compose-mail report-emacs-bug-address topic)
148 149
    ;; The rest of this does not execute if the user was asked to
    ;; confirm and said no.
150 151 152 153 154 155
    (when (eq major-mode 'message-mode)
      ;; Message-mode sorts the headers before sending.  We sort now so
      ;; that report-emacs-bug-orig-text remains valid.  (Bug#5178)
      (message-sort-headers)
      ;; Stop message-mode stealing the properties we will add.
      (set (make-local-variable 'message-strip-special-text-properties) nil))
156 157 158 159
    (rfc822-goto-eoh)
    (forward-line 1)
    (let ((signature (buffer-substring (point) (point-max))))
      (delete-region (point) (point-max))
160 161
      (insert signature)
      (backward-char (length signature)))
Richard M. Stallman's avatar
Richard M. Stallman committed
162 163
    (unless report-emacs-bug-no-explanations
      ;; Insert warnings for novice users.
164
      (when (string-match "@gnu\\.org$" report-emacs-bug-address)
165 166 167
	(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
168
          (overlay-put (make-overlay pos (point)) 'face 'highlight)))
169
      (insert "\nPlease write in ")
Richard M. Stallman's avatar
Richard M. Stallman committed
170 171
      (let ((pos (point)))
	(insert "English")
Glenn Morris's avatar
Glenn Morris committed
172
        (overlay-put (make-overlay pos (point)) 'face 'highlight))
173 174
      (insert " if possible, because the Emacs maintainers
usually do not have translators to read other languages for them.\n\n")
175
      (insert (format "Your bug report will be posted to the %s mailing list"
176
		      report-emacs-bug-address))
Glenn Morris's avatar
Glenn Morris committed
177
	(insert ",\nand to the gnu.emacs.bug news group.\n\n"))
178

179
    (insert "Please describe exactly what actions triggered the bug\n"
180 181
	    "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
182 183 184 185
    (add-text-properties (save-excursion
                           (rfc822-goto-eoh)
                           (line-beginning-position 2))
                         (point)
186
                         prompt-properties)
187
    (setq user-point (point))
188 189
    (insert "\n\n")

190
    (insert "If Emacs crashed, and you have the Emacs process in the gdb debugger,\n"
191 192 193 194 195
	    "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)
196 197
	  (insert "For information about debugging Emacs, please read the file\n"
		  debug-file ".\n")))
198
    (add-text-properties (1+ user-point) (point) prompt-properties)
199

200
    (insert "\n\nIn " (emacs-version) "\n")
201
    (if (fboundp 'x-server-vendor)
202
	(condition-case nil
203 204 205
            ;; This is used not only for X11 but also W32 and others.
	    (insert "Windowing system distributor `" (x-server-vendor)
                    "', version "
206 207
		    (mapconcat 'number-to-string (x-server-version) ".") "\n")
	  (error t)))
208 209 210
    (if (and system-configuration-options
	     (not (equal system-configuration-options "")))
	(insert "configured using `configure "
211
		system-configuration-options "'\n\n"))
212
    (insert "Important settings:\n")
213
    (mapc
214 215 216
     '(lambda (var)
	(insert (format "  value of $%s: %s\n" var (getenv var))))
     '("LC_ALL" "LC_COLLATE" "LC_CTYPE" "LC_MESSAGES"
217
       "LC_MONETARY" "LC_NUMERIC" "LC_TIME" "LANG" "XMODIFIERS"))
218
    (insert (format "  locale-coding-system: %s\n" locale-coding-system))
219 220
    (insert (format "  default enable-multibyte-characters: %s\n"
		    (default-value 'enable-multibyte-characters)))
221
    (insert "\n")
222
    (insert (format "Major mode: %s\n"
223 224 225
		    (format-mode-line
                     (buffer-local-value 'mode-name from-buffer)
                     nil nil from-buffer)))
226 227 228
    (insert "\n")
    (insert "Minor modes in effect:\n")
    (dolist (mode minor-mode-list)
229 230 231
      (and (boundp mode) (buffer-local-value mode from-buffer)
	   (insert (format "  %s: %s\n" mode
			   (buffer-local-value mode from-buffer)))))
232
    (insert "\n")
233
    (insert "Recent input:\n")
234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258
    (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))))
259 260 261 262 263 264 265 266 267 268 269 270
    ;; 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)))
271 272 273
    (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.
274 275
    (use-local-map (nconc (make-sparse-keymap) (current-local-map)))
    (define-key (current-local-map) "\C-c\C-i" 'report-emacs-bug-info)
276 277 278
    (if can-xdg-email
	(define-key (current-local-map) "\C-cm" 
	  'report-emacs-bug-insert-to-mailer))
Glenn Morris's avatar
Glenn Morris committed
279 280 281 282 283 284 285 286 287 288
    ;; 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)))
289 290
    (unless report-emacs-bug-no-explanations
      (with-output-to-temp-buffer "*Bug Help*"
291
	(princ "While in the mail buffer:\n\n")
Glenn Morris's avatar
Glenn Morris committed
292
        (if report-emacs-bug-send-command
293
            (princ (substitute-command-keys
Glenn Morris's avatar
Glenn Morris committed
294 295
                    (format "  Type \\[%s] to send the bug report.\n"
                            report-emacs-bug-send-command))))
296
	(princ (substitute-command-keys
297
		"  Type \\[kill-buffer] RET to cancel (don't send it).\n"))
298 299 300
	(if can-xdg-email
	    (princ (substitute-command-keys
		    "  Type \\[report-emacs-bug-insert-to-mailer] to insert text to you preferred mail program.\n")))
301 302
	(terpri)
	(princ (substitute-command-keys
303 304 305 306
		"  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*")))
307
    ;; Make it less likely people will send empty messages.
Glenn Morris's avatar
Glenn Morris committed
308 309
    (if report-emacs-bug-send-hook
        (add-hook report-emacs-bug-send-hook 'report-emacs-bug-hook nil t))
310 311 312 313 314
    (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)))
315
    (goto-char user-point)))
316

317 318 319
(defun report-emacs-bug-info ()
  "Go to the Info node on reporting Emacs bugs."
  (interactive)
Glenn Morris's avatar
Glenn Morris committed
320
  (info "(emacs)Bugs"))
321

322
(defun report-emacs-bug-hook ()
Glenn Morris's avatar
Glenn Morris committed
323
  "Do some checking before sending a bug report."
324
  (save-excursion
Glenn Morris's avatar
Glenn Morris committed
325 326 327 328 329 330 331
    (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"))
332
    ;; Check the buffer contents and reject non-English letters.
Glenn Morris's avatar
Glenn Morris committed
333 334 335 336 337 338 339 340 341 342 343
    ;; 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))))))
344 345

    ;; The last warning for novice users.
Glenn Morris's avatar
Glenn Morris committed
346 347 348
    (unless (or report-emacs-bug-no-confirmation
                (yes-or-no-p
                 "Send this bug report to the Emacs maintainers? "))
349 350
      (goto-char (point-min))
      (if (search-forward "To: ")
Glenn Morris's avatar
Glenn Morris committed
351 352 353
          (delete-region (point) (line-end-position)))
      (if report-emacs-bug-send-hook
          (kill-local-variable report-emacs-bug-send-hook))
354
      (with-output-to-temp-buffer "*Bug Help*"
Glenn Morris's avatar
Glenn Morris committed
355 356
	(princ (substitute-command-keys
                (format "\
357 358
You invoked the command M-x report-emacs-bug,
but you decided not to mail the bug report to the Emacs maintainers.
359

360 361
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
362 363 364 365 366
and send the mail again%s."
                        (if report-emacs-bug-send-command
                            (format " using \\[%s]"
                                    report-emacs-bug-send-command)
                          "")))))
367
      (error "M-x report-emacs-bug was cancelled, please read *Bug Help* buffer"))
368

Glenn Morris's avatar
Glenn Morris committed
369 370 371
    ;; Delete the uninteresting text that was just to help fill out the report.
    (rfc822-goto-eoh)
    (forward-line 1)
372 373 374 375
    (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
376

377 378
(provide 'emacsbug)

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