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.
33 (require 'elmo-signal)
35 (defvar elmo-pipe-folder-copied-filename "copied"
36 "Copied messages number set.")
40 (luna-define-class elmo-pipe-folder (elmo-folder)
42 (luna-define-internal-accessors 'elmo-pipe-folder))
44 (luna-define-method elmo-folder-initialize ((folder elmo-pipe-folder)
46 (when (string-match "^\\([^|]*\\)|\\(:?\\)\\(.*\\)$" name)
47 (elmo-pipe-folder-set-src-internal folder
49 (elmo-match-string 1 name)))
50 (elmo-pipe-folder-set-dst-internal folder
52 (elmo-match-string 3 name)))
53 (elmo-pipe-folder-set-copy-internal folder
55 (elmo-match-string 2 name))))
56 (elmo-pipe-connect-signals folder (elmo-pipe-folder-dst-internal folder))
59 (defun elmo-pipe-connect-signals (folder destination)
61 destination 'flag-changing folder
62 (elmo-define-signal-handler (folder dst number old-flags new-flags)
63 (elmo-emit-signal 'flag-changing folder number old-flags new-flags)))
65 destination 'flag-changed folder
66 (elmo-define-signal-handler (folder dst numbers)
67 (elmo-emit-signal 'flag-changed folder numbers)))
69 destination 'cache-changed folder
70 (elmo-define-signal-handler (folder dst number)
71 (elmo-emit-signal 'cache-changed folder number)))
73 destination 'update-overview folder
74 (elmo-define-signal-handler (folder dst number)
75 (elmo-emit-signal 'update-overview folder number))))
77 (luna-define-method elmo-folder-get-primitive-list ((folder elmo-pipe-folder))
79 (elmo-folder-get-primitive-list (elmo-pipe-folder-src-internal folder))
80 (elmo-folder-get-primitive-list (elmo-pipe-folder-dst-internal folder))))
82 (luna-define-method elmo-folder-contains-type ((folder elmo-pipe-folder)
84 (or (elmo-folder-contains-type (elmo-pipe-folder-src-internal folder) type)
85 (elmo-folder-contains-type (elmo-pipe-folder-dst-internal folder) type)))
87 (luna-define-method elmo-folder-append-messages ((folder elmo-pipe-folder)
89 &optional same-number)
90 (elmo-folder-append-messages (elmo-pipe-folder-dst-internal folder)
94 (luna-define-method elmo-folder-append-buffer ((folder elmo-pipe-folder)
95 &optional flag number)
96 (elmo-folder-append-buffer (elmo-pipe-folder-dst-internal folder)
99 (luna-define-method elmo-message-fetch ((folder elmo-pipe-folder)
101 &optional unseen section)
102 (elmo-message-fetch (elmo-pipe-folder-dst-internal folder)
103 number strategy unseen section))
105 (luna-define-method elmo-folder-clear :after ((folder elmo-pipe-folder)
106 &optional keep-killed)
108 (elmo-pipe-folder-copied-list-save folder nil)))
110 (luna-define-method elmo-folder-delete-messages ((folder elmo-pipe-folder)
112 (elmo-folder-delete-messages (elmo-pipe-folder-dst-internal folder)
115 (luna-define-method elmo-folder-detach-messages ((folder elmo-pipe-folder)
117 (elmo-folder-detach-messages (elmo-pipe-folder-dst-internal folder)
120 (defvar elmo-pipe-drained-hook nil "A hook called when the pipe is flushed.")
122 (defsubst elmo-pipe-folder-list-target-messages (src &optional ignore-list)
125 (elmo-folder-set-killed-list-internal src ignore-list)
126 (elmo-folder-list-messages src t))
127 (elmo-folder-set-killed-list-internal src nil)))
129 (defun elmo-pipe-drain (src dst &optional copy ignore-list)
130 "Move or copy all messages of SRC to DST."
131 (let ((elmo-inhibit-number-mapping (and (eq (elmo-folder-type-internal
133 (not copy))) ; No need to use UIDL
135 (message "Checking %s..." (elmo-folder-name-internal src))
136 ;; Warnnig: some function requires msgdb
137 ;; but elmo-folder-open-internal do not load msgdb.
138 (elmo-folder-open-internal src)
139 (setq msgs (elmo-pipe-folder-list-target-messages src ignore-list)
141 (when (> len elmo-display-progress-threshold)
142 (elmo-progress-set 'elmo-folder-move-messages
145 "Copying messages..."
146 "Moving messages...")))
148 (elmo-folder-move-messages src msgs dst copy)
149 (elmo-progress-clear 'elmo-folder-move-messages))
150 (when (and copy msgs)
151 (setq ignore-list (elmo-number-set-append-list ignore-list
153 (elmo-folder-close-internal src)
154 (run-hooks 'elmo-pipe-drained-hook)
157 (defun elmo-pipe-folder-copied-list-load (folder)
159 (expand-file-name elmo-pipe-folder-copied-filename
161 (elmo-replace-string-as-filename
162 (elmo-folder-name-internal folder))
163 (expand-file-name "pipe" elmo-msgdb-directory)))
166 (defun elmo-pipe-folder-copied-list-save (folder copied-list)
168 (expand-file-name elmo-pipe-folder-copied-filename
170 (elmo-replace-string-as-filename
171 (elmo-folder-name-internal folder))
172 (expand-file-name "pipe" elmo-msgdb-directory)))
175 (luna-define-method elmo-folder-msgdb ((folder elmo-pipe-folder))
176 (elmo-folder-msgdb (elmo-pipe-folder-dst-internal folder)))
178 (luna-define-method elmo-folder-open-internal ((folder elmo-pipe-folder))
179 (elmo-folder-open-internal (elmo-pipe-folder-dst-internal folder)))
181 (luna-define-method elmo-folder-close-internal ((folder elmo-pipe-folder))
182 (elmo-folder-close-internal(elmo-pipe-folder-dst-internal folder)))
184 (luna-define-method elmo-folder-list-messages ((folder elmo-pipe-folder)
185 &optional visible-only in-msgdb)
186 ;; Use target folder's killed-list in the pipe folder.
187 (elmo-folder-list-messages (elmo-pipe-folder-dst-internal
188 folder) visible-only in-msgdb))
190 (luna-define-method elmo-folder-diff ((folder elmo-pipe-folder))
191 (elmo-folder-open-internal (elmo-pipe-folder-src-internal folder))
192 (elmo-folder-open-internal (elmo-pipe-folder-dst-internal folder))
193 (let* ((elmo-inhibit-number-mapping
194 (not (elmo-pipe-folder-copy-internal folder)))
195 (src-length (length (elmo-pipe-folder-list-target-messages
196 (elmo-pipe-folder-src-internal folder)
197 (elmo-pipe-folder-copied-list-load folder))))
198 (dst-diff (elmo-folder-diff (elmo-pipe-folder-dst-internal folder))))
201 ((consp (cdr dst-diff)) ; new unread all
202 (mapcar (lambda (number) (+ number src-length)) dst-diff))
204 (cons (+ (or (car dst-diff) 0) src-length)
205 (+ (or (cdr dst-diff) 0) src-length))))
207 (elmo-folder-close-internal (elmo-pipe-folder-src-internal folder))
208 (elmo-folder-close-internal (elmo-pipe-folder-dst-internal folder)))))
210 (luna-define-method elmo-folder-exists-p ((folder elmo-pipe-folder))
211 (and (elmo-folder-exists-p (elmo-pipe-folder-src-internal folder))
212 (elmo-folder-exists-p (elmo-pipe-folder-dst-internal folder))))
214 (luna-define-method elmo-folder-expand-msgdb-path ((folder
216 ;; Share with destination...OK?
217 (elmo-folder-expand-msgdb-path (elmo-pipe-folder-dst-internal folder)))
219 (luna-define-method elmo-folder-newsgroups ((folder elmo-pipe-folder))
220 (elmo-folder-newsgroups (elmo-pipe-folder-src-internal folder)))
222 (luna-define-method elmo-folder-creatable-p ((folder elmo-pipe-folder))
224 (elmo-folder-exists-p (elmo-pipe-folder-src-internal folder))
225 (elmo-folder-creatable-p (elmo-pipe-folder-src-internal folder)))
227 (elmo-folder-exists-p (elmo-pipe-folder-dst-internal folder))
228 (elmo-folder-creatable-p (elmo-pipe-folder-dst-internal folder)))))
230 (luna-define-method elmo-folder-writable-p ((folder elmo-pipe-folder))
231 (elmo-folder-writable-p (elmo-pipe-folder-dst-internal folder)))
233 (luna-define-method elmo-folder-create ((folder elmo-pipe-folder))
234 (if (and (not (elmo-folder-exists-p (elmo-pipe-folder-src-internal folder)))
235 (elmo-folder-creatable-p (elmo-pipe-folder-src-internal folder)))
236 (elmo-folder-create (elmo-pipe-folder-src-internal folder)))
237 (if (and (not (elmo-folder-exists-p (elmo-pipe-folder-dst-internal folder)))
238 (elmo-folder-creatable-p (elmo-pipe-folder-dst-internal folder)))
239 (elmo-folder-create (elmo-pipe-folder-dst-internal folder))))
241 (luna-define-method elmo-folder-search ((folder elmo-pipe-folder)
242 condition &optional numlist)
243 (elmo-folder-search (elmo-pipe-folder-dst-internal folder)
246 (luna-define-method elmo-message-use-cache-p ((folder elmo-pipe-folder) number)
247 (elmo-message-use-cache-p (elmo-pipe-folder-dst-internal folder) number))
249 (luna-define-method elmo-folder-check ((folder elmo-pipe-folder))
250 (elmo-folder-check (elmo-pipe-folder-dst-internal folder)))
252 (luna-define-method elmo-folder-plugged-p ((folder elmo-pipe-folder))
253 (and (elmo-folder-plugged-p (elmo-pipe-folder-src-internal folder))
254 (elmo-folder-plugged-p (elmo-pipe-folder-dst-internal folder))))
256 (luna-define-method elmo-folder-message-file-p ((folder elmo-pipe-folder))
257 (elmo-folder-message-file-p (elmo-pipe-folder-dst-internal folder)))
259 (luna-define-method elmo-message-file-p ((folder elmo-pipe-folder) number)
260 (elmo-message-file-p (elmo-pipe-folder-dst-internal folder) number))
262 (luna-define-method elmo-message-file-name ((folder elmo-pipe-folder) number)
263 (elmo-message-file-name (elmo-pipe-folder-dst-internal folder) number))
265 (luna-define-method elmo-folder-message-file-number-p ((folder
267 (elmo-folder-message-file-number-p (elmo-pipe-folder-dst-internal folder)))
269 (luna-define-method elmo-folder-message-file-directory ((folder
271 (elmo-folder-message-file-directory
272 (elmo-pipe-folder-dst-internal folder)))
274 (luna-define-method elmo-folder-message-make-temp-file-p
275 ((folder elmo-pipe-folder))
276 (elmo-folder-message-make-temp-file-p
277 (elmo-pipe-folder-dst-internal folder)))
279 (luna-define-method elmo-folder-message-make-temp-files ((folder
284 (elmo-folder-message-make-temp-files
285 (elmo-pipe-folder-dst-internal folder) numbers start-number))
287 (luna-define-method elmo-folder-set-flag ((folder elmo-pipe-folder)
291 (elmo-folder-set-flag (elmo-pipe-folder-dst-internal folder)
292 numbers flag is-local))
294 (luna-define-method elmo-folder-unset-flag ((folder elmo-pipe-folder)
298 (elmo-folder-unset-flag (elmo-pipe-folder-dst-internal folder)
299 numbers flag is-local))
301 (luna-define-method elmo-folder-pack-numbers ((folder elmo-pipe-folder))
302 (elmo-folder-pack-numbers (elmo-pipe-folder-dst-internal folder)))
304 (luna-define-method elmo-folder-rename ((folder elmo-pipe-folder) new-name)
305 (let* ((new-folder (elmo-make-folder new-name)))
306 (unless (string= (elmo-folder-name-internal
307 (elmo-pipe-folder-src-internal folder))
308 (elmo-folder-name-internal
309 (elmo-pipe-folder-src-internal new-folder)))
310 (error "Source folder differ"))
311 (unless (eq (elmo-folder-type-internal
312 (elmo-pipe-folder-dst-internal folder))
313 (elmo-folder-type-internal
314 (elmo-pipe-folder-dst-internal new-folder)))
315 (error "Not same folder type"))
316 (if (or (file-exists-p (elmo-folder-msgdb-path
317 (elmo-pipe-folder-dst-internal new-folder)))
318 (elmo-folder-exists-p
319 (elmo-pipe-folder-dst-internal new-folder)))
320 (error "Already exists folder: %s" new-name))
321 (elmo-folder-send (elmo-pipe-folder-dst-internal folder)
322 'elmo-folder-rename-internal
323 (elmo-pipe-folder-dst-internal new-folder))
324 (elmo-msgdb-rename-path folder new-folder)))
326 (luna-define-method elmo-folder-synchronize ((folder elmo-pipe-folder)
332 (let ((src-folder (elmo-pipe-folder-src-internal folder))
333 (dst-folder (elmo-pipe-folder-dst-internal folder)))
334 (when (and (elmo-folder-plugged-p src-folder)
335 (elmo-folder-plugged-p dst-folder))
336 (if (elmo-pipe-folder-copy-internal folder)
337 (elmo-pipe-folder-copied-list-save
339 (elmo-pipe-drain src-folder
342 (elmo-pipe-folder-copied-list-load folder)))
343 (elmo-pipe-drain src-folder dst-folder))))
344 (elmo-folder-synchronize
345 (elmo-pipe-folder-dst-internal folder)
346 disable-killed ignore-msgdb no-check mask))
348 (luna-define-method elmo-folder-list-flagged ((folder elmo-pipe-folder)
351 (elmo-folder-list-flagged
352 (elmo-pipe-folder-dst-internal folder) flag in-msgdb))
354 (luna-define-method elmo-folder-commit ((folder elmo-pipe-folder))
355 (elmo-folder-commit (elmo-pipe-folder-dst-internal folder)))
357 (luna-define-method elmo-folder-length ((folder elmo-pipe-folder))
358 (elmo-folder-length (elmo-pipe-folder-dst-internal folder)))
360 (luna-define-method elmo-message-flag-available-p ((folder elmo-pipe-folder)
362 (elmo-message-flag-available-p
363 (elmo-pipe-folder-dst-internal folder)
366 (luna-define-method elmo-folder-count-flags ((folder elmo-pipe-folder))
367 (elmo-folder-count-flags (elmo-pipe-folder-dst-internal folder)))
369 (luna-define-method elmo-message-flags ((folder elmo-pipe-folder) number)
370 (elmo-message-flags (elmo-pipe-folder-dst-internal folder) number))
372 (luna-define-method elmo-message-field ((folder elmo-pipe-folder)
374 (elmo-message-field (elmo-pipe-folder-dst-internal folder)
378 (luna-define-method elmo-message-set-cached ((folder elmo-pipe-folder)
380 (elmo-message-set-cached (elmo-pipe-folder-dst-internal folder)
383 (luna-define-method elmo-find-fetch-strategy ((folder elmo-pipe-folder)
388 (elmo-find-fetch-strategy (elmo-pipe-folder-dst-internal folder)
393 (luna-define-method elmo-message-number ((folder elmo-pipe-folder)
395 (elmo-message-number (elmo-pipe-folder-dst-internal folder)
398 (luna-define-method elmo-message-entity ((folder elmo-pipe-folder) key)
399 (elmo-message-entity (elmo-pipe-folder-dst-internal folder) key))
401 (luna-define-method elmo-message-folder ((folder elmo-pipe-folder)
403 (elmo-message-folder (elmo-pipe-folder-dst-internal folder) number))
406 (product-provide (provide 'elmo-pipe) (require 'elmo-version))
408 ;;; elmo-pipe.el ends here