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