elmo/elmo-pipe.el

   1 ;;; elmo-pipe.el --- PIPE Interface for 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
  34 (defvar elmo-pipe-folder-copied-filename "copied"
  35   "Copied messages number set.")
  36
  37 ;;; ELMO pipe folder
  38 (eval-and-compile
  39   (luna-define-class elmo-pipe-folder (elmo-folder)
  40                      (src dst copy))
  41   (luna-define-internal-accessors 'elmo-pipe-folder))
  42
  43 (luna-define-method elmo-folder-initialize ((folder elmo-pipe-folder)
  44                                             name)
  45   (when (string-match "^\\([^|]*\\)|\\(:?\\)\\(.*\\)$" name)
  46     (elmo-pipe-folder-set-src-internal folder
  47                                        (elmo-make-folder
  48                                         (elmo-match-string 1 name)))
  49     (elmo-pipe-folder-set-dst-internal folder
  50                                        (elmo-make-folder
  51                                         (elmo-match-string 3 name)))
  52     (elmo-pipe-folder-set-copy-internal folder
  53                                         (string= ":"
  54                                                  (elmo-match-string 2 name))))
  55   folder)
  56
  57 (luna-define-method elmo-folder-get-primitive-list ((folder elmo-pipe-folder))
  58   (elmo-flatten
  59    (mapcar
  60     'elmo-folder-get-primitive-list
  61     (list (elmo-pipe-folder-src-internal folder)
  62           (elmo-pipe-folder-dst-internal folder)))))
  63
  64 (luna-define-method elmo-folder-contains-type ((folder elmo-pipe-folder)
  65                                                type)
  66   (or (elmo-folder-contains-type (elmo-pipe-folder-src-internal folder) type)
  67       (elmo-folder-contains-type (elmo-pipe-folder-dst-internal folder) type)))
  68
  69 (luna-define-method elmo-folder-msgdb-create ((folder elmo-pipe-folder)
  70                                               numlist flag-table)
  71   (elmo-folder-msgdb-create (elmo-pipe-folder-dst-internal folder)
  72                             numlist flag-table))
  73
  74 (luna-define-method elmo-folder-append-messages ((folder elmo-pipe-folder)
  75                                                  src-folder numbers
  76                                                  &optional same-number)
  77   (elmo-folder-append-messages (elmo-pipe-folder-dst-internal folder)
  78                                src-folder numbers
  79                                same-number))
  80
  81 (luna-define-method elmo-folder-append-buffer ((folder elmo-pipe-folder)
  82                                                &optional flag number)
  83   (elmo-folder-append-buffer (elmo-pipe-folder-dst-internal folder)
  84                              flag number))
  85
  86 (luna-define-method elmo-message-fetch ((folder elmo-pipe-folder)
  87                                         number strategy
  88                                         &optional section outbuf unseen)
  89   (elmo-message-fetch (elmo-pipe-folder-dst-internal folder)
  90                       number strategy section outbuf unseen))
  91
  92 (luna-define-method elmo-folder-clear :after ((folder elmo-pipe-folder)
  93                                               &optional keep-killed)
  94   (unless keep-killed
  95     (elmo-pipe-folder-copied-list-save folder nil)))
  96
  97 (luna-define-method elmo-folder-delete-messages ((folder elmo-pipe-folder)
  98                                                  numbers)
  99   (elmo-folder-delete-messages (elmo-pipe-folder-dst-internal folder)
 100                                numbers))
 101
 102 (defvar elmo-pipe-drained-hook nil "A hook called when the pipe is flushed.")
 103
 104 (defsubst elmo-pipe-folder-list-target-messages (src &optional ignore-list)
 105   (unwind-protect
 106       (progn
 107         (elmo-folder-set-killed-list-internal src ignore-list)
 108         (elmo-folder-list-messages src))
 109     (elmo-folder-set-killed-list-internal src nil)))
 110
 111 (defun elmo-pipe-drain (src dst &optional copy ignore-list)
 112   "Move or copy all messages of SRC to DST."
 113   (let ((elmo-inhibit-number-mapping (not copy)) ; No need to use UIDL
 114         msgs len)
 115     (message "Checking %s..." (elmo-folder-name-internal src))
 116     ;; Warnnig: some function requires msgdb
 117     ;;  but elmo-folder-open-internal do not load msgdb.
 118     (elmo-folder-open-internal src)
 119     (setq msgs (elmo-pipe-folder-list-target-messages src ignore-list)
 120           len (length msgs))
 121     (when (> len elmo-display-progress-threshold)
 122       (elmo-progress-set 'elmo-folder-move-messages
 123                          len
 124                          (if copy
 125                              "Copying messages..."
 126                            "Moving messages...")))
 127     (unwind-protect
 128         (elmo-folder-move-messages src msgs dst
 129                                    nil nil copy)
 130       (elmo-progress-clear 'elmo-folder-move-messages))
 131     (when (and copy msgs)
 132       (setq ignore-list (elmo-number-set-append-list ignore-list
 133                                                      msgs)))
 134     ;; Don't save msgdb here.
 135     ;; Because summary view of original folder is not updated yet.
 136     (elmo-folder-close-internal src)
 137     (run-hooks 'elmo-pipe-drained-hook)
 138     ignore-list))
 139
 140 (defun elmo-pipe-folder-copied-list-load (folder)
 141   (elmo-object-load
 142    (expand-file-name elmo-pipe-folder-copied-filename
 143                      (expand-file-name
 144                       (elmo-replace-string-as-filename
 145                        (elmo-folder-name-internal folder))
 146                       (expand-file-name "pipe" elmo-msgdb-directory)))
 147    nil t))
 148
 149 (defun elmo-pipe-folder-copied-list-save (folder copied-list)
 150   (elmo-object-save
 151    (expand-file-name elmo-pipe-folder-copied-filename
 152                      (expand-file-name
 153                       (elmo-replace-string-as-filename
 154                        (elmo-folder-name-internal folder))
 155                       (expand-file-name "pipe" elmo-msgdb-directory)))
 156    copied-list))
 157
 158 (luna-define-method elmo-folder-open-internal ((folder elmo-pipe-folder))
 159   (elmo-folder-open-internal (elmo-pipe-folder-dst-internal folder))
 160   (let ((src-folder (elmo-pipe-folder-src-internal folder))
 161         (dst-folder (elmo-pipe-folder-dst-internal folder)))
 162     (when (and (elmo-folder-plugged-p src-folder)
 163                (elmo-folder-plugged-p dst-folder))
 164       (if (elmo-pipe-folder-copy-internal folder)
 165           (elmo-pipe-folder-copied-list-save
 166            folder
 167            (elmo-pipe-drain src-folder
 168                             dst-folder
 169                             'copy
 170                             (elmo-pipe-folder-copied-list-load folder)))
 171         (elmo-pipe-drain src-folder dst-folder)))))
 172
 173 (luna-define-method elmo-folder-close-internal ((folder elmo-pipe-folder))
 174   (elmo-folder-close-internal(elmo-pipe-folder-dst-internal folder)))
 175
 176 (luna-define-method elmo-folder-list-messages-internal
 177   ((folder elmo-pipe-folder) &optional nohide)
 178   (elmo-folder-list-messages-internal (elmo-pipe-folder-dst-internal
 179                                        folder) nohide))
 180
 181 (luna-define-method elmo-folder-list-unreads ((folder elmo-pipe-folder))
 182   (elmo-folder-list-unreads (elmo-pipe-folder-dst-internal folder)))
 183
 184 (luna-define-method elmo-folder-list-importants ((folder elmo-pipe-folder))
 185   (elmo-folder-list-importants (elmo-pipe-folder-dst-internal folder)))
 186
 187 (luna-define-method elmo-folder-list-answereds ((folder elmo-pipe-folder))
 188   (elmo-folder-list-answereds (elmo-pipe-folder-dst-internal folder)))
 189
 190 (luna-define-method elmo-folder-status ((folder elmo-pipe-folder))
 191   (elmo-folder-open-internal (elmo-pipe-folder-src-internal folder))
 192   (elmo-folder-open-internal (elmo-pipe-folder-dst-internal folder))
 193   (let* ((elmo-inhibit-number-mapping
 194           (not (elmo-pipe-folder-copy-internal folder)))
 195          (src-length (length (elmo-pipe-folder-list-target-messages
 196                               (elmo-pipe-folder-src-internal folder)
 197                               (elmo-pipe-folder-copied-list-load folder))))
 198          (dst-list (elmo-folder-list-messages
 199                     (elmo-pipe-folder-dst-internal folder))))
 200     (prog1 (cons (+ src-length (elmo-max-of-list dst-list))
 201                  (+ src-length (length dst-list)))
 202       ;; No save.
 203       (elmo-folder-close-internal (elmo-pipe-folder-src-internal folder))
 204       (elmo-folder-close-internal (elmo-pipe-folder-dst-internal folder)))))
 205
 206 (luna-define-method elmo-folder-exists-p ((folder elmo-pipe-folder))
 207   (and (elmo-folder-exists-p (elmo-pipe-folder-src-internal folder))
 208        (elmo-folder-exists-p (elmo-pipe-folder-dst-internal folder))))
 209
 210 (luna-define-method elmo-folder-expand-msgdb-path ((folder
 211                                                     elmo-pipe-folder))
 212   ;; Share with destination...OK?
 213   (elmo-folder-expand-msgdb-path (elmo-pipe-folder-dst-internal folder)))
 214
 215 (luna-define-method elmo-folder-newsgroups ((folder elmo-pipe-folder))
 216   (elmo-folder-newsgroups (elmo-pipe-folder-src-internal folder)))
 217
 218 (luna-define-method elmo-folder-creatable-p ((folder elmo-pipe-folder))
 219   (and (or
 220         (elmo-folder-exists-p (elmo-pipe-folder-src-internal folder))
 221         (elmo-folder-creatable-p (elmo-pipe-folder-src-internal folder)))
 222        (or
 223         (elmo-folder-exists-p (elmo-pipe-folder-dst-internal folder))
 224         (elmo-folder-creatable-p (elmo-pipe-folder-dst-internal folder)))))
 225
 226 (luna-define-method elmo-folder-writable-p ((folder elmo-pipe-folder))
 227   (elmo-folder-writable-p (elmo-pipe-folder-dst-internal folder)))
 228
 229 (luna-define-method elmo-folder-create ((folder elmo-pipe-folder))
 230   (if (and (not (elmo-folder-exists-p (elmo-pipe-folder-src-internal folder)))
 231            (elmo-folder-creatable-p (elmo-pipe-folder-src-internal folder)))
 232       (elmo-folder-create (elmo-pipe-folder-src-internal folder)))
 233   (if (and (not (elmo-folder-exists-p (elmo-pipe-folder-dst-internal folder)))
 234            (elmo-folder-creatable-p (elmo-pipe-folder-dst-internal folder)))
 235       (elmo-folder-create (elmo-pipe-folder-dst-internal folder))))
 236
 237 (luna-define-method elmo-folder-search ((folder elmo-pipe-folder)
 238                                         condition &optional numlist)
 239   (elmo-folder-search (elmo-pipe-folder-dst-internal folder)
 240                       condition numlist))
 241
 242 (luna-define-method elmo-message-use-cache-p ((folder elmo-pipe-folder) number)
 243   (elmo-message-use-cache-p (elmo-pipe-folder-dst-internal folder) number))
 244
 245 (luna-define-method elmo-folder-check ((folder elmo-pipe-folder))
 246   (elmo-folder-close-internal folder)
 247   (elmo-folder-open-internal folder))
 248
 249 (luna-define-method elmo-folder-plugged-p ((folder elmo-pipe-folder))
 250   (and (elmo-folder-plugged-p (elmo-pipe-folder-src-internal folder))
 251        (elmo-folder-plugged-p (elmo-pipe-folder-dst-internal folder))))
 252
 253 (luna-define-method elmo-folder-message-file-p ((folder elmo-pipe-folder))
 254   (elmo-folder-message-file-p (elmo-pipe-folder-dst-internal folder)))
 255
 256 (luna-define-method elmo-message-file-p ((folder elmo-pipe-folder) number)
 257   (elmo-message-file-p (elmo-pipe-folder-dst-internal folder) number))
 258
 259 (luna-define-method elmo-message-file-name ((folder elmo-pipe-folder) number)
 260   (elmo-message-file-name (elmo-pipe-folder-dst-internal folder) number))
 261
 262 (luna-define-method elmo-folder-message-file-number-p ((folder
 263                                                         elmo-pipe-folder))
 264   (elmo-folder-message-file-number-p (elmo-pipe-folder-dst-internal folder)))
 265
 266 (luna-define-method elmo-folder-message-file-directory ((folder
 267                                                          elmo-pipe-folder))
 268   (elmo-folder-message-file-directory
 269    (elmo-pipe-folder-dst-internal folder)))
 270
 271 (luna-define-method elmo-folder-message-make-temp-file-p
 272   ((folder elmo-pipe-folder))
 273   (elmo-folder-message-make-temp-file-p
 274    (elmo-pipe-folder-dst-internal folder)))
 275
 276 (luna-define-method elmo-folder-message-make-temp-files ((folder
 277                                                           elmo-pipe-folder)
 278                                                          numbers
 279                                                          &optional
 280                                                          start-number)
 281   (elmo-folder-message-make-temp-files
 282    (elmo-pipe-folder-dst-internal folder) numbers start-number))
 283
 284 (luna-define-method elmo-folder-mark-as-read ((folder elmo-pipe-folder)
 285                                               numbers &optional ignore-flag)
 286   (elmo-folder-mark-as-read (elmo-pipe-folder-dst-internal folder)
 287                             numbers ignore-flag))
 288
 289 (luna-define-method elmo-folder-unmark-read ((folder elmo-pipe-folder)
 290                                              numbers
 291                                              &optional ignore-flag)
 292   (elmo-folder-unmark-read (elmo-pipe-folder-dst-internal folder)
 293                            numbers ignore-flag))
 294
 295 (luna-define-method elmo-folder-unmark-important ((folder elmo-pipe-folder)
 296                                                   numbers
 297                                                   &optional ignore-flag)
 298   (elmo-folder-unmark-important (elmo-pipe-folder-dst-internal folder)
 299                                 numbers ignore-flag))
 300
 301 (luna-define-method elmo-folder-mark-as-important ((folder elmo-pipe-folder)
 302                                                    numbers
 303                                                    &optional ignore-flag)
 304   (elmo-folder-mark-as-important (elmo-pipe-folder-dst-internal folder)
 305                                  numbers ignore-flag))
 306
 307 (luna-define-method elmo-folder-pack-numbers ((folder elmo-pipe-folder))
 308   (elmo-folder-pack-numbers (elmo-pipe-folder-dst-internal folder)))
 309
 310 (luna-define-method elmo-folder-rename ((folder elmo-pipe-folder) new-name)
 311   (let* ((new-folder (elmo-make-folder new-name)))
 312     (unless (string= (elmo-folder-name-internal
 313                       (elmo-pipe-folder-src-internal folder))
 314                      (elmo-folder-name-internal
 315                       (elmo-pipe-folder-src-internal new-folder)))
 316       (error "Source folder differ"))
 317     (unless (eq (elmo-folder-type-internal
 318                  (elmo-pipe-folder-dst-internal folder))
 319                 (elmo-folder-type-internal
 320                  (elmo-pipe-folder-dst-internal new-folder)))
 321       (error "Not same folder type"))
 322     (if (or (file-exists-p (elmo-folder-msgdb-path
 323                             (elmo-pipe-folder-dst-internal new-folder)))
 324             (elmo-folder-exists-p
 325              (elmo-pipe-folder-dst-internal new-folder)))
 326         (error "Already exists folder: %s" new-name))
 327     (elmo-folder-send (elmo-pipe-folder-dst-internal folder)
 328                       'elmo-folder-rename-internal
 329                       (elmo-pipe-folder-dst-internal new-folder))
 330     (elmo-msgdb-rename-path folder new-folder)))
 331
 332 (require 'product)
 333 (product-provide (provide 'elmo-pipe) (require 'elmo-version))
 334
 335 ;;; elmo-pipe.el ends here