1 ;;; elmo-pipe.el --- PIPE Interface for ELMO.
3 ;; Copyright (C) 1998,1999,2000 Yuuichi Teranishi <teranisi@gohome.org>
5 ;; Author: Yuuichi Teranishi <teranisi@gohome.org>
6 ;; Keywords: mail, net news
8 ;; This file is part of ELMO (Elisp Library for Message Orchestration).
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)
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.
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.
34 (defvar elmo-pipe-folder-copied-filename "copied"
35 "Copied messages number set.")
39 (luna-define-class elmo-pipe-folder (elmo-folder)
41 (luna-define-internal-accessors 'elmo-pipe-folder))
43 (luna-define-method elmo-folder-initialize ((folder elmo-pipe-folder)
45 (when (string-match "^\\([^|]*\\)|\\(:?\\)\\(.*\\)$" name)
46 (elmo-pipe-folder-set-src-internal folder
48 (elmo-match-string 1 name)))
49 (elmo-pipe-folder-set-dst-internal folder
51 (elmo-match-string 3 name)))
52 (elmo-pipe-folder-set-copy-internal folder
54 (elmo-match-string 2 name))))
57 (luna-define-method elmo-folder-get-primitive-list ((folder elmo-pipe-folder))
60 'elmo-folder-get-primitive-list
61 (list (elmo-pipe-folder-src-internal folder)
62 (elmo-pipe-folder-dst-internal folder)))))
64 (luna-define-method elmo-folder-contains-type ((folder elmo-pipe-folder)
66 (or (elmo-folder-contains-type (elmo-pipe-folder-src-internal folder) type)
67 (elmo-folder-contains-type (elmo-pipe-folder-dst-internal folder) type)))
69 (luna-define-method elmo-folder-append-messages ((folder elmo-pipe-folder)
71 &optional same-number)
72 (elmo-folder-append-messages (elmo-pipe-folder-dst-internal folder)
76 (luna-define-method elmo-folder-append-buffer ((folder elmo-pipe-folder)
77 &optional flag number)
78 (elmo-folder-append-buffer (elmo-pipe-folder-dst-internal folder)
81 (luna-define-method elmo-message-fetch ((folder elmo-pipe-folder)
83 &optional section outbuf unseen)
84 (elmo-message-fetch (elmo-pipe-folder-dst-internal folder)
85 number strategy section outbuf unseen))
87 (luna-define-method elmo-folder-clear :after ((folder elmo-pipe-folder)
88 &optional keep-killed)
90 (elmo-pipe-folder-copied-list-save folder nil)))
92 (luna-define-method elmo-folder-delete-messages ((folder elmo-pipe-folder)
94 (elmo-folder-delete-messages (elmo-pipe-folder-dst-internal folder)
97 (defvar elmo-pipe-drained-hook nil "A hook called when the pipe is flushed.")
99 (defsubst elmo-pipe-folder-list-target-messages (src &optional ignore-list)
102 (elmo-folder-set-killed-list-internal src ignore-list)
103 (elmo-folder-list-messages src))
104 (elmo-folder-set-killed-list-internal src nil)))
106 (defun elmo-pipe-drain (src dst &optional copy ignore-list)
107 "Move or copy all messages of SRC to DST."
108 (let ((elmo-inhibit-number-mapping (not copy)) ; No need to use UIDL
110 (message "Checking %s..." (elmo-folder-name-internal src))
111 ;; Warnnig: some function requires msgdb
112 ;; but elmo-folder-open-internal do not load msgdb.
113 (elmo-folder-open-internal src)
114 (setq msgs (elmo-pipe-folder-list-target-messages src ignore-list)
116 (when (> len elmo-display-progress-threshold)
117 (elmo-progress-set 'elmo-folder-move-messages
120 "Copying messages..."
121 "Moving messages...")))
123 (elmo-folder-move-messages src msgs dst
125 (elmo-progress-clear 'elmo-folder-move-messages))
126 (when (and copy msgs)
127 (setq ignore-list (elmo-number-set-append-list ignore-list
129 (elmo-folder-close-internal src)
130 (run-hooks 'elmo-pipe-drained-hook)
133 (defun elmo-pipe-folder-copied-list-load (folder)
135 (expand-file-name elmo-pipe-folder-copied-filename
137 (elmo-replace-string-as-filename
138 (elmo-folder-name-internal folder))
139 (expand-file-name "pipe" elmo-msgdb-directory)))
142 (defun elmo-pipe-folder-copied-list-save (folder copied-list)
144 (expand-file-name elmo-pipe-folder-copied-filename
146 (elmo-replace-string-as-filename
147 (elmo-folder-name-internal folder))
148 (expand-file-name "pipe" elmo-msgdb-directory)))
151 (luna-define-method elmo-folder-msgdb ((folder elmo-pipe-folder))
152 (elmo-folder-msgdb (elmo-pipe-folder-dst-internal folder)))
154 (luna-define-method elmo-folder-open-internal ((folder elmo-pipe-folder))
155 (elmo-folder-open-internal (elmo-pipe-folder-dst-internal folder)))
157 (luna-define-method elmo-folder-close-internal ((folder elmo-pipe-folder))
158 (elmo-folder-close-internal(elmo-pipe-folder-dst-internal folder)))
160 (luna-define-method elmo-folder-list-messages ((folder elmo-pipe-folder)
161 &optional visible-only in-msgdb)
162 ;; Use target folder's killed-list in the pipe folder.
163 (elmo-folder-list-messages (elmo-pipe-folder-dst-internal
164 folder) visible-only in-msgdb))
166 (luna-define-method elmo-folder-list-unreads ((folder elmo-pipe-folder))
167 (elmo-folder-list-unreads (elmo-pipe-folder-dst-internal folder)))
169 (luna-define-method elmo-folder-list-importants ((folder elmo-pipe-folder))
170 (elmo-folder-list-importants (elmo-pipe-folder-dst-internal folder)))
172 (luna-define-method elmo-folder-list-answereds ((folder elmo-pipe-folder))
173 (elmo-folder-list-answereds (elmo-pipe-folder-dst-internal folder)))
175 (luna-define-method elmo-folder-diff ((folder elmo-pipe-folder))
176 (elmo-folder-open-internal (elmo-pipe-folder-src-internal folder))
177 (elmo-folder-open-internal (elmo-pipe-folder-dst-internal folder))
178 (let* ((elmo-inhibit-number-mapping
179 (not (elmo-pipe-folder-copy-internal folder)))
180 (src-length (length (elmo-pipe-folder-list-target-messages
181 (elmo-pipe-folder-src-internal folder)
182 (elmo-pipe-folder-copied-list-load folder))))
183 (dst-diff (elmo-folder-diff (elmo-pipe-folder-dst-internal folder))))
186 ((consp (cdr dst-diff)) ; new unread all
187 (mapcar (lambda (number) (+ number src-length)) dst-diff))
189 (cons (+ (car dst-diff) src-length)
190 (+ (cdr dst-diff) src-length))))
192 (elmo-folder-close-internal (elmo-pipe-folder-src-internal folder))
193 (elmo-folder-close-internal (elmo-pipe-folder-dst-internal folder)))))
195 (luna-define-method elmo-folder-exists-p ((folder elmo-pipe-folder))
196 (and (elmo-folder-exists-p (elmo-pipe-folder-src-internal folder))
197 (elmo-folder-exists-p (elmo-pipe-folder-dst-internal folder))))
199 (luna-define-method elmo-folder-expand-msgdb-path ((folder
201 ;; Share with destination...OK?
202 (elmo-folder-expand-msgdb-path (elmo-pipe-folder-dst-internal folder)))
204 (luna-define-method elmo-folder-newsgroups ((folder elmo-pipe-folder))
205 (elmo-folder-newsgroups (elmo-pipe-folder-src-internal folder)))
207 (luna-define-method elmo-folder-creatable-p ((folder elmo-pipe-folder))
209 (elmo-folder-exists-p (elmo-pipe-folder-src-internal folder))
210 (elmo-folder-creatable-p (elmo-pipe-folder-src-internal folder)))
212 (elmo-folder-exists-p (elmo-pipe-folder-dst-internal folder))
213 (elmo-folder-creatable-p (elmo-pipe-folder-dst-internal folder)))))
215 (luna-define-method elmo-folder-writable-p ((folder elmo-pipe-folder))
216 (elmo-folder-writable-p (elmo-pipe-folder-dst-internal folder)))
218 (luna-define-method elmo-folder-create ((folder elmo-pipe-folder))
219 (if (and (not (elmo-folder-exists-p (elmo-pipe-folder-src-internal folder)))
220 (elmo-folder-creatable-p (elmo-pipe-folder-src-internal folder)))
221 (elmo-folder-create (elmo-pipe-folder-src-internal folder)))
222 (if (and (not (elmo-folder-exists-p (elmo-pipe-folder-dst-internal folder)))
223 (elmo-folder-creatable-p (elmo-pipe-folder-dst-internal folder)))
224 (elmo-folder-create (elmo-pipe-folder-dst-internal folder))))
226 (luna-define-method elmo-folder-search ((folder elmo-pipe-folder)
227 condition &optional numlist)
228 (elmo-folder-search (elmo-pipe-folder-dst-internal folder)
231 (luna-define-method elmo-message-use-cache-p ((folder elmo-pipe-folder) number)
232 (elmo-message-use-cache-p (elmo-pipe-folder-dst-internal folder) number))
234 (luna-define-method elmo-folder-check ((folder elmo-pipe-folder))
235 (elmo-folder-check (elmo-pipe-folder-dst-internal folder)))
237 (luna-define-method elmo-folder-plugged-p ((folder elmo-pipe-folder))
238 (and (elmo-folder-plugged-p (elmo-pipe-folder-src-internal folder))
239 (elmo-folder-plugged-p (elmo-pipe-folder-dst-internal folder))))
241 (luna-define-method elmo-folder-message-file-p ((folder elmo-pipe-folder))
242 (elmo-folder-message-file-p (elmo-pipe-folder-dst-internal folder)))
244 (luna-define-method elmo-message-file-p ((folder elmo-pipe-folder) number)
245 (elmo-message-file-p (elmo-pipe-folder-dst-internal folder) number))
247 (luna-define-method elmo-message-file-name ((folder elmo-pipe-folder) number)
248 (elmo-message-file-name (elmo-pipe-folder-dst-internal folder) number))
250 (luna-define-method elmo-folder-message-file-number-p ((folder
252 (elmo-folder-message-file-number-p (elmo-pipe-folder-dst-internal folder)))
254 (luna-define-method elmo-folder-message-file-directory ((folder
256 (elmo-folder-message-file-directory
257 (elmo-pipe-folder-dst-internal folder)))
259 (luna-define-method elmo-folder-message-make-temp-file-p
260 ((folder elmo-pipe-folder))
261 (elmo-folder-message-make-temp-file-p
262 (elmo-pipe-folder-dst-internal folder)))
264 (luna-define-method elmo-folder-message-make-temp-files ((folder
269 (elmo-folder-message-make-temp-files
270 (elmo-pipe-folder-dst-internal folder) numbers start-number))
272 (luna-define-method elmo-folder-mark-as-read ((folder elmo-pipe-folder)
273 numbers &optional ignore-flag)
274 (elmo-folder-mark-as-read (elmo-pipe-folder-dst-internal folder)
275 numbers ignore-flag))
277 (luna-define-method elmo-folder-unmark-read ((folder elmo-pipe-folder)
279 &optional ignore-flag)
280 (elmo-folder-unmark-read (elmo-pipe-folder-dst-internal folder)
281 numbers ignore-flag))
283 (luna-define-method elmo-folder-unmark-important ((folder elmo-pipe-folder)
285 &optional ignore-flag)
286 (elmo-folder-unmark-important (elmo-pipe-folder-dst-internal folder)
287 numbers ignore-flag))
289 (luna-define-method elmo-folder-mark-as-important ((folder elmo-pipe-folder)
291 &optional ignore-flag)
292 (elmo-folder-mark-as-important (elmo-pipe-folder-dst-internal folder)
293 numbers ignore-flag))
295 (luna-define-method elmo-folder-unmark-answered ((folder elmo-pipe-folder)
297 (elmo-folder-unmark-answered (elmo-pipe-folder-dst-internal folder)
300 (luna-define-method elmo-folder-mark-as-answered ((folder elmo-pipe-folder)
302 (elmo-folder-mark-as-answered (elmo-pipe-folder-dst-internal folder)
305 (luna-define-method elmo-folder-pack-numbers ((folder elmo-pipe-folder))
306 (elmo-folder-pack-numbers (elmo-pipe-folder-dst-internal folder)))
308 (luna-define-method elmo-folder-rename ((folder elmo-pipe-folder) new-name)
309 (let* ((new-folder (elmo-make-folder new-name)))
310 (unless (string= (elmo-folder-name-internal
311 (elmo-pipe-folder-src-internal folder))
312 (elmo-folder-name-internal
313 (elmo-pipe-folder-src-internal new-folder)))
314 (error "Source folder differ"))
315 (unless (eq (elmo-folder-type-internal
316 (elmo-pipe-folder-dst-internal folder))
317 (elmo-folder-type-internal
318 (elmo-pipe-folder-dst-internal new-folder)))
319 (error "Not same folder type"))
320 (if (or (file-exists-p (elmo-folder-msgdb-path
321 (elmo-pipe-folder-dst-internal new-folder)))
322 (elmo-folder-exists-p
323 (elmo-pipe-folder-dst-internal new-folder)))
324 (error "Already exists folder: %s" new-name))
325 (elmo-folder-send (elmo-pipe-folder-dst-internal folder)
326 'elmo-folder-rename-internal
327 (elmo-pipe-folder-dst-internal new-folder))
328 (elmo-msgdb-rename-path folder new-folder)))
330 (luna-define-method elmo-folder-commit ((folder elmo-pipe-folder))
332 (elmo-pipe-folder-dst-internal folder)))
334 (luna-define-method elmo-folder-synchronize ((folder elmo-pipe-folder)
339 (let ((src-folder (elmo-pipe-folder-src-internal folder))
340 (dst-folder (elmo-pipe-folder-dst-internal folder)))
341 (when (and (elmo-folder-plugged-p src-folder)
342 (elmo-folder-plugged-p dst-folder))
343 (if (elmo-pipe-folder-copy-internal folder)
344 (elmo-pipe-folder-copied-list-save
346 (elmo-pipe-drain src-folder
349 (elmo-pipe-folder-copied-list-load folder)))
350 (elmo-pipe-drain src-folder dst-folder))))
351 (elmo-folder-synchronize
352 (elmo-pipe-folder-dst-internal folder)
353 disable-killed ignore-msgdb no-check))
355 (luna-define-method elmo-folder-list-flagged ((folder elmo-pipe-folder)
358 (elmo-folder-list-flagged
359 (elmo-pipe-folder-dst-internal folder) flag in-msgdb))
361 (luna-define-method elmo-folder-commit ((folder elmo-pipe-folder))
362 (elmo-folder-commit (elmo-pipe-folder-dst-internal folder)))
364 (luna-define-method elmo-folder-length ((folder elmo-pipe-folder))
365 (elmo-folder-length (elmo-pipe-folder-dst-internal folder)))
367 (luna-define-method elmo-folder-count-flags ((folder elmo-pipe-folder))
368 (elmo-folder-count-flags (elmo-pipe-folder-dst-internal folder)))
370 (luna-define-method elmo-message-mark ((folder elmo-pipe-folder) number)
371 (elmo-message-mark (elmo-pipe-folder-dst-internal folder) number))
373 (luna-define-method elmo-message-field ((folder elmo-pipe-folder)
375 (elmo-message-field (elmo-pipe-folder-dst-internal folder)
379 (luna-define-method elmo-message-set-cached ((folder elmo-pipe-folder)
381 (elmo-message-set-cached (elmo-pipe-folder-dst-internal folder)
384 (luna-define-method elmo-find-fetch-strategy
385 ((folder elmo-pipe-folder) entity &optional ignore-cache)
386 (elmo-find-fetch-strategy (elmo-pipe-folder-dst-internal folder)
388 (elmo-pipe-folder-dst-internal folder)
389 (elmo-message-entity-number entity))
392 (luna-define-method elmo-message-entity ((folder elmo-pipe-folder) key)
393 (elmo-message-entity (elmo-pipe-folder-dst-internal folder) key))
395 (luna-define-method elmo-message-folder ((folder elmo-pipe-folder)
397 (elmo-pipe-folder-dst-internal folder))
400 (product-provide (provide 'elmo-pipe) (require 'elmo-version))
402 ;;; elmo-pipe.el ends here