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