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.
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* ((path (elmo-msgdb-expand-path folder))
281 (number-alist (elmo-msgdb-number-load path))
282 (number-list (mapcar 'car number-alist))
283 (append-list (elmo-dop-append-list-load folder))
284 (append-num (length append-list))
285 (killed (and elmo-use-killed-list
286 (elmo-msgdb-killed-list-load path)))
291 (if (rassoc (car append-list) number-alist)
292 (setq alreadies (append alreadies
293 (list (car append-list)))))
294 (setq append-list (cdr append-list)))
295 (setq append-num (- append-num (length alreadies)))
297 (or (nth (max (- (length number-list) 1) 0)
299 (while (< i append-num)
302 (list (+ max-num i 1))))
304 (elmo-living-messages number-list killed))
306 ;; not imap4 folder...list folder
307 (elmo-call-func folder "list-folder")))
309 (defun elmo-dop-count-appended (folder)
310 (length (elmo-dop-append-list-load folder)))
312 (defun elmo-dop-call-func-on-msgs (folder func-name msgs msgdb)
313 (let ((append-list (elmo-dop-append-list-load folder))
314 (number-alist (elmo-msgdb-get-number-alist msgdb))
316 (if (eq (elmo-folder-get-type folder) 'imap4)
318 ;;; (while append-list
319 ;;; (if (setq matched (car (rassoc (car append-list) number-alist)))
320 ;;; (setq msgs (delete matched msgs)))
321 ;;; (setq append-list (cdr append-list)))
323 (elmo-dop-queue-append folder func-name msgs)))
324 ;; maildir... XXX hard coding.....
325 (if (not (featurep 'elmo-maildir))
327 (funcall (intern (format "elmo-maildir-%s" func-name))
328 (elmo-folder-get-spec folder)
331 (defun elmo-dop-max-of-folder (folder)
332 (if (eq (elmo-folder-get-type folder) 'imap4)
333 (if elmo-enable-disconnected-operation
334 (let* ((number-alist (elmo-msgdb-number-load
335 (elmo-msgdb-expand-path folder)))
336 (number-list (mapcar 'car number-alist))
337 (append-list (elmo-dop-append-list-load folder))
338 (append-num (length append-list))
343 (if (rassoc (car append-list) number-alist)
344 (setq alreadies (append alreadies
345 (list (car append-list)))))
346 (setq append-list (cdr append-list)))
348 (or (nth (max (- (length number-list) 1) 0) number-list)
350 (cons (- (+ max-num append-num) (length alreadies))
351 (- (+ (length number-list) append-num) (length alreadies))))
354 (elmo-call-func folder "max-of-folder")))
356 (defun elmo-dop-save-pending-messages (folder)
357 (message (format "Saving queued message in %s..." elmo-lost+found-folder))
358 (let* ((append-list (elmo-dop-append-list-load folder))
361 (when (setq file-string (elmo-get-file-string ; message string
364 (elmo-append-msg elmo-lost+found-folder file-string)
365 (elmo-dop-unlock-message (car append-list)))
366 (setq append-list (cdr append-list))
367 (elmo-dop-append-list-save folder nil)))
368 (message (format "Saving queued message in %s...done"
369 elmo-lost+found-folder)))
371 (defun elmo-dop-flush-pending-append-operations (folder &optional appends resume)
372 (message "Appending queued messages...")
373 (let* ((append-list (or appends
374 (elmo-dop-append-list-load folder)))
375 (appendings append-list)
377 (num (length append-list))
380 ;; Resume msgdb changed by elmo-dop-msgdb-create.
381 (let* ((resumed-list (elmo-dop-append-list-load folder t))
382 (number-alist (elmo-msgdb-number-load
383 (elmo-msgdb-expand-path folder)))
384 (appendings append-list)
387 (if (setq pair (rassoc (car appendings) number-alist))
388 (setq resumed-list (append resumed-list
389 (list (car appendings)))))
390 (setq appendings (cdr appendings)))
391 (elmo-dop-append-list-save folder resumed-list t)))
393 (let* ((seen-list (elmo-msgdb-seen-load
394 (elmo-msgdb-expand-path folder))))
396 (setq file-string (elmo-get-file-string ; message string
401 (elmo-append-msg folder file-string (car appendings) nil
402 (not (member (car appendings) seen-list)))
403 (quit (setq failure t))
404 (error (setq failure t)))
406 (message (format "Appending queued messages...%d" i))
408 (elmo-append-msg elmo-lost+found-folder
409 file-string (car appendings) nil
410 (not (member (car appendings) seen-list)))))
411 (elmo-dop-unlock-message (car appendings))
412 (setq appendings (cdr appendings))))
413 ;; All pending append operation is flushed.
414 (elmo-dop-append-list-save folder nil)
417 ;; delete '(folder "append-operations") in elmo-dop-queue.
418 (let (elmo-dop-queue)
419 (elmo-dop-queue-load)
420 (setq elmo-dop-queue (delete (list folder "append-operations" nil)
422 (elmo-dop-queue-save))))
423 (message "Appending queued messages...done"))
425 (defun elmo-dop-folder-exists-p (folder)
426 (or (file-exists-p (elmo-msgdb-expand-path folder))
427 (if (and elmo-enable-disconnected-operation
428 (eq (elmo-folder-get-type folder) 'imap4))
429 (file-exists-p (elmo-msgdb-expand-path folder))
430 (elmo-call-func folder "folder-exists-p"))))
432 (defun elmo-dop-create-folder (folder)
433 (if (eq (elmo-folder-get-type folder) 'imap4)
434 (if elmo-enable-disconnected-operation
435 (elmo-dop-queue-append folder "create-folder-maybe" nil)
437 (elmo-call-func folder "create-folder")))
439 (defun elmo-dop-delete-folder (folder)
442 (defun elmo-dop-rename-folder (old-folder new-folder)
445 (defun elmo-dop-append-msg (folder string message-id &optional msg)
446 (if elmo-enable-disconnected-operation
449 (unless (elmo-cache-exists-p message-id)
452 (elmo-cache-save message-id nil folder msg (current-buffer))))
453 (let ((append-list (elmo-dop-append-list-load folder))
454 (number-alist (elmo-msgdb-number-load
455 (elmo-msgdb-expand-path folder))))
456 (when (and ; not in current folder.
457 (not (rassoc message-id number-alist))
458 (not (member message-id append-list)))
460 (append append-list (list message-id)))
461 (elmo-dop-lock-message message-id)
462 (elmo-dop-append-list-save folder append-list)
463 (elmo-dop-queue-append folder "append-operations" nil))
466 (error "Unplugged")))
468 (defalias 'elmo-dop-msgdb-create 'elmo-dop-msgdb-create-as-numlist)
470 (defun elmo-dop-msgdb-create-as-numlist (folder numlist new-mark already-mark
471 seen-mark important-mark
473 (if (or (eq (elmo-folder-get-type folder) 'imap4)
474 (eq (elmo-folder-get-type folder) 'nntp))
475 (if elmo-enable-disconnected-operation
476 (let* ((num-alist (elmo-msgdb-number-load
477 (elmo-msgdb-expand-path folder)))
478 (number-list (mapcar 'car num-alist))
479 (ov (elmo-msgdb-overview-load
480 (elmo-msgdb-expand-path folder)))
481 (append-list (elmo-dop-append-list-load folder))
482 (num (length numlist))
484 overview number-alist mark-alist msgid ov-entity
485 max-num percent seen gmark)
487 (or (nth (max (- (length number-list) 1) 0) number-list)
491 (nth (+ (length append-list)
492 (- (car numlist) max-num 1 num))
496 (elmo-msgdb-append-element
498 (elmo-localdir-msgdb-create-overview-entity-from-file
500 (elmo-cache-get-path msgid))))
502 (elmo-msgdb-number-add number-alist
503 (car numlist) msgid))
504 (setq seen (member msgid seen-list))
506 (or (elmo-msgdb-global-mark-get msgid)
507 (if (elmo-cache-exists-p
518 (elmo-msgdb-mark-append
519 mark-alist (car numlist) gmark))))
521 (when (setq ov-entity (assoc
522 (cdr (assq (car numlist) num-alist))
525 (elmo-msgdb-append-element
528 (elmo-msgdb-number-add number-alist
531 (setq seen (member ov-entity seen-list))
533 (or (elmo-msgdb-global-mark-get (car ov-entity))
534 (if (elmo-cache-exists-p
545 (elmo-msgdb-mark-append
546 mark-alist (car numlist) gmark)))))
547 (when (> num elmo-display-progress-threshold)
549 (setq percent (/ (* i 100) num))
550 (elmo-display-progress
551 'elmo-dop-msgdb-create-as-numlist "Creating msgdb..."
553 (setq numlist (cdr numlist)))
554 (list overview number-alist mark-alist))
556 ;; not imap4 folder...
557 (elmo-call-func folder "msgdb-create" numlist new-mark already-mark
558 seen-mark important-mark seen-list)))
561 (product-provide (provide 'elmo-dop) (require 'elmo-version))
563 ;;; elmo-dop.el ends here