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= ":" (elmo-match-string 2 name))))
  54   folder)
  55
  56 (luna-define-method elmo-folder-get-primitive-list ((folder elmo-pipe-folder))
  57   (elmo-flatten
  58    (mapcar
  59     'elmo-folder-get-primitive-list
  60     (list (elmo-pipe-folder-src-internal folder)
  61           (elmo-pipe-folder-dst-internal folder)))))
  62
  63 (luna-define-method elmo-folder-contains-type ((folder elmo-pipe-folder)
  64                                                type)
  65   (or (elmo-folder-contains-type (elmo-pipe-folder-src-internal folder) type)
  66       (elmo-folder-contains-type (elmo-pipe-folder-dst-internal folder) type)))
  67
  68 (luna-define-method elmo-folder-msgdb-create ((folder elmo-pipe-folder)
  69                                               numlist seen-list)
  70   (elmo-folder-msgdb-create (elmo-pipe-folder-dst-internal folder)
  71                             numlist seen-list))
  72
  73 (luna-define-method elmo-folder-append-messages ((folder elmo-pipe-folder)
  74                                                  src-folder numbers
  75                                                  &optional same-number)
  76   (elmo-folder-append-messages (elmo-pipe-folder-dst-internal folder)
  77                                src-folder numbers
  78                                same-number))
  79
  80 (luna-define-method elmo-folder-append-buffer ((folder elmo-pipe-folder)
  81                                                unread &optional number)
  82   (elmo-folder-append-buffer (elmo-pipe-folder-dst-internal folder)
  83                              unread number))
  84
  85 (luna-define-method elmo-message-fetch ((folder elmo-pipe-folder)
  86                                         number strategy
  87                                         &optional section outbuf unseen)
  88   (elmo-message-fetch (elmo-pipe-folder-dst-internal folder)
  89                       number strategy section outbuf unseen))
  90
  91 (luna-define-method elmo-folder-delete-messages ((folder elmo-pipe-folder)
  92                                                  numbers)
  93   (elmo-folder-delete-messages (elmo-pipe-folder-dst-internal folder)
  94                                numbers))
  95
  96 (defvar elmo-pipe-drained-hook nil "A hook called when the pipe is flushed.")
  97
  98 (defsubst elmo-pipe-folder-list-target-messages (src &optional ignore-list)
  99   (unwind-protect
 100       (progn
 101         (elmo-folder-set-killed-list-internal src ignore-list)
 102         (elmo-folder-list-messages src))
 103     (elmo-folder-set-killed-list-internal src nil)))
 104
 105 (defun elmo-pipe-drain (src dst &optional copy ignore-list)
 106   "Move or copy all messages of SRC to DST."
 107   (let ((elmo-inhibit-number-mapping (not copy)) ; No need to use UIDL
 108         msgs len)
 109     (message "Checking %s..." (elmo-folder-name-internal src))
 110     ;; Warnnig: some function requires msgdb
 111     ;;  but elmo-folder-open-internal do not load msgdb.
 112     (elmo-folder-open-internal src)
 113     (setq msgs (elmo-pipe-folder-list-target-messages src ignore-list)
 114           len (length msgs))
 115     (when (> len elmo-display-progress-threshold)
 116       (elmo-progress-set 'elmo-folder-move-messages
 117                          len
 118                          (if copy
 119                              "Copying messages..."
 120                            "Moving messages...")))
 121     (unwind-protect
 122         (elmo-folder-move-messages src msgs dst
 123                                    nil nil copy)
 124       (elmo-progress-clear 'elmo-folder-move-messages))
 125     (when (and copy msgs)
 126       (setq ignore-list (elmo-number-set-append-list ignore-list
 127                                                      msgs)))
 128     ;; Don't save msgdb here.
 129     ;; Because summary view of original folder is not updated yet.
 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-open-internal ((folder elmo-pipe-folder))
 153   (elmo-folder-open-internal (elmo-pipe-folder-dst-internal folder))
 154   (let ((src-folder (elmo-pipe-folder-src-internal folder))
 155         (dst-folder (elmo-pipe-folder-dst-internal folder)))
 156     (when (and (elmo-folder-plugged-p src-folder)
 157                (elmo-folder-plugged-p dst-folder))
 158       (if (elmo-pipe-folder-copy-internal folder)
 159           (elmo-pipe-folder-copied-list-save
 160            folder
 161            (elmo-pipe-drain src-folder
 162                             dst-folder
 163                             'copy
 164                             (elmo-pipe-folder-copied-list-load folder)))
 165         (elmo-pipe-drain src-folder dst-folder)))))
 166
 167 (luna-define-method elmo-folder-close-internal ((folder elmo-pipe-folder))
 168   (elmo-folder-close-internal(elmo-pipe-folder-dst-internal folder)))
 169
 170 (luna-define-method elmo-folder-list-messages-internal
 171   ((folder elmo-pipe-folder) &optional nohide)
 172   (elmo-folder-list-messages-internal (elmo-pipe-folder-dst-internal
 173                                        folder) nohide))
 174
 175 (luna-define-method elmo-folder-list-unreads ((folder elmo-pipe-folder))
 176   (elmo-folder-list-unreads (elmo-pipe-folder-dst-internal folder)))
 177
 178 (luna-define-method elmo-folder-list-importants ((folder elmo-pipe-folder))
 179   (elmo-folder-list-importants (elmo-pipe-folder-dst-internal folder)))
 180
 181 (luna-define-method elmo-folder-list-answereds ((folder elmo-pipe-folder))
 182   (elmo-folder-list-answereds (elmo-pipe-folder-dst-internal folder)))
 183
 184 (luna-define-method elmo-folder-status ((folder elmo-pipe-folder))
 185   (elmo-folder-open-internal (elmo-pipe-folder-src-internal folder))
 186   (elmo-folder-open-internal (elmo-pipe-folder-dst-internal folder))
 187   (let* ((elmo-inhibit-number-mapping
 188           (not (elmo-pipe-folder-copy-internal folder)))
 189          (src-length (length (elmo-pipe-folder-list-target-messages
 190                               (elmo-pipe-folder-src-internal folder)
 191                               (elmo-pipe-folder-copied-list-load folder))))
 192          (dst-list (elmo-folder-list-messages
 193                     (elmo-pipe-folder-dst-internal folder))))
 194     (prog1 (cons (+ src-length (elmo-max-of-list dst-list))
 195                  (+ src-length (length dst-list)))
 196       ;; No save.
 197       (elmo-folder-close-internal (elmo-pipe-folder-src-internal folder))
 198       (elmo-folder-close-internal (elmo-pipe-folder-dst-internal folder)))))
 199
 200 (luna-define-method elmo-folder-exists-p ((folder elmo-pipe-folder))
 201   (and (elmo-folder-exists-p (elmo-pipe-folder-src-internal folder))
 202        (elmo-folder-exists-p (elmo-pipe-folder-dst-internal folder))))
 203
 204 (luna-define-method elmo-folder-expand-msgdb-path ((folder
 205                                                     elmo-pipe-folder))
 206   ;; Share with destination...OK?
 207   (elmo-folder-expand-msgdb-path (elmo-pipe-folder-dst-internal folder)))
 208
 209 (luna-define-method elmo-folder-newsgroups ((folder elmo-pipe-folder))
 210   (elmo-folder-newsgroups (elmo-pipe-folder-src-internal folder)))
 211
 212 (luna-define-method elmo-folder-creatable-p ((folder elmo-pipe-folder))
 213   (and (or
 214         (elmo-folder-exists-p (elmo-pipe-folder-src-internal folder))
 215         (elmo-folder-creatable-p (elmo-pipe-folder-src-internal folder)))
 216        (or
 217         (elmo-folder-exists-p (elmo-pipe-folder-dst-internal folder))
 218         (elmo-folder-creatable-p (elmo-pipe-folder-dst-internal folder)))))
 219
 220 (luna-define-method elmo-folder-writable-p ((folder elmo-pipe-folder))
 221   (elmo-folder-writable-p (elmo-pipe-folder-dst-internal folder)))
 222
 223 (luna-define-method elmo-folder-create ((folder elmo-pipe-folder))
 224   (if (and (not (elmo-folder-exists-p (elmo-pipe-folder-src-internal folder)))
 225            (elmo-folder-creatable-p (elmo-pipe-folder-src-internal folder)))
 226       (elmo-folder-create (elmo-pipe-folder-src-internal folder)))
 227   (if (and (not (elmo-folder-exists-p (elmo-pipe-folder-dst-internal folder)))
 228            (elmo-folder-creatable-p (elmo-pipe-folder-dst-internal folder)))
 229       (elmo-folder-create (elmo-pipe-folder-dst-internal folder))))
 230
 231 (luna-define-method elmo-folder-search ((folder elmo-pipe-folder)
 232                                         condition &optional numlist)
 233   (elmo-folder-search (elmo-pipe-folder-dst-internal folder)
 234                       condition numlist))
 235
 236 (luna-define-method elmo-message-use-cache-p ((folder elmo-pipe-folder) number)
 237   (elmo-message-use-cache-p (elmo-pipe-folder-dst-internal folder) number))
 238
 239 (luna-define-method elmo-folder-check ((folder elmo-pipe-folder))
 240   (elmo-folder-close-internal folder)
 241   (elmo-folder-open-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-mark-as-read ((folder elmo-pipe-folder)
 279                                               numbers)
 280   (elmo-folder-mark-as-read (elmo-pipe-folder-dst-internal folder)
 281                             numbers))
 282
 283 (luna-define-method elmo-folder-unmark-read ((folder elmo-pipe-folder)
 284                                               numbers)
 285   (elmo-folder-unmark-read (elmo-pipe-folder-dst-internal folder)
 286                            numbers))
 287
 288 (luna-define-method elmo-folder-unmark-important ((folder elmo-pipe-folder)
 289                                                   numbers)
 290   (elmo-folder-unmark-important (elmo-pipe-folder-dst-internal folder)
 291                                 numbers))
 292
 293 (luna-define-method elmo-folder-mark-as-important ((folder elmo-pipe-folder)
 294                                                    numbers)
 295   (elmo-folder-mark-as-important (elmo-pipe-folder-dst-internal folder)
 296                                  numbers))
 297
 298 (luna-define-method elmo-folder-pack-numbers ((folder elmo-pipe-folder))
 299   (elmo-folder-pack-numbers (elmo-pipe-folder-dst-internal folder)))
 300
 301 (require 'product)
 302 (product-provide (provide 'elmo-pipe) (require 'elmo-version))
 303
 304 ;;; elmo-pipe.el ends here