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 (eval-when-compile (require 'cl))
  32
  33 (require 'elmo)
  34 (require 'elmo-vars)
  35 (require 'elmo-msgdb)
  36 (require 'elmo-util)
  37 (require 'elmo-localdir)
  38
  39 ;; global variable.
  40 (defvar elmo-dop-queue nil
  41   "A list of (folder-name function-to-be-called argument-list).
  42 Automatically loaded/saved.")
  43
  44 (defmacro elmo-make-dop-queue (fname method arguments)
  45   "Make a dop queue."
  46   (` (vector (, fname) (, method) (, arguments))))
  47
  48 (defmacro elmo-dop-queue-fname (queue)
  49   "Return the folder name string of the QUEUE."
  50   (` (aref (, queue) 0)))
  51
  52 (defmacro elmo-dop-queue-method (queue)
  53   "Return the method symbol of the QUEUE."
  54   (` (aref (, queue) 1)))
  55
  56 (defmacro elmo-dop-queue-arguments (queue)
  57   "Return the arguments of the QUEUE."
  58   (` (aref (, queue) 2)))
  59
  60 (defun elmo-dop-queue-append (folder method arguments)
  61   "Append to disconnected operation queue."
  62   (let ((queue (elmo-make-dop-queue (elmo-folder-name-internal folder)
  63                                     method arguments)))
  64     (setq elmo-dop-queue (nconc elmo-dop-queue (list queue)))))
  65
  66 (defvar elmo-dop-queue-merge-method-list
  67   '(elmo-folder-set-read-delayed
  68     elmo-folder-unset-read-delayed
  69     elmo-folder-set-important-delayed
  70     elmo-folder-unset-important-delayed
  71     elmo-folder-set-answered-delayed
  72     elmo-folder-unset-answered-delayed))
  73
  74 (defvar elmo-dop-queue-method-name-alist
  75   '((elmo-folder-append-buffer-dop-delayed . "Append")
  76     (elmo-folder-delete-messages-dop-delayed . "Delete")
  77     (elmo-message-encache . "Encache")
  78     (elmo-folder-create-dop-delayed . "Create")
  79     (elmo-folder-set-read-delayed . "Read")
  80     (elmo-folder-unset-read-delayed . "Unread")
  81     (elmo-folder-set-answered-delayed . "Answered")
  82     (elmo-folder-unset-answered-delayed . "Unanswered")
  83     (elmo-folder-set-important-delayed . "Important")
  84     (elmo-folder-unset-important-delayed . "Unimportant")
  85     (elmo-folder-set-flag . "Set flag")
  86     (elmo-folder-unset-flag . "Unset flag")))
  87
  88 (defmacro elmo-dop-queue-method-name (queue)
  89   `(cdr (assq (elmo-dop-queue-method ,queue)
  90               elmo-dop-queue-method-name-alist)))
  91
  92 (defun elmo-dop-queue-flush ()
  93   "Flush disconnected operations that consern plugged folders."
  94   ;; obsolete
  95   (unless (or (null elmo-dop-queue)
  96               (vectorp (car elmo-dop-queue)))
  97     (if (y-or-n-p "\
  98 Saved queue is old version(2.6).  Clear all pending operations? ")
  99         (progn
 100           (setq elmo-dop-queue nil)
 101           (message "All pending operations are cleared.")
 102           (elmo-dop-queue-save))
 103       (error "Please use 2.6 or earlier")))
 104   (elmo-dop-queue-merge)
 105   (let ((queue-all elmo-dop-queue)
 106         queue
 107         (count 0)
 108         len)
 109     (while queue-all
 110       (if (elmo-folder-plugged-p
 111            (elmo-make-folder (elmo-dop-queue-fname (car queue-all))))
 112           (setq queue (append queue (list (car queue-all)))))
 113       (setq queue-all (cdr queue-all)))
 114     (setq count (length queue))
 115     (when (> count 0)
 116       (if (elmo-y-or-n-p
 117            (format "%d pending operation(s) exists.  Perform now? " count)
 118            (not elmo-dop-flush-confirm) t)
 119           (progn
 120             (message "")
 121             (sit-for 0)
 122             (let ((queue elmo-dop-queue)
 123                   (performed 0)
 124                   (i 0)
 125                   (num (length elmo-dop-queue))
 126                   folder func failure)
 127               (while queue
 128                 ;; now perform pending processes.
 129                 (setq failure nil)
 130                 (setq i (+ 1 i))
 131                 (message "Flushing queue....%d/%d." i num)
 132                 (condition-case err
 133                     (progn
 134                       (apply (elmo-dop-queue-method (car queue))
 135                              (prog1
 136                                  (setq folder
 137                                        (elmo-make-folder
 138                                         (elmo-dop-queue-fname (car queue))))
 139                                (elmo-folder-open folder)
 140                                (unless (elmo-folder-plugged-p folder)
 141                                  (error "Unplugged")))
 142                              (elmo-dop-queue-arguments (car queue)))
 143                       (elmo-folder-close folder))
 144                   (quit  (setq failure t))
 145                   (error (setq failure err)))
 146                 (if failure
 147                     ();
 148                   (setq elmo-dop-queue (delq (car queue) elmo-dop-queue))
 149                   (setq performed (+ 1 performed)))
 150                 (setq queue (cdr queue)))
 151               (message "%d/%d operation(s) are performed successfully."
 152                        performed num)
 153               (sit-for 0) ;
 154               (elmo-dop-queue-save)))
 155         ;; when answer=NO against performing dop
 156         (if (elmo-y-or-n-p "Clear these pending operations? "
 157                            (not elmo-dop-flush-confirm) t)
 158             (progn
 159               (while queue
 160                 (when (eq (elmo-dop-queue-method (car queue))
 161                           'elmo-folder-append-buffer-dop-delayed)
 162                   (elmo-folder-delete-messages
 163                    (elmo-dop-spool-folder
 164                     (elmo-make-folder (elmo-dop-queue-fname (car queue))))
 165                    (list (nth 1 (elmo-dop-queue-arguments (car queue))))))
 166                 (setq elmo-dop-queue (delq (car queue) elmo-dop-queue))
 167                 (setq queue (cdr queue)))
 168               (message "Pending operations are cleared.")
 169               (elmo-dop-queue-save))
 170           (message "")))
 171       count)))
 172
 173 (defun elmo-dop-queue-merge ()
 174   (let ((queue elmo-dop-queue)
 175         new-queue match-queue que)
 176     (while (setq que (car queue))
 177       (if (and
 178            (memq (elmo-dop-queue-method que)
 179                  elmo-dop-queue-merge-method-list)
 180            (setq match-queue
 181                  (car (delete
 182                        nil
 183                        (mapcar
 184                         (lambda (nqueue)
 185                           (if (and
 186                                (string= (elmo-dop-queue-fname que)
 187                                         (elmo-dop-queue-fname nqueue))
 188                                (string= (elmo-dop-queue-method que)
 189                                         (elmo-dop-queue-method nqueue)))
 190                               nqueue))
 191                         new-queue)))))
 192           (setcar (elmo-dop-queue-arguments match-queue)
 193                   (append (car (elmo-dop-queue-arguments match-queue))
 194                           (car (elmo-dop-queue-arguments que))))
 195         (setq new-queue (nconc new-queue (list que))))
 196       (setq queue (cdr queue)) )
 197     (setq elmo-dop-queue new-queue)))
 198
 199 ;;; dop spool folder
 200 (defmacro elmo-dop-spool-folder (folder)
 201   "Return a spool folder for disconnected operations
 202 which is corresponded to the FOLDER."
 203   (` (elmo-make-folder
 204       (concat "+" (expand-file-name "spool" (elmo-folder-msgdb-path
 205                                              (, folder)))))))
 206
 207 (defun elmo-dop-spool-folder-append-buffer (folder flags)
 208   "Append current buffer content to the dop spool folder.
 209 FOLDER is the folder structure.
 210 Return a message number."
 211   (let ((spool (elmo-dop-spool-folder folder)))
 212     (unless (elmo-folder-exists-p spool)
 213       (elmo-folder-create spool))
 214     (let ((new-number (1+ (car (elmo-folder-status spool)))))
 215       (elmo-folder-append-buffer spool flags new-number)
 216       new-number)))
 217
 218
 219 (defun elmo-dop-spool-folder-list-messages (folder)
 220   "List messages in the dop spool folder.
 221 FOLDER is the folder structure."
 222   (setq folder (elmo-dop-spool-folder folder))
 223   (if (elmo-folder-exists-p folder)
 224       (elmo-folder-list-messages folder)))
 225
 226 (defun elmo-dop-list-deleting-messages (folder)
 227   "List messages which are on the deleting queue for the folder.
 228 FOLDER is the folder structure."
 229   (let (messages)
 230     (dolist (queue elmo-dop-queue)
 231       (if (and (string= (elmo-dop-queue-fname queue)
 232                         (elmo-folder-name-internal folder))
 233                (eq (elmo-dop-queue-method queue)
 234                    'elmo-folder-delete-messages-dop-delayed))
 235           (setq messages (nconc messages
 236                                 (mapcar
 237                                  'car
 238                                  (car (elmo-dop-queue-arguments queue)))))))))
 239
 240 (defun elmo-dop-filter-pending-messages (numbers)
 241   (elmo-delete-if (lambda (number) (< number 0)) numbers))
 242
 243 ;;; DOP operations.
 244 (defsubst elmo-folder-append-buffer-dop (folder &optional flag number)
 245   (elmo-dop-queue-append
 246    folder 'elmo-folder-append-buffer-dop-delayed
 247    (list flag
 248          (elmo-dop-spool-folder-append-buffer folder flag)
 249          number)))
 250
 251 (defsubst elmo-folder-delete-messages-dop (folder numbers)
 252   (let ((spool-folder (elmo-dop-spool-folder folder))
 253         queue)
 254     (dolist (number numbers)
 255       (if (< number 0)
 256           (progn
 257             ;; delete from queue
 258             (elmo-folder-delete-messages spool-folder
 259                                          (list (abs number)))
 260             (dolist (queue elmo-dop-queue)
 261               (when (and (eq (elmo-dop-queue-fname queue)
 262                              (elmo-folder-name-internal folder))
 263                          (eq (elmo-dop-queue-method queue)
 264                              'elmo-folder-append-buffer-dop-delayed)
 265                          (eq (abs number)
 266                              (nth 1 (elmo-dop-queue-arguments queue))))
 267                 (setq elmo-dop-queue (delq queue elmo-dop-queue)))))
 268         (setq queue (cons number queue))))
 269     (when queue
 270       (elmo-dop-queue-append folder 'elmo-folder-delete-messages-dop-delayed
 271                              (list
 272                               (mapcar
 273                                (lambda (number)
 274                                  (cons number (elmo-message-field
 275                                                folder number 'message-id)))
 276                                queue))))
 277     t))
 278
 279 (defsubst elmo-message-encache-dop (folder number &optional read)
 280   (elmo-dop-queue-append folder 'elmo-message-encache (list number read)))
 281
 282 (defsubst elmo-folder-create-dop (folder)
 283   (elmo-dop-queue-append folder 'elmo-folder-create-dop-delayed nil))
 284
 285 (defsubst elmo-folder-set-flag-dop (folder numbers flag)
 286   (when (setq numbers (elmo-dop-filter-pending-messages numbers))
 287     (let ((method (case flag
 288                     (unread
 289                      'elmo-folder-unset-read-delayed)
 290                     (read
 291                      'elmo-folder-set-read-delayed)
 292                     (important
 293                      'elmo-folder-set-important-delayed)
 294                     (answered
 295                      'elmo-folder-set-answered-delayed))))
 296       (if method
 297           (elmo-dop-queue-append folder method (list numbers))
 298         (elmo-dop-queue-append folder 'elmo-folder-set-flag
 299                                (list numbers flag))))))
 300
 301 (defsubst elmo-folder-unset-flag-dop (folder numbers flag)
 302   (when (setq numbers (elmo-dop-filter-pending-messages numbers))
 303     (let ((method (case flag
 304                     (unread
 305                      'elmo-folder-set-read-delayed)
 306                     (read
 307                      'elmo-folder-unset-read-delayed)
 308                     (important
 309                      'elmo-folder-unset-important-delayed)
 310                     (answered
 311                      'elmo-folder-unset-answered-delayed))))
 312       (if method
 313           (elmo-dop-queue-append folder method (list numbers))
 314         (elmo-dop-queue-append folder 'elmo-folder-unset-flag
 315                                (list numbers flag))))))
 316
 317 ;;; Execute as subsutitute for plugged operation.
 318 (defun elmo-folder-status-dop (folder)
 319   (let ((number-list (elmo-folder-list-messages folder nil 'in-msgdb))
 320         (spool-folder (elmo-dop-spool-folder folder))
 321         spool-length
 322         max-num)
 323     (setq spool-length (or (if (elmo-folder-exists-p spool-folder)
 324                                (car (elmo-folder-status spool-folder)))
 325                            0))
 326     (setq max-num (if number-list (apply #'max number-list) 0))
 327     (cons (+ max-num spool-length) (+ (length number-list) spool-length))))
 328
 329 (defun elmo-folder-next-message-number-dop (folder)
 330   (let ((spool-folder (elmo-dop-spool-folder folder)))
 331     (- (+ 1 (elmo-max-of-list (or (elmo-folder-list-messages
 332                                    spool-folder)
 333                                   '(0)))))))
 334
 335 ;;; Delayed operation (executed at online status).
 336 (defun elmo-folder-append-buffer-dop-delayed (folder flag number set-number)
 337   (let ((spool-folder (elmo-dop-spool-folder folder))
 338         flags)
 339     (with-temp-buffer
 340       (when (elmo-message-fetch spool-folder number
 341                                 (elmo-make-fetch-strategy 'entire)
 342                                 'unread)
 343         (setq flags (or (elmo-message-flags-for-append folder (* -1 number))
 344                         (cond ((listp flag)
 345                                flag)
 346                               ;; for compatibility with 2.11.12 or earlier
 347                               ((eq flag t)
 348                                nil)
 349                               (t
 350                                (list flag)))))
 351         (when (or (condition-case nil
 352                       (elmo-folder-append-buffer folder flags set-number)
 353                     (error))
 354                   ;; Append failed...
 355                   (elmo-folder-append-buffer
 356                    (elmo-make-folder elmo-lost+found-folder)
 357                    flags))
 358           (elmo-folder-delete-messages spool-folder (list number)))))
 359     ;; ignore failure (already dequed)
 360     t))
 361
 362 (defun elmo-folder-delete-messages-dop-delayed (folder number-alist)
 363   (ignore-errors
 364     (elmo-folder-delete-messages
 365      folder
 366      ;; messages are deleted only if message-id is not changed.
 367      (mapcar 'car
 368              (elmo-delete-if
 369               (lambda (pair)
 370                 (not (string=
 371                       (cdr pair)
 372                       (elmo-message-fetch-field folder (car pair)
 373                                                 'message-id))))
 374               number-alist)))
 375     t)) ; Always success (If failure, just remain)
 376
 377 (defun elmo-folder-create-dop-delayed (folder)
 378   (unless (elmo-folder-exists-p folder)
 379     (elmo-folder-create folder)))
 380
 381 (defun elmo-folder-set-important-delayed (folder numbers)
 382   (elmo-folder-set-flag folder numbers 'important))
 383
 384 (defun elmo-folder-unset-important-delayed (folder numbers)
 385   (elmo-folder-unset-flag folder numbers 'important))
 386
 387 (defun elmo-folder-set-read-delayed (folder numbers)
 388   (elmo-folder-unset-flag folder numbers 'unread))
 389
 390 (defun elmo-folder-unset-read-delayed (folder numbers)
 391   (elmo-folder-set-flag folder numbers 'unread))
 392
 393 (defun elmo-folder-set-answered-delayed (folder numbers)
 394   (elmo-folder-set-flag folder numbers 'answered))
 395
 396 (defun elmo-folder-unset-answered-delayed (folder numbers)
 397   (elmo-folder-unset-flag folder numbers 'answered))
 398
 399 ;;; Util
 400 (defun elmo-dop-msgdb (msgdb)
 401   (let ((new-db (elmo-make-msgdb))
 402         entity)
 403     (dolist (dop-entity (mapcar
 404                          (lambda (number)
 405                            (setq entity (elmo-msgdb-message-entity
 406                                          msgdb number))
 407                            (elmo-message-entity-set-number
 408                             entity
 409                             (* -1 (elmo-message-entity-number entity)))
 410                            entity)
 411                          (elmo-msgdb-list-messages msgdb)))
 412       (elmo-msgdb-append-entity new-db
 413                                 dop-entity
 414                                 (elmo-msgdb-flags
 415                                  msgdb
 416                                  (abs (elmo-message-entity-number
 417                                        dop-entity)))))
 418     new-db))
 419
 420 (require 'product)
 421 (product-provide (provide 'elmo-dop) (require 'elmo-version))
 422
 423 ;;; elmo-dop.el ends here