1 ;;; debbugs-gnu.el --- interface for the GNU bug tracker
3 ;; Copyright (C) 2011 Free Software Foundation, Inc.
5 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
6 ;; Keywords: comm, hypermedia, maint
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
31 (eval-when-compile (require 'cl))
33 (autoload 'gnus-read-ephemeral-emacs-bug-group "gnus-group")
34 (autoload 'mail-header-subject "nnheader")
35 (autoload 'gnus-summary-article-header "gnus-sum")
36 (autoload 'message-make-from "message")
38 (defface debbugs-new '((t (:foreground "red")))
39 "Face for new reports that nobody has answered.")
41 (defface debbugs-handled '((t (:foreground "ForestGreen")))
42 "Face for new reports that nobody has answered.")
44 (defface debbugs-stale '((t (:foreground "orange")))
45 "Face for new reports that nobody has answered.")
47 (defface debbugs-done '((t (:foreground "DarkGrey")))
48 "Face for closed bug reports.")
50 (defvar debbugs-widget-map
51 (let ((map (make-sparse-keymap)))
52 (define-key map "\r" 'widget-button-press)
55 (defun debbugs-emacs (severities &optional package suppress-done archivedp)
56 "List all outstanding Emacs bugs."
59 (completing-read "Severity: "
60 '("important" "normal" "minor" "wishlist")
62 (unless (consp severities)
63 (setq severities (list severities)))
64 (let ((debbugs-port "gnu.org")
67 (dolist (severity severities)
69 (debbugs-get-bugs :package (or package "emacs")
71 :archive (if archivedp
73 (setq ids (sort ids '<))
75 (if (> (length ids) default)
76 (let ((cursor-in-echo-area nil))
81 "How many reports (available %d, default %d): "
85 (number-to-string default))))))
87 (if (> (length ids) default)
92 curr-ids (butlast ids (- (length ids) default))
98 :follow-link 'mouse-face
99 :notify (lambda (widget &rest ignore)
100 (debbugs-show-reports
101 (widget-get widget :suppress-done)
103 (widget-get widget :widgets)))
104 :keymap debbugs-widget-map
105 :suppress-done suppress-done
106 :buffer-name (format "*Emacs Bugs*<%d>" i)
107 :bug-ids (butlast ids (- (length ids) default))
109 ids (last ids (- (length ids) default))))
110 (debbugs-show-reports suppress-done (car widgets) widgets))
112 (debbugs-show-reports suppress-done
115 :buffer-name "*Emacs Bugs*"
119 (defun debbugs-show-reports (suppress-done widget widgets)
120 "Show bug reports as given in WIDGET property :bug-ids."
121 (pop-to-buffer (get-buffer-create (widget-get widget :buffer-name)))
123 (let ((inhibit-read-only t))
127 (widget-insert "Page:")
131 (widget-put obj :widgets widgets)
133 (widget-put obj :button-face 'widget-button-pressed)
134 (widget-put obj :button-face 'widget-button-face))
135 (widget-apply obj :create))
137 (widget-insert "\n\n"))
139 (dolist (status (sort (apply 'debbugs-get-status
140 (widget-get widget :bug-ids))
142 (< (cdr (assq 'id s1))
143 (cdr (assq 'id s2))))))
144 (when (or (not suppress-done)
145 (not (equal (cdr (assq 'pending status)) "done")))
146 (let ((address (mail-header-parse-address
147 (decode-coding-string (cdr (assq 'originator status))
149 (subject (decode-coding-string (cdr (assq 'subject status))
153 ;; Prefer the name over the address.
157 (format "%5d %-20s [%-23s] %s\n"
158 (cdr (assq 'id status))
162 (cons (cdr (assq 'severity status))
163 (cdr (assq 'keywords status)))
165 (unless (equal (cdr (assq 'pending status)) "pending")
167 (concat words "," (cdr (assq 'pending status)))))
168 (when (setq merged (cdr (assq 'mergedwith status)))
169 (setq words (format "%s,%s"
172 (mapconcat 'number-to-string merged
175 (if (> (length words) 20)
176 (propertize (substring words 0 20) 'help-echo words)
178 (if (> (length address) 23)
179 (propertize (substring address 0 23) 'help-echo address)
181 (propertize subject 'help-echo subject)))
183 (put-text-property (point) (1+ (point))
184 'debbugs-status status)
186 (+ (point) 5) (+ (point) 26)
189 ((equal (cdr (assq 'pending status)) "done")
191 ((= (cdr (assq 'date status))
192 (cdr (assq 'log_modified status)))
195 (cdr (assq 'log_modified status)))
203 (widget-insert "\nPage:")
207 (widget-put obj :widgets widgets)
209 (widget-put obj :button-face 'widget-button-pressed)
210 (widget-put obj :button-face 'widget-button-face))
211 (widget-apply obj :create))
215 (goto-char (point-min))))
217 (defvar debbugs-mode-map
218 (let ((map (make-sparse-keymap)))
219 (define-key map "\r" 'debbugs-select-report)
220 (define-key map "q" 'kill-buffer)
221 (define-key map "s" 'debbugs-toggle-sort)
222 (define-key map "d" 'debbugs-display-status)
225 (defvar debbugs-sort-state 'number)
227 (defun debbugs-mode ()
228 "Major mode for listing bug reports.
230 All normal editing commands are switched off.
233 The following commands are available:
235 \\{debbugs-mode-map}"
237 (kill-all-local-variables)
238 (setq major-mode 'debbugs-mode)
239 (setq mode-name "Debbugs")
240 (use-local-map debbugs-mode-map)
241 (set (make-local-variable 'debbugs-sort-state)
243 (buffer-disable-undo)
244 (setq truncate-lines t)
245 (setq buffer-read-only t))
247 (defvar debbugs-state-preference
250 (debbugs-handled . 3)
253 (defun debbugs-toggle-sort ()
254 "Toggle sorting by age and by state."
257 (let ((buffer-read-only nil)
258 (before-change-functions nil)
259 (current-bug (and (not (eobp))
260 (buffer-substring (point) (+ (point) 5)))))
261 (setq debbugs-sort-state
262 (if (eq debbugs-sort-state 'number)
265 (goto-char (point-min))
266 (while (and (not (eobp))
267 (not (get-text-property (point) 'debbugs-status)))
273 (goto-char (point-max))
275 (while (and (not (bobp))
276 (not (get-text-property (point) 'debbugs-status)))
280 (goto-char (point-min))
282 nil (lambda () (forward-line 1)) 'end-of-line
284 (if (eq debbugs-sort-state 'number)
285 (string-to-number (buffer-substring (point) (+ (point) 5)))
286 (or (cdr (assq (get-text-property (+ (point) 7) 'face)
287 debbugs-state-preference))
289 (if (not current-bug)
290 (goto-char (point-max))
291 (goto-char (point-min))
292 (re-search-forward (concat "^" current-bug) nil t))))
294 (defvar debbugs-bug-number nil)
296 (defun debbugs-current-id ()
297 (or (cdr (assq 'id (get-text-property (line-beginning-position)
299 (error "No bug on the current line")))
301 (defun debbugs-display-status (id)
302 "Display the status of the report on the current line."
303 (interactive (list (debbugs-current-id)))
304 (let ((status (get-text-property (line-beginning-position)
306 (pop-to-buffer "*Bug Status*")
308 (pp status (current-buffer))
309 (goto-char (point-min))))
311 (defun debbugs-select-report (id)
312 "Select the report on the current line."
313 (interactive (list (debbugs-current-id)))
314 ;; We open the report messages.
315 (gnus-read-ephemeral-emacs-bug-group
316 id (cons (current-buffer)
317 (current-window-configuration)))
318 (with-current-buffer (window-buffer (selected-window))
319 (debbugs-summary-mode 1)
320 (set (make-local-variable 'debbugs-bug-number) id)))))
322 (defvar debbugs-summary-mode-map
323 (let ((map (make-sparse-keymap)))
324 (define-key map "C" 'debbugs-send-control-message)
327 (define-minor-mode debbugs-summary-mode
328 "Minor mode for providing a debbugs interface in Gnus summary buffers.
330 \\{debbugs-summary-mode-map}"
331 :lighter " Debbugs" :keymap debbugs-summary-mode-map
332 (set (make-local-variable 'gnus-posting-styles)
335 (with-current-buffer gnus-article-copy
336 (set (make-local-variable 'message-prune-recipient-rules)
337 '((".*@debbugs.*" "emacs-pretest-bug")
338 (".*@debbugs.*" "bug-gnu-emacs")))
339 (set (make-local-variable 'message-alter-recipients-function)
341 (if (string-match "\\([0-9]+\\)@donarmstrong" (car address))
342 (let ((new (format "%s@debbugs.gnu.org"
343 (match-string 1 (car address)))))
347 (defun debbugs-send-control-message (message)
348 "Send a control message for the current bug report.
349 You can set the severity or add a tag, or close the report. If
350 you use the special \"done\" MESSAGE, the report will be marked as
351 fixed, and then closed."
353 (list (completing-read
355 '("important" "normal" "minor" "wishlist"
357 "unarchive" "reopen" "close"
359 "patch" "wontfix" "moreinfo" "unreproducible" "fixed" "notabug")
361 (let* ((id debbugs-bug-number) ; Set on group entry.
363 (when (member message '("close" "done"))
367 ;; Emacs development versions.
369 "^\\([0-9]+\\)\\.\\([0-9]+\\)\\.\\([0-9]+\\)\\." emacs-version)
371 (match-string 1 emacs-version)
372 (1+ (string-to-number (match-string 2 emacs-version)))))
373 ;; Emacs release versions.
375 "^\\([0-9]+\\)\\.\\([0-9]+\\)\\.\\([0-9]+\\)$" emacs-version)
377 (match-string 1 emacs-version)
378 (match-string 2 emacs-version)))
379 (t emacs-version))))))
381 (insert "To: control@debbugs.gnu.org\n"
382 "From: " (message-make-from) "\n"
383 (format "Subject: control message for bug #%d\n" id)
386 ((member message '("unarchive" "reopen"))
387 (format "%s %d\n" message id))
388 ((member message '("merge" "forcemerge"))
389 (format "%s %d %s\n" message id
390 (read-string "Merge with bug #: ")))
391 ((equal message "close")
392 (format "close %d %s\n" id version))
393 ((equal message "done")
394 (format "tags %d fixed\nclose %d %s\n" id id version))
395 ((member message '("important" "normal" "minor" "wishlist"))
396 (format "severity %d %s\n" id message))
398 (format "tags %d %s\n" id message))))
399 (funcall send-mail-function))))
401 (provide 'debbugs-gnu)
405 ;; * Widget-oriented bug overview like webDDTs.
406 ;; * Actions on bugs.
407 ;; * Integration into gnus (nnir).
409 ;;; debbugs-gnu.el ends here