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