1 ;;; elmo-dop.el -- Modules for Disconnected Operations on ELMO.
3 ;; Copyright 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.
37 (require 'elmo-localdir))
40 (defvar elmo-dop-queue nil
41 "A list of (folder-name function-to-be-called argument-list).
42 Automatically loaded/saved.")
44 (defun elmo-dop-queue-append (folder function argument)
45 (let ((operation (list (format "%s" folder) function argument)))
47 (unless (member operation elmo-dop-queue) ;; don't append same operation
49 (append elmo-dop-queue
51 (elmo-dop-queue-save))))
53 (defun elmo-dop-queue-flush (&optional force)
54 "Flush Disconnected operations.
55 If optional argument FORCE is non-nil, try flushing all operation queues
56 even an operation concerns the unplugged folder."
57 (elmo-dop-queue-load) ; load cache.
58 (elmo-dop-queue-merge)
59 (let ((queue elmo-dop-queue)
63 (if (or force (elmo-folder-plugged-p (caar queue)))
64 (setq count (1+ count)))
65 (setq queue (cdr queue)))
68 (format "%d pending operation(s) exists. Perform now?" count)
69 (not elmo-dop-flush-confirm) t)
73 (let ((queue elmo-dop-queue)
76 (num (length elmo-dop-queue))
79 ;; now perform pending processes.
82 (message "Flushing queue....%d/%d." i num)
85 (not (elmo-folder-plugged-p (nth 0 (car queue)))))
87 (setq folder (nth 0 (car queue))
88 func (nth 1 (car queue)))
90 ((string= func "prefetch-msgs")
93 (nth 2 (car queue)))) ;argunemt
94 ((string= func "append-operations")
95 (elmo-dop-flush-pending-append-operations
101 (nth 2 (car queue)) ;argunemt
103 (quit (setq failure t))
104 (error (setq failure err)))
106 ;; create-folder was failed.
107 (when (and (string= func "create-folder-maybe")
110 "Create folder %s failed. Abort creating?"
112 (not elmo-dop-flush-confirm) t))
113 (elmo-dop-save-pending-messages folder)
114 (setq elmo-dop-queue (delq (car queue) elmo-dop-queue)))
115 (setq elmo-dop-queue (delq (car queue) elmo-dop-queue))
116 (setq performed (+ 1 performed)))
117 (setq queue (cdr queue)))
118 (message "%d/%d operation(s) are performed successfully."
121 (elmo-dop-queue-save)))
122 (if (elmo-y-or-n-p "Clear all pending operations?"
123 (not elmo-dop-flush-confirm) t)
124 (let ((queue elmo-dop-queue))
126 (if (string= (nth 1 (car queue)) "append-operations")
127 (elmo-dop-append-list-save (nth 0 (car queue)) nil))
128 (setq queue (cdr queue)))
129 (setq elmo-dop-queue nil)
130 (message "All pending operations are cleared.")
131 (elmo-dop-queue-save))
135 (defconst elmo-dop-merge-funcs
143 (defun elmo-dop-queue-merge ()
144 (let ((queue elmo-dop-queue)
145 new-queue match-queue que)
146 (while (setq que (car queue))
148 (member (cadr que) elmo-dop-merge-funcs)
151 (mapcar '(lambda (new-queue)
153 (string= (car que) (car new-queue))
154 (string= (cadr que) (cadr new-queue)))
157 (setcar (cddr match-queue)
158 (append (nth 2 match-queue) (nth 2 que)))
159 (setq new-queue (append new-queue (list que))))
160 (setq queue (cdr queue)))
161 (setq elmo-dop-queue new-queue)))
163 (defun elmo-dop-queue-load ()
167 (expand-file-name elmo-queue-filename
170 (defun elmo-dop-queue-save ()
173 (expand-file-name elmo-queue-filename
177 (defun elmo-dop-lock-message (message-id &optional lock-list)
178 (let ((locked (or lock-list
181 elmo-msgdb-lock-list-filename
183 (setq locked (cons message-id locked))
185 (expand-file-name elmo-msgdb-lock-list-filename
189 (defun elmo-dop-unlock-message (message-id &optional lock-list)
190 (let ((locked (or lock-list
192 (expand-file-name elmo-msgdb-lock-list-filename
194 (setq locked (delete message-id locked))
196 (expand-file-name elmo-msgdb-lock-list-filename
200 (defun elmo-dop-lock-list-load ()
202 (expand-file-name elmo-msgdb-lock-list-filename
205 (defun elmo-dop-lock-list-save (lock-list)
207 (expand-file-name elmo-msgdb-lock-list-filename
211 (defun elmo-dop-append-list-load (folder &optional resume)
213 (expand-file-name (if resume
214 elmo-msgdb-resume-list-filename
215 elmo-msgdb-append-list-filename)
216 (elmo-msgdb-expand-path folder))))
218 (defun elmo-dop-append-list-save (folder append-list &optional resume)
221 (expand-file-name (if resume
222 elmo-msgdb-resume-list-filename
223 elmo-msgdb-append-list-filename)
224 (elmo-msgdb-expand-path folder))
227 (delete-file (expand-file-name (if resume
228 elmo-msgdb-resume-list-filename
229 elmo-msgdb-append-list-filename)
230 (elmo-msgdb-expand-path folder)))
233 (defun elmo-dop-deleting-numbers-to-msgids (alist numbers appended)
234 "returns (new-appended . deleting-msgids)."
235 (let (msgid deleting-msgids)
237 (setq msgid (cdr (assq (car numbers) alist)))
238 (if (member msgid appended)
239 (setq appended (delete msgid appended))
240 (setq deleting-msgids (append deleting-msgids (list msgid))))
241 (setq numbers (cdr numbers)))
242 (cons appended deleting-msgids)))
244 (defun elmo-dop-delete-msgs (folder msgs msgdb)
246 (let ((folder-numbers (elmo-make-folder-numbers-list folder msgs))
248 (while folder-numbers
249 (if (eq (elmo-folder-get-type (car (car folder-numbers)))
251 (if elmo-enable-disconnected-operation
253 (setq appended-deleting
254 (elmo-dop-deleting-numbers-to-msgids
255 (elmo-msgdb-get-number-alist msgdb)
256 msgs ; virtual number
257 (elmo-dop-append-list-load folder)))
258 (if (cdr appended-deleting)
259 (elmo-dop-queue-append
260 (car (car folder-numbers)) ; real folder
261 "delete-msgids" ;; for secure removal.
262 (cdr appended-deleting)))
263 (elmo-dop-append-list-save folder (car appended-deleting)))
265 ;; not imap4 folder...delete now!
266 (elmo-call-func (car (car folder-numbers)) "delete-msgs"
267 (cdr (car folder-numbers))))
268 (setq folder-numbers (cdr folder-numbers))))
271 (defun elmo-dop-prefetch-msgs (folder msgs)
273 (elmo-dop-queue-append folder "prefetch-msgs" msgs)))
275 (defun elmo-dop-list-folder (folder)
276 (if (or (memq (elmo-folder-get-type folder)
277 '(imap4 nntp pop3 filter pipe))
278 (and (elmo-multi-p folder) (not (elmo-folder-local-p folder))))
279 (if elmo-enable-disconnected-operation
280 (let* ((number-alist (elmo-msgdb-number-load
281 (elmo-msgdb-expand-path folder)))
282 (number-list (mapcar 'car number-alist))
283 (append-list (elmo-dop-append-list-load folder))
284 (append-num (length append-list))
289 (if (rassoc (car append-list) number-alist)
290 (setq alreadies (append alreadies
291 (list (car append-list)))))
292 (setq append-list (cdr append-list)))
293 (setq append-num (- append-num (length alreadies)))
295 (or (nth (max (- (length number-list) 1) 0)
297 (while (< i append-num)
300 (list (+ max-num i 1))))
304 ;; not imap4 folder...list folder
305 (elmo-call-func folder "list-folder")))
307 (defun elmo-dop-count-appended (folder)
308 (length (elmo-dop-append-list-load folder)))
310 (defun elmo-dop-call-func-on-msgs (folder func-name msgs msgdb)
311 (let ((append-list (elmo-dop-append-list-load folder))
312 (number-alist (elmo-msgdb-get-number-alist msgdb))
314 (if (eq (elmo-folder-get-type folder) 'imap4)
317 (if (setq matched (car (rassoc (car append-list) number-alist)))
318 (setq msgs (delete matched msgs)))
319 (setq append-list (cdr append-list)))
321 (elmo-dop-queue-append folder func-name msgs)))
322 ;; maildir... XXX hard coding.....
323 (if (not (featurep 'elmo-maildir))
325 (funcall (intern (format "elmo-maildir-%s" func-name))
326 (elmo-folder-get-spec folder)
329 (defun elmo-dop-max-of-folder (folder)
330 (if (eq (elmo-folder-get-type folder) 'imap4)
331 (if elmo-enable-disconnected-operation
332 (let* ((number-alist (elmo-msgdb-number-load
333 (elmo-msgdb-expand-path folder)))
334 (number-list (mapcar 'car number-alist))
335 (append-list (elmo-dop-append-list-load folder))
336 (append-num (length append-list))
341 (if (rassoc (car append-list) number-alist)
342 (setq alreadies (append alreadies
343 (list (car append-list)))))
344 (setq append-list (cdr append-list)))
346 (or (nth (max (- (length number-list) 1) 0) number-list)
348 (cons (- (+ max-num append-num) (length alreadies))
349 (- (+ (length number-list) append-num) (length alreadies))))
352 (elmo-call-func folder "max-of-folder")))
354 (defun elmo-dop-save-pending-messages (folder)
355 (message (format "Saving queued message in %s..." elmo-lost+found-folder))
356 (let* ((append-list (elmo-dop-append-list-load folder))
359 (when (setq file-string (elmo-get-file-string ; message string
362 (elmo-append-msg elmo-lost+found-folder file-string)
363 (elmo-dop-unlock-message (car append-list)))
364 (setq append-list (cdr append-list))
365 (elmo-dop-append-list-save folder nil)))
366 (message (format "Saving queued message in %s...done."
367 elmo-lost+found-folder)))
369 (defun elmo-dop-flush-pending-append-operations (folder &optional appends resume)
370 (message "Appending queued messages...")
371 (let* ((append-list (or appends
372 (elmo-dop-append-list-load folder)))
373 (appendings append-list)
375 (num (length append-list))
378 ;; Resume msgdb changed by elmo-dop-msgdb-create.
379 (let* ((resumed-list (elmo-dop-append-list-load folder t))
380 (number-alist (elmo-msgdb-number-load
381 (elmo-msgdb-expand-path folder)))
382 (appendings append-list)
385 (if (setq pair (rassoc (car appendings) number-alist))
386 (setq resumed-list (append resumed-list
387 (list (car appendings)))))
388 (setq appendings (cdr appendings)))
389 (elmo-dop-append-list-save folder resumed-list t)))
392 (setq file-string (elmo-get-file-string ; message string
397 (elmo-append-msg folder file-string (car appendings))
398 (quit (setq failure t))
399 (error (setq failure t)))
401 (message (format "Appending queued messages...%d" i))
403 (elmo-append-msg elmo-lost+found-folder
404 file-string (car appendings))))
405 (elmo-dop-unlock-message (car appendings))
406 (setq appendings (cdr appendings)))
407 ;; All pending append operation is flushed.
408 (elmo-dop-append-list-save folder nil)
411 ;; delete '(folder "append-operations") in elmo-dop-queue.
412 (let (elmo-dop-queue)
413 (elmo-dop-queue-load)
414 (setq elmo-dop-queue (delete (list folder "append-operations" nil)
416 (elmo-dop-queue-save))))
417 (message "Appending queued messages...done."))
419 (defun elmo-dop-folder-exists-p (folder)
420 (if (and elmo-enable-disconnected-operation
421 (eq (elmo-folder-get-type folder) 'imap4))
422 (file-exists-p (elmo-msgdb-expand-path folder))
423 (elmo-call-func folder "folder-exists-p")))
425 (defun elmo-dop-create-folder (folder)
426 (if (eq (elmo-folder-get-type folder) 'imap4)
427 (if elmo-enable-disconnected-operation
428 (elmo-dop-queue-append folder "create-folder-maybe" nil)
430 (elmo-call-func folder "create-folder")))
432 (defun elmo-dop-delete-folder (folder)
435 (defun elmo-dop-rename-folder (old-folder new-folder)
438 (defun elmo-dop-append-msg (folder string message-id &optional msg)
439 (if elmo-enable-disconnected-operation
442 (unless (elmo-cache-exists-p message-id)
445 (elmo-cache-save message-id nil folder msg (current-buffer))))
446 (let ((append-list (elmo-dop-append-list-load folder))
447 (number-alist (elmo-msgdb-number-load
448 (elmo-msgdb-expand-path folder))))
449 (when (and ; not in current folder.
450 (not (rassoc message-id number-alist))
451 (not (member message-id append-list)))
453 (append append-list (list message-id)))
454 (elmo-dop-lock-message message-id)
455 (elmo-dop-append-list-save folder append-list)
456 (elmo-dop-queue-append folder "append-operations" nil))
459 (error "Unplugged")))
461 (defalias 'elmo-dop-msgdb-create 'elmo-dop-msgdb-create-as-numlist)
463 (defun elmo-dop-msgdb-create-as-numlist (folder numlist new-mark already-mark
464 seen-mark important-mark
466 (if (or (eq (elmo-folder-get-type folder) 'imap4)
467 (eq (elmo-folder-get-type folder) 'nntp))
468 (if elmo-enable-disconnected-operation
469 (let* ((num-alist (elmo-msgdb-number-load
470 (elmo-msgdb-expand-path folder)))
471 (number-list (mapcar 'car num-alist))
472 (ov (elmo-msgdb-overview-load
473 (elmo-msgdb-expand-path folder)))
474 (append-list (elmo-dop-append-list-load folder))
475 (num (length numlist))
477 overview number-alist mark-alist msgid ov-entity
478 max-num percent seen gmark)
480 (or (nth (max (- (length number-list) 1) 0) number-list)
484 (nth (+ (length append-list)
485 (- (car numlist) max-num 1 num))
489 (elmo-msgdb-append-element
491 (elmo-localdir-msgdb-create-overview-entity-from-file
493 (elmo-cache-get-path msgid))))
495 (elmo-msgdb-number-add number-alist
496 (car numlist) msgid))
497 (setq seen (member msgid seen-list))
499 (or (elmo-msgdb-global-mark-get msgid)
500 (if (elmo-cache-exists-p
511 (elmo-msgdb-mark-append
512 mark-alist (car numlist) gmark))))
514 (when (setq ov-entity (assoc
515 (cdr (assq (car numlist) num-alist))
518 (elmo-msgdb-append-element
521 (elmo-msgdb-number-add number-alist
524 (setq seen (member ov-entity seen-list))
526 (or (elmo-msgdb-global-mark-get (car ov-entity))
527 (if (elmo-cache-exists-p
538 (elmo-msgdb-mark-append
539 mark-alist (car numlist) gmark)))))
541 (setq percent (/ (* i 100) num))
542 (elmo-display-progress
543 'elmo-dop-msgdb-create-as-numlist "Creating msgdb..."
545 (setq numlist (cdr numlist)))
546 (list overview number-alist mark-alist))
548 ;; not imap4 folder...
549 (elmo-call-func folder "msgdb-create" numlist new-mark already-mark
550 seen-mark important-mark seen-list)))
554 ;;; elmo-dop.el ends here