elmo/elmo-dop.el

   1 ;;; elmo-dop.el --- Modules for Disconnected Operations on ELMO.
   2
   3 ;; Copyright (C) 1998,1999,2000 Yuuichi Teranishi <teranisi@gohome.org>
   4
   5 ;; Author: Yuuichi Teranishi <teranisi@gohome.org>
   6 ;; Keywords: mail, net news
   7
   8 ;; This file is part of ELMO (Elisp Library for Message Orchestration).
   9
  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)
  13 ;; any later version.
  14 ;;
  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.
  19 ;;
  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.
  24 ;;
  25
  26 ;;; Commentary:
  27 ;;
  28
  29 ;;; Code:
  30 ;;
  31
  32 (require 'elmo)
  33 (require 'elmo-vars)
  34 (require 'elmo-msgdb)
  35 (require 'elmo-util)
  36 (require 'elmo-localdir)
  37
  38 ;; global variable.
  39 (defvar elmo-dop-queue nil
  40   "A list of (folder-name function-to-be-called argument-list).
  41 Automatically loaded/saved.")
  42
  43 (defmacro elmo-make-dop-queue (fname method arguments)
  44   "Make a dop queue."
  45   (` (vector (, fname) (, method) (, arguments))))
  46
  47 (defmacro elmo-dop-queue-fname (queue)
  48   "Return the folder name string of the QUEUE."
  49   (` (aref (, queue) 0)))
  50
  51 (defmacro elmo-dop-queue-method (queue)
  52   "Return the method symbol of the QUEUE."
  53   (` (aref (, queue) 1)))
  54
  55 (defmacro elmo-dop-queue-arguments (queue)
  56   "Return the arguments of the QUEUE."
  57   (` (aref (, queue) 2)))
  58
  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)
  62                                     method arguments)))
  63     (setq elmo-dop-queue (nconc elmo-dop-queue (list queue)))))
  64
  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
  71 (defvar elmo-dop-queue-method-name-alist
  72   '((elmo-folder-append-buffer-dop-delayed . "Append")
  73     (elmo-folder-delete-messages-dop-delayed . "Delete")
  74     (elmo-message-encache . "Encache")
  75     (elmo-folder-create-dop-delayed . "Create")
  76     (elmo-folder-mark-as-read . "Read")
  77     (elmo-folder-unmark-read . "Unread")
  78     (elmo-folder-mark-as-important . "Important")
  79     (elmo-folder-unmark-important . "Unimportant")))
  80
  81 (defmacro elmo-dop-queue-method-name (queue)
  82   `(cdr (assq (elmo-dop-queue-method ,queue)
  83               elmo-dop-queue-method-name-alist)))
  84
  85 (defun elmo-dop-queue-flush ()
  86   "Flush disconnected operations that consern plugged folders."
  87   ;; obsolete
  88   (unless (or (null elmo-dop-queue)
  89               (vectorp (car elmo-dop-queue)))
  90     (if (y-or-n-p "\
  91 Saved queue is old version(2.6). Clear all pending operations? ")
  92         (progn
  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   (elmo-dop-queue-merge)
  98   (let ((queue-all elmo-dop-queue)
  99         queue
 100         (count 0)
 101         len)
 102     (while queue-all
 103       (if (elmo-folder-plugged-p
 104            (elmo-make-folder (elmo-dop-queue-fname (car queue-all))))
 105           (setq queue (append queue (list (car queue-all)))))
 106       (setq queue-all (cdr queue-all)))
 107     (setq count (length queue))
 108     (when (> count 0)
 109       (if (elmo-y-or-n-p
 110            (format "%d pending operation(s) exists.  Perform now? " count)
 111            (not elmo-dop-flush-confirm) t)
 112           (progn
 113             (message "")
 114             (sit-for 0)
 115             (let ((queue elmo-dop-queue)
 116                   (performed 0)
 117                   (i 0)
 118                   (num (length elmo-dop-queue))
 119                   folder func failure)
 120               (while queue
 121                 ;; now perform pending processes.
 122                 (setq failure nil)
 123                 (setq i (+ 1 i))
 124                 (message "Flushing queue....%d/%d." i num)
 125                 (condition-case err
 126                     (progn
 127                       (apply (elmo-dop-queue-method (car queue))
 128                              (prog1
 129                                  (setq folder
 130                                        (elmo-make-folder
 131                                         (elmo-dop-queue-fname (car queue))))
 132                                (elmo-folder-open folder))
 133                              (elmo-dop-queue-arguments (car queue)))
 134                       (elmo-folder-close folder))
 135                   (quit  (setq failure t))
 136                   (error (setq failure err)))
 137                 (if failure
 138                     ();
 139                   (setq elmo-dop-queue (delq (car queue) elmo-dop-queue))
 140                   (setq performed (+ 1 performed)))
 141                 (setq queue (cdr queue)))
 142               (message "%d/%d operation(s) are performed successfully."
 143                        performed num)
 144               (sit-for 0) ;
 145               (elmo-dop-queue-save)))
 146         ;; when answer=NO against performing dop
 147         (if (elmo-y-or-n-p "Clear these pending operations? "
 148                            (not elmo-dop-flush-confirm) t)
 149             (progn
 150               (while queue
 151                 (setq elmo-dop-queue (delq (car queue) elmo-dop-queue))
 152                 (setq queue (cdr queue)))
 153               (message "Pending operations are cleared.")
 154               (elmo-dop-queue-save))
 155           (message "")))
 156       count)))
 157
 158 (defun elmo-dop-queue-merge ()
 159   (let ((queue elmo-dop-queue)
 160         new-queue match-queue que)
 161     (while (setq que (car queue))
 162       (if (and
 163            (memq (elmo-dop-queue-method que)
 164                  elmo-dop-queue-merge-method-list)
 165            (setq match-queue
 166                  (car (delete
 167                        nil
 168                        (mapcar
 169                         (lambda (nqueue)
 170                           (if (and
 171                                (string= (elmo-dop-queue-fname que)
 172                                         (elmo-dop-queue-fname nqueue))
 173                                (string= (elmo-dop-queue-method que)
 174                                         (elmo-dop-queue-method nqueue)))
 175                               nqueue))
 176                         new-queue)))))
 177           (setcar (elmo-dop-queue-arguments match-queue)
 178                   (append (car (elmo-dop-queue-arguments match-queue))
 179                           (car (elmo-dop-queue-arguments que))))
 180         (setq new-queue (nconc new-queue (list que))))
 181       (setq queue (cdr queue)) )
 182     (setq elmo-dop-queue new-queue)))
 183
 184 ;;; dop spool folder
 185 (defmacro elmo-dop-spool-folder (folder)
 186   "Return a spool folder for disconnected operations
 187 which is corresponded to the FOLDER."
 188   (` (elmo-make-folder
 189       (concat "+" (expand-file-name "spool" (elmo-folder-msgdb-path
 190                                              (, folder)))))))
 191
 192 (defun elmo-dop-spool-folder-append-buffer (folder)
 193   "Append current buffer content to the dop spool folder.
 194 FOLDER is the folder structure.
 195 Return a message number."
 196   (setq folder (elmo-dop-spool-folder folder))
 197   (unless (elmo-folder-exists-p folder)
 198     (elmo-folder-create folder))
 199   (let ((new-number (1+ (car (elmo-folder-status folder)))))
 200     ;; dop folder is a localdir folder.
 201     (write-region-as-binary (point-min) (point-max)
 202                           (expand-file-name
 203                            (int-to-string new-number)
 204                            (elmo-localdir-folder-directory-internal folder))
 205                           nil 'no-msg)
 206     new-number))
 207
 208
 209 (defun elmo-dop-spool-folder-list-messages (folder)
 210   "List messages in the dop spool folder.
 211 FOLDER is the folder structure."
 212   (setq folder (elmo-dop-spool-folder folder))
 213   (if (elmo-folder-exists-p folder)
 214       (elmo-folder-list-messages folder)))
 215
 216 (defun elmo-dop-list-deleting-messages (folder)
 217   "List messages which are on the deleting queue for the folder.
 218 FOLDER is the folder structure."
 219   (let (messages)
 220     (dolist (queue elmo-dop-queue)
 221       (if (and (string= (elmo-dop-queue-fname queue)
 222                         (elmo-folder-name-internal folder))
 223                (eq (elmo-dop-queue-method queue)
 224                    'elmo-folder-delete-messages-dop-delayed))
 225           (setq messages (nconc messages
 226                                 (mapcar
 227                                  'car
 228                                  (car (elmo-dop-queue-arguments queue)))))))))
 229
 230 ;;; DOP operations.
 231 (defsubst elmo-folder-append-buffer-dop (folder unread &optional number)
 232   (elmo-dop-queue-append
 233    folder 'elmo-folder-append-buffer-dop-delayed
 234    (list unread
 235          (elmo-dop-spool-folder-append-buffer
 236           folder)
 237          number)))
 238
 239 (defsubst elmo-folder-delete-messages-dop (folder numbers)
 240   (let ((spool-folder (elmo-dop-spool-folder folder))
 241         queue)
 242     (dolist (number numbers)
 243       (if (< number 0)
 244           (elmo-folder-delete-messages spool-folder
 245                                        (list (abs number))) ; delete from queue
 246         (setq queue (cons number queue))))
 247     (when queue
 248       (elmo-dop-queue-append folder 'elmo-folder-delete-messages-dop-delayed
 249                              (list
 250                               (mapcar
 251                                (lambda (number)
 252                                  (cons number (elmo-message-field
 253                                                folder number 'message-id)))
 254                                queue))))
 255     t))
 256
 257 (defsubst elmo-message-encache-dop (folder number &optional read)
 258   (elmo-dop-queue-append folder 'elmo-message-encache (list number read)))
 259
 260 (defsubst elmo-folder-create-dop (folder)
 261   (elmo-dop-queue-append folder 'elmo-folder-create-dop-delayed nil))
 262
 263 (defsubst elmo-folder-mark-as-read-dop (folder numbers)
 264   (elmo-dop-queue-append folder 'elmo-folder-mark-as-read (list numbers)))
 265
 266 (defsubst elmo-folder-unmark-read-dop (folder numbers)
 267   (elmo-dop-queue-append folder 'elmo-folder-unmark-read (list numbers)))
 268
 269 (defsubst elmo-folder-mark-as-important-dop (folder numbers)
 270   (elmo-dop-queue-append folder 'elmo-folder-mark-as-important (list numbers)))
 271
 272 (defsubst elmo-folder-unmark-important-dop (folder numbers)
 273   (elmo-dop-queue-append folder 'elmo-folder-unmark-important (list numbers)))
 274
 275 ;;; Execute as subsutitute for plugged operation.
 276 (defun elmo-folder-status-dop (folder)
 277   (let* ((number-alist (elmo-msgdb-number-load
 278                         (elmo-folder-msgdb-path folder)))
 279          (number-list (mapcar 'car number-alist))
 280          (spool-folder (elmo-dop-spool-folder folder))
 281          spool-length
 282          (i 0)
 283          max-num)
 284     (setq spool-length (car (if (elmo-folder-exists-p spool-folder)
 285                                 (elmo-folder-status spool-folder))))
 286     (setq max-num
 287           (or (nth (max (- (length number-list) 1) 0) number-list)
 288               0))
 289     (cons (+ max-num spool-length) (+ (length number-list) spool-length))))
 290
 291 ;;; Delayed operation (executed at online status).
 292 (defun elmo-folder-append-buffer-dop-delayed (folder unread number set-number)
 293   (let ((spool-folder (elmo-dop-spool-folder folder))
 294         failure saved dequeued)
 295     (with-temp-buffer
 296       (if (elmo-message-fetch spool-folder number
 297                               (elmo-make-fetch-strategy 'entire)
 298                               nil (current-buffer) 'unread)
 299           (condition-case nil
 300               (setq failure (not
 301                              (elmo-folder-append-buffer
 302                               folder unread set-number)))
 303             (error (setq failure t)))
 304         (setq dequeued t)) ; Already deletef from queue.
 305       (when failure
 306         ;; Append failed...
 307         (setq saved (elmo-folder-append-buffer
 308                      (elmo-make-folder elmo-lost+found-folder)
 309                      unread set-number)))
 310       (if (and (not dequeued)    ; if dequeued, no need to delete.
 311                (or (not failure) ; succeed
 312                    saved))       ; in lost+found
 313           (elmo-folder-delete-messages spool-folder (list number)))
 314       t)))
 315
 316 (defun elmo-folder-delete-messages-dop-delayed (folder number-alist)
 317   (elmo-folder-delete-messages
 318    folder
 319    ;; messages are deleted only if message-id is not changed.
 320    (mapcar 'car
 321            (elmo-delete-if
 322             (lambda (pair)
 323               (not (string=
 324                     (cdr pair)
 325                     (elmo-message-fetch-field folder (car pair)
 326                                               'message-id))))
 327             number-alist))))
 328
 329 (defun elmo-folder-create-dop-delayed (folder)
 330   (unless (elmo-folder-exists-p folder)
 331     (elmo-folder-create folder)))
 332
 333 ;;; Util
 334 (defun elmo-dop-msgdb (msgdb)
 335   (list (mapcar (function
 336                  (lambda (x)
 337                    (elmo-msgdb-overview-entity-set-number
 338                     x
 339                     (* -1
 340                        (elmo-msgdb-overview-entity-get-number x)))))
 341                 (nth 0 msgdb))
 342         (mapcar (function
 343                  (lambda (x) (cons
 344                               (* -1 (car x))
 345                               (cdr x))))
 346                 (nth 1 msgdb))
 347         (mapcar (function
 348                  (lambda (x) (cons
 349                               (* -1 (car x))
 350                               (cdr x)))) (nth 2 msgdb))))
 351
 352 (require 'product)
 353 (product-provide (provide 'elmo-dop) (require 'elmo-version))
 354
 355 ;;; elmo-dop.el ends here