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 (expand-file-name
  95                     (elmo-localdir-folder-dir-name-internal folder))
  96                    "/"))
  97     "/")
  98    (expand-file-name ;;"localdir"
  99     (symbol-name (elmo-folder-type-internal folder))
 100     elmo-msgdb-directory)))
 101
 102 (luna-define-method elmo-message-file-name ((folder
 103                                              elmo-localdir-folder)
 104                                             number)
 105   (expand-file-name (int-to-string number)
 106                     (elmo-localdir-folder-directory-internal folder)))
 107
 108 (luna-define-method elmo-folder-message-file-number-p ((folder
 109                                                         elmo-localdir-folder))
 110   t)
 111
 112 (luna-define-method elmo-folder-message-file-directory ((folder
 113                                                          elmo-localdir-folder))
 114   (elmo-localdir-folder-directory-internal folder))
 115
 116 (luna-define-method elmo-folder-message-make-temp-file-p
 117   ((folder elmo-localdir-folder))
 118   t)
 119
 120 (luna-define-method elmo-folder-message-make-temp-files ((folder
 121                                                           elmo-localdir-folder)
 122                                                          numbers
 123                                                          &optional
 124                                                          start-number)
 125   (let ((temp-dir (elmo-folder-make-temporary-directory folder))
 126         (cur-number (or start-number 0)))
 127     (dolist (number numbers)
 128       (elmo-copy-file
 129        (expand-file-name
 130         (int-to-string number)
 131         (elmo-localdir-folder-directory-internal folder))
 132        (expand-file-name
 133         (int-to-string (if start-number cur-number number))
 134         temp-dir))
 135       (incf cur-number))
 136     temp-dir))
 137
 138 (defun elmo-localdir-msgdb-create-entity (dir number)
 139   (elmo-msgdb-create-overview-entity-from-file
 140    number (expand-file-name (int-to-string number) dir)))
 141
 142 (luna-define-method elmo-folder-msgdb-create ((folder elmo-localdir-folder)
 143                                               numbers
 144                                               new-mark
 145                                               already-mark
 146                                               seen-mark
 147                                               important-mark
 148                                               seen-list)
 149   (when numbers
 150     (let ((dir (elmo-localdir-folder-directory-internal folder))
 151           overview number-alist mark-alist entity message-id
 152           num seen gmark
 153           (i 0)
 154           (len (length numbers)))
 155       (message "Creating msgdb...")
 156       (while numbers
 157         (setq entity
 158               (elmo-localdir-msgdb-create-entity
 159                dir (car numbers)))
 160         (if (null entity)
 161             ()
 162           (setq num (elmo-msgdb-overview-entity-get-number entity))
 163           (setq overview
 164                 (elmo-msgdb-append-element
 165                  overview entity))
 166           (setq message-id (elmo-msgdb-overview-entity-get-id entity))
 167           (setq number-alist
 168                 (elmo-msgdb-number-add number-alist
 169                                        num
 170                                        message-id))
 171           (setq seen (member message-id seen-list))
 172           (if (setq gmark (or (elmo-msgdb-global-mark-get message-id)
 173                               (if (elmo-file-cache-exists-p message-id) ; XXX
 174                                   (if seen
 175                                       nil
 176                                     already-mark)
 177                                 (if seen
 178                                     nil ;;seen-mark
 179                                   new-mark))))
 180               (setq mark-alist
 181                     (elmo-msgdb-mark-append
 182                      mark-alist
 183                      num
 184                      gmark))))
 185         (when (> len elmo-display-progress-threshold)
 186           (setq i (1+ i))
 187           (elmo-display-progress
 188            'elmo-localdir-msgdb-create-as-numbers "Creating msgdb..."
 189            (/ (* i 100) len)))
 190         (setq numbers (cdr numbers)))
 191       (message "Creating msgdb...done")
 192       (list overview number-alist mark-alist))))
 193
 194 (luna-define-method elmo-folder-list-subfolders ((folder elmo-localdir-folder)
 195                                                  &optional one-level)
 196   (elmo-mapcar-list-of-list
 197    (lambda (x) (concat (elmo-folder-prefix-internal folder) x))
 198    (elmo-list-subdirectories
 199     (elmo-localdir-folder-path folder)
 200     (or (elmo-localdir-folder-dir-name-internal folder) "")
 201     one-level)))
 202
 203 (defsubst elmo-localdir-list-subr (folder &optional nonsort)
 204   (let ((flist (mapcar 'string-to-int
 205                        (directory-files
 206                         (elmo-localdir-folder-directory-internal folder)
 207                         nil "^[0-9]+$" t)))
 208         (killed (elmo-msgdb-killed-list-load (elmo-folder-msgdb-path folder))))
 209     (if nonsort
 210         (cons (or (elmo-max-of-list flist) 0)
 211               (if killed
 212                   (- (length flist)
 213                      (elmo-msgdb-killed-list-length killed))
 214                 (length flist)))
 215       (sort flist '<))))
 216
 217 (luna-define-method elmo-folder-append-buffer ((folder elmo-localdir-folder)
 218                                                unread
 219                                                &optional number)
 220   (let ((filename (elmo-message-file-name
 221                    folder
 222                    (or number
 223                        (1+ (car (elmo-folder-status folder)))))))
 224     (when (file-writable-p filename)
 225       (write-region-as-binary
 226        (point-min) (point-max) filename nil 'no-msg)
 227       t)))
 228
 229 (luna-define-method elmo-folder-append-messages :around
 230   ((folder elmo-localdir-folder)
 231    src-folder numbers unread-marks &optional same-number)
 232   (if (elmo-folder-message-file-p src-folder)
 233       (let ((dir (elmo-localdir-folder-directory-internal folder))
 234             (succeeds numbers)
 235             (next-num (1+ (car (elmo-folder-status folder)))))
 236         (while numbers
 237           (elmo-copy-file
 238            (elmo-message-file-name src-folder (car numbers))
 239            (expand-file-name
 240             (int-to-string
 241              (if same-number (car numbers) next-num))
 242             dir))
 243           (elmo-progress-notify 'elmo-folder-move-messages)
 244           (if (and (setq numbers (cdr numbers))
 245                    (not same-number))
 246               (setq next-num
 247                     (if (elmo-localdir-locked-p)
 248                         ;; MDA is running.
 249                         (1+ (car (elmo-folder-status folder)))
 250                       (1+ next-num)))))
 251         succeeds)
 252     (luna-call-next-method)))
 253
 254 (luna-define-method elmo-folder-delete-messages ((folder elmo-localdir-folder)
 255                                                  numbers)
 256   (dolist (number numbers)
 257     (elmo-localdir-delete-message folder number))
 258   t)
 259
 260 (defun elmo-localdir-delete-message (folder number)
 261   "Delete message in the FOLDER with NUMBER."
 262   (let ((filename (elmo-message-file-name folder number)))
 263     (when (and (string-match "[0-9]+" filename) ; for safety.
 264                (file-exists-p filename)
 265                (file-writable-p filename)
 266                (not (file-directory-p filename)))
 267       (delete-file filename)
 268       t)))
 269
 270 (luna-define-method elmo-message-fetch-internal ((folder elmo-localdir-folder)
 271                                                  number strategy
 272                                                  &optional section unread)
 273   (when (file-exists-p (elmo-message-file-name folder number))
 274     (insert-file-contents-as-binary
 275      (elmo-message-file-name folder number))))
 276
 277 (luna-define-method elmo-folder-list-messages-internal
 278   ((folder elmo-localdir-folder) &optional nohide)
 279   (elmo-localdir-list-subr folder))
 280
 281 (luna-define-method elmo-folder-status ((folder elmo-localdir-folder))
 282   (elmo-localdir-list-subr folder t))
 283
 284 (luna-define-method elmo-folder-creatable-p ((folder elmo-localdir-folder))
 285   t)
 286
 287 (luna-define-method elmo-folder-writable-p ((folder elmo-localdir-folder))
 288   t)
 289
 290 (luna-define-method elmo-folder-create ((folder elmo-localdir-folder))
 291   (let ((dir (elmo-localdir-folder-directory-internal folder)))
 292     (if (file-directory-p dir)
 293         ()
 294       (if (file-exists-p dir)
 295           (error "Create folder failed")
 296         (elmo-make-directory dir))
 297       t)))
 298
 299 (luna-define-method elmo-folder-delete :before ((folder elmo-localdir-folder))
 300   (let ((dir (elmo-localdir-folder-directory-internal folder)))
 301     (if (not (file-directory-p dir))
 302         (error "No such directory: %s" dir)
 303       (elmo-delete-match-files dir "[0-9]+" t)
 304       t)))
 305
 306 (luna-define-method elmo-folder-rename-internal ((folder elmo-localdir-folder)
 307                                                  new-folder)
 308   (let* ((old (elmo-localdir-folder-directory-internal folder))
 309          (new (elmo-localdir-folder-directory-internal new-folder))
 310          (new-dir (directory-file-name (file-name-directory new))))
 311     (if (not (file-directory-p old))
 312         (error "No such directory: %s" old)
 313       (if (file-exists-p new)
 314           (error "Already exists directory: %s" new)
 315         (if (not (file-directory-p new-dir))
 316             (elmo-make-directory new-dir))
 317         (rename-file old new)
 318         t))))
 319
 320 (defsubst elmo-localdir-field-condition-match (folder condition
 321                                                       number number-list)
 322   (elmo-file-field-condition-match
 323    (expand-file-name (int-to-string number)
 324                      (elmo-localdir-folder-directory-internal folder))
 325    condition number number-list))
 326
 327 (luna-define-method elmo-folder-pack-numbers ((folder elmo-localdir-folder))
 328   (let* ((dir (elmo-localdir-folder-directory-internal folder))
 329          (msgdb (elmo-folder-msgdb folder))
 330          (onum-alist (elmo-msgdb-get-number-alist msgdb))
 331          (omark-alist (elmo-msgdb-get-mark-alist msgdb))
 332          (new-number 1)                 ; first ordinal position in localdir
 333          flist onum mark new-mark-alist total)
 334     (setq flist
 335           (if elmo-pack-number-check-strict
 336               (elmo-folder-list-messages folder) ; allow localnews
 337             (mapcar 'car onum-alist)))
 338     (setq total (length flist))
 339     (while flist
 340       (when (> total elmo-display-progress-threshold)
 341         (elmo-display-progress
 342          'elmo-folder-pack-numbers "Packing..."
 343          (/ (* new-number 100) total)))
 344       (setq onum (car flist))
 345       (when (not (eq onum new-number))          ; why \=() is wrong..
 346         (elmo-bind-directory
 347          dir
 348          ;; xxx  nfs,hardlink
 349          (rename-file (int-to-string onum) (int-to-string new-number) t))
 350         ;; update overview
 351         (elmo-msgdb-overview-entity-set-number
 352          (elmo-msgdb-overview-get-entity onum msgdb)
 353          new-number)
 354         ;; update number-alist
 355         (setcar (assq onum onum-alist) new-number))
 356       ;; update mark-alist
 357       (when (setq mark (cadr (assq onum omark-alist)))
 358         (setq new-mark-alist
 359               (elmo-msgdb-mark-append
 360                new-mark-alist
 361                new-number mark)))
 362       (setq new-number (1+ new-number))
 363       (setq flist (cdr flist)))
 364     (message "Packing...done")
 365     (elmo-folder-set-msgdb-internal
 366      folder
 367      (elmo-make-msgdb
 368       (elmo-msgdb-get-overview msgdb)
 369       onum-alist
 370       new-mark-alist))))
 371
 372 (luna-define-method elmo-folder-message-file-p ((folder elmo-localdir-folder))
 373   t)
 374
 375 (luna-define-method elmo-message-file-name ((folder elmo-localdir-folder)
 376                                             number)
 377   (expand-file-name
 378    (int-to-string number)
 379    (elmo-localdir-folder-directory-internal folder)))
 380
 381 (defun elmo-localdir-locked-p ()
 382   (if elmo-localdir-lockfile-list
 383       (let ((lock elmo-localdir-lockfile-list))
 384         (catch 'found
 385           (while lock
 386             (if (file-exists-p (car lock))
 387                 (throw 'found t))
 388             (setq lock (cdr lock)))))))
 389
 390 (require 'product)
 391 (product-provide (provide 'elmo-localdir) (require 'elmo-version))
 392
 393 ;;; elmo-localdir.el ends here