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 (and (eq (elmo-folder-type-internal
110 (not copy))) ; No need to use UIDL
112 (message "Checking %s..." (elmo-folder-name-internal src))
113 ;; Warnnig: some function requires msgdb
114 ;; but elmo-folder-open-internal do not load msgdb.
115 (elmo-folder-open-internal src)
116 (setq msgs (elmo-pipe-folder-list-target-messages src ignore-list)
118 (when (> len elmo-display-progress-threshold)
119 (elmo-progress-set 'elmo-folder-move-messages
122 "Copying messages..."
123 "Moving messages...")))
125 (elmo-folder-move-messages src msgs dst copy)
126 (elmo-progress-clear 'elmo-folder-move-messages))
127 (when (and copy msgs)
128 (setq ignore-list (elmo-number-set-append-list ignore-list
130 (elmo-folder-close-internal src)
131 (run-hooks 'elmo-pipe-drained-hook)
134 (defun elmo-pipe-folder-copied-list-load (folder)
136 (expand-file-name elmo-pipe-folder-copied-filename
138 (elmo-replace-string-as-filename
139 (elmo-folder-name-internal folder))
140 (expand-file-name "pipe" elmo-msgdb-directory)))
143 (defun elmo-pipe-folder-copied-list-save (folder copied-list)
145 (expand-file-name elmo-pipe-folder-copied-filename
147 (elmo-replace-string-as-filename
148 (elmo-folder-name-internal folder))
149 (expand-file-name "pipe" elmo-msgdb-directory)))
152 (luna-define-method elmo-folder-msgdb ((folder elmo-pipe-folder))
153 (elmo-folder-msgdb (elmo-pipe-folder-dst-internal folder)))
155 (luna-define-method elmo-folder-open-internal ((folder elmo-pipe-folder))
156 (elmo-folder-open-internal (elmo-pipe-folder-dst-internal folder)))
158 (luna-define-method elmo-folder-close-internal ((folder elmo-pipe-folder))
159 (elmo-folder-close-internal(elmo-pipe-folder-dst-internal folder)))
161 (luna-define-method elmo-folder-set-message-modified
162 ((folder elmo-pipe-folder) modified)
163 (elmo-folder-set-message-modified-internal
164 (elmo-pipe-folder-dst-internal folder) modified))
166 (luna-define-method elmo-folder-list-messages ((folder elmo-pipe-folder)
167 &optional visible-only in-msgdb)
168 ;; Use target folder's killed-list in the pipe folder.
169 (elmo-folder-list-messages (elmo-pipe-folder-dst-internal
170 folder) visible-only in-msgdb))
172 (luna-define-method elmo-folder-list-unreads ((folder elmo-pipe-folder))
173 (elmo-folder-list-unreads (elmo-pipe-folder-dst-internal folder)))
175 (luna-define-method elmo-folder-list-importants ((folder elmo-pipe-folder))
176 (elmo-folder-list-importants (elmo-pipe-folder-dst-internal folder)))
178 (luna-define-method elmo-folder-list-answereds ((folder elmo-pipe-folder))
179 (elmo-folder-list-answereds (elmo-pipe-folder-dst-internal folder)))
181 (luna-define-method elmo-folder-diff ((folder elmo-pipe-folder))
182 (elmo-folder-open-internal (elmo-pipe-folder-src-internal folder))
183 (elmo-folder-open-internal (elmo-pipe-folder-dst-internal folder))
184 (let* ((elmo-inhibit-number-mapping
185 (not (elmo-pipe-folder-copy-internal folder)))
186 (src-length (length (elmo-pipe-folder-list-target-messages
187 (elmo-pipe-folder-src-internal folder)
188 (elmo-pipe-folder-copied-list-load folder))))
189 (dst-diff (elmo-folder-diff (elmo-pipe-folder-dst-internal folder))))
192 ((consp (cdr dst-diff)) ; new unread all
193 (mapcar (lambda (number) (+ number src-length)) dst-diff))
195 (cons (+ (car dst-diff) src-length)
196 (+ (cdr dst-diff) src-length))))
198 (elmo-folder-close-internal (elmo-pipe-folder-src-internal folder))
199 (elmo-folder-close-internal (elmo-pipe-folder-dst-internal folder)))))
201 (luna-define-method elmo-folder-exists-p ((folder elmo-pipe-folder))
202 (and (elmo-folder-exists-p (elmo-pipe-folder-src-internal folder))
203 (elmo-folder-exists-p (elmo-pipe-folder-dst-internal folder))))
205 (luna-define-method elmo-folder-expand-msgdb-path ((folder
207 ;; Share with destination...OK?
208 (elmo-folder-expand-msgdb-path (elmo-pipe-folder-dst-internal folder)))
210 (luna-define-method elmo-folder-newsgroups ((folder elmo-pipe-folder))
211 (elmo-folder-newsgroups (elmo-pipe-folder-src-internal folder)))
213 (luna-define-method elmo-folder-creatable-p ((folder elmo-pipe-folder))
215 (elmo-folder-exists-p (elmo-pipe-folder-src-internal folder))
216 (elmo-folder-creatable-p (elmo-pipe-folder-src-internal folder)))
218 (elmo-folder-exists-p (elmo-pipe-folder-dst-internal folder))
219 (elmo-folder-creatable-p (elmo-pipe-folder-dst-internal folder)))))
221 (luna-define-method elmo-folder-writable-p ((folder elmo-pipe-folder))
222 (elmo-folder-writable-p (elmo-pipe-folder-dst-internal folder)))
224 (luna-define-method elmo-folder-create ((folder elmo-pipe-folder))
225 (if (and (not (elmo-folder-exists-p (elmo-pipe-folder-src-internal folder)))
226 (elmo-folder-creatable-p (elmo-pipe-folder-src-internal folder)))
227 (elmo-folder-create (elmo-pipe-folder-src-internal folder)))
228 (if (and (not (elmo-folder-exists-p (elmo-pipe-folder-dst-internal folder)))
229 (elmo-folder-creatable-p (elmo-pipe-folder-dst-internal folder)))
230 (elmo-folder-create (elmo-pipe-folder-dst-internal folder))))
232 (luna-define-method elmo-folder-search ((folder elmo-pipe-folder)
233 condition &optional numlist)
234 (elmo-folder-search (elmo-pipe-folder-dst-internal folder)
237 (luna-define-method elmo-message-use-cache-p ((folder elmo-pipe-folder) number)
238 (elmo-message-use-cache-p (elmo-pipe-folder-dst-internal folder) number))
240 (luna-define-method elmo-folder-check ((folder elmo-pipe-folder))
241 (elmo-folder-check (elmo-pipe-folder-dst-internal folder)))
243 (luna-define-method elmo-folder-plugged-p ((folder elmo-pipe-folder))
244 (and (elmo-folder-plugged-p (elmo-pipe-folder-src-internal folder))
245 (elmo-folder-plugged-p (elmo-pipe-folder-dst-internal folder))))
247 (luna-define-method elmo-folder-message-file-p ((folder elmo-pipe-folder))
248 (elmo-folder-message-file-p (elmo-pipe-folder-dst-internal folder)))
250 (luna-define-method elmo-message-file-p ((folder elmo-pipe-folder) number)
251 (elmo-message-file-p (elmo-pipe-folder-dst-internal folder) number))
253 (luna-define-method elmo-message-file-name ((folder elmo-pipe-folder) number)
254 (elmo-message-file-name (elmo-pipe-folder-dst-internal folder) number))
256 (luna-define-method elmo-folder-message-file-number-p ((folder
258 (elmo-folder-message-file-number-p (elmo-pipe-folder-dst-internal folder)))
260 (luna-define-method elmo-folder-message-file-directory ((folder
262 (elmo-folder-message-file-directory
263 (elmo-pipe-folder-dst-internal folder)))
265 (luna-define-method elmo-folder-message-make-temp-file-p
266 ((folder elmo-pipe-folder))
267 (elmo-folder-message-make-temp-file-p
268 (elmo-pipe-folder-dst-internal folder)))
270 (luna-define-method elmo-folder-message-make-temp-files ((folder
275 (elmo-folder-message-make-temp-files
276 (elmo-pipe-folder-dst-internal folder) numbers start-number))
278 (luna-define-method elmo-folder-mark-as-read ((folder elmo-pipe-folder)
279 numbers &optional ignore-flag)
280 (elmo-folder-mark-as-read (elmo-pipe-folder-dst-internal folder)
281 numbers ignore-flag))
283 (luna-define-method elmo-folder-unmark-read ((folder elmo-pipe-folder)
285 &optional ignore-flag)
286 (elmo-folder-unmark-read (elmo-pipe-folder-dst-internal folder)
287 numbers ignore-flag))
289 (luna-define-method elmo-folder-unmark-important ((folder elmo-pipe-folder)
291 &optional ignore-flag)
292 (elmo-folder-unmark-important (elmo-pipe-folder-dst-internal folder)
293 numbers ignore-flag))
295 (luna-define-method elmo-folder-mark-as-important ((folder elmo-pipe-folder)
297 &optional ignore-flag)
298 (elmo-folder-mark-as-important (elmo-pipe-folder-dst-internal folder)
299 numbers ignore-flag))
301 (luna-define-method elmo-folder-unmark-answered ((folder elmo-pipe-folder)
303 (elmo-folder-unmark-answered (elmo-pipe-folder-dst-internal folder)
306 (luna-define-method elmo-folder-mark-as-answered ((folder elmo-pipe-folder)
308 (elmo-folder-mark-as-answered (elmo-pipe-folder-dst-internal folder)
311 (luna-define-method elmo-folder-pack-numbers ((folder elmo-pipe-folder))
312 (elmo-folder-pack-numbers (elmo-pipe-folder-dst-internal folder)))
314 (luna-define-method elmo-folder-rename ((folder elmo-pipe-folder) new-name)
315 (let* ((new-folder (elmo-make-folder new-name)))
316 (unless (string= (elmo-folder-name-internal
317 (elmo-pipe-folder-src-internal folder))
318 (elmo-folder-name-internal
319 (elmo-pipe-folder-src-internal new-folder)))
320 (error "Source folder differ"))
321 (unless (eq (elmo-folder-type-internal
322 (elmo-pipe-folder-dst-internal folder))
323 (elmo-folder-type-internal
324 (elmo-pipe-folder-dst-internal new-folder)))
325 (error "Not same folder type"))
326 (if (or (file-exists-p (elmo-folder-msgdb-path
327 (elmo-pipe-folder-dst-internal new-folder)))
328 (elmo-folder-exists-p
329 (elmo-pipe-folder-dst-internal new-folder)))
330 (error "Already exists folder: %s" new-name))
331 (elmo-folder-send (elmo-pipe-folder-dst-internal folder)
332 'elmo-folder-rename-internal
333 (elmo-pipe-folder-dst-internal new-folder))
334 (elmo-msgdb-rename-path folder new-folder)))
336 (luna-define-method elmo-folder-synchronize ((folder elmo-pipe-folder)
341 (let ((src-folder (elmo-pipe-folder-src-internal folder))
342 (dst-folder (elmo-pipe-folder-dst-internal folder)))
343 (when (and (elmo-folder-plugged-p src-folder)
344 (elmo-folder-plugged-p dst-folder))
345 (if (elmo-pipe-folder-copy-internal folder)
346 (elmo-pipe-folder-copied-list-save
348 (elmo-pipe-drain src-folder
351 (elmo-pipe-folder-copied-list-load folder)))
352 (elmo-pipe-drain src-folder dst-folder))))
353 (elmo-folder-synchronize
354 (elmo-pipe-folder-dst-internal folder)
355 disable-killed ignore-msgdb no-check))
357 (luna-define-method elmo-folder-list-flagged ((folder elmo-pipe-folder)
360 (elmo-folder-list-flagged
361 (elmo-pipe-folder-dst-internal folder) flag in-msgdb))
363 (luna-define-method elmo-folder-commit ((folder elmo-pipe-folder))
364 (elmo-folder-commit (elmo-pipe-folder-dst-internal folder)))
366 (luna-define-method elmo-folder-length ((folder elmo-pipe-folder))
367 (elmo-folder-length (elmo-pipe-folder-dst-internal folder)))
369 (luna-define-method elmo-folder-count-flags ((folder elmo-pipe-folder))
370 (elmo-folder-count-flags (elmo-pipe-folder-dst-internal folder)))
372 (luna-define-method elmo-message-mark ((folder elmo-pipe-folder) number)
373 (elmo-message-mark (elmo-pipe-folder-dst-internal folder) number))
375 (luna-define-method elmo-message-flags ((folder elmo-pipe-folder) number)
376 (elmo-message-flags (elmo-pipe-folder-dst-internal folder) number))
378 (luna-define-method elmo-message-field ((folder elmo-pipe-folder)
380 (elmo-message-field (elmo-pipe-folder-dst-internal folder)
384 (luna-define-method elmo-message-set-cached ((folder elmo-pipe-folder)
386 (elmo-message-set-cached (elmo-pipe-folder-dst-internal folder)
389 (luna-define-method elmo-find-fetch-strategy
390 ((folder elmo-pipe-folder) entity &optional ignore-cache)
391 (elmo-find-fetch-strategy (elmo-pipe-folder-dst-internal folder)
393 (elmo-pipe-folder-dst-internal folder)
394 (elmo-message-entity-number entity))
397 (luna-define-method elmo-message-entity ((folder elmo-pipe-folder) key)
398 (elmo-message-entity (elmo-pipe-folder-dst-internal folder) key))
400 (luna-define-method elmo-message-folder ((folder elmo-pipe-folder)
402 (elmo-pipe-folder-dst-internal folder))
405 (product-provide (provide 'elmo-pipe) (require 'elmo-version))
407 ;;; elmo-pipe.el ends here