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-append-messages ((folder elmo-pipe-folder)
  70                                                  src-folder numbers
  71                                                  &optional same-number)
  72   (elmo-folder-append-messages (elmo-pipe-folder-dst-internal folder)
  73                                src-folder numbers
  74                                same-number))
  75
  76 (luna-define-method elmo-folder-append-buffer ((folder elmo-pipe-folder)
  77                                                &optional flag number)
  78   (elmo-folder-append-buffer (elmo-pipe-folder-dst-internal folder)
  79                              flag number))
  80
  81 (luna-define-method elmo-message-fetch ((folder elmo-pipe-folder)
  82                                         number strategy
  83                                         &optional section outbuf unseen)
  84   (elmo-message-fetch (elmo-pipe-folder-dst-internal folder)
  85                       number strategy section outbuf unseen))
  86
  87 (luna-define-method elmo-folder-clear :after ((folder elmo-pipe-folder)
  88                                               &optional keep-killed)
  89   (unless keep-killed
  90     (elmo-pipe-folder-copied-list-save folder nil)))
  91
  92 (luna-define-method elmo-folder-delete-messages ((folder elmo-pipe-folder)
  93                                                  numbers)
  94   (elmo-folder-delete-messages (elmo-pipe-folder-dst-internal folder)
  95                                numbers))
  96
  97 (defvar elmo-pipe-drained-hook nil "A hook called when the pipe is flushed.")
  98
  99 (defsubst elmo-pipe-folder-list-target-messages (src &optional ignore-list)
 100   (unwind-protect
 101       (progn
 102         (elmo-folder-set-killed-list-internal src ignore-list)
 103         (elmo-folder-list-messages src))
 104     (elmo-folder-set-killed-list-internal src nil)))
 105
 106 (defun elmo-pipe-drain (src dst &optional copy ignore-list)
 107   "Move or copy all messages of SRC to DST."
 108   (let ((elmo-inhibit-number-mapping (and (eq (elmo-folder-type-internal
 109                                                src) 'pop3)
 110                                           (not copy))) ; No need to use UIDL
 111         msgs len)
 112     (message "Checking %s..." (elmo-folder-name-internal src))
 113     ;; Warnnig: some function requires msgdb
 114     ;; but elmo-folder-open-internal do not load msgdb.
 115     (elmo-folder-open-internal src)
 116     (setq msgs (elmo-pipe-folder-list-target-messages src ignore-list)
 117           len (length msgs))
 118     (when (> len elmo-display-progress-threshold)
 119       (elmo-progress-set 'elmo-folder-move-messages
 120                          len
 121                          (if copy
 122                              "Copying messages..."
 123                            "Moving messages...")))
 124     (unwind-protect
 125         (elmo-folder-move-messages src msgs dst
 126                                    nil nil copy)
 127       (elmo-progress-clear 'elmo-folder-move-messages))
 128     (when (and copy msgs)
 129       (setq ignore-list (elmo-number-set-append-list ignore-list
 130                                                      msgs)))
 131     (elmo-folder-close-internal src)
 132     (run-hooks 'elmo-pipe-drained-hook)
 133     ignore-list))
 134
 135 (defun elmo-pipe-folder-copied-list-load (folder)
 136   (elmo-object-load
 137    (expand-file-name elmo-pipe-folder-copied-filename
 138                      (expand-file-name
 139                       (elmo-replace-string-as-filename
 140                        (elmo-folder-name-internal folder))
 141                       (expand-file-name "pipe" elmo-msgdb-directory)))
 142    nil t))
 143
 144 (defun elmo-pipe-folder-copied-list-save (folder copied-list)
 145   (elmo-object-save
 146    (expand-file-name elmo-pipe-folder-copied-filename
 147                      (expand-file-name
 148                       (elmo-replace-string-as-filename
 149                        (elmo-folder-name-internal folder))
 150                       (expand-file-name "pipe" elmo-msgdb-directory)))
 151    copied-list))
 152
 153 (luna-define-method elmo-folder-msgdb ((folder elmo-pipe-folder))
 154   (elmo-folder-msgdb (elmo-pipe-folder-dst-internal folder)))
 155
 156 (luna-define-method elmo-folder-open-internal ((folder elmo-pipe-folder))
 157   (elmo-folder-open-internal (elmo-pipe-folder-dst-internal folder)))
 158
 159 (luna-define-method elmo-folder-close-internal ((folder elmo-pipe-folder))
 160   (elmo-folder-close-internal(elmo-pipe-folder-dst-internal folder)))
 161
 162 (luna-define-method elmo-folder-set-message-modified
 163   ((folder elmo-pipe-folder) modified)
 164   (elmo-folder-set-message-modified-internal
 165    (elmo-pipe-folder-dst-internal folder) modified))
 166
 167 (luna-define-method elmo-folder-list-messages ((folder elmo-pipe-folder)
 168                                                &optional visible-only in-msgdb)
 169   ;; Use target folder's killed-list in the pipe folder.
 170   (elmo-folder-list-messages (elmo-pipe-folder-dst-internal
 171                               folder) visible-only in-msgdb))
 172
 173 (luna-define-method elmo-folder-list-unreads ((folder elmo-pipe-folder))
 174   (elmo-folder-list-unreads (elmo-pipe-folder-dst-internal folder)))
 175
 176 (luna-define-method elmo-folder-list-importants ((folder elmo-pipe-folder))
 177   (elmo-folder-list-importants (elmo-pipe-folder-dst-internal folder)))
 178
 179 (luna-define-method elmo-folder-list-answereds ((folder elmo-pipe-folder))
 180   (elmo-folder-list-answereds (elmo-pipe-folder-dst-internal folder)))
 181
 182 (luna-define-method elmo-folder-diff ((folder elmo-pipe-folder))
 183   (elmo-folder-open-internal (elmo-pipe-folder-src-internal folder))
 184   (elmo-folder-open-internal (elmo-pipe-folder-dst-internal folder))
 185   (let* ((elmo-inhibit-number-mapping
 186           (not (elmo-pipe-folder-copy-internal folder)))
 187          (src-length (length (elmo-pipe-folder-list-target-messages
 188                               (elmo-pipe-folder-src-internal folder)
 189                               (elmo-pipe-folder-copied-list-load folder))))
 190          (dst-diff (elmo-folder-diff (elmo-pipe-folder-dst-internal folder))))
 191     (prog1
 192         (cond
 193          ((consp (cdr dst-diff)) ; new unread all
 194           (mapcar (lambda (number) (+ number src-length)) dst-diff))
 195          (t
 196           (cons (+ (car dst-diff) src-length)
 197                 (+ (cdr dst-diff) src-length))))
 198       ;; No save.
 199       (elmo-folder-close-internal (elmo-pipe-folder-src-internal folder))
 200       (elmo-folder-close-internal (elmo-pipe-folder-dst-internal folder)))))
 201
 202 (luna-define-method elmo-folder-exists-p ((folder elmo-pipe-folder))
 203   (and (elmo-folder-exists-p (elmo-pipe-folder-src-internal folder))
 204        (elmo-folder-exists-p (elmo-pipe-folder-dst-internal folder))))
 205
 206 (luna-define-method elmo-folder-expand-msgdb-path ((folder
 207                                                     elmo-pipe-folder))
 208   ;; Share with destination...OK?
 209   (elmo-folder-expand-msgdb-path (elmo-pipe-folder-dst-internal folder)))
 210
 211 (luna-define-method elmo-folder-newsgroups ((folder elmo-pipe-folder))
 212   (elmo-folder-newsgroups (elmo-pipe-folder-src-internal folder)))
 213
 214 (luna-define-method elmo-folder-creatable-p ((folder elmo-pipe-folder))
 215   (and (or
 216         (elmo-folder-exists-p (elmo-pipe-folder-src-internal folder))
 217         (elmo-folder-creatable-p (elmo-pipe-folder-src-internal folder)))
 218        (or
 219         (elmo-folder-exists-p (elmo-pipe-folder-dst-internal folder))
 220         (elmo-folder-creatable-p (elmo-pipe-folder-dst-internal folder)))))
 221
 222 (luna-define-method elmo-folder-writable-p ((folder elmo-pipe-folder))
 223   (elmo-folder-writable-p (elmo-pipe-folder-dst-internal folder)))
 224
 225 (luna-define-method elmo-folder-create ((folder elmo-pipe-folder))
 226   (if (and (not (elmo-folder-exists-p (elmo-pipe-folder-src-internal folder)))
 227            (elmo-folder-creatable-p (elmo-pipe-folder-src-internal folder)))
 228       (elmo-folder-create (elmo-pipe-folder-src-internal folder)))
 229   (if (and (not (elmo-folder-exists-p (elmo-pipe-folder-dst-internal folder)))
 230            (elmo-folder-creatable-p (elmo-pipe-folder-dst-internal folder)))
 231       (elmo-folder-create (elmo-pipe-folder-dst-internal folder))))
 232
 233 (luna-define-method elmo-folder-search ((folder elmo-pipe-folder)
 234                                         condition &optional numlist)
 235   (elmo-folder-search (elmo-pipe-folder-dst-internal folder)
 236                       condition numlist))
 237
 238 (luna-define-method elmo-message-use-cache-p ((folder elmo-pipe-folder) number)
 239   (elmo-message-use-cache-p (elmo-pipe-folder-dst-internal folder) number))
 240
 241 (luna-define-method elmo-folder-check ((folder elmo-pipe-folder))
 242   (elmo-folder-check (elmo-pipe-folder-dst-internal folder)))
 243
 244 (luna-define-method elmo-folder-plugged-p ((folder elmo-pipe-folder))
 245   (and (elmo-folder-plugged-p (elmo-pipe-folder-src-internal folder))
 246        (elmo-folder-plugged-p (elmo-pipe-folder-dst-internal folder))))
 247
 248 (luna-define-method elmo-folder-message-file-p ((folder elmo-pipe-folder))
 249   (elmo-folder-message-file-p (elmo-pipe-folder-dst-internal folder)))
 250
 251 (luna-define-method elmo-message-file-p ((folder elmo-pipe-folder) number)
 252   (elmo-message-file-p (elmo-pipe-folder-dst-internal folder) number))
 253
 254 (luna-define-method elmo-message-file-name ((folder elmo-pipe-folder) number)
 255   (elmo-message-file-name (elmo-pipe-folder-dst-internal folder) number))
 256
 257 (luna-define-method elmo-folder-message-file-number-p ((folder
 258                                                         elmo-pipe-folder))
 259   (elmo-folder-message-file-number-p (elmo-pipe-folder-dst-internal folder)))
 260
 261 (luna-define-method elmo-folder-message-file-directory ((folder
 262                                                          elmo-pipe-folder))
 263   (elmo-folder-message-file-directory
 264    (elmo-pipe-folder-dst-internal folder)))
 265
 266 (luna-define-method elmo-folder-message-make-temp-file-p
 267   ((folder elmo-pipe-folder))
 268   (elmo-folder-message-make-temp-file-p
 269    (elmo-pipe-folder-dst-internal folder)))
 270
 271 (luna-define-method elmo-folder-message-make-temp-files ((folder
 272                                                           elmo-pipe-folder)
 273                                                          numbers
 274                                                          &optional
 275                                                          start-number)
 276   (elmo-folder-message-make-temp-files
 277    (elmo-pipe-folder-dst-internal folder) numbers start-number))
 278
 279 (luna-define-method elmo-folder-mark-as-read ((folder elmo-pipe-folder)
 280                                               numbers &optional ignore-flag)
 281   (elmo-folder-mark-as-read (elmo-pipe-folder-dst-internal folder)
 282                             numbers ignore-flag))
 283
 284 (luna-define-method elmo-folder-unmark-read ((folder elmo-pipe-folder)
 285                                              numbers
 286                                              &optional ignore-flag)
 287   (elmo-folder-unmark-read (elmo-pipe-folder-dst-internal folder)
 288                            numbers ignore-flag))
 289
 290 (luna-define-method elmo-folder-unmark-important ((folder elmo-pipe-folder)
 291                                                   numbers
 292                                                   &optional ignore-flag)
 293   (elmo-folder-unmark-important (elmo-pipe-folder-dst-internal folder)
 294                                 numbers ignore-flag))
 295
 296 (luna-define-method elmo-folder-mark-as-important ((folder elmo-pipe-folder)
 297                                                    numbers
 298                                                    &optional ignore-flag)
 299   (elmo-folder-mark-as-important (elmo-pipe-folder-dst-internal folder)
 300                                  numbers ignore-flag))
 301
 302 (luna-define-method elmo-folder-unmark-answered ((folder elmo-pipe-folder)
 303                                                  numbers)
 304   (elmo-folder-unmark-answered (elmo-pipe-folder-dst-internal folder)
 305                                numbers))
 306
 307 (luna-define-method elmo-folder-mark-as-answered ((folder elmo-pipe-folder)
 308                                                   numbers)
 309   (elmo-folder-mark-as-answered (elmo-pipe-folder-dst-internal folder)
 310                                 numbers))
 311
 312 (luna-define-method elmo-folder-pack-numbers ((folder elmo-pipe-folder))
 313   (elmo-folder-pack-numbers (elmo-pipe-folder-dst-internal folder)))
 314
 315 (luna-define-method elmo-folder-rename ((folder elmo-pipe-folder) new-name)
 316   (let* ((new-folder (elmo-make-folder new-name)))
 317     (unless (string= (elmo-folder-name-internal
 318                       (elmo-pipe-folder-src-internal folder))
 319                      (elmo-folder-name-internal
 320                       (elmo-pipe-folder-src-internal new-folder)))
 321       (error "Source folder differ"))
 322     (unless (eq (elmo-folder-type-internal
 323                  (elmo-pipe-folder-dst-internal folder))
 324                 (elmo-folder-type-internal
 325                  (elmo-pipe-folder-dst-internal new-folder)))
 326       (error "Not same folder type"))
 327     (if (or (file-exists-p (elmo-folder-msgdb-path
 328                             (elmo-pipe-folder-dst-internal new-folder)))
 329             (elmo-folder-exists-p
 330              (elmo-pipe-folder-dst-internal new-folder)))
 331         (error "Already exists folder: %s" new-name))
 332     (elmo-folder-send (elmo-pipe-folder-dst-internal folder)
 333                       'elmo-folder-rename-internal
 334                       (elmo-pipe-folder-dst-internal new-folder))
 335     (elmo-msgdb-rename-path folder new-folder)))
 336
 337 (luna-define-method elmo-folder-synchronize ((folder elmo-pipe-folder)
 338                                              &optional
 339                                              disable-killed
 340                                              ignore-msgdb
 341                                              no-check)
 342   (let ((src-folder (elmo-pipe-folder-src-internal folder))
 343         (dst-folder (elmo-pipe-folder-dst-internal folder)))
 344     (when (and (elmo-folder-plugged-p src-folder)
 345                (elmo-folder-plugged-p dst-folder))
 346       (if (elmo-pipe-folder-copy-internal folder)
 347           (elmo-pipe-folder-copied-list-save
 348            folder
 349            (elmo-pipe-drain src-folder
 350                             dst-folder
 351                             'copy
 352                             (elmo-pipe-folder-copied-list-load folder)))
 353         (elmo-pipe-drain src-folder dst-folder))))
 354   (elmo-folder-synchronize
 355    (elmo-pipe-folder-dst-internal folder)
 356    disable-killed ignore-msgdb no-check))
 357
 358 (luna-define-method elmo-folder-list-flagged ((folder elmo-pipe-folder)
 359                                               flag
 360                                               &optional in-msgdb)
 361   (elmo-folder-list-flagged
 362    (elmo-pipe-folder-dst-internal folder) flag in-msgdb))
 363
 364 (luna-define-method elmo-folder-commit ((folder elmo-pipe-folder))
 365   (elmo-folder-commit (elmo-pipe-folder-dst-internal folder)))
 366
 367 (luna-define-method elmo-folder-length ((folder elmo-pipe-folder))
 368   (elmo-folder-length (elmo-pipe-folder-dst-internal folder)))
 369
 370 (luna-define-method elmo-folder-count-flags ((folder elmo-pipe-folder))
 371   (elmo-folder-count-flags (elmo-pipe-folder-dst-internal folder)))
 372
 373 (luna-define-method elmo-message-mark ((folder elmo-pipe-folder) number)
 374   (elmo-message-mark (elmo-pipe-folder-dst-internal folder) number))
 375
 376 (luna-define-method elmo-message-field ((folder elmo-pipe-folder)
 377                                         number field)
 378   (elmo-message-field (elmo-pipe-folder-dst-internal folder)
 379                       number
 380                       field))
 381
 382 (luna-define-method elmo-message-set-cached ((folder elmo-pipe-folder)
 383                                              number cached)
 384   (elmo-message-set-cached (elmo-pipe-folder-dst-internal folder)
 385                            number cached))
 386
 387 (luna-define-method elmo-find-fetch-strategy
 388   ((folder elmo-pipe-folder) entity &optional ignore-cache)
 389   (elmo-find-fetch-strategy (elmo-pipe-folder-dst-internal folder)
 390                             (elmo-message-entity
 391                              (elmo-pipe-folder-dst-internal folder)
 392                              (elmo-message-entity-number entity))
 393                             ignore-cache))
 394
 395 (luna-define-method elmo-message-entity ((folder elmo-pipe-folder) key)
 396   (elmo-message-entity (elmo-pipe-folder-dst-internal folder) key))
 397
 398 (luna-define-method elmo-message-folder ((folder elmo-pipe-folder)
 399                                          number)
 400   (elmo-pipe-folder-dst-internal folder))
 401
 402 (require 'product)
 403 (product-provide (provide 'elmo-pipe) (require 'elmo-version))
 404
 405 ;;; elmo-pipe.el ends here