* nnmairix.el: Remove old documentation in the commentary block.
[gnus] / lisp / mm-partial.el
1 ;;; mm-partial.el --- showing message/partial
2
3 ;; Copyright (C) 2000, 2001, 2002, 2003, 2004,
4 ;;   2005, 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
5
6 ;; Author: Shenghuo Zhu <zsh@cs.rochester.edu>
7 ;; Keywords: message partial
8
9 ;; This file is part of GNU Emacs.
10
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
15
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19 ;; GNU General Public License for more details.
20
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
23
24 ;;; Commentary:
25
26 ;;; Code:
27
28 (eval-when-compile (require 'cl))
29
30 (require 'gnus-sum)
31 (require 'mm-util)
32 (require 'mm-decode)
33
34 (defun mm-partial-find-parts (id &optional art)
35   (let ((headers (with-current-buffer gnus-summary-buffer
36                    gnus-newsgroup-headers))
37         phandles header)
38     (while (setq header (pop headers))
39       (unless (eq (aref header 0) art)
40         (mm-with-unibyte-buffer
41           (gnus-request-article-this-buffer (aref header 0)
42                                             gnus-newsgroup-name)
43           (when (search-forward id nil t)
44             (let ((nhandles (mm-dissect-buffer
45                              nil gnus-article-loose-mime)) nid)
46               (if (consp (car nhandles))
47                   (mm-destroy-parts nhandles)
48                 (setq nid (cdr (assq 'id
49                                      (cdr (mm-handle-type nhandles)))))
50                 (if (not (equal id nid))
51                     (mm-destroy-parts nhandles)
52                   (push nhandles phandles))))))))
53     phandles))
54
55 ;;;###autoload
56 (defun mm-inline-partial (handle &optional no-display)
57   "Show the partial part of HANDLE.
58 This function replaces the buffer of HANDLE with a buffer contains
59 the entire message.
60 If NO-DISPLAY is nil, display it. Otherwise, do nothing after replacing."
61   (let ((id (cdr (assq 'id (cdr (mm-handle-type handle)))))
62         phandles
63         (b (point)) (n 1) total
64         phandle nn ntotal
65         gnus-displaying-mime handles buffer)
66     (unless (mm-handle-cache handle)
67       (unless id
68         (error "Can not find message/partial id"))
69       (setq phandles
70             (sort (cons handle
71                         (mm-partial-find-parts
72                          id
73                          (save-excursion
74                            (set-buffer gnus-summary-buffer)
75                            (gnus-summary-article-number))))
76                   #'(lambda (a b)
77                       (let ((anumber (string-to-number
78                                       (cdr (assq 'number
79                                                  (cdr (mm-handle-type a))))))
80                             (bnumber (string-to-number
81                                       (cdr (assq 'number
82                                                  (cdr (mm-handle-type b)))))))
83                         (< anumber bnumber)))))
84       (setq gnus-article-mime-handles
85             (mm-merge-handles gnus-article-mime-handles phandles))
86       (save-excursion
87         (set-buffer (generate-new-buffer " *mm*"))
88         (while (setq phandle (pop phandles))
89           (setq nn (string-to-number
90                     (cdr (assq 'number
91                                (cdr (mm-handle-type phandle))))))
92           (setq ntotal (string-to-number
93                         (cdr (assq 'total
94                                    (cdr (mm-handle-type phandle))))))
95           (if ntotal
96               (if total
97                   (unless (eq total ntotal)
98                   (error "The numbers of total are different"))
99                 (setq total ntotal)))
100           (unless (< nn n)
101             (unless (eq nn n)
102               (error "Missing part %d" n))
103             (mm-insert-part phandle)
104             (goto-char (point-max))
105             (when (not (eq 0 (skip-chars-backward "\r\n")))
106               ;; remove tail blank spaces except one
107               (if (looking-at "\r?\n")
108                   (goto-char (match-end 0)))
109               (delete-region (point) (point-max)))
110             (setq n (+ n 1))))
111         (unless total
112           (error "Don't known the total number of"))
113         (if (<= n total)
114             (error "Missing part %d" n))
115         (kill-buffer (mm-handle-buffer handle))
116         (goto-char (point-min))
117         (let ((point (if (search-forward "\n\n" nil t)
118                          (1- (point))
119                        (point-max))))
120           (goto-char (point-min))
121           (unless (re-search-forward "^mime-version:" point t)
122             (insert "MIME-Version: 1.0\n")))
123         (setcar handle (current-buffer))
124         (mm-handle-set-cache handle t)))
125     (unless no-display
126       (save-excursion
127         (save-restriction
128           (narrow-to-region b b)
129           (mm-insert-part handle)
130           (let (gnus-article-mime-handles)
131             (run-hooks 'gnus-article-decode-hook)
132             (gnus-article-prepare-display)
133             (setq handles gnus-article-mime-handles))
134           (when handles
135             ;; It is in article buffer.
136             (setq gnus-article-mime-handles
137                   (mm-merge-handles gnus-article-mime-handles handles)))
138           (mm-handle-set-undisplayer
139            handle
140            `(lambda ()
141               (let (buffer-read-only)
142                 (condition-case nil
143                     ;; This is only valid on XEmacs.
144                     (mapcar (lambda (prop)
145                             (remove-specifier
146                              (face-property 'default prop) (current-buffer)))
147                             '(background background-pixmap foreground))
148                   (error nil))
149                 (delete-region ,(point-min-marker) ,(point-max-marker))))))))))
150
151 (provide 'mm-partial)
152
153 ;; arch-tag: 460e7424-05f2-4a1d-a0f2-70ec081eff7d
154 ;;; mm-partial.el ends here