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 (&optional force)
  86   "Flush disconnected operations.
  87 If optional argument FORCE is non-nil, try flushing all operation queues
  88 even an operation concerns the unplugged folder."
  89   (elmo-dop-queue-merge)
  90   (let ((queue elmo-dop-queue)
  91         (count 0)
  92         folder
  93         len)
  94     ;; obsolete
  95     (unless (or (null queue)
  96                 (vectorp (car queue)))
  97       (if (y-or-n-p "Saved queue is old version(2.6). Clear all pending operations? ")
  98           (progn
  99             (setq elmo-dop-queue nil)
 100             (message "All pending operations are cleared.")
 101             (elmo-dop-queue-save))
 102         (error "Please use 2.6 or earlier.")))
 103     (setq count (length queue))
 104     (when (> count 0)
 105       (if (elmo-y-or-n-p
 106            (format "%d pending operation(s) exists.  Perform now? " count)
 107            (not elmo-dop-flush-confirm) t)
 108           (progn
 109             (message "")
 110             (sit-for 0)
 111             (let ((queue elmo-dop-queue)
 112                   (performed 0)
 113                   (i 0)
 114                   (num (length elmo-dop-queue))
 115                   folder func failure)
 116               (while queue
 117                 ;; now perform pending processes.
 118                 (setq failure nil)
 119                 (setq i (+ 1 i))
 120                 (message "Flushing queue....%d/%d." i num)
 121                 (condition-case err
 122                     (progn
 123                       (apply (elmo-dop-queue-method (car queue))
 124                              (prog1
 125                                  (setq folder
 126                                        (elmo-make-folder
 127                                         (elmo-dop-queue-fname (car queue))))
 128                                (elmo-folder-open folder)
 129                                (unless (elmo-folder-plugged-p folder)
 130                                  (error "Unplugged.")))
 131                              (elmo-dop-queue-arguments (car queue)))
 132                       (elmo-folder-close folder))
 133                   (quit  (setq failure t))
 134                   (error (setq failure err)))
 135                 (if failure
 136                     ();
 137                   (setq elmo-dop-queue (delq (car queue) elmo-dop-queue))
 138                   (setq performed (+ 1 performed)))
 139                 (setq queue (cdr queue)))
 140               (message "%d/%d operation(s) are performed successfully."
 141                        performed num)
 142               (sit-for 0) ;
 143               (elmo-dop-queue-save)))
 144         (if (elmo-y-or-n-p "Clear all pending operations? "
 145                            (not elmo-dop-flush-confirm) t)
 146             (progn
 147               (setq elmo-dop-queue nil)
 148               (message "All pending operations are cleared.")
 149               (elmo-dop-queue-save))
 150           (message "")))
 151       count)))
 152
 153 (defun elmo-dop-queue-merge ()
 154   (let ((queue elmo-dop-queue)
 155         new-queue match-queue que)
 156     (while (setq que (car queue))
 157       (if (and
 158            (memq (elmo-dop-queue-method que)
 159                  elmo-dop-queue-merge-method-list)
 160            (setq match-queue
 161                  (car (delete
 162                        nil
 163                        (mapcar
 164                         (lambda (nqueue)
 165                           (if (and
 166                                (string= (elmo-dop-queue-fname que)
 167                                         (elmo-dop-queue-fname nqueue))
 168                                (string= (elmo-dop-queue-method que)
 169                                         (elmo-dop-queue-method nqueue)))
 170                               nqueue))
 171                         new-queue)))))
 172           (setcar (elmo-dop-queue-arguments match-queue)
 173                   (append (car (elmo-dop-queue-arguments match-queue))
 174                           (car (elmo-dop-queue-arguments que))))
 175         (setq new-queue (nconc new-queue (list que))))
 176       (setq queue (cdr queue)) )
 177     (setq elmo-dop-queue new-queue)))
 178
 179 ;;; dop spool folder
 180 (defmacro elmo-dop-spool-folder (folder)
 181   "Return a spool folder for disconnected operations
 182 which is corresponded to the FOLDER."
 183   (` (elmo-make-folder
 184       (concat "+" (expand-file-name "spool" (elmo-folder-msgdb-path
 185                                              (, folder)))))))
 186
 187 (defun elmo-dop-spool-folder-append-buffer (folder)
 188   "Append current buffer content to the dop spool folder.
 189 FOLDER is the folder structure.
 190 Return a message number."
 191   (setq folder (elmo-dop-spool-folder folder))
 192   (unless (elmo-folder-exists-p folder)
 193     (elmo-folder-create folder))
 194   (let ((new-number (1+ (car (elmo-folder-status folder)))))
 195     ;; dop folder is a localdir folder.
 196     (write-region-as-binary (point-min) (point-max)
 197                           (expand-file-name
 198                            (int-to-string new-number)
 199                            (elmo-localdir-folder-directory-internal folder))
 200                           nil 'no-msg)
 201     new-number))
 202
 203
 204 (defun elmo-dop-spool-folder-list-messages (folder)
 205   "List messages in the dop spool folder.
 206 FOLDER is the folder structure."
 207   (setq folder (elmo-dop-spool-folder folder))
 208   (if (elmo-folder-exists-p folder)
 209       (elmo-folder-list-messages folder)))
 210
 211 (defun elmo-dop-list-deleting-messages (folder)
 212   "List messages which are on the deleting queue for the folder.
 213 FOLDER is the folder structure."
 214   (let (messages)
 215     (dolist (queue elmo-dop-queue)
 216       (if (and (string= (elmo-dop-queue-fname queue)
 217                         (elmo-folder-name-internal folder))
 218                (eq (elmo-dop-queue-method queue)
 219                    'elmo-folder-delete-messages-dop-delayed))
 220           (setq messages (nconc messages
 221                                 (mapcar
 222                                  'car
 223                                  (car (elmo-dop-queue-arguments queue)))))))))
 224
 225 ;;; DOP operations.
 226 (defsubst elmo-folder-append-buffer-dop (folder unread &optional number)
 227   (elmo-dop-queue-append
 228    folder 'elmo-folder-append-buffer-dop-delayed
 229    (list unread
 230          (elmo-dop-spool-folder-append-buffer
 231           folder)
 232          number)))
 233
 234 (defsubst elmo-folder-delete-messages-dop (folder numbers)
 235   (let ((spool-folder (elmo-dop-spool-folder folder))
 236         queue)
 237     (dolist (number numbers)
 238       (if (< number 0)
 239           (elmo-folder-delete-messages spool-folder
 240                                        (list (abs number))) ; delete from queue
 241         (setq queue (cons number queue))))
 242     (when queue
 243       (elmo-dop-queue-append folder 'elmo-folder-delete-messages-dop-delayed
 244                              (list
 245                               (mapcar
 246                                (lambda (number)
 247                                  (cons number (elmo-message-field
 248                                                folder number 'message-id)))
 249                                queue))))
 250     t))
 251
 252 (defsubst elmo-message-encache-dop (folder number &optional read)
 253   (elmo-dop-queue-append folder 'elmo-message-encache (list number read)))
 254
 255 (defsubst elmo-folder-create-dop (folder)
 256   (elmo-dop-queue-append folder 'elmo-folder-create-dop-delayed nil))
 257
 258 (defsubst elmo-folder-mark-as-read-dop (folder numbers)
 259   (elmo-dop-queue-append folder 'elmo-folder-mark-as-read (list numbers)))
 260
 261 (defsubst elmo-folder-unmark-read-dop (folder numbers)
 262   (elmo-dop-queue-append folder 'elmo-folder-unmark-read (list numbers)))
 263
 264 (defsubst elmo-folder-mark-as-important-dop (folder numbers)
 265   (elmo-dop-queue-append folder 'elmo-folder-mark-as-important (list numbers)))
 266
 267 (defsubst elmo-folder-unmark-important-dop (folder numbers)
 268   (elmo-dop-queue-append folder 'elmo-folder-unmark-important (list numbers)))
 269
 270 ;;; Execute as subsutitute for plugged operation.
 271 (defun elmo-folder-status-dop (folder)
 272   (let* ((number-alist (elmo-msgdb-number-load
 273                         (elmo-folder-msgdb-path folder)))
 274          (number-list (mapcar 'car number-alist))
 275          (spool-folder (elmo-dop-spool-folder folder))
 276          spool-length
 277          (i 0)
 278          max-num)
 279     (setq spool-length (car (if (elmo-folder-exists-p spool-folder)
 280                                 (elmo-folder-status spool-folder))))
 281     (setq max-num
 282           (or (nth (max (- (length number-list) 1) 0) number-list)
 283               0))
 284     (cons (+ max-num spool-length) (+ (length number-list) spool-length))))
 285
 286 ;;; Delayed operation (executed at online status).
 287 (defun elmo-folder-append-buffer-dop-delayed (folder unread number set-number)
 288   (let ((spool-folder (elmo-dop-spool-folder folder))
 289         failure saved dequeued)
 290     (with-temp-buffer
 291       (if (elmo-message-fetch spool-folder number
 292                               (elmo-make-fetch-strategy 'entire)
 293                               nil (current-buffer) 'unread)
 294           (condition-case nil
 295               (setq failure (not
 296                              (elmo-folder-append-buffer
 297                               folder unread set-number)))
 298             (error (setq failure t)))
 299         (setq dequeued t)) ; Already deletef from queue.
 300       (when failure
 301         ;; Append failed...
 302         (setq saved (elmo-folder-append-buffer
 303                      (elmo-make-folder elmo-lost+found-folder)
 304                      unread set-number)))
 305       (if (and (not dequeued)    ; if dequeued, no need to delete.
 306                (or (not failure) ; succeed
 307                    saved))       ; in lost+found
 308           (elmo-folder-delete-messages spool-folder (list number)))
 309       t)))
 310
 311 (defun elmo-folder-delete-messages-dop-delayed (folder number-alist)
 312   (elmo-folder-delete-messages
 313    folder
 314    ;; messages are deleted only if message-id is not changed.
 315    (mapcar 'car
 316            (elmo-delete-if
 317             (lambda (pair)
 318               (not (string=
 319                     (cdr pair)
 320                     (elmo-message-fetch-field folder (car pair)
 321                                               'message-id))))
 322             number-alist))))
 323
 324 (defun elmo-folder-create-dop-delayed (folder)
 325   (unless (elmo-folder-exists-p folder)
 326     (elmo-folder-create folder)))
 327
 328 ;;; Util
 329 (defun elmo-dop-msgdb (msgdb)
 330   (list (mapcar (function
 331                  (lambda (x)
 332                    (elmo-msgdb-overview-entity-set-number
 333                     x
 334                     (* -1
 335                        (elmo-msgdb-overview-entity-get-number x)))))
 336                 (nth 0 msgdb))
 337         (mapcar (function
 338                  (lambda (x) (cons
 339                               (* -1 (car x))
 340                               (cdr x))))
 341                 (nth 1 msgdb))
 342         (mapcar (function
 343                  (lambda (x) (cons
 344                               (* -1 (car x))
 345                               (cdr x)))) (nth 2 msgdb))))
 346
 347 (require 'product)
 348 (product-provide (provide 'elmo-dop) (require 'elmo-version))
 349
 350 ;;; elmo-dop.el ends here