emacsbug.el 17.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
;; Copyright (C) 1985, 1994, 1997-1998, 2000-2011
4
;;   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
9
;; Package: emacs
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

35 36
(require 'url-util)

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 43 44
(define-obsolete-variable-alias 'report-emacs-bug-pretest-address
  'report-emacs-bug-address "24.1")

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

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

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

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

62 63 64
(defvar report-emacs-bug-tracker-url "http://debbugs.gnu.org/cgi/"
  "Base URL of the GNU bugtracker.
Used for querying duplicates and linking to existing bugs.")
Glenn Morris's avatar
Glenn Morris committed
65 66

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

77 78
(declare-function x-server-vendor "xfns.c" (&optional terminal))
(declare-function x-server-version "xfns.c" (&optional terminal))
79
(declare-function message-sort-headers "message" ())
80
(defvar message-strip-special-text-properties)
81

82 83 84 85 86 87
(defun report-emacs-bug-can-use-osx-open ()
  "Check if OSX open can be used to insert bug report into mailer"
  (and (featurep 'ns)
       (equal (executable-find "open") "/usr/bin/open")
       (memq system-type '(darwin))))

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 123 124 125 126
(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)
127 128 129 130 131 132 133 134 135
	  (if (report-emacs-bug-can-use-osx-open)
	      (start-process "/usr/bin/open" nil "open"
			     (concat "mailto:" to 
				     "?subject=" (url-hexify-string subject)
				     "&body=" (url-hexify-string body)))
	    (start-process "xdg-email" nil "xdg-email"
			   "--subject" subject
			   "--body" body
			   (concat "mailto:" to)))
136 137
	(error "Subject, To or body not found")))))

Jim Blandy's avatar
Jim Blandy committed
138
;;;###autoload
139
(defun report-emacs-bug (topic &optional recent-keys)
Jim Blandy's avatar
Jim Blandy committed
140
  "Report a bug in GNU Emacs.
Joseph Arceneaux's avatar
Joseph Arceneaux committed
141
Prompts for bug subject.  Leaves you in a mail buffer."
142 143 144
  ;; 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: "))))
145 146
  ;; The syntax `version;' is preferred to `[version]' because the
  ;; latter could be mistakenly stripped by mailing software.
147 148 149 150
  (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))))
151 152 153 154 155 156
  (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))
157 158
	(can-insert-mail (or (report-emacs-bug-can-use-xdg-email)
			     (report-emacs-bug-can-use-osx-open)))
159
        user-point message-end-point)
160
    (setq message-end-point
161
	  (with-current-buffer (get-buffer-create "*Messages*")
162
	    (point-max-marker)))
163
    (compose-mail report-emacs-bug-address topic)
164 165
    ;; The rest of this does not execute if the user was asked to
    ;; confirm and said no.
166 167 168 169 170 171
    (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))
172 173 174 175
    (rfc822-goto-eoh)
    (forward-line 1)
    (let ((signature (buffer-substring (point) (point-max))))
      (delete-region (point) (point-max))
176 177
      (insert signature)
      (backward-char (length signature)))
