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-merge-method-list
66 '(elmo-folder-mark-as-read
67 elmo-folder-unmark-read
68 elmo-folder-mark-as-important
69 elmo-folder-unmark-important
70 elmo-folder-mark-as-answered
71 elmo-folder-unmark-answered))
73 (defvar elmo-dop-queue-method-name-alist
74 '((elmo-folder-append-buffer-dop-delayed . "Append")
75 (elmo-folder-delete-messages-dop-delayed . "Delete")
76 (elmo-message-encache . "Encache")
77 (elmo-folder-create-dop-delayed . "Create")
78 (elmo-folder-mark-as-read . "Read")
79 (elmo-folder-unmark-read . "Unread")
80 (elmo-folder-mark-as-answered . "Answered")
81 (elmo-folder-unmark-answered . "Unanswered")
82 (elmo-folder-mark-as-important . "Important")
83 (elmo-folder-unmark-important . "Unimportant")))
85 (defmacro elmo-dop-queue-method-name (queue)
86 `(cdr (assq (elmo-dop-queue-method ,queue)
87 elmo-dop-queue-method-name-alist)))
89 (defun elmo-dop-queue-flush ()
90 "Flush disconnected operations that consern plugged folders."
92 (unless (or (null elmo-dop-queue)
93 (vectorp (car elmo-dop-queue)))
95 Saved queue is old version(2.6). Clear all pending operations? ")
97 (setq elmo-dop-queue nil)
98 (message "All pending operations are cleared.")
99 (elmo-dop-queue-save))
100 (error "Please use 2.6 or earlier")))
101 (elmo-dop-queue-merge)
102 (let ((queue-all elmo-dop-queue)
107 (if (elmo-folder-plugged-p
108 (elmo-make-folder (elmo-dop-queue-fname (car queue-all))))
109 (setq queue (append queue (list (car queue-all)))))
110 (setq queue-all (cdr queue-all)))
111 (setq count (length queue))
114 (format "%d pending operation(s) exists. Perform now? " count)
115 (not elmo-dop-flush-confirm) t)
119 (let ((queue elmo-dop-queue)
122 (num (length elmo-dop-queue))
125 ;; now perform pending processes.
128 (message "Flushing queue....%d/%d." i num)
131 (apply (elmo-dop-queue-method (car queue))
135 (elmo-dop-queue-fname (car queue))))
136 (elmo-folder-open folder)
137 (unless (elmo-folder-plugged-p folder)
138 (error "Unplugged")))
139 (elmo-dop-queue-arguments (car queue)))
140 (elmo-folder-close folder))
141 (quit (setq failure t))
142 (error (setq failure err)))
145 (setq elmo-dop-queue (delq (car queue) elmo-dop-queue))
146 (setq performed (+ 1 performed)))
147 (setq queue (cdr queue)))
148 (message "%d/%d operation(s) are performed successfully."
151 (elmo-dop-queue-save)))
152 ;; when answer=NO against performing dop
153 (if (elmo-y-or-n-p "Clear these pending operations? "
154 (not elmo-dop-flush-confirm) t)
157 (setq elmo-dop-queue (delq (car queue) elmo-dop-queue))
158 (setq queue (cdr queue)))
159 (message "Pending operations are cleared.")
160 (elmo-dop-queue-save))
164 (defun elmo-dop-queue-merge ()
165 (let ((queue elmo-dop-queue)
166 new-queue match-queue que)
167 (while (setq que (car queue))
169 (memq (elmo-dop-queue-method que)
170 elmo-dop-queue-merge-method-list)
177 (string= (elmo-dop-queue-fname que)
178 (elmo-dop-queue-fname nqueue))
179 (string= (elmo-dop-queue-method que)
180 (elmo-dop-queue-method nqueue)))
183 (setcar (elmo-dop-queue-arguments match-queue)
184 (append (car (elmo-dop-queue-arguments match-queue))
185 (car (elmo-dop-queue-arguments que))))
186 (setq new-queue (nconc new-queue (list que))))
187 (setq queue (cdr queue)) )
188 (setq elmo-dop-queue new-queue)))
191 (defmacro elmo-dop-spool-folder (folder)
192 "Return a spool folder for disconnected operations
193 which is corresponded to the FOLDER."
195 (concat "+" (expand-file-name "spool" (elmo-folder-msgdb-path
198 (defun elmo-dop-spool-folder-append-buffer (folder)
199 "Append current buffer content to the dop spool folder.
200 FOLDER is the folder structure.
201 Return a message number."
202 (setq folder (elmo-dop-spool-folder folder))
203 (unless (elmo-folder-exists-p folder)
204 (elmo-folder-create folder))
205 (let ((new-number (1+ (car (elmo-folder-status folder)))))
206 ;; dop folder is a localdir folder.
207 (write-region-as-binary (point-min) (point-max)
209 (int-to-string new-number)
210 (elmo-localdir-folder-directory-internal folder))
215 (defun elmo-dop-spool-folder-list-messages (folder)
216 "List messages in the dop spool folder.
217 FOLDER is the folder structure."
218 (setq folder (elmo-dop-spool-folder folder))
219 (if (elmo-folder-exists-p folder)
220 (elmo-folder-list-messages folder)))
222 (defun elmo-dop-list-deleting-messages (folder)
223 "List messages which are on the deleting queue for the folder.
224 FOLDER is the folder structure."
226 (dolist (queue elmo-dop-queue)
227 (if (and (string= (elmo-dop-queue-fname queue)
228 (elmo-folder-name-internal folder))
229 (eq (elmo-dop-queue-method queue)
230 'elmo-folder-delete-messages-dop-delayed))
231 (setq messages (nconc messages
234 (car (elmo-dop-queue-arguments queue)))))))))
237 (defsubst elmo-folder-append-buffer-dop (folder unread &optional number)
238 (elmo-dop-queue-append
239 folder 'elmo-folder-append-buffer-dop-delayed
241 (elmo-dop-spool-folder-append-buffer
245 (defsubst elmo-folder-delete-messages-dop (folder numbers)
246 (let ((spool-folder (elmo-dop-spool-folder folder))
248 (dolist (number numbers)
250 (elmo-folder-delete-messages spool-folder
251 (list (abs number))) ; delete from queue
252 (setq queue (cons number queue))))
254 (elmo-dop-queue-append folder 'elmo-folder-delete-messages-dop-delayed
258 (cons number (elmo-message-field
259 folder number 'message-id)))
263 (defsubst elmo-message-encache-dop (folder number &optional read)
264 (elmo-dop-queue-append folder 'elmo-message-encache (list number read)))
266 (defsubst elmo-folder-create-dop (folder)
267 (elmo-dop-queue-append folder 'elmo-folder-create-dop-delayed nil))
269 (defsubst elmo-folder-mark-as-read-dop (folder numbers)
270 (elmo-dop-queue-append folder 'elmo-folder-mark-as-read (list numbers)))
272 (defsubst elmo-folder-unmark-read-dop (folder numbers)
273 (elmo-dop-queue-append folder 'elmo-folder-unmark-read (list numbers)))
275 (defsubst elmo-folder-mark-as-important-dop (folder numbers)
276 (elmo-dop-queue-append folder 'elmo-folder-mark-as-important (list numbers)))
278 (defsubst elmo-folder-unmark-important-dop (folder numbers)
279 (elmo-dop-queue-append folder 'elmo-folder-unmark-important (list numbers)))
281 (defsubst elmo-folder-mark-as-answered-dop (folder numbers)
282 (elmo-dop-queue-append folder 'elmo-folder-mark-as-answered (list numbers)))
284 (defsubst elmo-folder-unmark-answered-dop (folder numbers)
285 (elmo-dop-queue-append folder 'elmo-folder-unmark-answered (list numbers)))
287 ;;; Execute as subsutitute for plugged operation.
288 (defun elmo-folder-status-dop (folder)
289 (let* ((number-alist (elmo-msgdb-number-load
290 (elmo-folder-msgdb-path folder)))
291 (number-list (mapcar 'car number-alist))
292 (spool-folder (elmo-dop-spool-folder folder))
296 (setq spool-length (or (car (if (elmo-folder-exists-p spool-folder)
297 (elmo-folder-status spool-folder))) 0))
299 (or (nth (max (- (length number-list) 1) 0) number-list)
301 (cons (+ max-num spool-length) (+ (length number-list) spool-length))))
303 ;;; Delayed operation (executed at online status).
304 (defun elmo-folder-append-buffer-dop-delayed (folder unread number set-number)
305 (let ((spool-folder (elmo-dop-spool-folder folder))
306 failure saved dequeued)
308 (if (elmo-message-fetch spool-folder number
309 (elmo-make-fetch-strategy 'entire)
310 nil (current-buffer) 'unread)
313 (elmo-folder-append-buffer
314 folder unread set-number)))
315 (error (setq failure t)))
316 (setq dequeued t)) ; Already deletef from queue.
319 (setq saved (elmo-folder-append-buffer
320 (elmo-make-folder elmo-lost+found-folder)
322 (if (and (not dequeued) ; if dequeued, no need to delete.
323 (or (not failure) ; succeed
324 saved)) ; in lost+found
325 (elmo-folder-delete-messages spool-folder (list number)))
328 (defun elmo-folder-delete-messages-dop-delayed (folder number-alist)
329 (elmo-folder-delete-messages
331 ;; messages are deleted only if message-id is not changed.
337 (elmo-message-fetch-field folder (car pair)
341 (defun elmo-folder-create-dop-delayed (folder)
342 (unless (elmo-folder-exists-p folder)
343 (elmo-folder-create folder)))
346 (defun elmo-dop-msgdb (msgdb)
347 (list (mapcar (function
349 (elmo-msgdb-overview-entity-set-number
352 (elmo-msgdb-overview-entity-get-number x)))))
362 (cdr x)))) (nth 2 msgdb))))
365 (product-provide (provide 'elmo-dop) (require 'elmo-version))
367 ;;; elmo-dop.el ends here