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