Add basic integration for debbugs

Message-ID: <20230610095858.26982-6-jlicht@fsfe.org>

3 files changed, 74 insertions, 3 deletions

diff --git a/Documentation/piem.texi b/Documentation/piem.texi
index 99185d3..091a054 100644
--- a/Documentation/piem.texi
+++ b/Documentation/piem.texi
@@ -222,6 +222,7 @@ command @code{piem-clear-merged-inboxes} to clear the cache.
 
 @node Enabling integration libraries
 @section Enabling integration libraries
+@findex piem-debbugs-mode
 @findex piem-elfeed-mode
 @findex piem-eww-mode
 @findex piem-gnus-mode
@@ -233,6 +234,7 @@ particular Emacs modes to link a buffer with a registered inbox.  piem
 currently has libraries to support
 
 @itemize
+@item Debbugs
 @item EWW
 @item Elfeed
 @item Gnus
diff --git a/Makefile b/Makefile
index b8d9fe6..917cbaa 100644
--- a/Makefile
+++ b/Makefile
@@ -4,9 +4,10 @@ EMACS   = emacs
 # Rely on EMACSLOADPATH for everything but the current directory.
 BATCH   = $(EMACS) --batch -Q -L . -L tests
 
-EL = piem.el piem-b4.el piem-elfeed.el piem-eww.el piem-gnus.el \
-     piem-lei.el piem-maildir.el piem-notmuch.el piem-rmail.el \
-     tests/piem-lei-tests.el tests/piem-rmail-tests.el tests/piem-tests.el
+EL = piem.el piem-b4.el piem-debbugs.el piem-elfeed.el piem-eww.el	\
+     piem-gnus.el piem-lei.el piem-maildir.el piem-notmuch.el		\
+     piem-rmail.el tests/piem-lei-tests.el tests/piem-rmail-tests.el	\
+     tests/piem-tests.el
 ELC = $(EL:.el=.elc)
 
 all: compile Documentation/piem.info piem-autoloads.el
@@ -33,6 +34,7 @@ docs: Documentation/piem.html Documentation/piem.info
 
 piem-b4.elc: piem-b4.el piem.elc
 piem-elfeed.elc: piem-elfeed.el piem.elc
+piem-debbugs.elc: piem-debbugs.el piem.elc
 piem-eww.elc: piem-eww.el piem.elc
 piem-gnus.elc: piem-gnus.el piem.elc
 piem-lei.elc: piem-lei.el piem.elc
diff --git a/piem-debbugs.el b/piem-debbugs.el
new file mode 100644
index 0000000..00b0354
--- /dev/null
+++ b/piem-debbugs.el
@@ -0,0 +1,67 @@
+;;; piem-debbugs.el --- Debbugs integration for piem  -*- lexical-binding: t; -*-
+
+;; Copyright all piem contributors <piem@inbox.kyleam.com>
+
+;; Author: Jelle Licht <jlicht@fsfe.org>
+;; Keywords: vc, tools
+;; Package-Requires: ((emacs "26.3")(debbugs "0.29"))
+
+;; This program is free software; you can redistribute it and/or modify
+;; it under the terms of the GNU General Public License as published by
+;; the Free Software Foundation, either version 3 of the License, or
+;; (at your option) any later version.
+
+;; This program 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
+;; along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+;;; Commentary:
+
+;; This library provides a minor mode, `piem-debbugs-mode', that modifies
+;; `piem' variables to teach functions like `piem-inbox' how to
+;; extract information from Debbugs buffers.
+
+;;; Code:
+
+(require 'debbugs-gnu)
+(require 'piem)
+
+(defgroup piem-debbugs nil
+  "Debbugs integration for piem."
+  :group 'piem)
+
+(defun piem-debbugs-get-inbox ()
+  "Return inbox name from a Debbugs buffer."
+  (when (and (derived-mode-p 'debbugs-gnu-mode)
+             (boundp 'debbugs-gnu-local-query))
+    (when-let ((gnu-package (alist-get 'package debbugs-gnu-local-query)))
+      (piem-inbox-by-gnu-package-match gnu-package))))
+
+(defun piem-debbugs-get-mid ()
+  "Return the message ID of a Debbugs buffer."
+  (when (derived-mode-p 'debbugs-gnu-mode)
+    (let ((msgid (alist-get 'msgid (debbugs-gnu-current-status))))
+      (when (stringp msgid)
+        (string-trim msgid "<" ">")))))
+
+;;;###autoload
+(define-minor-mode piem-debbugs-mode
+  "Toggle Debbugs support for piem.
+With a prefix argument ARG, enable piem-debbugs mode if ARG is
+positive, and disable it otherwise.  If called from Lisp, enable
+the mode if ARG is omitted or nil."
+  :global t
+  :init-value nil
+  (if piem-debbugs-mode
+      (progn
+        (add-hook 'piem-get-inbox-functions #'piem-debbugs-get-inbox)
+        (add-hook 'piem-get-mid-functions #'piem-debbugs-get-mid))
+    (remove-hook 'piem-get-inbox-functions #'piem-debbugs-get-inbox)
+    (remove-hook 'piem-get-mid-functions #'piem-debbugs-get-mid)))
+
+;;; piem-debbugs.el ends here
+(provide 'piem-debbugs)