git.notmuchmail.org Git - notmuch/blob - emacs/notmuch-wash.el

   1 ;; notmuch-wash.el --- cleaning up message bodies
   2 ;;
   3 ;; Copyright © Carl Worth
   4 ;; Copyright © David Edmondson
   5 ;;
   6 ;; This file is part of Notmuch.
   7 ;;
   8 ;; Notmuch is free software: you can redistribute it and/or modify it
   9 ;; 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 ;; Notmuch is distributed in the hope that it will be useful, but
  14 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
  15 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16 ;; General Public License for more details.
  17 ;;
  18 ;; You should have received a copy of the GNU General Public License
  19 ;; along with Notmuch.  If not, see <http://www.gnu.org/licenses/>.
  20 ;;
  21 ;; Authors: Carl Worth <cworth@cworth.org>
  22 ;;          David Edmondson <dme@dme.org>
  23
  24 (require 'coolj)
  25
  26 (declare-function notmuch-show-insert-bodypart "notmuch-show" (msg part depth))
  27
  28 ;;
  29
  30 (defvar notmuch-wash-signature-regexp
  31   "^\\(-- ?\\|_+\\)$"
  32   "Pattern to match a line that separates content from signature.")
  33
  34 (defvar notmuch-wash-citation-regexp
  35   "\\(^[[:space:]]*>.*\n\\)+"
  36   "Pattern to match citation lines.")
  37
  38 (defvar notmuch-wash-original-regexp "^\\(--+\s?[oO]riginal [mM]essage\s?--+\\)$"
  39   "Pattern to match a line that separates original message from reply in top-posted message.")
  40
  41 (defvar notmuch-wash-button-signature-hidden-format
  42   "[ %d-line signature. Click/Enter to show. ]"
  43   "String used to construct button text for hidden signatures.
  44 Can use up to one integer format parameter, i.e. %d")
  45
  46 (defvar notmuch-wash-button-signature-visible-format
  47   "[ %d-line signature. Click/Enter to hide. ]"
  48   "String used to construct button text for visible signatures.
  49 Can use up to one integer format parameter, i.e. %d")
  50
  51 (defvar notmuch-wash-button-citation-hidden-format
  52   "[ %d more citation lines. Click/Enter to show. ]"
  53   "String used to construct button text for hidden citations.
  54 Can use up to one integer format parameter, i.e. %d")
  55
  56 (defvar notmuch-wash-button-citation-visible-format
  57   "[ %d more citation lines. Click/Enter to hide. ]"
  58   "String used to construct button text for visible citations.
  59 Can use up to one integer format parameter, i.e. %d")
  60
  61 (defvar notmuch-wash-button-original-hidden-format
  62   "[ %d-line hidden original message. Click/Enter to show. ]"
  63   "String used to construct button text for hidden citations.
  64 Can use up to one integer format parameter, i.e. %d")
  65
  66 (defvar notmuch-wash-button-original-visible-format
  67   "[ %d-line original message. Click/Enter to hide. ]"
  68   "String used to construct button text for visible citations.
  69 Can use up to one integer format parameter, i.e. %d")
  70
  71 (defvar notmuch-wash-signature-lines-max 12
  72   "Maximum length of signature that will be hidden by default.")
  73
  74 (defvar notmuch-wash-citation-lines-prefix 3
  75   "Always show at least this many lines from the start of a citation.
  76
  77 If there is one more line than the sum of
  78 `notmuch-wash-citation-lines-prefix' and
  79 `notmuch-wash-citation-lines-suffix', show that, otherwise
  80 collapse the remaining lines into a button.")
  81
  82 (defvar notmuch-wash-citation-lines-suffix 3
  83   "Always show at least this many lines from the end of a citation.
  84
  85 If there is one more line than the sum of
  86 `notmuch-wash-citation-lines-prefix' and
  87 `notmuch-wash-citation-lines-suffix', show that, otherwise
  88 collapse the remaining lines into a button.")
  89
  90 (defun notmuch-wash-toggle-invisible-action (cite-button)
  91   (let ((invis-spec (button-get cite-button 'invisibility-spec)))
  92     (if (invisible-p invis-spec)
  93         (remove-from-invisibility-spec invis-spec)
  94       (add-to-invisibility-spec invis-spec)))
  95   (let* ((new-start (button-start cite-button))
  96          (overlay (button-get cite-button 'overlay))
  97          (button-label (notmuch-wash-button-label overlay))
  98          (old-point (point))
  99          (inhibit-read-only t))
 100     (goto-char new-start)
 101     (insert button-label)
 102     (let ((old-end (button-end cite-button)))
 103       (move-overlay cite-button new-start (point))
 104       (delete-region (point) old-end))
 105     (goto-char (min old-point (1- (button-end cite-button)))))
 106   (force-window-update)
 107   (redisplay t))
 108
 109 (define-button-type 'notmuch-wash-button-invisibility-toggle-type
 110   'action 'notmuch-wash-toggle-invisible-action
 111   'follow-link t
 112   'face 'font-lock-comment-face)
 113
 114 (define-button-type 'notmuch-wash-button-citation-toggle-type
 115   'help-echo "mouse-1, RET: Show citation"
 116   :supertype 'notmuch-wash-button-invisibility-toggle-type)
 117
 118 (define-button-type 'notmuch-wash-button-signature-toggle-type
 119   'help-echo "mouse-1, RET: Show signature"
 120   :supertype 'notmuch-wash-button-invisibility-toggle-type)
 121
 122 (define-button-type 'notmuch-wash-button-original-toggle-type
 123   'help-echo "mouse-1, RET: Show original message"
 124   :supertype 'notmuch-wash-button-invisibility-toggle-type)
 125
 126 (defun notmuch-wash-region-isearch-show (overlay)
 127   (dolist (invis-spec (overlay-get overlay 'invisible))
 128     (remove-from-invisibility-spec invis-spec)))
 129
 130 (defun notmuch-wash-button-label (overlay)
 131   (let* ((type (overlay-get overlay 'type))
 132          (invis-spec (overlay-get overlay 'invisible))
 133          (state (if (invisible-p invis-spec) "hidden" "visible"))
 134          (label-format (symbol-value (intern-soft (concat "notmuch-wash-button-"
 135                                                           type "-" state "-format"))))
 136          (lines-count (count-lines (overlay-start overlay) (overlay-end overlay))))
 137     (format label-format lines-count)))
 138
 139 (defun notmuch-wash-region-to-button (msg beg end type prefix)
 140   "Auxilary function to do the actual making of overlays and buttons
 141
 142 BEG and END are buffer locations. TYPE should a string, either
 143 \"citation\" or \"signature\". PREFIX is some arbitrary text to
 144 insert before the button, probably for indentation."
 145
 146   ;; This uses some slightly tricky conversions between strings and
 147   ;; symbols because of the way the button code works. Note that
 148   ;; replacing intern-soft with make-symbol will cause this to fail,
 149   ;; since the newly created symbol has no plist.
 150
 151   (let ((overlay (make-overlay beg end))
 152         (message-invis-spec (plist-get msg :message-invis-spec))
 153         (invis-spec (make-symbol (concat "notmuch-" type "-region")))
 154         (button-type (intern-soft (concat "notmuch-wash-button-"
 155                                           type "-toggle-type"))))
 156     (add-to-invisibility-spec invis-spec)
 157     (overlay-put overlay 'invisible (list invis-spec message-invis-spec))
 158     (overlay-put overlay 'isearch-open-invisible #'notmuch-wash-region-isearch-show)
 159     (overlay-put overlay 'type type)
 160     (goto-char (1+ end))
 161     (save-excursion
 162       (goto-char (1- beg))
 163       (insert prefix)
 164       (insert-button (notmuch-wash-button-label overlay)
 165                      'invisibility-spec invis-spec
 166                      'overlay overlay
 167                      :type button-type))))
 168
 169 (defun notmuch-wash-excerpt-citations (msg depth)
 170   "Excerpt citations and up to one signature."
 171   (goto-char (point-min))
 172   (beginning-of-line)
 173   (if (and (< (point) (point-max))
 174            (re-search-forward notmuch-wash-original-regexp nil t))
 175       (let* ((msg-start (match-beginning 0))
 176              (msg-end (point-max))
 177              (msg-lines (count-lines msg-start msg-end)))
 178         (notmuch-wash-region-to-button
 179          msg msg-start msg-end "original" "\n")))
 180   (while (and (< (point) (point-max))
 181               (re-search-forward notmuch-wash-citation-regexp nil t))
 182     (let* ((cite-start (match-beginning 0))
 183            (cite-end (match-end 0))
 184            (cite-lines (count-lines cite-start cite-end)))
 185       (overlay-put (make-overlay cite-start cite-end) 'face 'message-cited-text)
 186       (when (> cite-lines (+ notmuch-wash-citation-lines-prefix
 187                              notmuch-wash-citation-lines-suffix
 188                              1))
 189         (goto-char cite-start)
 190         (forward-line notmuch-wash-citation-lines-prefix)
 191         (let ((hidden-start (point-marker)))
 192           (goto-char cite-end)
 193           (forward-line (- notmuch-wash-citation-lines-suffix))
 194           (notmuch-wash-region-to-button
 195            msg hidden-start (point-marker)
 196            "citation" "\n")))))
 197   (if (and (not (eobp))
 198            (re-search-forward notmuch-wash-signature-regexp nil t))
 199       (let* ((sig-start (match-beginning 0))
 200              (sig-end (match-end 0))
 201              (sig-lines (count-lines sig-start (point-max))))
 202         (if (<= sig-lines notmuch-wash-signature-lines-max)
 203             (let ((sig-start-marker (make-marker))
 204                   (sig-end-marker (make-marker)))
 205               (set-marker sig-start-marker sig-start)
 206               (set-marker sig-end-marker (point-max))
 207               (overlay-put (make-overlay sig-start-marker sig-end-marker) 'face 'message-cited-text)
 208               (notmuch-wash-region-to-button
 209                msg sig-start-marker sig-end-marker
 210                "signature" "\n"))))))
 211
 212 ;;
 213
 214 (defun notmuch-wash-elide-blank-lines (msg depth)
 215   "Elide leading, trailing and successive blank lines."
 216
 217   ;; Algorithm derived from `article-strip-multiple-blank-lines' in
 218   ;; `gnus-art.el'.
 219
 220   ;; Make all blank lines empty.
 221   (goto-char (point-min))
 222   (while (re-search-forward "^[[:space:]\t]+$" nil t)
 223     (replace-match "" nil t))
 224
 225   ;; Replace multiple empty lines with a single empty line.
 226   (goto-char (point-min))
 227   (while (re-search-forward "^\n\\(\n+\\)" nil t)
 228     (delete-region (match-beginning 1) (match-end 1)))
 229
 230   ;; Remove a leading blank line.
 231   (goto-char (point-min))
 232   (if (looking-at "\n")
 233       (delete-region (match-beginning 0) (match-end 0)))
 234
 235   ;; Remove a trailing blank line.
 236   (goto-char (point-max))
 237   (if (looking-at "\n")
 238       (delete-region (match-beginning 0) (match-end 0))))
 239
 240 ;;
 241
 242 (defun notmuch-wash-tidy-citations (msg depth)
 243   "Improve the display of cited regions of a message.
 244
 245 Perform several transformations on the message body:
 246
 247 - Remove lines of repeated citation leaders with no other
 248   content,
 249 - Remove citation leaders standing alone before a block of cited
 250   text,
 251 - Remove citation trailers standing alone after a block of cited
 252   text."
 253
 254   ;; Remove lines of repeated citation leaders with no other content.
 255   (goto-char (point-min))
 256   (while (re-search-forward "\\(^>[> ]*\n\\)\\{2,\\}" nil t)
 257     (replace-match "\\1"))
 258
 259   ;; Remove citation leaders standing alone before a block of cited
 260   ;; text.
 261   (goto-char (point-min))
 262   (while (re-search-forward "\\(\n\\|^[^>].*\\)\n\\(^>[> ]*\n\\)" nil t)
 263     (replace-match "\\1\n"))
 264
 265   ;; Remove citation trailers standing alone after a block of cited
 266   ;; text.
 267   (goto-char (point-min))
 268   (while (re-search-forward "\\(^>[> ]*\n\\)\\(^$\\|^[^>].*\\)" nil t)
 269     (replace-match "\\2")))
 270
 271 ;;
 272
 273 (defun notmuch-wash-wrap-long-lines (msg depth)
 274   "Wrap any long lines in the message to the width of the window.
 275
 276 When doing so, maintaining citation leaders in the wrapped text."
 277
 278   (let ((coolj-wrap-follows-window-size nil)
 279         (fill-column (- (window-width)
 280                         depth
 281                         ;; 2 to avoid poor interaction with
 282                         ;; `word-wrap'.
 283                         2)))
 284     (coolj-wrap-region (point-min) (point-max))))
 285
 286 ;;
 287
 288 (require 'diff-mode)
 289
 290 (defvar diff-file-header-re) ; From `diff-mode.el'.
 291
 292 (defun notmuch-wash-convert-inline-patch-to-part (msg depth)
 293   "Convert an inline patch into a fake 'text/x-diff' attachment.
 294
 295 Given that this function guesses whether a buffer includes a
 296 patch and then guesses the extent of the patch, there is scope
 297 for error."
 298
 299   (goto-char (point-min))
 300   (if (re-search-forward diff-file-header-re nil t)
 301       (progn
 302         (beginning-of-line -1)
 303         (let ((patch-start (point))
 304               (patch-end (point-max))
 305               part)
 306           (goto-char patch-start)
 307           (if (or
 308                ;; Patch ends with signature.
 309                (re-search-forward notmuch-wash-signature-regexp nil t)
 310                ;; Patch ends with bugtraq comment.
 311                (re-search-forward "^\\*\\*\\* " nil t))
 312               (setq patch-end (match-beginning 0)))
 313           (save-restriction
 314             (narrow-to-region patch-start patch-end)
 315             (setq part (plist-put part :content-type "text/x-diff"))
 316             (setq part (plist-put part :content (buffer-string)))
 317             (setq part (plist-put part :id -1))
 318             (setq part (plist-put part :filename "inline patch"))
 319             (delete-region (point-min) (point-max))
 320             (notmuch-show-insert-bodypart nil part depth))))))
 321
 322 ;;
 323
 324 ;; Temporary workaround for Emacs bug #8721
 325 ;; http://debbugs.gnu.org/cgi/bugreport.cgi?bug=8721
 326
 327 (defun notmuch-isearch-range-invisible (beg end)
 328   "Same as `isearch-range-invisible' but with fixed Emacs bug #8721."
 329   (when (/= beg end)
 330     ;; Check that invisibility runs up to END.
 331     (save-excursion
 332       (goto-char beg)
 333       (let (;; can-be-opened keeps track if we can open some overlays.
 334             (can-be-opened (eq search-invisible 'open))
 335             ;; the list of overlays that could be opened
 336             (crt-overlays nil))
 337         (when (and can-be-opened isearch-hide-immediately)
 338           (isearch-close-unnecessary-overlays beg end))
 339         ;; If the following character is currently invisible,
 340         ;; skip all characters with that same `invisible' property value.
 341         ;; Do that over and over.
 342         (while (and (< (point) end) (invisible-p (point)))
 343           (if (invisible-p (get-text-property (point) 'invisible))
 344               (progn
 345                 (goto-char (next-single-property-change (point) 'invisible
 346                                                         nil end))
 347                 ;; if text is hidden by an `invisible' text property
 348                 ;; we cannot open it at all.
 349                 (setq can-be-opened nil))
 350             (when can-be-opened
 351               (let ((overlays (overlays-at (point)))
 352                     ov-list
 353                     o
 354                     invis-prop)
 355                 (while overlays
 356                   (setq o (car overlays)
 357                         invis-prop (overlay-get o 'invisible))
 358                   (if (invisible-p invis-prop)
 359                       (if (overlay-get o 'isearch-open-invisible)
 360                           (setq ov-list (cons o ov-list))
 361                         ;; We found one overlay that cannot be
 362                         ;; opened, that means the whole chunk
 363                         ;; cannot be opened.
 364                         (setq can-be-opened nil)))
 365                   (setq overlays (cdr overlays)))
 366                 (if can-be-opened
 367                     ;; It makes sense to append to the open
 368                     ;; overlays list only if we know that this is
 369                     ;; t.
 370                     (setq crt-overlays (append ov-list crt-overlays)))))
 371             (goto-char (next-overlay-change (point)))))
 372         ;; See if invisibility reaches up thru END.
 373         (if (>= (point) end)
 374             (if (and can-be-opened (consp crt-overlays))
 375                 (progn
 376                   (setq isearch-opened-overlays
 377                         (append isearch-opened-overlays crt-overlays))
 378                   (mapc 'isearch-open-overlay-temporary crt-overlays)
 379                   nil)
 380               (setq isearch-hidden t)))))))
 381
 382 (defadvice isearch-range-invisible (around notmuch-isearch-range-invisible-advice activate)
 383   "Call `notmuch-isearch-range-invisible' instead of the original
 384 `isearch-range-invisible' when in `notmuch-show-mode' mode."
 385   (if (eq major-mode 'notmuch-show-mode)
 386       (setq ad-return-value (notmuch-isearch-range-invisible beg end))
 387     ad-do-it))
 388
 389 ;;
 390
 391 (provide 'notmuch-wash)