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-folder (folder &optional nohide)
294 (if (or (memq (elmo-folder-get-type folder)
295 '(imap4 nntp pop3 filter pipe))
296 (and (elmo-multi-p folder) (not (elmo-folder-local-p folder))))
297 (if elmo-enable-disconnected-operation
298 (let* ((path (elmo-msgdb-expand-path folder))
299 (number-alist (elmo-msgdb-number-load path))
300 (number-list (mapcar 'car number-alist))
301 (append-list (elmo-dop-append-list-load folder))
302 (append-num (length append-list))
303 (killed (and elmo-use-killed-list
304 (elmo-msgdb-killed-list-load path)))
308 (setq killed (nconc (elmo-dop-list-deleted folder number-alist)
311 (if (rassoc (car append-list) number-alist)
312 (setq alreadies (append alreadies
313 (list (car append-list)))))
314 (setq append-list (cdr append-list)))
315 (setq append-num (- append-num (length alreadies)))
317 (or (nth (max (- (length number-list) 1) 0)
319 (while (< i append-num)
322 (list (+ max-num i 1))))
324 (elmo-living-messages number-list killed))
326 ;; not imap4 folder...list folder
327 (elmo-call-func folder "list-folder")))
329 (defun elmo-dop-count-appended (folder)
330 (length (elmo-dop-append-list-load folder)))
332 (defun elmo-dop-call-func-on-msgs (folder func-name msgs msgdb)
333 (let ((append-list (elmo-dop-append-list-load folder))
334 (number-alist (elmo-msgdb-get-number-alist msgdb))
336 (if (eq (elmo-folder-get-type folder) 'imap4)
338 ;;; (while append-list
339 ;;; (if (setq matched (car (rassoc (car append-list) number-alist)))
340 ;;; (setq msgs (delete matched msgs)))
341 ;;; (setq append-list (cdr append-list)))
343 (elmo-dop-queue-append folder func-name msgs)))
344 ;; maildir... XXX hard coding.....
345 (if (not (featurep 'elmo-maildir))
347 (funcall (intern (format "elmo-maildir-%s" func-name))
348 (elmo-folder-get-spec folder)
351 (defun elmo-dop-folder-status (folder)
352 (let* ((number-alist (elmo-msgdb-number-load
353 (elmo-folder-msgdb-path folder)))
354 (number-list (mapcar 'car number-alist))
355 (append-list (elmo-dop-append-list-load folder))
356 (append-num (length append-list))
361 (if (rassoc (car append-list) number-alist)
362 (setq alreadies (append alreadies
363 (list (car append-list)))))
364 (setq append-list (cdr append-list)))
366 (or (nth (max (- (length number-list) 1) 0) number-list)
368 (cons (- (+ max-num append-num) (length alreadies))
369 (- (+ (length number-list) append-num) (length alreadies)))))
371 (defun elmo-dop-max-of-folder (folder)
372 (if (eq (elmo-folder-get-type folder) 'imap4)
373 (if elmo-enable-disconnected-operation
374 (let* ((number-alist (elmo-msgdb-number-load
375 (elmo-msgdb-expand-path folder)))
376 (number-list (mapcar 'car number-alist))
377 (append-list (elmo-dop-append-list-load folder))
378 (append-num (length append-list))
383 (if (rassoc (car append-list) number-alist)
384 (setq alreadies (append alreadies
385 (list (car append-list)))))
386 (setq append-list (cdr append-list)))
388 (or (nth (max (- (length number-list) 1) 0) number-list)
390 (cons (- (+ max-num append-num) (length alreadies))
391 (- (+ (length number-list) append-num) (length alreadies))))
394 (elmo-call-func folder "max-of-folder")))
396 (defun elmo-dop-save-pending-messages (folder)
397 (message (format "Saving queued message in %s..." elmo-lost+found-folder))
398 (let* ((append-list (elmo-dop-append-list-load folder))
401 (when (setq file-string (elmo-get-file-string ; message string
404 (elmo-append-msg elmo-lost+found-folder file-string)
405 (elmo-dop-unlock-message (car append-list)))
406 (setq append-list (cdr append-list))
407 (elmo-dop-append-list-save folder nil)))
408 (message (format "Saving queued message in %s...done"
409 elmo-lost+found-folder)))
411 (defun elmo-dop-flush-pending-append-operations (folder &optional appends resume)
412 (message "Appending queued messages...")
413 (let* ((append-list (or appends
414 (elmo-dop-append-list-load folder)))
415 (appendings append-list)
417 (num (length append-list))
420 ;; Resume msgdb changed by elmo-dop-msgdb-create.
421 (let* ((resumed-list (elmo-dop-append-list-load folder t))
422 (number-alist (elmo-msgdb-number-load
423 (elmo-msgdb-expand-path folder)))
424 (appendings append-list)
427 (if (setq pair (rassoc (car appendings) number-alist))
428 (setq resumed-list (append resumed-list
429 (list (car appendings)))))
430 (setq appendings (cdr appendings)))
431 (elmo-dop-append-list-save folder resumed-list t)))
433 (let* ((seen-list (elmo-msgdb-seen-load
434 (elmo-msgdb-expand-path folder))))
436 (setq file-string (elmo-get-file-string ; message string
441 (elmo-append-msg folder file-string (car appendings) nil
442 (not (member (car appendings) seen-list)))
443 (quit (setq failure t))
444 (error (setq failure t)))
446 (message (format "Appending queued messages...%d" i))
448 (elmo-append-msg elmo-lost+found-folder
449 file-string (car appendings) nil
450 (not (member (car appendings) seen-list)))))
451 (elmo-dop-unlock-message (car appendings))
452 (setq appendings (cdr appendings))))
453 ;; All pending append operation is flushed.
454 (elmo-dop-append-list-save folder nil)
457 ;; delete '(folder "append-operations") in elmo-dop-queue.
458 (let (elmo-dop-queue)
459 (elmo-dop-queue-load)
460 (setq elmo-dop-queue (delete (list folder "append-operations" nil)
462 (elmo-dop-queue-save))))
463 (message "Appending queued messages...done"))
465 (defun elmo-dop-folder-exists-p (folder)
466 (or (file-exists-p (elmo-msgdb-expand-path folder))
467 (if (and elmo-enable-disconnected-operation
468 (eq (elmo-folder-get-type folder) 'imap4))
469 (file-exists-p (elmo-msgdb-expand-path folder))
470 (elmo-call-func folder "folder-exists-p"))))
472 (defun elmo-dop-create-folder (folder)
473 (if (eq (elmo-folder-get-type folder) 'imap4)
474 (if elmo-enable-disconnected-operation
475 (elmo-dop-queue-append folder "create-folder-maybe" nil)
477 (elmo-call-func folder "create-folder")))
479 (defun elmo-dop-delete-folder (folder)
482 (defun elmo-dop-rename-folder (old-folder new-folder)
485 (defun elmo-dop-append-msg (folder string message-id &optional msg)
486 (if elmo-enable-disconnected-operation
489 (unless (elmo-cache-exists-p message-id)
492 (elmo-cache-save message-id nil folder msg (current-buffer))))
493 (let ((append-list (elmo-dop-append-list-load folder))
494 (number-alist (elmo-msgdb-number-load
495 (elmo-msgdb-expand-path folder))))
496 (when (and ; not in current folder.
497 (not (rassoc message-id number-alist))
498 (not (member message-id append-list)))
500 (append append-list (list message-id)))
501 (elmo-dop-lock-message message-id)
502 (elmo-dop-append-list-save folder append-list)
503 (elmo-dop-queue-append folder "append-operations" nil))
506 (error "Unplugged")))
508 (defalias 'elmo-dop-msgdb-create 'elmo-dop-msgdb-create-as-numlist)
510 (defun elmo-dop-msgdb-create-as-numlist (folder numlist new-mark already-mark
511 seen-mark important-mark
513 (if (or (eq (elmo-folder-get-type folder) 'imap4)
514 (eq (elmo-folder-get-type folder) 'nntp))
515 (if elmo-enable-disconnected-operation
516 (let* ((num-alist (elmo-msgdb-number-load
517 (elmo-msgdb-expand-path folder)))
518 (number-list (mapcar 'car num-alist))
519 (ov (elmo-msgdb-overview-load
520 (elmo-msgdb-expand-path folder)))
521 (append-list (elmo-dop-append-list-load folder))
522 (num (length numlist))
524 overview number-alist mark-alist msgid ov-entity
525 max-num percent seen gmark)
527 (or (nth (max (- (length number-list) 1) 0) number-list)
531 (nth (+ (length append-list)
532 (- (car numlist) max-num 1 num))
536 (elmo-msgdb-append-element
538 (elmo-localdir-msgdb-create-overview-entity-from-file
540 (elmo-cache-get-path msgid))))
542 (elmo-msgdb-number-add number-alist
543 (car numlist) msgid))
544 (setq seen (member msgid seen-list))
546 (or (elmo-msgdb-global-mark-get msgid)
547 (if (elmo-cache-exists-p
558 (elmo-msgdb-mark-append
559 mark-alist (car numlist) gmark))))
561 (when (setq ov-entity (assoc
562 (cdr (assq (car numlist) num-alist))
565 (elmo-msgdb-append-element
568 (elmo-msgdb-number-add number-alist
571 (setq seen (member ov-entity seen-list))
573 (or (elmo-msgdb-global-mark-get (car ov-entity))
574 (if (elmo-cache-exists-p
585 (elmo-msgdb-mark-append
586 mark-alist (car numlist) gmark)))))
587 (when (> num elmo-display-progress-threshold)
589 (setq percent (/ (* i 100) num))
590 (elmo-display-progress
591 'elmo-dop-msgdb-create-as-numlist "Creating msgdb..."
593 (setq numlist (cdr numlist)))
594 (list overview number-alist mark-alist))
596 ;; not imap4 folder...
597 (elmo-call-func folder "msgdb-create" numlist new-mark already-mark
598 seen-mark important-mark seen-list)))
601 (product-provide (provide 'elmo-dop) (require 'elmo-version))
603 ;;; elmo-dop.el ends here