1 ;;; emacsbug.el --- command to report Emacs bugs to appropriate mailing list
3 ;; Copyright (C) 1985, 1994, 1997-1998, 2000-2017 Free Software
6 ;; Author: K. Shane Hartman
7 ;; Maintainer: emacs-devel@gnu.org
8 ;; Keywords: maint mail
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; 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/>.
28 ;; `M-x report-emacs-bug' starts an email note to the Emacs maintainers
29 ;; describing a problem. You need to be able to send mail from Emacs
30 ;; to complete the process. Alternatively, compose the bug report in
31 ;; Emacs then paste it into your normal mail client.
38 (defgroup emacsbug nil
39 "Sending Emacs bug reports."
43 (define-obsolete-variable-alias 'report-emacs-bug-pretest-address
44 'report-emacs-bug-address
"24.1")
46 (defcustom report-emacs-bug-no-confirmation nil
47 "If non-nil, suppress the confirmations asked for the sake of novice users."
51 (defcustom report-emacs-bug-no-explanations nil
52 "If non-nil, suppress the explanations given for the sake of novice users."
56 ;; User options end here.
58 (defvar report-emacs-bug-orig-text nil
59 "The automatically-created initial text of the bug report.")
61 (defvar report-emacs-bug-send-command nil
62 "Name of the command to send the bug report, as a string.")
63 (make-variable-buffer-local 'report-emacs-bug-send-command
)
65 (defvar report-emacs-bug-send-hook nil
66 "Hook run before sending the bug report.")
67 (make-variable-buffer-local 'report-emacs-bug-send-hook
)
69 (declare-function x-server-vendor
"xfns.c" (&optional terminal
))
70 (declare-function x-server-version
"xfns.c" (&optional terminal
))
71 (declare-function message-sort-headers
"message" ())
72 (defvar message-strip-special-text-properties
)
74 (defun report-emacs-bug-can-use-osx-open ()
75 "Return non-nil if the macOS \"open\" command is available for mailing."
77 (equal (executable-find "open") "/usr/bin/open")
78 (memq system-type
'(darwin))))
80 ;; FIXME this duplicates much of the logic from browse-url-can-use-xdg-open.
81 (defun report-emacs-bug-can-use-xdg-email ()
82 "Return non-nil if the \"xdg-email\" command can be used.
83 xdg-email is a desktop utility that calls your preferred mail client.
84 This requires you to be running either Gnome, KDE, or Xfce4."
85 (and (getenv "DISPLAY")
86 (executable-find "xdg-email")
87 (or (getenv "GNOME_DESKTOP_SESSION_ID")
88 ;; GNOME_DESKTOP_SESSION_ID is deprecated, check on Dbus also.
91 "dbus-send" nil nil nil
92 "--dest=org.gnome.SessionManager"
94 "/org/gnome/SessionManager"
95 "org.gnome.SessionManager.CanShutdown"))
97 (equal (getenv "KDE_FULL_SESSION") "true")
98 ;; FIXME? browse-url-can-use-xdg-open also accepts LXDE.
99 ;; Is that no good here, or just overlooked?
102 "/bin/sh" nil nil nil
104 ;; FIXME use string-match rather than grep.
105 "xprop -root _DT_SAVE_MODE|grep xfce4"))
108 (defun report-emacs-bug-insert-to-mailer ()
109 "Send the message to your preferred mail client.
110 This requires either the macOS \"open\" command, or the freedesktop
111 \"xdg-email\" command to be available."
114 ;; FIXME? use mail-fetch-field?
116 (goto-char (point-min))
118 (and (looking-at "^To: \\(.*\\)")
119 (match-string-no-properties 1))))
122 (and (looking-at "^Subject: \\(.*\\)")
123 (match-string-no-properties 1))))
126 (if (> (point-max) (point))
127 (buffer-substring-no-properties (point) (point-max))))))
128 (if (and to subject body
)
129 (if (report-emacs-bug-can-use-osx-open)
130 (start-process "/usr/bin/open" nil
"open"
132 "?subject=" (url-hexify-string subject
)
133 "&body=" (url-hexify-string body
)))
134 (start-process "xdg-email" nil
"xdg-email"
137 (concat "mailto:" to
)))
138 (error "Subject, To or body not found")))))
140 ;; It's the default mail mode, so it seems OK to use its features.
141 (autoload 'message-bogus-recipient-p
"message")
142 (autoload 'message-make-address
"message")
143 (defvar message-send-mail-function
)
144 (defvar message-sendmail-envelope-from
)
147 (defun report-emacs-bug (topic &optional unused
)
148 "Report a bug in GNU Emacs.
149 Prompts for bug subject. Leaves you in a mail buffer."
150 (declare (advertised-calling-convention (topic) "24.5"))
151 (interactive "sBug Subject: ")
152 ;; The syntax `version;' is preferred to `[version]' because the
153 ;; latter could be mistakenly stripped by mailing software.
154 (if (eq system-type
'ms-dos
)
155 (setq topic
(concat emacs-version
"; " topic
))
156 (when (string-match "^\\(\\([.0-9]+\\)*\\)\\.[0-9]+$" emacs-version
)
157 (setq topic
(concat (match-string 1 emacs-version
) "; " topic
))))
158 (let ((from-buffer (current-buffer))
159 (can-insert-mail (or (report-emacs-bug-can-use-xdg-email)
160 (report-emacs-bug-can-use-osx-open)))
161 user-point message-end-point
)
162 (setq message-end-point
163 (with-current-buffer (messages-buffer)
166 ;; For the novice user make sure there's always enough space for
167 ;; the mail and the warnings buffer on this frame (Bug#10873).
168 (unless report-emacs-bug-no-explanations
169 (delete-other-windows)
170 (set-window-dedicated-p nil nil
)
171 (set-frame-parameter nil
'unsplittable nil
))
173 (compose-mail report-emacs-bug-address topic
)
174 ;; The rest of this does not execute if the user was asked to
175 ;; confirm and said no.
176 (when (eq major-mode
'message-mode
)
177 ;; Message-mode sorts the headers before sending. We sort now so
178 ;; that report-emacs-bug-orig-text remains valid. (Bug#5178)
179 (message-sort-headers)
180 ;; Stop message-mode stealing the properties we will add.
181 (set (make-local-variable 'message-strip-special-text-properties
) nil
)
182 ;; Make sure we default to the From: address as envelope when sending
184 (when (and (not message-sendmail-envelope-from
)
185 (message-bogus-recipient-p (message-make-address)))
186 (set (make-local-variable 'message-sendmail-envelope-from
) 'header
)))
189 ;; Move the mail signature to the proper place.
190 (let ((signature (buffer-substring (point) (point-max)))
191 (inhibit-read-only t
))
192 (delete-region (point) (point-max))
194 (backward-char (length signature
)))
195 (unless report-emacs-bug-no-explanations
196 ;; Insert warnings for novice users.
197 (if (not (equal "bug-gnu-emacs@gnu.org" report-emacs-bug-address
))
198 (insert (format "The report will be sent to %s.\n\n"
199 report-emacs-bug-address
))
200 (insert "This bug report will be sent to the ")
204 'help-echo
(concat "mouse-2, RET: Follow this link")
205 'action
(lambda (button)
206 (browse-url "http://lists.gnu.org/archive/html/bug-gnu-emacs/"))
208 (insert " mailing list\nand the GNU bug tracker at ")
212 'help-echo
(concat "mouse-2, RET: Follow this link")
213 'action
(lambda (button)
214 (browse-url "http://debbugs.gnu.org/"))
217 (insert ". Please check that
218 the From: line contains a valid email address. After a delay of up
219 to one day, you should receive an acknowledgment at that address.
221 Please write in English if possible, as the Emacs maintainers
222 usually do not have translators for other languages.\n\n")))
224 (insert "Please describe exactly what actions triggered the bug, and\n"
225 "the precise symptoms of the bug. If you can, give a recipe\n"
226 "starting from 'emacs -Q':\n\n")
227 (let ((txt (delete-and-extract-region
228 (save-excursion (rfc822-goto-eoh) (line-beginning-position 2))
230 (insert (propertize "\n" 'display txt
)))
231 (setq user-point
(point))
234 (insert "If Emacs crashed, and you have the Emacs process in the gdb debugger,\n"
235 "please include the output from the following gdb commands:\n"
236 " 'bt full' and 'xbacktrace'.\n")
238 (let ((debug-file (expand-file-name "DEBUG" data-directory
)))
239 (if (file-readable-p debug-file
)
240 (insert "For information about debugging Emacs, please read the file\n"
242 (let ((txt (delete-and-extract-region (1+ user-point
) (point))))
243 (insert (propertize "\n" 'display txt
)))
245 (insert "\nIn " (emacs-version))
246 (if emacs-build-system
247 (insert " built on " emacs-build-system
))
250 (if (stringp emacs-repository-version
)
251 (insert "Repository revision: " emacs-repository-version
"\n"))
252 (if (fboundp 'x-server-vendor
)
254 ;; This is used not only for X11 but also W32 and others.
255 (insert "Windowing system distributor '" (x-server-vendor)
257 (mapconcat 'number-to-string
(x-server-version) ".") "\n")
259 (let ((lsb (with-temp-buffer
260 (if (eq 0 (ignore-errors
261 (call-process "lsb_release" nil
'(t nil
)
265 (insert "System " lsb
"\n")))
266 (let ((message-buf (get-buffer "*Messages*")))
269 (end-pos message-end-point
))
270 (with-current-buffer message-buf
273 (setq beg-pos
(point)))
274 (terpri (current-buffer) t
)
275 (insert "Recent messages:\n")
276 (insert-buffer-substring message-buf beg-pos end-pos
))))
278 (when (and system-configuration-options
279 (not (equal system-configuration-options
"")))
280 (insert "Configured using:\n 'configure "
281 system-configuration-options
"'\n\n")
282 (fill-region (line-beginning-position -
1) (point)))
283 (insert "Configured features:\n" system-configuration-features
"\n\n")
284 (fill-region (line-beginning-position -
1) (point))
285 (insert "Important settings:\n")
288 (let ((val (getenv var
)))
289 (if val
(insert (format " value of $%s: %s\n" var val
)))))
290 '("EMACSDATA" "EMACSDOC" "EMACSLOADPATH" "EMACSPATH"
291 "LC_ALL" "LC_COLLATE" "LC_CTYPE" "LC_MESSAGES"
292 "LC_MONETARY" "LC_NUMERIC" "LC_TIME" "LANG" "XMODIFIERS"))
293 (insert (format " locale-coding-system: %s\n" locale-coding-system
))
294 ;; Only ~ 0.2% of people from a sample of 3200 changed this from
296 (or (default-value 'enable-multibyte-characters
)
297 (insert (format " default enable-multibyte-characters: %s\n"
298 (default-value 'enable-multibyte-characters
))))
300 (insert (format "Major mode: %s\n"
302 (buffer-local-value 'mode-name from-buffer
)
303 nil nil from-buffer
)))
305 (insert "Minor modes in effect:\n")
306 (dolist (mode minor-mode-list
)
307 (and (boundp mode
) (buffer-local-value mode from-buffer
)
308 (insert (format " %s: %s\n" mode
309 (buffer-local-value mode from-buffer
)))))
311 (insert "Load-path shadows:\n")
312 (let* ((msg "Checking for load-path shadows...")
314 (shadows (progn (message "%s" msg
)
315 (condition-case nil
(list-load-path-shadows t
)
317 (setq result
"error")
318 "Error during checking")))))
319 (message "%s%s" msg result
)
320 (insert (if (zerop (length shadows
))
323 (insert (format "\nFeatures:\n%s\n" features
))
324 (fill-region (line-beginning-position 0) (point))
326 (insert (format "\nMemory information:\n"))
327 (pp (garbage-collect) (current-buffer))
329 ;; This is so the user has to type something in order to send easily.
330 (use-local-map (nconc (make-sparse-keymap) (current-local-map)))
331 (define-key (current-local-map) "\C-c\C-i" 'info-emacs-bug
)
333 (define-key (current-local-map) "\C-c\M-i"
334 'report-emacs-bug-insert-to-mailer
))
335 (setq report-emacs-bug-send-command
(get mail-user-agent
'sendfunc
)
336 report-emacs-bug-send-hook
(get mail-user-agent
'hookvar
))
337 (if report-emacs-bug-send-command
338 (setq report-emacs-bug-send-command
339 (symbol-name report-emacs-bug-send-command
)))
340 (unless report-emacs-bug-no-explanations
341 (with-output-to-temp-buffer "*Bug Help*"
342 (princ "While in the mail buffer:\n\n")
343 (if report-emacs-bug-send-command
344 (princ (substitute-command-keys
345 (format " Type \\[%s] to send the bug report.\n"
346 report-emacs-bug-send-command
))))
347 (princ (substitute-command-keys
348 " Type \\[kill-buffer] RET to cancel (don't send it).\n"))
350 (princ (substitute-command-keys
351 " Type \\[report-emacs-bug-insert-to-mailer] to copy text to your preferred mail program.\n")))
353 (princ (substitute-command-keys
354 " Type \\[info-emacs-bug] to visit in Info the Emacs Manual section
355 about when and how to write a bug report, and what
356 information you should include to help fix the bug.")))
357 (shrink-window-if-larger-than-buffer (get-buffer-window "*Bug Help*")))
358 ;; Make it less likely people will send empty messages.
359 (if report-emacs-bug-send-hook
360 (add-hook report-emacs-bug-send-hook
'report-emacs-bug-hook nil t
))
361 (goto-char (point-max))
362 (skip-chars-backward " \t\n")
363 (make-local-variable 'report-emacs-bug-orig-text
)
364 (setq report-emacs-bug-orig-text
365 (buffer-substring-no-properties (point-min) (point)))
366 (goto-char user-point
)))
368 (define-obsolete-function-alias 'report-emacs-bug-info
'info-emacs-bug
"24.3")
370 (defun report-emacs-bug-hook ()
371 "Do some checking before sending a bug report."
373 (goto-char (point-max))
374 (skip-chars-backward " \t\n")
375 (and (= (- (point) (point-min))
376 (length report-emacs-bug-orig-text
))
377 (string-equal (buffer-substring-no-properties (point-min) (point))
378 report-emacs-bug-orig-text
)
379 (error "No text entered in bug report"))
380 ;; Warning for novice users.
381 (unless (or report-emacs-bug-no-confirmation
383 "Send this bug report to the Emacs maintainers? "))
384 (goto-char (point-min))
385 (if (search-forward "To: ")
386 (delete-region (point) (line-end-position)))
387 (if report-emacs-bug-send-hook
388 (kill-local-variable report-emacs-bug-send-hook
))
389 (with-output-to-temp-buffer "*Bug Help*"
390 (princ (substitute-command-keys
392 You invoked the command M-x report-emacs-bug,
393 but you decided not to mail the bug report to the Emacs maintainers.
395 If you want to mail it to someone else instead,
396 please insert the proper e-mail address after \"To: \",
397 and send the mail again%s."
398 (if report-emacs-bug-send-command
399 (format " using \\[%s]"
400 report-emacs-bug-send-command
)
402 (error "M-x report-emacs-bug was canceled, please read *Bug Help* buffer"))
403 ;; Query the user for the SMTP method, so that we can skip
404 ;; questions about From header validity if the user is going to
405 ;; use mailclient, anyway.
406 (when (or (and (derived-mode-p 'message-mode
)
407 (eq message-send-mail-function
'sendmail-query-once
))
408 (and (not (derived-mode-p 'message-mode
))
409 (eq send-mail-function
'sendmail-query-once
)))
410 (sendmail-query-user-about-smtp)
411 (when (derived-mode-p 'message-mode
)
412 (setq message-send-mail-function
(message-default-send-mail-function))))
413 (or report-emacs-bug-no-confirmation
414 ;; mailclient.el does not need a valid From
415 (if (derived-mode-p 'message-mode
)
416 (eq message-send-mail-function
'message-send-mail-with-mailclient
)
417 (eq send-mail-function
'mailclient-send-it
))
418 ;; Not narrowing to the headers, but that's OK.
419 (let ((from (mail-fetch-field "From")))
421 (message-bogus-recipient-p from
)
422 ;; This is the default user-mail-address. On today's
423 ;; systems, it seems more likely to be wrong than right,
424 ;; since most people don't run their own mail server.
425 (string-match (format "\\<%s@%s\\>"
426 (regexp-quote (user-login-name))
427 (regexp-quote (system-name)))
430 (format-message "Is `%s' really your email address? "
432 (error "Please edit the From address and try again"))))))
437 ;;; emacsbug.el ends here