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