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