a06e3de78ab47d21d8a4449606678c8ac54a9cb5
[elisp/wanderlust.git] / elmo / elmo-pipe.el
1 ;;; elmo-pipe.el -- PIPE Interface for ELMO.
2
3 ;; Copyright (C) 1998,1999,2000 Yuuichi Teranishi <teranisi@gohome.org>
4
5 ;; Author: Yuuichi Teranishi <teranisi@gohome.org>
6 ;; Keywords: mail, net news
7
8 ;; This file is part of ELMO (Elisp Library for Message Orchestration).
9
10 ;; This program is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
13 ;; any later version.
14 ;;
15 ;; This program is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 ;; GNU General Public License for more details.
19 ;;
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 ;; Boston, MA 02111-1307, USA.
24 ;;
25
26 ;;; Commentary:
27 ;;
28
29 ;;; Code:
30 ;;
31
32 (require 'elmo)
33
34 ;;; ELMO pipe folder
35 (eval-and-compile
36   (luna-define-class elmo-pipe-folder (elmo-folder)
37                      (src dst copy))
38   (luna-define-internal-accessors 'elmo-pipe-folder))
39
40 (luna-define-method elmo-folder-initialize ((folder elmo-pipe-folder)
41                                             name)
42   (when (string-match "^\\([^|]*\\)|\\(:?\\)\\(.*\\)$" name)
43     (elmo-pipe-folder-set-src-internal folder
44                                        (elmo-make-folder
45                                         (elmo-match-string 1 name)))
46     (elmo-pipe-folder-set-dst-internal folder
47                                        (elmo-make-folder
48                                         (elmo-match-string 3 name)))
49     (elmo-pipe-folder-set-copy-internal folder
50                                         (string= ":" (elmo-match-string 2 name))))
51   folder)
52
53 (luna-define-method elmo-folder-get-primitive-list ((folder elmo-pipe-folder))
54   (elmo-flatten
55    (mapcar
56     'elmo-folder-get-primitive-list
57     (list (elmo-pipe-folder-src-internal folder)
58           (elmo-pipe-folder-dst-internal folder)))))
59
60 (luna-define-method elmo-folder-contains-type ((folder elmo-pipe-folder)
61                                                type)
62   (or (elmo-folder-contains-type (elmo-pipe-folder-src-internal folder) type)
63       (elmo-folder-contains-type (elmo-pipe-folder-dst-internal folder) type)))
64
65 (luna-define-method elmo-folder-msgdb-create ((folder elmo-pipe-folder)
66                                               numlist new-mark already-mark
67                                               seen-mark important-mark
68                                               seen-list)
69   (elmo-folder-msgdb-create (elmo-pipe-folder-dst-internal folder)
70                             numlist new-mark already-mark
71                             seen-mark important-mark seen-list))
72
73 (luna-define-method elmo-folder-append-messages ((folder elmo-pipe-folder)
74                                                  src-folder numbers
75                                                  unread-marks
76                                                  &optional same-number)
77   (elmo-folder-append-messages (elmo-pipe-folder-dst-internal folder)
78                                src-folder numbers
79                                unread-marks
80                                same-number))
81
82 (luna-define-method elmo-folder-append-buffer ((folder elmo-pipe-folder)
83                                                unread &optional number)
84   (elmo-folder-append-buffer (elmo-pipe-folder-dst-internal folder)
85                              unread number))
86
87 (luna-define-method elmo-message-fetch ((folder elmo-pipe-folder)
88                                         number strategy
89                                         &optional section outbuf unseen)
90   (elmo-message-fetch (elmo-pipe-folder-dst-internal folder)
91                       number strategy section outbuf unseen))
92
93 (luna-define-method elmo-folder-delete-messages ((folder elmo-pipe-folder)
94                                                  numbers)
95   (elmo-folder-delete-messages (elmo-pipe-folder-dst-internal folder)
96                                numbers))
97
98 (defvar elmo-pipe-drained-hook nil "A hook called when the pipe is flushed.")
99
100 (defun elmo-pipe-drain (src dst copy)
101   "Move all messages of SRC to DST."
102   (let ((elmo-inhibit-number-mapping t) ; No need to use UIDL
103         msgs len)
104     (message "Checking %s..." (elmo-folder-name-internal src))
105     (elmo-folder-open-internal src)
106     (setq msgs (elmo-folder-list-messages src)
107           len (length msgs))
108     (when (> len elmo-display-progress-threshold)
109       (elmo-progress-set 'elmo-folder-move-messages
110                          len "Moving messages..."))
111     (unwind-protect
112         (elmo-folder-move-messages src msgs dst
113                                    nil nil copy)
114       (elmo-progress-clear 'elmo-folder-move-messages))
115     (if copy
116         (elmo-msgdb-append-to-killed-list src msgs)))
117   ;; Don't save msgdb here.
118   ;; Because summary view of original folder is not updated yet.
119   (elmo-folder-close-internal src)
120   (run-hooks 'elmo-pipe-drained-hook))
121
122 (luna-define-method elmo-folder-open-internal ((folder elmo-pipe-folder))
123   (elmo-folder-open-internal (elmo-pipe-folder-dst-internal folder))
124   (let ((src-folder (elmo-pipe-folder-src-internal folder))
125         (dst-folder (elmo-pipe-folder-dst-internal folder))
126         (copy (elmo-pipe-folder-copy-internal folder)))
127     (when (and (elmo-folder-plugged-p src-folder)
128                (elmo-folder-plugged-p dst-folder))
129       (elmo-pipe-drain src-folder dst-folder copy))))
130
131 (luna-define-method elmo-folder-close-internal ((folder elmo-pipe-folder))
132   (elmo-folder-close-internal(elmo-pipe-folder-dst-internal folder)))
133
134 (luna-define-method elmo-folder-list-messages-internal
135   ((folder elmo-pipe-folder) &optional nohide)
136   (elmo-folder-list-messages-internal (elmo-pipe-folder-dst-internal
137                                        folder) nohide))
138
139 (luna-define-method elmo-folder-list-unreads-internal
140   ((folder elmo-pipe-folder) unread-marks &optional mark-alist)
141   (elmo-folder-list-unreads-internal (elmo-pipe-folder-dst-internal folder)
142                                      unread-marks mark-alist))
143
144 (luna-define-method elmo-folder-list-importants-internal
145   ((folder elmo-pipe-folder) important-mark)
146   (elmo-folder-list-importants-internal (elmo-pipe-folder-dst-internal folder)
147                                         important-mark))
148
149 (luna-define-method elmo-folder-status ((folder elmo-pipe-folder))
150   (elmo-folder-open-internal (elmo-pipe-folder-src-internal folder))
151   (elmo-folder-open-internal (elmo-pipe-folder-dst-internal folder))
152   (let* ((elmo-inhibit-number-mapping t)
153          (src-length (length (elmo-folder-list-messages
154                               (elmo-pipe-folder-src-internal folder))))
155          (dst-list (elmo-folder-list-messages
156                     (elmo-pipe-folder-dst-internal folder))))
157     (prog1 (cons (+ src-length (elmo-max-of-list dst-list))
158                  (+ src-length (length dst-list)))
159       ;; No save.
160       (elmo-folder-close-internal (elmo-pipe-folder-src-internal folder))
161       (elmo-folder-close-internal (elmo-pipe-folder-dst-internal folder)))))
162
163 (luna-define-method elmo-folder-exists-p ((folder elmo-pipe-folder))
164   (and (elmo-folder-exists-p (elmo-pipe-folder-src-internal folder))
165        (elmo-folder-exists-p (elmo-pipe-folder-dst-internal folder))))
166
167 (luna-define-method elmo-folder-expand-msgdb-path ((folder
168                                                     elmo-pipe-folder))
169   ;; Share with destination...OK?
170   (elmo-folder-expand-msgdb-path (elmo-pipe-folder-dst-internal folder)))
171
172 (luna-define-method elmo-folder-newsgroups ((folder elmo-pipe-folder))
173   (elmo-folder-newsgroups (elmo-pipe-folder-src-internal folder)))
174
175 (luna-define-method elmo-folder-creatable-p ((folder elmo-pipe-folder))
176   (and (elmo-folder-creatable-p (elmo-pipe-folder-src-internal folder))
177        (elmo-folder-creatable-p (elmo-pipe-folder-dst-internal folder))))
178
179 (luna-define-method elmo-folder-writable-p ((folder elmo-pipe-folder))
180   (elmo-folder-writable-p (elmo-pipe-folder-dst-internal folder)))
181
182 (luna-define-method elmo-folder-create ((folder elmo-pipe-folder))
183   (if (and (not (elmo-folder-exists-p (elmo-pipe-folder-src-internal folder)))
184            (elmo-folder-creatable-p (elmo-pipe-folder-src-internal folder)))
185       (elmo-folder-create (elmo-pipe-folder-src-internal folder)))
186   (if (and (not (elmo-folder-exists-p (elmo-pipe-folder-dst-internal folder)))
187            (elmo-folder-creatable-p (elmo-pipe-folder-dst-internal folder)))
188       (elmo-folder-create (elmo-pipe-folder-dst-internal folder))))
189
190 (luna-define-method elmo-folder-search ((folder elmo-pipe-folder)
191                                         condition &optional numlist)
192   (elmo-folder-search (elmo-pipe-folder-dst-internal folder)
193                       condition numlist))
194
195 (luna-define-method elmo-message-use-cache-p ((folder elmo-pipe-folder) number)
196   (elmo-message-use-cache-p (elmo-pipe-folder-dst-internal folder) number))
197
198 (luna-define-method elmo-folder-check ((folder elmo-pipe-folder))
199   (elmo-folder-close-internal folder)
200   (elmo-folder-open-internal folder))
201
202 (luna-define-method elmo-folder-plugged-p ((folder elmo-pipe-folder))
203   (and (elmo-folder-plugged-p (elmo-pipe-folder-src-internal folder))
204        (elmo-folder-plugged-p (elmo-pipe-folder-dst-internal folder))))
205
206 (luna-define-method elmo-folder-message-file-p ((folder elmo-pipe-folder))
207   (elmo-folder-message-file-p (elmo-pipe-folder-dst-internal folder)))
208
209 (luna-define-method elmo-message-file-p ((folder elmo-pipe-folder) number)
210   (elmo-message-file-p (elmo-pipe-folder-dst-internal folder) number))
211
212 (luna-define-method elmo-message-file-name ((folder elmo-pipe-folder) number)
213   (elmo-message-file-name (elmo-pipe-folder-dst-internal folder) number))
214
215 (luna-define-method elmo-folder-message-file-number-p ((folder
216                                                         elmo-pipe-folder))
217   (elmo-folder-message-file-number-p (elmo-pipe-folder-dst-internal folder)))
218
219 (luna-define-method elmo-folder-message-file-directory ((folder
220                                                          elmo-pipe-folder))
221   (elmo-folder-message-file-directory
222    (elmo-pipe-folder-dst-internal folder)))
223
224 (luna-define-method elmo-folder-message-make-temp-file-p
225   ((folder elmo-pipe-folder))
226   (elmo-folder-message-make-temp-file-p
227    (elmo-pipe-folder-dst-internal folder)))
228
229 (luna-define-method elmo-folder-message-make-temp-files ((folder
230                                                           elmo-pipe-folder)
231                                                          numbers
232                                                          &optional
233                                                          start-number)
234   (elmo-folder-message-make-temp-files
235    (elmo-pipe-folder-dst-internal folder) numbers start-number))
236
237 (luna-define-method elmo-folder-mark-as-read ((folder elmo-pipe-folder)
238                                               numbers)
239   (elmo-folder-mark-as-read (elmo-pipe-folder-dst-internal folder)
240                             numbers))
241
242 (luna-define-method elmo-folder-unmark-read ((folder elmo-pipe-folder)
243                                               numbers)
244   (elmo-folder-unmark-read (elmo-pipe-folder-dst-internal folder)
245                            numbers))
246
247 (luna-define-method elmo-folder-unmark-important ((folder elmo-pipe-folder)
248                                                   numbers)
249   (elmo-folder-unmark-important (elmo-pipe-folder-dst-internal folder)
250                                 numbers))
251
252 (luna-define-method elmo-folder-mark-as-important ((folder elmo-pipe-folder)
253                                                    numbers)
254   (elmo-folder-mark-as-important (elmo-pipe-folder-dst-internal folder)
255                                  numbers))
256
257 (luna-define-method elmo-folder-pack-numbers ((folder elmo-pipe-folder))
258   (elmo-folder-pack-numbers (elmo-pipe-folder-dst-internal folder)))
259
260 (require 'product)
261 (product-provide (provide 'elmo-pipe) (require 'elmo-version))
262
263 ;;; elmo-pipe.el ends here