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