1 ;;; elmo-dop.el -- Modules for Disconnected Operations on 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.
38 (defvar elmo-dop-queue nil
39 "A list of (folder-name function-to-be-called argument-list).
40 Automatically loaded/saved.")
42 (defun elmo-dop-queue-append (folder function argument)
43 (let ((operation (list (elmo-folder-name-internal folder)
46 (unless (member operation elmo-dop-queue) ;; don't append same operation
48 (append elmo-dop-queue
50 (elmo-dop-queue-save))))
52 (defun elmo-dop-queue-flush (&optional force)
53 "Flush Disconnected operations.
54 If optional argument FORCE is non-nil, try flushing all operation queues
55 even an operation concerns the unplugged folder."
56 (elmo-dop-queue-load) ; load cache.
57 (elmo-dop-queue-merge)
58 (let ((queue elmo-dop-queue)
62 (if (or force (elmo-folder-plugged-p (elmo-make-folder (caar queue))))
63 (setq count (1+ count)))
64 (setq queue (cdr queue)))
67 (format "%d pending operation(s) exists. Perform now? " count)
68 (not elmo-dop-flush-confirm) t)
72 (let ((queue elmo-dop-queue)
75 (num (length elmo-dop-queue))
78 ;; now perform pending processes.
81 (message "Flushing queue....%d/%d." i num)
84 (not (elmo-folder-plugged-p (nth 0 (car queue)))))
86 (setq folder (nth 0 (car queue))
87 func (nth 1 (car queue)))
89 ((string= func "prefetch-msgs")
92 (nth 2 (car queue)))) ;argunemt
93 ((string= func "append-operations")
94 (elmo-dop-flush-pending-append-operations
100 (nth 2 (car queue)) ;argunemt
102 (quit (setq failure t))
103 (error (setq failure err)))
105 ;; create-folder was failed.
106 (when (and (string= func "create-folder-maybe")
109 "Create folder %s failed. Abort creating? "
111 (not elmo-dop-flush-confirm) t))
112 (elmo-dop-save-pending-messages folder)
113 (setq elmo-dop-queue (delq (car queue) elmo-dop-queue)))
114 (setq elmo-dop-queue (delq (car queue) elmo-dop-queue))
115 (setq performed (+ 1 performed)))
116 (setq queue (cdr queue)))
117 (message "%d/%d operation(s) are performed successfully."
120 (elmo-dop-queue-save)))
121 (if (elmo-y-or-n-p "Clear all pending operations? "
122 (not elmo-dop-flush-confirm) t)
123 (let ((queue elmo-dop-queue))
125 (if (string= (nth 1 (car queue)) "append-operations")
126 (elmo-dop-append-list-save (nth 0 (car queue)) nil))
127 (setq queue (cdr queue)))
128 (setq elmo-dop-queue nil)
129 (message "All pending operations are cleared.")
130 (elmo-dop-queue-save))
134 (defconst elmo-dop-merge-funcs
142 (defun elmo-dop-queue-merge ()
143 (let ((queue elmo-dop-queue)
144 new-queue match-queue que)
145 (while (setq que (car queue))
147 (member (cadr que) elmo-dop-merge-funcs)
150 (mapcar '(lambda (new-queue)
152 (string= (car que) (car new-queue))
153 (string= (cadr que) (cadr new-queue)))
156 (setcar (cddr match-queue)
157 (append (nth 2 match-queue) (nth 2 que)))
158 (setq new-queue (append new-queue (list que))))
159 (setq queue (cdr queue)))
160 (setq elmo-dop-queue new-queue)))
162 (defun elmo-dop-queue-load ()
166 (expand-file-name elmo-queue-filename
169 (defun elmo-dop-queue-save ()
172 (expand-file-name elmo-queue-filename
176 (defun elmo-dop-lock-message (message-id &optional lock-list)
177 (let ((locked (or lock-list
180 elmo-msgdb-lock-list-filename
182 (setq locked (cons message-id locked))
184 (expand-file-name elmo-msgdb-lock-list-filename
188 (defun elmo-dop-unlock-message (message-id &optional lock-list)
189 (let ((locked (or lock-list
191 (expand-file-name elmo-msgdb-lock-list-filename
193 (setq locked (delete message-id locked))
195 (expand-file-name elmo-msgdb-lock-list-filename
199 (defun elmo-dop-lock-list-load ()
201 (expand-file-name elmo-msgdb-lock-list-filename
204 (defun elmo-dop-lock-list-save (lock-list)
206 (expand-file-name elmo-msgdb-lock-list-filename
210 (defun elmo-dop-append-list-load (folder &optional resume)
212 (expand-file-name (if resume
213 elmo-msgdb-resume-list-filename
214 elmo-msgdb-append-list-filename)
215 (elmo-folder-msgdb-path folder))))
217 (defun elmo-dop-append-list-save (folder append-list &optional resume)
220 (expand-file-name (if resume
221 elmo-msgdb-resume-list-filename
222 elmo-msgdb-append-list-filename)
223 (elmo-folder-msgdb-path folder))
226 (delete-file (expand-file-name (if resume
227 elmo-msgdb-resume-list-filename
228 elmo-msgdb-append-list-filename)
229 (elmo-folder-msgdb-path folder)))
232 (defun elmo-dop-deleting-numbers-to-msgids (alist numbers appended)
233 "returns (new-appended . deleting-msgids)."
234 (let (msgid deleting-msgids)
236 (setq msgid (cdr (assq (car numbers) alist)))
237 (if (member msgid appended)
238 (setq appended (delete msgid appended))
239 (setq deleting-msgids (append deleting-msgids (list msgid))))
240 (setq numbers (cdr numbers)))
241 (cons appended deleting-msgids)))
243 (defun elmo-dop-list-deleted (name number-alist)
244 "List message numbers to be deleted on folder with NAME from NUMBER-ALIST."
245 (elmo-dop-queue-load)
246 (let ((queue elmo-dop-queue)
247 numbers matches nalist)
249 (if (and (string= (nth 0 (car queue)) name)
250 (string= (nth 1 (car queue)) "delete-msgids"))
256 (elmo-string-rassoc-all
258 (nth 2 (car queue)))))))
259 (setq queue (cdr queue)))
260 (elmo-uniq-list (elmo-flatten numbers))))
262 (defun elmo-dop-delete-msgs (folder msgs msgdb)
264 (let ((folder-numbers (elmo-make-folder-numbers-list folder msgs))
266 (while folder-numbers
267 (if (eq (elmo-folder-get-type (car (car folder-numbers)))
269 (if elmo-enable-disconnected-operation
271 (setq appended-deleting
272 (elmo-dop-deleting-numbers-to-msgids
273 (elmo-msgdb-get-number-alist msgdb)
274 msgs ; virtual number
275 (elmo-dop-append-list-load folder)))
276 (if (cdr appended-deleting)
277 (elmo-dop-queue-append
278 (car (car folder-numbers)) ; real folder
279 "delete-msgids" ;; for secure removal.
280 (cdr appended-deleting)))
281 (elmo-dop-append-list-save folder (car appended-deleting)))
283 ;; not imap4 folder...delete now!
284 (elmo-call-func (car (car folder-numbers)) "delete-msgs"
285 (cdr (car folder-numbers))))
286 (setq folder-numbers (cdr folder-numbers))))
289 (defun elmo-dop-prefetch-msgs (folder msgs)
291 (elmo-dop-queue-append folder "prefetch-msgs" msgs)))
293 (defun elmo-dop-list-messages (folder)
294 (let* ((path (elmo-msgdb-expand-path folder))
295 (number-alist (elmo-msgdb-number-load path))
296 (number-list (mapcar 'car number-alist))
297 (append-list (elmo-dop-append-list-load folder))
298 (append-num (length append-list))
303 (setq killed (elmo-dop-list-deleted folder number-alist))
305 (if (rassoc (car append-list) number-alist)
306 (setq alreadies (append alreadies
307 (list (car append-list)))))
308 (setq append-list (cdr append-list)))
309 (setq append-num (- append-num (length alreadies)))
311 (or (nth (max (- (length number-list) 1) 0)
313 (while (< i append-num)
316 (list (+ max-num i 1))))
318 (elmo-living-messages number-list killed)))
320 (defun elmo-dop-count-appended (folder)
321 (length (elmo-dop-append-list-load folder)))
323 (defun elmo-dop-call-func-on-msgs (folder func-name msgs msgdb)
324 (let ((append-list (elmo-dop-append-list-load folder))
325 (number-alist (elmo-msgdb-get-number-alist msgdb))
327 (if (eq (elmo-folder-get-type folder) 'imap4)
329 ;;; (while append-list
330 ;;; (if (setq matched (car (rassoc (car append-list) number-alist)))
331 ;;; (setq msgs (delete matched msgs)))
332 ;;; (setq append-list (cdr append-list)))
334 (elmo-dop-queue-append folder func-name msgs)))
335 ;; maildir... XXX hard coding.....
336 (if (not (featurep 'elmo-maildir))
338 (funcall (intern (format "elmo-maildir-%s" func-name))
339 (elmo-folder-get-spec folder)
342 (defun elmo-dop-folder-status (folder)
343 (let* ((number-alist (elmo-msgdb-number-load
344 (elmo-folder-msgdb-path folder)))
345 (number-list (mapcar 'car number-alist))
346 (append-list (elmo-dop-append-list-load folder))
347 (append-num (length append-list))
352 (if (rassoc (car append-list) number-alist)
353 (setq alreadies (append alreadies
354 (list (car append-list)))))
355 (setq append-list (cdr append-list)))
357 (or (nth (max (- (length number-list) 1) 0) number-list)
359 (cons (- (+ max-num append-num) (length alreadies))
360 (- (+ (length number-list) append-num) (length alreadies)))))
362 (defun elmo-dop-max-of-folder (folder)
363 (if (eq (elmo-folder-get-type folder) 'imap4)
364 (if elmo-enable-disconnected-operation
365 (let* ((number-alist (elmo-msgdb-number-load
366 (elmo-msgdb-expand-path folder)))
367 (number-list (mapcar 'car number-alist))
368 (append-list (elmo-dop-append-list-load folder))
369 (append-num (length append-list))
374 (if (rassoc (car append-list) number-alist)
375 (setq alreadies (append alreadies
376 (list (car append-list)))))
377 (setq append-list (cdr append-list)))
379 (or (nth (max (- (length number-list) 1) 0) number-list)
381 (cons (- (+ max-num append-num) (length alreadies))
382 (- (+ (length number-list) append-num) (length alreadies))))
385 (elmo-call-func folder "max-of-folder")))
387 (defun elmo-dop-save-pending-messages (folder)
388 (message (format "Saving queued message in %s..." elmo-lost+found-folder))
389 (let* ((append-list (elmo-dop-append-list-load folder))
392 (when (setq file-string (elmo-get-file-string ; message string
395 (elmo-append-msg elmo-lost+found-folder file-string)
396 (elmo-dop-unlock-message (car append-list)))
397 (setq append-list (cdr append-list))
398 (elmo-dop-append-list-save folder nil)))
399 (message (format "Saving queued message in %s...done"
400 elmo-lost+found-folder)))
402 (defun elmo-dop-flush-pending-append-operations (folder &optional appends resume)
403 (message "Appending queued messages...")
404 (let* ((append-list (or appends
405 (elmo-dop-append-list-load folder)))
406 (appendings append-list)
408 (num (length append-list))
411 ;; Resume msgdb changed by elmo-dop-msgdb-create.
412 (let* ((resumed-list (elmo-dop-append-list-load folder t))
413 (number-alist (elmo-msgdb-number-load
414 (elmo-msgdb-expand-path folder)))
415 (appendings append-list)
418 (if (setq pair (rassoc (car appendings) number-alist))
419 (setq resumed-list (append resumed-list
420 (list (car appendings)))))
421 (setq appendings (cdr appendings)))
422 (elmo-dop-append-list-save folder resumed-list t)))
424 (let* ((seen-list (elmo-msgdb-seen-load
425 (elmo-msgdb-expand-path folder))))
427 (setq file-string (elmo-get-file-string ; message string
432 (elmo-append-msg folder file-string (car appendings) nil
433 (not (member (car appendings) seen-list)))
434 (quit (setq failure t))
435 (error (setq failure t)))
437 (message (format "Appending queued messages...%d" i))
439 (elmo-append-msg elmo-lost+found-folder
440 file-string (car appendings) nil
441 (not (member (car appendings) seen-list)))))
442 (elmo-dop-unlock-message (car appendings))
443 (setq appendings (cdr appendings))))
444 ;; All pending append operation is flushed.
445 (elmo-dop-append-list-save folder nil)
448 ;; delete '(folder "append-operations") in elmo-dop-queue.
449 (let (elmo-dop-queue)
450 (elmo-dop-queue-load)
451 (setq elmo-dop-queue (delete (list folder "append-operations" nil)
453 (elmo-dop-queue-save))))
454 (message "Appending queued messages...done"))
456 (defun elmo-dop-folder-exists-p (folder)
457 (or (file-exists-p (elmo-msgdb-expand-path folder))
458 (if (and elmo-enable-disconnected-operation
459 (eq (elmo-folder-get-type folder) 'imap4))
460 (file-exists-p (elmo-msgdb-expand-path folder))
461 (elmo-call-func folder "folder-exists-p"))))
463 (defun elmo-dop-create-folder (folder)
464 (if (eq (elmo-folder-get-type folder) 'imap4)
465 (if elmo-enable-disconnected-operation
466 (elmo-dop-queue-append folder "create-folder-maybe" nil)
468 (elmo-call-func folder "create-folder")))
470 (defun elmo-dop-delete-folder (folder)
473 (defun elmo-dop-rename-folder (old-folder new-folder)
476 (defun elmo-dop-append-msg (folder string message-id &optional msg)
477 (if elmo-enable-disconnected-operation
480 (unless (elmo-cache-exists-p message-id)
483 (elmo-cache-save message-id nil folder msg (current-buffer))))
484 (let ((append-list (elmo-dop-append-list-load folder))
485 (number-alist (elmo-msgdb-number-load
486 (elmo-msgdb-expand-path folder))))
487 (when (and ; not in current folder.
488 (not (rassoc message-id number-alist))
489 (not (member message-id append-list)))
491 (append append-list (list message-id)))
492 (elmo-dop-lock-message message-id)
493 (elmo-dop-append-list-save folder append-list)
494 (elmo-dop-queue-append folder "append-operations" nil))
497 (error "Unplugged")))
499 (defalias 'elmo-dop-msgdb-create 'elmo-dop-msgdb-create-as-numlist)
501 (defun elmo-dop-msgdb-create-as-numlist (folder numlist new-mark already-mark
502 seen-mark important-mark
504 (if (or (eq (elmo-folder-get-type folder) 'imap4)
505 (eq (elmo-folder-get-type folder) 'nntp))
506 (if elmo-enable-disconnected-operation
507 (let* ((num-alist (elmo-msgdb-number-load
508 (elmo-msgdb-expand-path folder)))
509 (number-list (mapcar 'car num-alist))
510 (ov (elmo-msgdb-overview-load
511 (elmo-msgdb-expand-path folder)))
512 (append-list (elmo-dop-append-list-load folder))
513 (num (length numlist))
515 overview number-alist mark-alist msgid ov-entity
516 max-num percent seen gmark)
518 (or (nth (max (- (length number-list) 1) 0) number-list)
522 (nth (+ (length append-list)
523 (- (car numlist) max-num 1 num))
527 (elmo-msgdb-append-element
529 (elmo-localdir-msgdb-create-overview-entity-from-file
531 (elmo-cache-get-path msgid))))
533 (elmo-msgdb-number-add number-alist
534 (car numlist) msgid))
535 (setq seen (member msgid seen-list))
537 (or (elmo-msgdb-global-mark-get msgid)
538 (if (elmo-cache-exists-p
549 (elmo-msgdb-mark-append
550 mark-alist (car numlist) gmark))))
552 (when (setq ov-entity (assoc
553 (cdr (assq (car numlist) num-alist))
556 (elmo-msgdb-append-element
559 (elmo-msgdb-number-add number-alist
562 (setq seen (member ov-entity seen-list))
564 (or (elmo-msgdb-global-mark-get (car ov-entity))
565 (if (elmo-cache-exists-p
576 (elmo-msgdb-mark-append
577 mark-alist (car numlist) gmark)))))
578 (when (> num elmo-display-progress-threshold)
580 (setq percent (/ (* i 100) num))
581 (elmo-display-progress
582 'elmo-dop-msgdb-create-as-numlist "Creating msgdb..."
584 (setq numlist (cdr numlist)))
585 (list overview number-alist mark-alist))
587 ;; not imap4 folder...
588 (elmo-call-func folder "msgdb-create" numlist new-mark already-mark
589 seen-mark important-mark seen-list)))
592 (product-provide (provide 'elmo-dop) (require 'elmo-version))
594 ;;; elmo-dop.el ends here