(require 'sendmail)
(defgroup emacsbug nil
"Sending Emacs bug reports."
:group 'maint
:group 'mail)
(defcustom report-emacs-bug-address "bug-gnu-emacs@gnu.org"
"*Address of mailing list for GNU Emacs bugs."
:group 'emacsbug
:type 'string)
(defcustom report-emacs-bug-pretest-address "emacs-pretest-bug@gnu.org"
"*Address of mailing list for GNU Emacs pretest bugs."
:group 'emacsbug
:type 'string)
(defvar report-emacs-bug-orig-text nil
"The automatically-created initial text of bug report.")
(defcustom report-emacs-bug-no-confirmation nil
"*If non-nil, suppress the confirmations asked for the sake of novice users."
:group 'emacsbug
:type 'boolean)
(defcustom report-emacs-bug-no-explanations nil
"*If non-nil, suppress the explanations given for the sake of novice users."
:group 'emacsbug
:type 'boolean)
(defun report-emacs-bug (topic &optional recent-keys)
"Report a bug in GNU Emacs.
Prompts for bug subject. Leaves you in a mail buffer."
(interactive (reverse (list (recent-keys) (read-string "Bug Subject: "))))
(let* ((pretest-p (string-match "\\..*\\..*\\." emacs-version))
(from-buffer (current-buffer))
(reporting-address (if pretest-p
report-emacs-bug-pretest-address
report-emacs-bug-address))
(prompt-properties '(field emacsbug-prompt
intangible but-helpful
rear-nonsticky t))
user-point message-end-point)
(setq message-end-point
(with-current-buffer (get-buffer-create "*Messages*")
(point-max-marker)))
(compose-mail reporting-address
topic)
(rfc822-goto-eoh)
(forward-line 1)
(let ((signature (buffer-substring (point) (point-max))))
(delete-region (point) (point-max))
(insert signature)
(backward-char (length signature)))
(unless report-emacs-bug-no-explanations
(when (string-match "@gnu\\.org^" reporting-address)
(insert "This bug report will be sent to the Free Software Foundation,\n")
(let ((pos (point)))
(insert "not to your local site managers!")
(put-text-property pos (point) 'face 'highlight)))
(insert "\nPlease write in ")
(let ((pos (point)))
(insert "English")
(put-text-property pos (point) 'face 'highlight))
(insert " if possible, because the Emacs maintainers
usually do not have translators to read other languages for them.\n\n")
(insert (format "Your bug report will be posted to the %s mailing list"
reporting-address))
(if pretest-p
(insert ".\n\n")
(insert ",\nand to the gnu.emacs.bug news group.\n\n")))
(insert "Please describe exactly what actions triggered the bug\n"
"and the precise symptoms of the bug:\n\n")
(add-text-properties (point) (save-excursion (mail-text) (point))
prompt-properties)
(setq user-point (point))
(insert "\n\n")
(insert "If Emacs crashed, and you have the Emacs process in the gdb debugger,\n"
"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)
(insert "If you would like to further debug the crash, please read the file\n"
debug-file " for instructions.\n")))
(add-text-properties (1+ user-point) (point) prompt-properties)
(insert "\n\nIn " (emacs-version) "\n")
(if (fboundp 'x-server-vendor)
(condition-case nil
(insert "Windowing system distributor `" (x-server-vendor)
"', version "
(mapconcat 'number-to-string (x-server-version) ".") "\n")
(error t)))
(if (and system-configuration-options
(not (equal system-configuration-options "")))
(insert "configured using `configure "
system-configuration-options "'\n\n"))
(insert "Important settings:\n")
(mapcar
'(lambda (var)
(insert (format " value of $%s: %s\n" var (getenv var))))
'("LC_ALL" "LC_COLLATE" "LC_CTYPE" "LC_MESSAGES"
"LC_MONETARY" "LC_NUMERIC" "LC_TIME" "LANG"))
(insert (format " locale-coding-system: %s\n" locale-coding-system))
(insert (format " default-enable-multibyte-characters: %s\n"
default-enable-multibyte-characters))
(insert "\n")
(insert (format "Major mode: %s\n"
(buffer-local-value 'mode-name from-buffer)))
(insert "\n")
(insert "Minor modes in effect:\n")
(dolist (mode minor-mode-list)
(and (boundp mode) (buffer-local-value mode from-buffer)
(insert (format " %s: %s\n" mode
(buffer-local-value mode from-buffer)))))
(insert "\n")
(insert "Recent input:\n")
(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))))
(use-local-map (nconc (make-sparse-keymap) (current-local-map)))
(define-key (current-local-map) "\C-c\C-i" 'report-emacs-bug-info)
(unless report-emacs-bug-no-explanations
(with-output-to-temp-buffer "*Bug Help*"
(if (eq mail-user-agent 'sendmail-user-agent)
(princ (substitute-command-keys
"Type \\[mail-send-and-exit] to send the bug report.\n")))
(princ (substitute-command-keys
"Type \\[kill-buffer] RET to cancel (don't send it).\n"))
(terpri)
(princ (substitute-command-keys
"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 to supply so that the bug can be fixed.
Type SPC to scroll through this section and its subsections."))))
(make-local-variable 'mail-send-hook)
(add-hook 'mail-send-hook 'report-emacs-bug-hook)
(save-excursion
(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 (point-min) (point))))
(goto-char user-point)))
(defun report-emacs-bug-info ()
"Go to the Info node on reporting Emacs bugs."
(interactive)
(info)
(Info-directory)
(Info-menu "emacs")
(Info-goto-node "Bugs"))
(defun report-emacs-bug-hook ()
(save-excursion
(save-excursion
(goto-char (point-max))
(skip-chars-backward " \t\n")
(if (and (= (- (point) (point-min))
(length report-emacs-bug-orig-text))
(equal (buffer-substring (point-min) (point))
report-emacs-bug-orig-text))
(error "No text entered in bug report")))
(save-excursion
(goto-char (point-min))
(skip-chars-forward "\0-\177")
(if (not (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)))))))
(if (or report-emacs-bug-no-confirmation
(yes-or-no-p
"Send this bug report to the Emacs maintainers? "))
nil
(goto-char (point-min))
(if (search-forward "To: ")
(let ((pos (point)))
(end-of-line)
(delete-region pos (point))))
(kill-local-variable 'mail-send-hook)
(with-output-to-temp-buffer "*Bug Help*"
(princ (substitute-command-keys "\
You invoked the command M-x report-emacs-bug,
but you decided not to mail the bug report to the Emacs maintainers.
If you want to mail it to someone else instead,
please insert the proper e-mail address after \"To: \",
and send the mail again using \\[mail-send-and-exit].")))
(error "M-x report-emacs-bug was cancelled, please read *Bug Help* buffer"))
(mail-text)
(let ((pos (1- (point))))
(while (setq pos (text-property-any pos (point-max)
'field 'emacsbug-prompt))
(delete-region pos (field-end (1+ pos)))))))
(provide 'emacsbug)