Richard M. Stallman's avatar
Richard M. Stallman committed
178 179
    (unless report-emacs-bug-no-explanations
      ;; Insert warnings for novice users.
180
      (when (string-match "@gnu\\.org$" report-emacs-bug-address)
181 182 183
	(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
184
          (overlay-put (make-overlay pos (point)) 'face 'highlight)))
185
      (insert "\nPlease write in ")
Richard M. Stallman's avatar
Richard M. Stallman committed
186 187
      (let ((pos (point)))
	(insert "English")
Glenn Morris's avatar
Glenn Morris committed
188
        (overlay-put (make-overlay pos (point)) 'face 'highlight))
189 190
      (insert " if possible, because the Emacs maintainers
usually do not have translators to read other languages for them.\n\n")
191
      (insert (format "Your report will be posted to the %s mailing list"
192
		      report-emacs-bug-address))
193
      (insert "\nand the gnu.emacs.bug news group, and at http://debbugs.gnu.org.\n\n"))
194

195
    (insert "Please describe exactly what actions triggered the bug\n"
196 197
	    "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
198 199 200 201
    (add-text-properties (save-excursion
                           (rfc822-goto-eoh)
                           (line-beginning-position 2))
                         (point)
202
                         prompt-properties)
203
    (setq user-point (point))
204 205
    (insert "\n\n")

206
    (insert "If Emacs crashed, and you have the Emacs process in the gdb debugger,\n"
207 208 209 210 211
	    "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)
212 213
	  (insert "For information about debugging Emacs, please read the file\n"
		  debug-file ".\n")))
214
    (add-text-properties (1+ user-point) (point) prompt-properties)
215

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

328 329 330
(defun report-emacs-bug-info ()
  "Go to the Info node on reporting Emacs bugs."
  (interactive)
Glenn Morris's avatar
Glenn Morris committed
331
  (info "(emacs)Bugs"))
332

333
(defun report-emacs-bug-hook ()
Glenn Morris's avatar
Glenn Morris committed
334
  "Do some checking before sending a bug report."
335
  (save-excursion
Glenn Morris's avatar
Glenn Morris committed
336 337 338 339 340 341 342
    (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"))
343 344

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

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

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

376 377 378

;; Querying the bug database

Glenn Morris's avatar
Glenn Morris committed
379 380 381 382 383
(defvar report-emacs-bug-bug-alist nil)
(make-variable-buffer-local 'report-emacs-bug-bug-alist)
(defvar report-emacs-bug-choice-widget nil)
(make-variable-buffer-local 'report-emacs-bug-choice-widget)

384
(defun report-emacs-bug-create-existing-bugs-buffer (bugs keywords)
385 386 387 388
  (switch-to-buffer (get-buffer-create "*Existing Emacs Bugs*"))
  (setq buffer-read-only t)
  (let ((inhibit-read-only t))
    (erase-buffer)
Glenn Morris's avatar
Glenn Morris committed
389
    (setq report-emacs-bug-bug-alist bugs)
390 391 392
    (widget-insert (propertize (concat "Already known bugs ("
				       keywords "):\n\n")
			       'face 'bold))
393
    (if bugs
Glenn Morris's avatar
Glenn Morris committed
394
	(setq report-emacs-bug-choice-widget
395
	      (apply 'widget-create 'radio-button-choice
396
		     :value (caar bugs)
397 398 399 400
		     (let (items)
		       (dolist (bug bugs)
			 (push (list
				'url-link
Glenn Morris's avatar
Glenn Morris committed
401
				:format (concat "Bug#" (number-to-string (nth 2 bug))
402
						": " (cadr bug) "\n    %[%v%]\n")
403 404
				;; FIXME: Why is only the link of the
				;; active item clickable?
Glenn Morris's avatar
Glenn Morris committed
405
				(car bug))
406 407 408 409 410 411 412 413 414 415 416 417 418
			       items))
		       (nreverse items))))
      (widget-insert "No bugs maching your keywords found.\n"))
    (widget-insert "\n")
    (widget-create 'push-button
		   :notify (lambda (&rest ignore)
			     ;; TODO: Do something!
			     (message "Reporting new bug!"))
		   "Report new bug")
    (when bugs
      (widget-insert " ")
      (widget-create 'push-button
		     :notify (lambda (&rest ignore)
Glenn Morris's avatar
Glenn Morris committed
419
			       (let ((val (widget-value report-emacs-bug-choice-widget)))
420 421
				 ;; TODO: Do something!
				 (message "Appending to bug %s!"
Glenn Morris's avatar
Glenn Morris committed
422
					  (nth 2 (assoc val report-emacs-bug-bug-alist)))))
423 424 425 426 427 428 429 430 431 432 433
		     "Append to chosen bug"))
    (widget-insert " ")
    (widget-create 'push-button
		   :notify (lambda (&rest ignore)
			     (kill-buffer))
		   "Quit reporting bug")
    (widget-insert "\n"))
  (use-local-map widget-keymap)
  (widget-setup)
  (goto-char (point-min)))

434
(defun report-emacs-bug-parse-query-results (status keywords)
435 436 437 438 439 440 441 442 443 444 445 446 447
  (goto-char (point-min))
  (let (buglist)
    (while (re-search-forward "<a href=\"bugreport\\.cgi\\?bug=\\([[:digit:]]+\\)\">\\([^<]+\\)</a>" nil t)
      (let ((number (match-string 1))
	    (subject (match-string 2)))
	(when (not (string-match "^#" subject))
	  (push (list
		 ;; first the bug URL
		 (concat report-emacs-bug-tracker-url
			 "bugreport.cgi?bug=" number)
		 ;; then the subject and number
		 subject (string-to-number number))
		buglist))))
448
    (report-emacs-bug-create-existing-bugs-buffer (nreverse buglist) keywords)))
449 450 451 452

(defun report-emacs-bug-query-existing-bugs (keywords)
  "Query for KEYWORDS at `report-emacs-bug-tracker-url', and return the result.
The result is an alist with items of the form (URL SUBJECT NO)."
453
  (interactive "sBug keywords (comma separated): ")
454 455 456 457
  (url-retrieve (concat report-emacs-bug-tracker-url
			"pkgreport.cgi?include=subject%3A"
			(replace-regexp-in-string "[[:space:]]+" "+" keywords)
			";package=emacs")
458
		'report-emacs-bug-parse-query-results (list keywords)))
459

460 461
(provide 'emacsbug)

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