elmo/elmo-localdir.el

   1 ;;; elmo-localdir.el --- Localdir Interface for ELMO.
   2
   3 ;; Copyright (C) 1998,1999,2000 Yuuichi Teranishi <teranisi@gohome.org>
   4 ;; Copyright (C) 1998,1999,2000 Masahiro MURATA <muse@ba2.so-net.ne.jp>
   5 ;; Copyright (C) 1999,2000      Kenichi OKADA  <okada@opaopa.org>
   6
   7 ;; Author: Yuuichi Teranishi <teranisi@gohome.org>
   8 ;;      Masahiro MURATA <muse@ba2.so-net.ne.jp>
   9 ;;      Kenichi OKADA <okada@opaopa.org>
  10 ;; Keywords: mail, net news
  11
  12 ;; This file is part of ELMO (Elisp Library for Message Orchestration).
  13
  14 ;; This program is free software; you can redistribute it and/or modify
  15 ;; it under the terms of the GNU General Public License as published by
  16 ;; the Free Software Foundation; either version 2, or (at your option)
  17 ;; any later version.
  18 ;;
  19 ;; This program is distributed in the hope that it will be useful,
  20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22 ;; GNU General Public License for more details.
  23 ;;
  24 ;; You should have received a copy of the GNU General Public License
  25 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  26 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  27 ;; Boston, MA 02111-1307, USA.
  28 ;;
  29
  30 ;;; Commentary:
  31 ;;
  32
  33 ;;; Code:
  34 ;;
  35 (eval-when-compile (require 'cl))
  36
  37 (require 'elmo-msgdb)
  38 (require 'elmo)
  39
  40 (defcustom elmo-localdir-folder-path "~/Mail"
  41   "*Local mail directory (MH format) path."
  42   :type 'directory
  43   :group 'elmo)
  44
  45 (defvar elmo-localdir-lockfile-list nil)
  46
  47 ;;; ELMO Local directory folder
  48 (eval-and-compile
  49   (luna-define-class elmo-localdir-folder (elmo-folder)
  50                      (dir-name directory))
  51   (luna-define-internal-accessors 'elmo-localdir-folder))
  52
  53 ;;; elmo-localdir specific methods.
  54 (luna-define-generic elmo-localdir-folder-path (folder)
  55   "Return local directory path of the FOLDER.")
  56
  57 (luna-define-generic elmo-localdir-folder-name (folder name)
  58   "Return directory NAME for FOLDER.")
  59
  60 (luna-define-method elmo-localdir-folder-path ((folder elmo-localdir-folder))
  61   elmo-localdir-folder-path)
  62
  63 (luna-define-method elmo-localdir-folder-name ((folder elmo-localdir-folder)
  64                                                name)
  65   name)
  66
  67 (luna-define-method elmo-folder-initialize ((folder
  68                                              elmo-localdir-folder)
  69                                             name)
  70   (elmo-localdir-folder-set-dir-name-internal folder name)
  71   (if (file-name-absolute-p name)
  72       (elmo-localdir-folder-set-directory-internal
  73        folder
  74        (expand-file-name name))
  75     (elmo-localdir-folder-set-directory-internal
  76      folder
  77      (expand-file-name
  78       (elmo-localdir-folder-name folder name)
  79       (elmo-localdir-folder-path folder))))
  80   folder)
  81
  82 ;; open, check, commit, and close are generic.
  83
  84 (luna-define-method elmo-folder-exists-p ((folder elmo-localdir-folder))
  85   (file-directory-p (elmo-localdir-folder-directory-internal folder)))
  86
  87 (luna-define-method elmo-folder-expand-msgdb-path ((folder
  88                                                     elmo-localdir-folder))
  89   (expand-file-name
  90    (mapconcat
  91     'identity
  92     (mapcar
  93      'elmo-replace-string-as-filename
  94      (split-string
  95       (let ((dir-name (elmo-localdir-folder-dir-name-internal folder)))
  96         (if (file-name-absolute-p dir-name)
  97             (expand-file-name dir-name)
  98           dir-name))
  99       "/"))
 100     "/")
 101    (expand-file-name ;;"localdir"
 102     (symbol-name (elmo-folder-type-internal folder))
 103     elmo-msgdb-directory)))
 104
 105 (luna-define-method elmo-message-file-name ((folder
 106                                              elmo-localdir-folder)
 107                                             number)
 108   (expand-file-name (int-to-string number)
 109                     (elmo-localdir-folder-directory-internal folder)))
 110
 111 (luna-define-method elmo-folder-message-file-number-p ((folder
 112                                                         elmo-localdir-folder))
 113   t)
 114
 115 (luna-define-method elmo-folder-message-file-directory ((folder
 116                                                          elmo-localdir-folder))
 117   (elmo-localdir-folder-directory-internal folder))
 118
 119 (luna-define-method elmo-folder-message-make-temp-file-p
 120   ((folder elmo-localdir-folder))
 121   t)
 122
 123 (luna-define-method elmo-folder-message-make-temp-files ((folder
 124                                                           elmo-localdir-folder)
 125                                                          numbers
 126                                                          &optional
 127                                                          start-number)
 128   (let ((temp-dir (elmo-folder-make-temporary-directory folder))
 129         (cur-number (or start-number 0)))
 130     (dolist (number numbers)
 131       (elmo-copy-file
 132        (expand-file-name
 133         (int-to-string number)
 134         (elmo-localdir-folder-directory-internal folder))
 135        (expand-file-name
 136         (int-to-string (if start-number cur-number number))
 137         temp-dir))
 138       (incf cur-number))
 139     temp-dir))
 140
 141 (defun elmo-localdir-msgdb-create-entity (dir number)
 142   (elmo-msgdb-create-overview-entity-from-file
 143    number (expand-file-name (int-to-string number) dir)))
 144
 145 (luna-define-method elmo-folder-msgdb-create ((folder elmo-localdir-folder)
 146                                               numbers
 147                                               new-mark
 148                                               already-mark
 149                                               seen-mark
 150                                               important-mark
 151                                               seen-list)
 152   (when numbers
 153     (let ((dir (elmo-localdir-folder-directory-internal folder))
 154           overview number-alist mark-alist entity message-id
 155           num seen gmark
 156           (i 0)
 157           (len (length numbers)))
 158       (message "Creating msgdb...")
 159       (while numbers
 160         (setq entity
 161               (elmo-localdir-msgdb-create-entity
 162                dir (car numbers)))
 163         (if (null entity)
 164             ()
 165           (setq num (elmo-msgdb-overview-entity-get-number entity))
 166           (setq overview
 167                 (elmo-msgdb-append-element
 168                  overview entity))
 169           (setq message-id (elmo-msgdb-overview-entity-get-id entity))
 170           (setq number-alist
 171                 (elmo-msgdb-number-add number-alist
 172                                        num
 173                                        message-id))
 174           (setq seen (member message-id seen-list))
 175           (if (setq gmark (or (elmo-msgdb-global-mark-get message-id)
 176                               (if (elmo-file-cache-exists-p message-id) ; XXX
 177                                   (if seen
 178                                       nil
 179                                     already-mark)
 180                                 (if seen
 181                                     nil ;;seen-mark
 182                                   new-mark))))
 183               (setq mark-alist
 184                     (elmo-msgdb-mark-append
 185                      mark-alist
 186                      num
 187                      gmark))))
 188         (when (> len elmo-display-progress-threshold)
 189           (setq i (1+ i))
 190           (elmo-display-progress
 191            'elmo-localdir-msgdb-create-as-numbers "Creating msgdb..."
 192            (/ (* i 100) len)))
 193         (setq numbers (cdr numbers)))
 194       (message "Creating msgdb...done")
 195       (list overview number-alist mark-alist))))
 196
 197 (luna-define-method elmo-folder-list-subfolders ((folder elmo-localdir-folder)
 198                                                  &optional one-level)
 199   (elmo-mapcar-list-of-list
 200    (lambda (x) (concat (elmo-folder-prefix-internal folder) x))
 201    (elmo-list-subdirectories
 202     (elmo-localdir-folder-path folder)
 203     (or (elmo-localdir-folder-dir-name-internal folder) "")
 204     one-level)))
 205
 206 (defsubst elmo-localdir-list-subr (folder &optional nonsort)
 207   (let ((flist (mapcar 'string-to-int
 208                        (directory-files
 209                         (elmo-localdir-folder-directory-internal folder)
 210                         nil "^[0-9]+$" t)))
 211         (killed (elmo-msgdb-killed-list-load (elmo-folder-msgdb-path folder))))
 212     (if nonsort
 213         (cons (or (elmo-max-of-list flist) 0)
 214               (if killed
 215                   (- (length flist)
 216                      (elmo-msgdb-killed-list-length killed))
 217                 (length flist)))
 218       (sort flist '<))))
 219
 220 (luna-define-method elmo-folder-append-buffer ((folder elmo-localdir-folder)
 221                                                unread
 222                                                &optional number)
 223   (let ((filename (elmo-message-file-name
 224                    folder
 225                    (or number
 226                        (1+ (car (elmo-folder-status folder)))))))
 227     (when (file-writable-p filename)
 228       (write-region-as-binary
 229        (point-min) (point-max) filename nil 'no-msg)
 230       t)))
 231
 232 (luna-define-method elmo-folder-append-messages :around
 233   ((folder elmo-localdir-folder)
 234    src-folder numbers unread-marks &optional same-number)
 235   (if (elmo-folder-message-file-p src-folder)
 236       (let ((dir (elmo-localdir-folder-directory-internal folder))
 237             (succeeds numbers)
 238             (next-num (1+ (car (elmo-folder-status folder)))))
 239         (while numbers
 240           (elmo-copy-file
 241            (elmo-message-file-name src-folder (car numbers))
 242            (expand-file-name
 243             (int-to-string
 244              (if same-number (car numbers) next-num))
 245             dir))
 246           (elmo-progress-notify 'elmo-folder-move-messages)
 247           (if (and (setq numbers (cdr numbers))
 248                    (not same-number))
 249               (setq next-num
 250                     (if (elmo-localdir-locked-p)
 251                         ;; MDA is running.
 252                         (1+ (car (elmo-folder-status folder)))
 253                       (1+ next-num)))))
 254         succeeds)
 255     (luna-call-next-method)))
 256
 257 (luna-define-method elmo-folder-delete-messages ((folder elmo-localdir-folder)
 258                                                  numbers)
 259   (dolist (number numbers)
 260     (elmo-localdir-delete-message folder number))
 261   t)
 262
 263 (defun elmo-localdir-delete-message (folder number)
 264   "Delete message in the FOLDER with NUMBER."
 265   (let ((filename (elmo-message-file-name folder number)))
 266     (when (and (string-match "[0-9]+" filename) ; for safety.
 267                (file-exists-p filename)
 268                (file-writable-p filename)
 269                (not (file-directory-p filename)))
 270       (delete-file filename)
 271       t)))
 272
 273 (luna-define-method elmo-message-fetch-internal ((folder elmo-localdir-folder)
 274                                                  number strategy
 275                                                  &optional section unread)
 276   (when (file-exists-p (elmo-message-file-name folder number))
 277     (insert-file-contents-as-binary
 278      (elmo-message-file-name folder number))))
 279
 280 (luna-define-method elmo-folder-list-messages-internal
 281   ((folder elmo-localdir-folder) &optional nohide)
 282   (elmo-localdir-list-subr folder))
 283
 284 (luna-define-method elmo-folder-status ((folder elmo-localdir-folder))
 285   (elmo-localdir-list-subr folder t))
 286
 287 (luna-define-method elmo-folder-creatable-p ((folder elmo-localdir-folder))
 288   t)
 289
 290 (luna-define-method elmo-folder-writable-p ((folder elmo-localdir-folder))
 291   t)
 292
 293 (luna-define-method elmo-folder-create ((folder elmo-localdir-folder))
 294   (let ((dir (elmo-localdir-folder-directory-internal folder)))
 295     (if (file-directory-p dir)
 296         ()
 297       (if (file-exists-p dir)
 298           (error "Create folder failed")
 299         (elmo-make-directory dir))
 300       t)))
 301
 302 (luna-define-method elmo-folder-delete :before ((folder elmo-localdir-folder))
 303   (let ((dir (elmo-localdir-folder-directory-internal folder)))
 304     (if (not (file-directory-p dir))
 305         (error "No such directory: %s" dir)
 306       (elmo-delete-match-files dir "[0-9]+" t)
 307       t)))
 308
 309 (luna-define-method elmo-folder-rename-internal ((folder elmo-localdir-folder)
 310                                                  new-folder)
 311   (let* ((old (elmo-localdir-folder-directory-internal folder))
 312          (new (elmo-localdir-folder-directory-internal new-folder))
 313          (new-dir (directory-file-name (file-name-directory new))))
 314     (if (not (file-directory-p old))
 315         (error "No such directory: %s" old)
 316       (if (file-exists-p new)
 317           (error "Already exists directory: %s" new)
 318         (if (not (file-exists-p new-dir))
 319             (elmo-make-directory new-dir))
 320         (rename-file old new)
 321         t))))
 322
 323 (defsubst elmo-localdir-field-condition-match (folder condition
 324                                                       number number-list)
 325   (elmo-file-field-condition-match
 326    (expand-file-name (int-to-string number)
 327                      (elmo-localdir-folder-directory-internal folder))
 328    condition number number-list))
 329
 330 (luna-define-method elmo-folder-pack-numbers ((folder elmo-localdir-folder))
 331   (let* ((dir (elmo-localdir-folder-directory-internal folder))
 332          (msgdb (elmo-folder-msgdb folder))
 333          (onum-alist (elmo-msgdb-get-number-alist msgdb))
 334          (omark-alist (elmo-msgdb-get-mark-alist msgdb))
 335          (new-number 1)                 ; first ordinal position in localdir
 336          flist onum mark new-mark-alist total)
 337     (setq flist
 338           (if elmo-pack-number-check-strict
 339               (elmo-folder-list-messages folder) ; allow localnews
 340             (mapcar 'car onum-alist)))
 341     (setq total (length flist))
 342     (while flist
 343       (when (> total elmo-display-progress-threshold)
 344         (elmo-display-progress
 345          'elmo-folder-pack-numbers "Packing..."
 346          (/ (* new-number 100) total)))
 347       (setq onum (car flist))
 348       (when (not (eq onum new-number))          ; why \=() is wrong..
 349         (elmo-bind-directory
 350          dir
 351          ;; xxx  nfs,hardlink
 352          (rename-file (int-to-string onum) (int-to-string new-number) t))
 353         ;; update overview
 354         (elmo-msgdb-overview-entity-set-number
 355          (elmo-msgdb-overview-get-entity onum msgdb)
 356          new-number)
 357         ;; update number-alist
 358         (setcar (assq onum onum-alist) new-number))
 359       ;; update mark-alist
 360       (when (setq mark (cadr (assq onum omark-alist)))
 361         (setq new-mark-alist
 362               (elmo-msgdb-mark-append
 363                new-mark-alist
 364                new-number mark)))
 365       (setq new-number (1+ new-number))
 366       (setq flist (cdr flist)))
 367     (message "Packing...done")
 368     (elmo-folder-set-msgdb-internal
 369      folder
 370      (elmo-make-msgdb
 371       (elmo-msgdb-get-overview msgdb)
 372       onum-alist
 373       new-mark-alist))))
 374
 375 (luna-define-method elmo-folder-message-file-p ((folder elmo-localdir-folder))
 376   t)
 377
 378 (luna-define-method elmo-message-file-name ((folder elmo-localdir-folder)
 379                                             number)
 380   (expand-file-name
 381    (int-to-string number)
 382    (elmo-localdir-folder-directory-internal folder)))
 383
 384 (defun elmo-localdir-locked-p ()
 385   (if elmo-localdir-lockfile-list
 386       (let ((lock elmo-localdir-lockfile-list))
 387         (catch 'found
 388           (while lock
 389             (if (file-exists-p (car lock))
 390                 (throw 'found t))
 391             (setq lock (cdr lock)))))))
 392
 393 (require 'product)
 394 (product-provide (provide 'elmo-localdir) (require 'elmo-version))
 395
 396 ;;; elmo-localdir.el ends here