code.delx.au - gnu-emacs-elpa/blob - gnorb-gnus.el

   1 ;;; gnorb-gnus.el --- The gnus-centric fuctions of gnorb
   2
   3 ;; Copyright (C) 2014  Eric Abrahamsen
   4
   5 ;; Author: Eric Abrahamsen <eric@ericabrahamsen.net>
   6 ;; Keywords:
   7
   8 ;; This program is free software; you can redistribute it and/or modify
   9 ;; it under the terms of the GNU General Public License as published by
  10 ;; the Free Software Foundation, either version 3 of the License, or
  11 ;; (at your option) any later version.
  12
  13 ;; This program is distributed in the hope that it will be useful,
  14 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 ;; GNU General Public License for more details.
  17
  18 ;; You should have received a copy of the GNU General Public License
  19 ;; along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20
  21 ;;; Commentary:
  22
  23 ;;
  24
  25 ;;; Code:
  26
  27 (eval-when-compile
  28   (require 'cl))
  29
  30 (require 'gnus)
  31 (require 'gnorb-utils)
  32
  33 (declare-function org-gnus-article-link "org-gnus"
  34                   (group newsgroups message-id x-no-archive))
  35 (declare-function org-gnus-follow-link "org-gnus"
  36                   (group article))
  37
  38 (defgroup gnorb-gnus nil
  39   "The Gnus bits of Gnorb."
  40   :tag "Gnorb Gnus"
  41   :group 'gnorb)
  42
  43
  44 (defcustom gnorb-gnus-mail-search-backends
  45   '((notmuch (lambda (terms)
  46                (mapconcat
  47                 (lambda (m)
  48                   (replace-regexp-in-string "\\." "\\\\." m))
  49                 terms " OR "))
  50              notmuch-search)
  51     (mairix (lambda (terms)
  52               (mapconcat 'identity
  53                          terms ","))
  54             mairix-search)
  55     (namazu (lambda (terms)
  56               (mapconcat 'identity
  57                          terms " or "))
  58             namazu-search))
  59   "Various backends for mail search.
  60
  61 An alist of backends, where each element consists of three parts:
  62 the symbol name of the backend, a lambda form which receives a
  63 list of email addresses and returns a properly-formatted search
  64 string, and the symbol name of the function used to initiate the
  65 search."
  66   :group 'gnorb-gnus
  67   :type 'list)
  68
  69 (defcustom gnorb-gnus-mail-search-backend nil
  70   "Mail search backend currently in use. One of the three symbols
  71 notmuch, namazu, or mairix."
  72   :group 'gnorb-gnus
  73   :type 'symbol)
  74
  75 (defcustom gnorb-gnus-capture-always-attach nil
  76   "Always prompt about attaching attachments when capturing from
  77   a Gnus message, even if the template being used hasn't
  78   specified the :gnus-attachments key.
  79
  80 Basically behave as if all attachments have \":gnus-attachments t\"."
  81   :group 'gnorb-gnus
  82   :type 'boolean)
  83
  84 (defcustom gnorb-gnus-new-todo-capture-key nil
  85   "Key for the capture template to use when creating a new TODO
  86   from an outgoing message."
  87   :group 'gnorb-gnus
  88   :type 'string)
  89
  90 (defcustom gnorb-gnus-hint-relevant-article t
  91   "When opening a gnus message, should gnorb let you know if the
  92   message is relevant to an existing TODO?"
  93   :group 'gnorb-gnus
  94   :type 'boolean)
  95
  96 (defcustom gnorb-gnus-summary-mark-format-letter "g"
  97   "Format letter to be used as part of your
  98   `gnus-summary-line-format', to indicate in the *Summary* buffer
  99   which articles might be relevant to TODOs. Since this is a user
 100   format code, it should be prefixed with %u, eg %ug. It will
 101   result in the insertion of the value of
 102   `gnorb-gnus-summary-mark', for relevant messages, or
 103   else a space."
 104   :group 'gnorb-gnus
 105   :type 'string)
 106
 107 (defcustom gnorb-gnus-summary-mark "¡"
 108   "Default mark to insert in the summary format line of articles
 109   that are likely relevant to existing TODO headings."
 110   :group 'gnorb-gnus
 111   :type 'string)
 112
 113 (defcustom gnorb-gnus-trigger-refile-targets
 114   '((org-agenda-files :maxlevel . 4))
 115   "A value to use as an equivalent of `org-refile-targets' (which
 116   see) when offering trigger targets for
 117   `gnorb-gnus-incoming-do-todo'."
 118   :group 'gnorb-gnus
 119   :type 'list)
 120
 121 (defcustom gnorb-gnus-sent-groups nil
 122   "A list of strings indicating sent mail groups.
 123
 124 In some cases, Gnorb can't detect where your sent messages are
 125 stored (ie if you're using IMAP sent mail folders instead of
 126 local archiving. If you want Gnorb to be able to find sent
 127 messages, this option can help it do that. It should be set to a
 128 list of strings, which are assumed to be fully qualified
 129 server+group combinations, ie \"nnimap+Server:[Gmail]/Sent
 130 Mail\", or something similar. This only has to be done once for
 131 each message."
 132   :group 'gnorb-gnus
 133   :type 'list)
 134
 135 (defvar gnorb-gnus-capture-attachments nil
 136   "Holding place for attachment names during the capture
 137   process.")
 138
 139 ;;; What follows is a very careful copy-pasta of bits and pieces from
 140 ;;; mm-decode.el and gnus-art.el. Voodoo was involved.
 141
 142 ;;;###autoload
 143 (defun gnorb-gnus-article-org-attach (n)
 144   "Save MIME part N, which is the numerical prefix, of the
 145   article under point as an attachment to the specified org
 146   heading."
 147   (interactive "P")
 148   (gnus-article-part-wrapper n 'gnorb-gnus-attach-part))
 149
 150 ;;;###autoload
 151 (defun gnorb-gnus-mime-org-attach ()
 152   "Save the MIME part under point as an attachment to the
 153   specified org heading."
 154   (interactive)
 155   (gnus-article-check-buffer)
 156   (let ((data (get-text-property (point) 'gnus-data)))
 157     (when data
 158       (gnorb-gnus-attach-part data))))
 159
 160 (defun gnorb-gnus-attach-part (handle &optional org-heading)
 161   "Attach HANDLE to an existing org heading."
 162   (let* ((filename (gnorb-gnus-save-part handle))
 163          (org-refile-targets gnorb-gnus-trigger-refile-targets)
 164          (headers (gnus-data-header
 165                    (gnus-data-find
 166                     (gnus-summary-article-number))))
 167          (tracked-headings (gnorb-find-tracked-headings headers))
 168          (target-heading
 169           (gnorb-choose-trigger-heading tracked-headings)))
 170     (require 'org-attach)
 171     (save-window-excursion
 172       (org-id-goto target-heading)
 173       (org-attach-attach filename nil 'mv))))
 174
 175 (defun gnorb-gnus-save-part (handle)
 176   (let ((filename (or (mail-content-type-get
 177                        (mm-handle-disposition handle) 'filename)
 178                       (mail-content-type-get
 179                        (mm-handle-type handle) 'name))))
 180     (setq filename
 181           (gnus-map-function mm-file-name-rewrite-functions
 182                              (file-name-nondirectory filename)))
 183     (setq filename (expand-file-name filename gnorb-tmp-dir))
 184     (mm-save-part-to-file handle filename)
 185     filename))
 186
 187 (defun gnorb-gnus-collect-all-attachments (&optional capture-p store)
 188   "Collect all the attachments from the message under point, and
 189 save them into `gnorb-tmp-dir'."
 190   (save-window-excursion
 191     (when capture-p
 192       (set-buffer (org-capture-get :original-buffer)))
 193     (unless (memq major-mode '(gnus-summary-mode gnus-article-mode))
 194       (error "Only works in Gnus summary or article buffers"))
 195     (let ((article (gnus-summary-article-number))
 196           mime-handles)
 197       (when (or (null gnus-current-article)
 198                 (null gnus-article-current)
 199                 (/= article (cdr gnus-article-current))
 200                 (not (equal (car gnus-article-current) gnus-newsgroup-name)))
 201         (gnus-summary-display-article article))
 202       (gnus-eval-in-buffer-window gnus-article-buffer
 203         (setq mime-handles (cl-remove-if-not
 204                             (lambda (h)
 205                               (let ((disp (mm-handle-disposition (cdr h))))
 206                                 (and (member (car disp)
 207                                              '("inline" "attachment"))
 208                                      (mail-content-type-get disp 'filename))))
 209                             gnus-article-mime-handle-alist)))
 210       (when mime-handles
 211         (dolist (h mime-handles)
 212           (let ((filename
 213                  (gnorb-gnus-save-part (cdr h))))
 214             (when (or capture-p store)
 215               (push filename gnorb-gnus-capture-attachments))))))))
 216
 217 ;;; Make the above work in the capture process
 218
 219 (defun gnorb-gnus-capture-attach ()
 220   (when (and (or gnorb-gnus-capture-always-attach
 221                  (org-capture-get :gnus-attachments))
 222              (with-current-buffer
 223                  (org-capture-get :original-buffer)
 224                (memq major-mode '(gnus-summary-mode gnus-article-mode))))
 225     (require 'org-attach)
 226     (setq gnorb-gnus-capture-attachments nil)
 227     (gnorb-gnus-collect-all-attachments t)
 228     (map-y-or-n-p
 229      (lambda (a)
 230        (format "Attach %s to capture heading? "
 231                (file-name-nondirectory a)))
 232      (lambda (a) (org-attach-attach a nil 'mv))
 233      gnorb-gnus-capture-attachments
 234      '("file" "files" "attach"))
 235     (setq gnorb-gnus-capture-attachments nil)))
 236
 237 (add-hook 'org-capture-mode-hook 'gnorb-gnus-capture-attach)
 238
 239 (defun gnorb-gnus-capture-abort-cleanup ()
 240   (with-no-warnings ; For `org-note-abort'
 241    (when (and org-note-abort
 242               (org-capture-get :gnus-attachments))
 243      (condition-case error
 244          (progn (org-attach-delete-all)
 245                 (setq abort-note 'clean)
 246                 ;; remove any gnorb-mail-header values here
 247                 )
 248        (error
 249         (setq abort-note 'dirty))))))
 250
 251 (add-hook 'org-capture-prepare-finalize-hook
 252           'gnorb-gnus-capture-abort-cleanup)
 253
 254 ;;; Storing, removing, and acting on Org headers in messages.
 255
 256 (defvar gnorb-gnus-message-info nil
 257   "Place to store the To, Subject, Date, and Message-ID headers
 258   of the currently-sending or last-sent message.")
 259
 260 (defun gnorb-gnus-check-outgoing-headers ()
 261   "Save the value of the `gnorb-mail-header' for the current
 262 message; multiple header values returned as a string. Also save
 263 information about the outgoing message into
 264 `gnorb-gnus-message-info'."
 265   (save-restriction
 266     (message-narrow-to-headers)
 267     (setq gnorb-gnus-message-info nil)
 268     (let* ((org-ids (mail-fetch-field gnorb-mail-header nil nil t))
 269            (msg-id (mail-fetch-field "Message-ID"))
 270            (refs (mail-fetch-field "References"))
 271            (in-reply-to (mail-fetch-field "In-Reply-To"))
 272            (to (if (message-news-p)
 273                    (mail-fetch-field "Newsgroups")
 274                  (mail-fetch-field "To")))
 275            (from (mail-fetch-field "From"))
 276            (subject (mail-fetch-field "Subject"))
 277            (date (mail-fetch-field "Date"))
 278            ;; If we can get a link, that's awesome.
 279            (gcc (mail-fetch-field "Gcc"))
 280            (link (or (and gcc
 281                           (org-store-link nil))
 282                      nil))
 283            (group (ignore-errors (car (split-string link "#")))))
 284       ;; If we can't make a real link, then save some information so
 285       ;; we can fake it.
 286       (when in-reply-to
 287         (setq refs (concat refs " " in-reply-to)))
 288       (when refs
 289         (setq refs (gnus-extract-references refs)))
 290       (setq gnorb-gnus-message-info
 291             `(:subject ,subject :msg-id ,msg-id
 292                        :to ,to :from ,from
 293                        :link ,link :date ,date :refs ,refs
 294                        :group ,group))
 295       (if org-ids
 296           (progn
 297             (require 'gnorb-org)
 298             (setq gnorb-message-org-ids org-ids)
 299             ;; `gnorb-org-setup-message' may have put this here, but
 300             ;; if we're working from a draft, or triggering this from
 301             ;; a reply, it might not be there yet.
 302             (add-to-list 'message-exit-actions
 303                          'gnorb-org-restore-after-send t))
 304         (setq gnorb-message-org-ids nil)))))
 305
 306 (add-hook 'message-header-hook 'gnorb-gnus-check-outgoing-headers)
 307
 308 ;;;###autoload
 309 (defun gnorb-gnus-outgoing-do-todo (&optional arg)
 310   "Use this command to use the message currently being composed
 311 as an email todo action.
 312
 313 If it's a new message, or a reply to a message that isn't
 314 referenced by any TODOs, a new TODO will be created.
 315
 316 If it references an existing TODO, you'll be prompted to trigger
 317 a state-change or a note on that TODO after the message is sent.
 318
 319 You can call it with a prefix arg to force choosing an Org
 320 subtree to associate with.
 321
 322 If you've already called this command, but realize you made a
 323 mistake, you can call this command with a double prefix to reset
 324 the association.
 325
 326 If a new todo is made, it needs a capture template: set
 327 `gnorb-gnus-new-todo-capture-key' to the string key for the
 328 appropriate capture template. If you're using a gnus-based
 329 archive method (ie you have `gnus-message-archive-group' set to
 330 something, and your outgoing messages have a \"Fcc\" header),
 331 then a real link will be made to the outgoing message, and all
 332 the gnus-type escapes will be available (see the Info
 333 manual (org) Template expansion section). If you don't, then the
 334 %:subject, %:to, %:toname, %:toaddress, and %:date escapes for
 335 the outgoing message will still be available -- nothing else will
 336 work."
 337   (interactive "P")
 338   (let ((org-refile-targets gnorb-gnus-trigger-refile-targets)
 339         (compose-marker (make-marker))
 340         header-ids ref-ids rel-headings
 341         gnorb-window-conf in-reply-to)
 342     (when (equal arg '(4))
 343       (setq rel-headings
 344             (org-refile-get-location "Trigger action on" nil t))
 345       (setq rel-headings
 346             (list (list (save-window-excursion
 347                           (find-file (nth 1 rel-headings))
 348                           (goto-char (nth 3 rel-headings))
 349                           (org-id-get-create))))))
 350     (if (not (eq major-mode 'message-mode))
 351         ;; The message is already sent, so we're relying on whatever was
 352         ;; stored into `gnorb-gnus-message-info'.
 353         (if (equal arg '(16))
 354             (user-error "A double prefix is only useful with an
 355             unsent message.")
 356           (if arg
 357               (progn
 358                 (push (car rel-headings) gnorb-message-org-ids)
 359                 (gnorb-org-restore-after-send))
 360             (setq ref-ids (plist-get gnorb-gnus-message-info :refs))
 361             (if ref-ids
 362                 ;; the message might be relevant to some TODO
 363                 ;; heading(s). But if there had been org-id
 364                 ;; headers, they would already have been
 365                 ;; handled when the message was sent.
 366                 (progn
 367                   (setq rel-headings (gnorb-find-visit-candidates ref-ids))
 368                   (if (not rel-headings)
 369                       (gnorb-gnus-outgoing-make-todo-1)
 370                     (dolist (h rel-headings)
 371                       (push h gnorb-message-org-ids))
 372                     (gnorb-org-restore-after-send)))
 373               ;; not relevant, just make a new TODO
 374               (gnorb-gnus-outgoing-make-todo-1))))
 375       ;; We are still in the message composition buffer, so let's see
 376       ;; what we've got.
 377
 378       (if (equal arg '(16))
 379           ;; Double prefix arg means delete the association we already
 380           ;; made.
 381           (save-excursion
 382             (save-restriction
 383               (widen)
 384               (setq message-exit-actions
 385                     (remove 'gnorb-org-restore-after-send
 386                             (remove 'gnorb-gnus-outgoing-make-todo-1
 387                                     message-exit-actions)))
 388               (message-narrow-to-headers-or-head)
 389               (message-remove-header
 390                gnorb-mail-header)
 391               (message "Message associations have been reset")))
 392         ;; Save-excursion won't work, because point will move if we
 393         ;; insert headings.
 394         (move-marker compose-marker (point))
 395         (save-restriction
 396           (widen)
 397           (message-narrow-to-headers-or-head)
 398           (setq header-ids (mail-fetch-field gnorb-mail-header nil nil t))
 399           ;; With a prefix arg we do not check references, because the
 400           ;; whole point is to add new references. We still want to know
 401           ;; what org id headers are present, though, so we don't add
 402           ;; duplicates.
 403           (setq ref-ids (unless arg (mail-fetch-field "References" t)))
 404           (setq in-reply-to (unless arg (mail-fetch-field "In-Reply-to" t)))
 405           (when in-reply-to
 406             (setq ref-ids (concat ref-ids " " in-reply-to)))
 407           (when ref-ids
 408             ;; if the References header points to any message ids that are
 409             ;; tracked by TODO headings...
 410             (setq rel-headings (gnorb-find-visit-candidates ref-ids)))
 411           (when rel-headings
 412             (goto-char (point-min))
 413             (dolist (h (delete-dups rel-headings))
 414               ;; then get the org-ids of those headings, and insert
 415               ;; them into this message as headers. If the id was
 416               ;; already present in a header, don't add it again.
 417               (unless (member h header-ids)
 418                 (goto-char (point-at-bol))
 419                 (open-line 1)
 420                 (message-insert-header
 421                  (intern gnorb-mail-header)
 422                  h)
 423                 ;; tell the rest of the function that this is a relevant
 424                 ;; message
 425                 (push h header-ids)))))
 426         (goto-char compose-marker)
 427         (add-to-list
 428          'message-exit-actions
 429          (if header-ids
 430              'gnorb-org-restore-after-send
 431            'gnorb-gnus-outgoing-make-todo-1)
 432          t)
 433         (message
 434          (if header-ids
 435              "Message will trigger TODO state-changes after sending"
 436            "A TODO will be made from this message after it's sent"))))))
 437
 438 (defun gnorb-gnus-outgoing-make-todo-1 ()
 439   (unless gnorb-gnus-new-todo-capture-key
 440     (error "No capture template key set, customize gnorb-gnus-new-todo-capture-key"))
 441   (let* ((link (plist-get gnorb-gnus-message-info :link))
 442          (group (plist-get gnorb-gnus-message-info :group))
 443          (date (plist-get gnorb-gnus-message-info :date))
 444          (date-ts (and date
 445                        (ignore-errors
 446                          (format-time-string
 447                           (org-time-stamp-format t)
 448                           (date-to-time date)))))
 449          (date-ts-ia (and date
 450                           (ignore-errors
 451                             (format-time-string
 452                              (org-time-stamp-format t t)
 453                              (date-to-time date)))))
 454          (msg-id (plist-get gnorb-gnus-message-info :msg-id))
 455          (sender (plist-get gnorb-gnus-message-info :from))
 456          (subject (plist-get gnorb-gnus-message-info :subject))
 457          ;; Convince Org we already have a link stored, even if we
 458          ;; don't.
 459          (org-capture-link-is-already-stored t))
 460     (if link
 461         ;; Even if you make a link to not-yet-sent messages, even if
 462         ;; you've saved the draft and it has a Date header, that
 463         ;; header isn't saved into the link plist. So fake that, too.
 464         (org-add-link-props
 465          :date date
 466          :date-timestamp date-ts
 467          :date-timestamp-inactive date-ts-ia
 468          :annotation link)
 469       (org-store-link-props
 470        :subject (plist-get gnorb-gnus-message-info :subject)
 471        :to (plist-get gnorb-gnus-message-info :to)
 472        :date date
 473        :date-timestamp date-ts
 474        :date-timestamp-inactive date-ts-ia
 475        :message-id msg-id
 476        :annotation link))
 477     (org-capture nil gnorb-gnus-new-todo-capture-key)
 478     (when msg-id
 479       (org-entry-put (point) gnorb-org-msg-id-key msg-id)
 480       (gnorb-registry-make-entry msg-id sender subject (org-id-get-create) group))))
 481
 482 ;;; If an incoming message should trigger state-change for a Org todo,
 483 ;;; call this function on it.
 484
 485 ;;;###autoload
 486 (defun gnorb-gnus-incoming-do-todo (arg &optional id)
 487   "Call this function from a received gnus message to store a
 488 link to the message, prompt for a related Org heading, visit the
 489 heading, and either add a note or trigger a TODO state change.
 490 Set `gnorb-trigger-todo-default' to 'note or 'todo (you can
 491 get the non-default behavior by calling this function with a
 492 prefix argument), or to 'prompt to always be prompted.
 493
 494 In some cases, Gnorb can guess for you which Org heading you
 495 probably want to trigger, which can save some time. It does this
 496 by looking in the References header, and seeing if any of the IDs
 497 there match the value of the `gnorb-org-msg-id-key' property for
 498 any headings. In order for this to work, you will have to have
 499 loaded org-id, and have the variable `org-id-track-globally' set
 500 to t (it is, by default)."
 501   (interactive "P")
 502   (when (not (memq major-mode '(gnus-summary-mode gnus-article-mode)))
 503     (user-error "Only works in gnus summary or article mode"))
 504   ;; We should only store a link if it's not already at the head of
 505   ;; `org-stored-links'. There's some duplicate storage, at
 506   ;; present. Take a look at calling it non-interactively.
 507   (setq gnorb-window-conf (current-window-configuration))
 508   (move-marker gnorb-return-marker (point))
 509   (setq gnorb-gnus-message-info nil)
 510   (let* ((headers (gnus-data-header
 511                    (gnus-data-find
 512                     (gnus-summary-article-number))))
 513          (msg-id (mail-header-id headers))
 514          (from (mail-header-from headers))
 515          (subject (mail-header-subject headers))
 516          (date (mail-header-date headers))
 517          (to (cdr (assoc 'To (mail-header-extra headers))))
 518          (group gnus-newsgroup-name)
 519          (link (call-interactively 'org-store-link))
 520          (org-refile-targets gnorb-gnus-trigger-refile-targets)
 521          (ref-msg-ids (concat (mail-header-references headers) " "
 522                               msg-id))
 523          (related-headings
 524           (when (and (null id) ref-msg-ids)
 525             ;; Specifically ask for zombies, so the user has chance to
 526             ;; flush them out.
 527             (gnorb-find-tracked-headings headers t)))
 528          targ)
 529     (setq gnorb-gnus-message-info
 530           `(:subject ,subject :msg-id ,msg-id
 531                      :to ,to :from ,from
 532                      :link ,link :date ,date :refs ,ref-msg-ids
 533                      :group ,group))
 534     (gnorb-gnus-collect-all-attachments nil t)
 535     ;; Delete other windows, users can restore with
 536     ;; `gnorb-restore-layout'.
 537     (delete-other-windows)
 538     (if id
 539         (gnorb-trigger-todo-action arg id)
 540       ;; Flush out zombies (dead associations).
 541       (setq related-headings
 542             (cl-remove-if
 543              (lambda (h)
 544                (when (null (org-id-find-id-file h))
 545                  (when (y-or-n-p
 546                         (format
 547                          "ID %s no longer exists, disassociate message?"
 548                          h))
 549                    (gnorb-delete-association msg-id h))))
 550              related-headings))
 551       (if (catch 'target
 552             (dolist (h related-headings nil)
 553               (when (yes-or-no-p
 554                      (format "Trigger action on %s"
 555                              (gnorb-pretty-outline h)))
 556                 (throw 'target (setq targ h)))))
 557           (gnorb-trigger-todo-action arg targ)
 558         (setq targ (org-refile-get-location
 559                     "Trigger heading" nil t))
 560         (find-file (nth 1 targ))
 561         (goto-char (nth 3 targ))
 562         (gnorb-trigger-todo-action arg)))))
 563
 564 ;;;###autoload
 565 (defun gnorb-gnus-search-messages (str &optional ret)
 566   "Initiate a search for gnus message links in an org subtree.
 567 The arg STR can be one of two things: an Org heading id value
 568 \(IDs should be prefixed with \"id+\"\), in which case links will
 569 be collected from that heading, or a string corresponding to an
 570 Org tags search, in which case links will be collected from all
 571 matching headings.
 572
 573 In either case, once a collection of links have been made, they
 574 will all be displayed in an ephemeral group on the \"nngnorb\"
 575 server. There must be an active \"nngnorb\" server for this to
 576 work."
 577   (interactive)
 578   (require 'nnir)
 579   (let ((nnir-address
 580          (or (gnus-method-to-server '(nngnorb))
 581              (user-error
 582               "Please add a \"nngnorb\" backend to your gnus installation."))))
 583     (when (version= "5.13" gnus-version-number)
 584       (with-no-warnings           ; All these variables are available.
 585         (setq nnir-current-query nil
 586               nnir-current-server nil
 587               nnir-current-group-marked nil
 588               nnir-artlist nil)))
 589     (gnus-group-read-ephemeral-group
 590      ;; in 24.4, the group name is mostly decorative. in 24.3, the
 591      ;; query itself is read from there. It should look like (concat
 592      ;; "nnir:" (prin1-to-string '((query str))))
 593      (if (version= "5.13" gnus-version-number)
 594          (concat "nnir:" (prin1-to-string `((query ,str))))
 595        (concat "gnorb-" str))
 596      (if (version= "5.13" gnus-version-number)
 597          (list 'nnir nnir-address)
 598        (list 'nnir "nnir"))
 599      nil
 600      ret
 601      nil nil
 602      ;; the following seems to simply be ignored under gnus 5.13
 603      (list (cons 'nnir-specs (list (cons 'nnir-query-spec `((query . ,str)))
 604                                    (cons 'nnir-group-spec `((,nnir-address nil)))))
 605            (cons 'nnir-artlist nil)))
 606     (gnorb-summary-minor-mode)))
 607
 608 ;;; Automatic noticing of relevant messages
 609
 610 ;; likely hooks for the summary buffer include:
 611 ;; `gnus-parse-headers-hook'
 612
 613 ;; BBDB puts its notice stuff in the `gnus-article-prepare-hook',
 614 ;; which seems as good a spot as any.
 615
 616 (defun gnorb-gnus-hint-relevant-message ()
 617   "When opening an article buffer, check the message to see if it
 618 is relevant to any existing TODO headings. If so, flash a message
 619 to that effect. This function is added to the
 620 `gnus-article-prepare-hook'. It will only do anything if the
 621 option `gnorb-gnus-hint-relevant-article' is non-nil."
 622   (when (and gnorb-gnus-hint-relevant-article
 623              (not (memq (car (gnus-find-method-for-group
 624                               gnus-newsgroup-name))
 625                         '(nnvirtual nnir))))
 626     (let* ((headers
 627             (gnus-data-header
 628              (gnus-data-find
 629               (gnus-summary-article-number))))
 630            (assoc-heading
 631             (gnus-registry-get-id-key
 632              (gnus-fetch-original-field "message-id") 'gnorb-ids))
 633            (tracked-headings (gnorb-find-tracked-headings headers))
 634            (key
 635             (where-is-internal 'gnorb-gnus-incoming-do-todo
 636                                nil t))
 637            rel-headings)
 638       (cond (assoc-heading
 639              (message "Message is associated with %s"
 640                       (gnorb-pretty-outline (car assoc-heading) t)))
 641             (tracked-headings
 642              (message "Possible relevant todo %s, trigger with %s"
 643                       (gnorb-pretty-outline (car tracked-headings) t)
 644                       (if key
 645                           (key-description key)
 646                         "M-x gnorb-gnus-incoming-do-todo")))
 647             (t nil)))))
 648
 649 (add-hook 'gnus-article-prepare-hook 'gnorb-gnus-hint-relevant-message)
 650
 651 (defun gnorb-gnus-insert-format-letter-maybe (header)
 652   (if (not (memq (car (gnus-find-method-for-group
 653                        gnus-newsgroup-name))
 654                  '(nnvirtual nnir)))
 655       (if (gnorb-find-tracked-headings header)
 656           gnorb-gnus-summary-mark
 657         " ")
 658     " "))
 659
 660 (fset (intern (concat "gnus-user-format-function-"
 661                       gnorb-gnus-summary-mark-format-letter))
 662       (lambda (header)
 663         (gnorb-gnus-insert-format-letter-maybe header)))
 664
 665 ;;;###autoload
 666 (defun gnorb-gnus-view ()
 667   "Display the first relevant TODO heading for the message under point"
 668   (interactive)
 669   (let ((headers (gnus-data-header
 670                    (gnus-data-find
 671                     (gnus-summary-article-number))))
 672         (tracked-headings
 673          (gnorb-find-tracked-headings headers)))
 674     (when tracked-headings
 675       (setq gnorb-window-conf (current-window-configuration))
 676       (move-marker gnorb-return-marker (point))
 677       (delete-other-windows)
 678       (org-id-goto (car tracked-headings)))))
 679
 680 (provide 'gnorb-gnus)
 681 ;;; gnorb-gnus.el ends here