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.
36 (require 'elmo-localdir)
39 (defvar elmo-dop-queue nil
40 "A list of (folder-name function-to-be-called argument-list).
41 Automatically loaded/saved.")
43 (defmacro elmo-make-dop-queue (fname method arguments)
45 (` (vector (, fname) (, method) (, arguments))))
47 (defmacro elmo-dop-queue-fname (queue)
48 "Return the folder name string of the QUEUE."
49 (` (aref (, queue) 0)))
51 (defmacro elmo-dop-queue-method (queue)
52 "Return the method symbol of the QUEUE."
53 (` (aref (, queue) 1)))
55 (defmacro elmo-dop-queue-arguments (queue)
56 "Return the arguments of the QUEUE."
57 (` (aref (, queue) 2)))
59 (defun elmo-dop-queue-append (folder method arguments)
60 "Append to disconnected operation queue."
61 (let ((queue (elmo-make-dop-queue (elmo-folder-name-internal folder)
63 (setq elmo-dop-queue (nconc elmo-dop-queue (list queue)))))
65 (defvar elmo-dop-queue-method-name-alist
66 '((elmo-folder-append-buffer-dop-delayed . "Append")
67 (elmo-folder-delete-messages-dop-delayed . "Delete")
68 (elmo-message-encache . "Encache")
69 (elmo-create-folder . "Create")
70 (elmo-folder-mark-as-read . "Read")
71 (elmo-folder-unmark-read . "Unread")
72 (elmo-folder-mark-as-important . "Important")
73 (elmo-folder-unmark-important . "Unimportant")))
75 (defmacro elmo-dop-queue-method-name (queue)
76 `(cdr (assq (elmo-dop-queue-method ,queue)
77 elmo-dop-queue-method-name-alist)))
79 (defun elmo-dop-queue-flush (&optional force)
80 "Flush disconnected operations.
81 If optional argument FORCE is non-nil, try flushing all operation queues
82 even an operation concerns the unplugged folder."
83 (elmo-dop-queue-merge)
84 (let ((queue elmo-dop-queue)
89 (unless (or (null queue)
90 (vectorp (car queue)))
91 (if (y-or-n-p "Saved queue is old version(2.6). Clear all pending operations? ")
93 (setq elmo-dop-queue nil)
94 (message "All pending operations are cleared.")
95 (elmo-dop-queue-save))
96 (error "Please use 2.6 or earlier.")))
97 (setq count (length queue))
100 (format "%d pending operation(s) exists. Perform now? " count)
101 (not elmo-dop-flush-confirm) t)
105 (let ((queue elmo-dop-queue)
108 (num (length elmo-dop-queue))
111 ;; now perform pending processes.
114 (message "Flushing queue....%d/%d." i num)
117 (apply (elmo-dop-queue-method (car queue))
121 (elmo-dop-queue-fname (car queue))))
122 (elmo-folder-open folder)
123 (unless (elmo-folder-plugged-p folder)
124 (error "Unplugged.")))
125 (elmo-dop-queue-arguments (car queue)))
126 (elmo-folder-close folder))
127 (quit (setq failure t))
128 (error (setq failure err)))
131 (setq elmo-dop-queue (delq (car queue) elmo-dop-queue))
132 (setq performed (+ 1 performed)))
133 (setq queue (cdr queue)))
134 (message "%d/%d operation(s) are performed successfully."
137 (elmo-dop-queue-save)))
138 (if (elmo-y-or-n-p "Clear all pending operations? "
139 (not elmo-dop-flush-confirm) t)
141 (setq elmo-dop-queue nil)
142 (message "All pending operations are cleared.")
143 (elmo-dop-queue-save))
147 (defvar elmo-dop-merge-funcs nil)
148 (defun elmo-dop-queue-merge ()
149 ;; XXXX Not implemented yet.
153 (defmacro elmo-dop-spool-folder (folder)
154 "Return a spool folder for disconnected operations
155 which is corresponded to the FOLDER."
157 (concat "+" (expand-file-name "spool" (elmo-folder-msgdb-path
160 (defun elmo-dop-spool-folder-append-buffer (folder)
161 "Append current buffer content to the dop spool folder.
162 FOLDER is the folder structure.
163 Return a message number."
164 (setq folder (elmo-dop-spool-folder folder))
165 (unless (elmo-folder-exists-p folder)
166 (elmo-folder-create folder))
167 (let ((new-number (1+ (car (elmo-folder-status folder)))))
168 ;; dop folder is a localdir folder.
169 (write-region-as-binary (point-min) (point-max)
171 (int-to-string new-number)
172 (elmo-localdir-folder-directory-internal folder))
177 (defun elmo-dop-spool-folder-list-messages (folder)
178 "List messages in the dop spool folder.
179 FOLDER is the folder structure."
180 (setq folder (elmo-dop-spool-folder folder))
181 (if (elmo-folder-exists-p folder)
182 (elmo-folder-list-messages folder)))
184 (defun elmo-dop-list-deleting-messages (folder)
185 "List messages which are on the deleting queue for the folder.
186 FOLDER is the folder structure."
188 (dolist (queue elmo-dop-queue)
189 (if (and (string= (elmo-dop-queue-fname queue)
190 (elmo-folder-name-internal folder))
191 (eq (elmo-dop-queue-method queue)
192 'elmo-folder-delete-messages-dop-delayed))
193 (setq messages (nconc messages
196 (car (elmo-dop-queue-arguments queue)))))))))
199 (defsubst elmo-folder-append-buffer-dop (folder unread &optional number)
200 (elmo-dop-queue-append
201 folder 'elmo-folder-append-buffer-dop-delayed
203 (elmo-dop-spool-folder-append-buffer
207 (defsubst elmo-folder-delete-messages-dop (folder numbers)
208 (elmo-dop-queue-append folder 'elmo-folder-delete-messages-dop-delayed
212 (cons number (elmo-message-field
213 folder number 'message-id)))
217 (defsubst elmo-message-encache-dop (folder number &optional read)
218 (elmo-dop-queue-append folder 'elmo-message-encache (list number read)))
220 (defsubst elmo-create-folder-dop (folder)
221 (elmo-dop-queue-append folder 'elmo-folder-create nil))
223 (defsubst elmo-folder-mark-as-read-dop (folder numbers)
224 (elmo-dop-queue-append folder 'elmo-folder-mark-as-read (list numbers)))
226 (defsubst elmo-folder-unmark-read-dop (folder numbers)
227 (elmo-dop-queue-append folder 'elmo-folder-unmark-read (list numbers)))
229 (defsubst elmo-folder-mark-as-important-dop (folder numbers)
230 (elmo-dop-queue-append folder 'elmo-folder-mark-as-important (list numbers)))
232 (defsubst elmo-folder-unmark-important-dop (folder numbers)
233 (elmo-dop-queue-append folder 'elmo-folder-unmark-important (list numbers)))
235 ;;; Execute as subsutitute for plugged operation.
236 (defun elmo-folder-status-dop (folder)
237 (let* ((number-alist (elmo-msgdb-number-load
238 (elmo-folder-msgdb-path folder)))
239 (number-list (mapcar 'car number-alist))
240 (spool-folder (elmo-dop-spool-folder folder))
244 (setq spool-length (length (car (if (elmo-folder-exists-p spool-folder)
245 (elmo-folder-status spool-folder)))))
247 (or (nth (max (- (length number-list) 1) 0) number-list)
249 (cons (+ max-num spool-length) (+ (length number-list) spool-length))))
251 ;;; Delayed operation (executed at online status).
252 (defun elmo-folder-append-buffer-dop-delayed (folder unread number set-number)
253 (let ((spool-folder (elmo-dop-spool-folder folder))
256 (elmo-message-fetch spool-folder number
257 (elmo-make-fetch-strategy 'entire)
258 nil (current-buffer) 'unread)
261 (elmo-folder-append-buffer folder unread set-number)))
262 (error (setq failure t)))
265 (setq saved (elmo-folder-append-buffer
266 (elmo-make-folder elmo-lost+found-folder)
268 (if (or (not failure)
270 (elmo-folder-delete-messages spool-folder (list number)))
273 (defun elmo-folder-delete-messages-dop-delayed (folder number-alist)
274 (elmo-folder-delete-messages
276 ;; messages are deleted only if message-id is not changed.
282 (elmo-message-fetch-field folder (car pair)
287 (defun elmo-dop-msgdb (msgdb)
288 (list (mapcar (function
290 (elmo-msgdb-overview-entity-set-number
293 (elmo-msgdb-overview-entity-get-number x)))))
303 (cdr x)))) (nth 2 msgdb))))
306 (product-provide (provide 'elmo-dop) (require 'elmo-version))
308 ;;; elmo-dop.el ends here