emacsbug.el 17.9 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
10
;; Package: emacs
Eric S. Raymond's avatar
Eric S. Raymond committed
11

Joseph Arceneaux's avatar
Joseph Arceneaux committed
12 13
;; This file is part of GNU Emacs.

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

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

27 28
;;; Commentary:

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

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

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

41 42 43
(define-obsolete-variable-alias 'report-emacs-bug-pretest-address
  'report-emacs-bug-address "24.1")

44
(defcustom report-emacs-bug-address "bug-gnu-emacs@gnu.org"
Glenn Morris's avatar
Glenn Morris committed
45
  "Address of mailing list for GNU Emacs bugs."
46 47
  :group 'emacsbug
  :type 'string)
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
;; User options end here.

61 62 63
(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
64 65

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

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

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

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

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

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

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

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

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

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

380 381 382

;; Querying the bug database

383
(defun report-emacs-bug-create-existing-bugs-buffer (bugs keywords)
384 385 386 387 388 389 390
  (switch-to-buffer (get-buffer-create "*Existing Emacs Bugs*"))
  (setq buffer-read-only t)
  (let ((inhibit-read-only t))
    (erase-buffer)
    (make-local-variable 'bug-alist)
    (setq bug-alist bugs)
    (make-local-variable 'bug-choice-widget)
391 392 393
    (widget-insert (propertize (concat "Already known bugs ("
				       keywords "):\n\n")
			       'face 'bold))
394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434
    (if bugs
	(setq bug-choice-widget
	      (apply 'widget-create 'radio-button-choice
		     :value (car (first bugs))
		     (let (items)
		       (dolist (bug bugs)
			 (push (list
				'url-link
				:format (concat "Bug#" (number-to-string (third bug))
						": " (second bug) "\n    %[%v%]\n")
				;; FIXME: Why is only the link of the
				;; active item clickable?
				(first bug))
			       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)
			       (let ((val (widget-value bug-choice-widget)))
				 ;; TODO: Do something!
				 (message "Appending to bug %s!"
					  (third (assoc val bug-alist)))))
		     "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)))

435
(defun report-emacs-bug-parse-query-results (status keywords)
436 437 438 439 440 441 442 443 444 445 446 447 448
  (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))))
449
    (report-emacs-bug-create-existing-bugs-buffer (nreverse buglist) keywords)))
450 451 452 453 454 455 456 457 458

(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)."
  (interactive "sBug keywords: ")
  (url-retrieve (concat report-emacs-bug-tracker-url
			"pkgreport.cgi?include=subject%3A"
			(replace-regexp-in-string "[[:space:]]+" "+" keywords)
			";package=emacs")
459
		'report-emacs-bug-parse-query-results (list keywords)))
460

461 462
(provide 'emacsbug)

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