elmo/elmo-maildir.el

   1 ;;; elmo-maildir.el -- Maildir interface for ELMO.
   2
   3 ;; Copyright 1998,1999,2000 Yuuichi Teranishi <teranisi@gohome.org>
   4
   5 ;; Author: Yuuichi Teranishi <teranisi@gohome.org>
   6 ;; Keywords: mail, net news
   7 ;; Time-stamp: <00/03/22 00:14:31 teranisi>
   8
   9 ;; This file is part of ELMO (Elisp Library for Message Orchestration).
  10
  11 ;; This program is free software; you can redistribute it and/or modify
  12 ;; it under the terms of the GNU General Public License as published by
  13 ;; the Free Software Foundation; either version 2, or (at your option)
  14 ;; any later version.
  15 ;;
  16 ;; This program is distributed in the hope that it will be useful,
  17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19 ;; GNU General Public License for more details.
  20 ;;
  21 ;; You should have received a copy of the GNU General Public License
  22 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  24 ;; Boston, MA 02111-1307, USA.
  25 ;;
  26
  27 ;;; Commentary:
  28 ;;
  29
  30 ;;; Code:
  31 ;;
  32
  33 (eval-when-compile (require 'cl))
  34 (require 'elmo-util)
  35 (require 'elmo-localdir)
  36
  37 (defvar elmo-maildir-sequence-number-internal 0
  38   "Sequence number for the pid part of unique filename.
  39 This variable should not be used in elsewhere.")
  40
  41 (defsubst elmo-maildir-get-folder-directory (spec)
  42   (if (file-name-absolute-p (nth 1 spec))
  43       (nth 1 spec) ; already full path.
  44     (expand-file-name (nth 1 spec)
  45                       elmo-maildir-folder-path)))
  46
  47 (defun elmo-maildir-number-to-filename (dir number loc-alist)
  48   (let ((location (cdr (assq number loc-alist))))
  49     (and location (elmo-maildir-get-filename location dir))))
  50
  51 (defun elmo-maildir-get-filename (location dir)
  52   "Get a filename that is corresponded to LOCATION in DIR."
  53   (expand-file-name
  54    (let ((file (file-name-completion (symbol-name location)
  55                                      (expand-file-name "cur" dir))))
  56      (if (eq file t) location file))
  57    (expand-file-name "cur" dir)))
  58
  59 (defsubst elmo-maildir-list-location (dir &optional child-dir)
  60   (let* ((cur-dir (expand-file-name (or child-dir "cur") dir))
  61          (cur (directory-files cur-dir
  62                                nil "^[^.].*$" t))
  63          seen-list seen sym list)
  64     (setq list
  65           (mapcar
  66            (lambda (x)
  67              (if (string-match "^\\([^:]+\\):\\([^:]+\\)$" x)
  68                  (progn
  69                    (setq seen nil)
  70                    (save-match-data
  71                      (if (string-match
  72                           "S"
  73                           (elmo-match-string 2 x))
  74                          (setq seen t)))
  75                    (setq sym (intern (elmo-match-string 1 x)))
  76                    (if seen
  77                        (setq seen-list (cons sym seen-list)))
  78                    sym)
  79                (intern x)))
  80            cur))
  81     (cons list seen-list)))
  82
  83 (defun elmo-maildir-msgdb-create-entity (dir number loc-alist)
  84   (elmo-localdir-msgdb-create-overview-entity-from-file
  85    number
  86    (elmo-maildir-number-to-filename dir number loc-alist)))
  87
  88 (defun elmo-maildir-cleanup-temporal (dir)
  89   ;; Delete files in the tmp dir which are not accessed
  90   ;; for more than 36 hours.
  91   (let ((cur-time (current-time))
  92         (count 0)
  93         last-accessed)
  94     (mapcar (function
  95              (lambda (file)
  96                (setq last-accessed (nth 4 (file-attributes file)))
  97                (when (or (> (- (car cur-time)(car last-accessed)) 1)
  98                          (and (eq (- (car cur-time)(car last-accessed)) 1)
  99                               (> (- (cadr cur-time)(cadr last-accessed))
 100                                  64064))) ; 36 hours.
 101                  (message "Maildir: %d tmp file(s) are cleared."
 102                           (setq count (1+ count)))
 103                  (delete-file file))))
 104             (directory-files (expand-file-name "tmp" dir)
 105                              t ; full
 106                              "^[^.].*$" t))))
 107
 108 (defun elmo-maildir-update-current (spec)
 109   "Move all new msgs to cur in the maildir"
 110   (let* ((maildir (elmo-maildir-get-folder-directory spec))
 111          (news (directory-files (expand-file-name "new"
 112                                                   maildir)
 113                                 nil
 114                                 "^[^.].*$" t)))
 115     ;; cleanup tmp directory.
 116     (elmo-maildir-cleanup-temporal maildir)
 117     ;; move new msgs to cur directory.
 118     (mapcar (lambda (x)
 119               (rename-file
 120                (expand-file-name x (expand-file-name "new" maildir))
 121                (expand-file-name (concat x ":2,")
 122                                  (expand-file-name "cur" maildir))))
 123             news)))
 124
 125 (defun elmo-maildir-set-mark (filename mark)
 126   "Mark the file in the maildir. MARK is a character."
 127   (if (string-match "^\\([^:]+:2,\\)\\(.*\\)$" filename)
 128       (let ((flaglist (string-to-char-list (elmo-match-string
 129                                             2 filename))))
 130         (unless (memq mark flaglist)
 131           (setq flaglist (sort (cons mark flaglist) '<))
 132           (rename-file filename
 133                        (concat (elmo-match-string 1 filename)
 134                                (char-list-to-string flaglist)))))))
 135
 136 (defun elmo-maildir-delete-mark (filename mark)
 137   "Mark the file in the maildir. MARK is a character."
 138   (if (string-match "^\\([^:]+:2,\\)\\(.*\\)$" filename)
 139       (let ((flaglist (string-to-char-list (elmo-match-string
 140                                             2 filename))))
 141         (when (memq mark flaglist)
 142           (setq flaglist (delq mark flaglist))
 143           (rename-file filename
 144                        (concat (elmo-match-string 1 filename)
 145                                (if flaglist
 146                                    (char-list-to-string flaglist))))))))
 147
 148 (defsubst elmo-maildir-set-mark-msgs (spec mark msgs msgdb)
 149   (let ((dir (elmo-maildir-get-folder-directory spec))
 150         (locs (if msgdb
 151                   (elmo-msgdb-get-location msgdb)
 152                 (elmo-msgdb-location-load (elmo-msgdb-expand-path nil spec))))
 153         file)
 154     (while msgs
 155       (if (setq file (elmo-maildir-number-to-filename dir (car msgs) locs))
 156           (elmo-maildir-set-mark file mark))
 157       (setq msgs (cdr msgs)))))
 158
 159 (defsubst elmo-maildir-delete-mark-msgs (spec mark msgs msgdb)
 160   (let ((dir (elmo-maildir-get-folder-directory spec))
 161         (locs (if msgdb
 162                   (elmo-msgdb-get-location msgdb)
 163                 (elmo-msgdb-location-load (elmo-msgdb-expand-path nil spec))))
 164         file)
 165     (while msgs
 166       (if (setq file (elmo-maildir-number-to-filename dir (car msgs) locs))
 167           (elmo-maildir-delete-mark file mark))
 168       (setq msgs (cdr msgs)))))
 169
 170 (defun elmo-maildir-mark-as-important (spec msgs &optional msgdb)
 171   (elmo-maildir-set-mark-msgs spec ?F msgs msgdb))
 172
 173 (defun elmo-maildir-unmark-important (spec msgs &optional msgdb)
 174   (elmo-maildir-delete-mark-msgs spec ?F msgs msgdb))
 175
 176 (defun elmo-maildir-mark-as-read (spec msgs &optional msgdb)
 177   (elmo-maildir-set-mark-msgs spec ?S msgs msgdb))
 178
 179 (defun elmo-maildir-mark-as-unread (spec msgs &optional msgdb)
 180   (elmo-maildir-delete-mark-msgs spec ?S msgs msgdb))
 181
 182 (defun elmo-maildir-msgdb-create (spec numlist new-mark
 183                                        already-mark seen-mark
 184                                        important-mark
 185                                        seen-list
 186                                        &optional msgdb)
 187   (when numlist
 188     (let* ((dir (elmo-maildir-get-folder-directory spec))
 189            (loc-alist (if msgdb (elmo-msgdb-get-location msgdb)
 190                         (elmo-msgdb-location-load (elmo-msgdb-expand-path
 191                                                    nil spec))))
 192            (loc-seen (elmo-maildir-list-location dir))
 193            (loc-list  (car loc-seen))
 194            (seen-list (cdr loc-seen))
 195            overview number-alist mark-alist entity
 196            i percent num location pair)
 197       (setq num (length numlist))
 198       (setq i 0)
 199       (message "Creating msgdb...")
 200       (while numlist
 201         (setq entity
 202               (elmo-maildir-msgdb-create-entity
 203                dir (car numlist) loc-alist))
 204         (if (null entity)
 205             ()
 206           (setq overview
 207                 (elmo-msgdb-append-element
 208                  overview entity))
 209           (setq number-alist
 210                 (elmo-msgdb-number-add number-alist
 211                                        (elmo-msgdb-overview-entity-get-number
 212                                         entity)
 213                                        (elmo-msgdb-overview-entity-get-id
 214                                         entity)))
 215           (setq location (cdr (assq (car numlist) loc-alist)))
 216           (unless (member location seen-list)
 217             (setq mark-alist
 218                   (elmo-msgdb-mark-append
 219                    mark-alist
 220                    (elmo-msgdb-overview-entity-get-number
 221                     entity)
 222                    (or (elmo-msgdb-global-mark-get
 223                         (elmo-msgdb-overview-entity-get-id
 224                          entity))
 225                        new-mark)))))
 226         (setq i (1+ i))
 227         (setq percent (/ (* i 100) num))
 228         (elmo-display-progress
 229          'elmo-maildir-msgdb-create "Creating msgdb..."
 230          percent)
 231         (setq numlist (cdr numlist)))
 232       (message "Creating msgdb...done.")
 233       (list overview number-alist mark-alist loc-alist))))
 234
 235 (defalias 'elmo-maildir-msgdb-create-as-numlist 'elmo-maildir-msgdb-create)
 236
 237 (defun elmo-maildir-list-folders (spec &optional hierarchy)
 238   (let ((elmo-localdir-folder-path elmo-maildir-folder-path)
 239         (elmo-localdir-list-folders-spec-string ".")
 240         (elmo-localdir-list-folders-filter-regexp
 241          "^\\(\\.\\.?\\|cur\\|tmp\\|new\\)$")
 242         elmo-have-link-count folders)
 243     (setq folders (elmo-localdir-list-folders spec hierarchy))
 244     (if (eq (length (nth 1 spec)) 0) ; top
 245         (setq folders (append
 246                        (list (concat elmo-localdir-list-folders-spec-string
 247                                      (nth 1 spec)))
 248                        folders)))
 249     (elmo-delete-if
 250      (function (lambda (folder)
 251                  (not (or (listp folder) (elmo-folder-exists-p folder)))))
 252      folders)))
 253
 254 (static-cond
 255  ((>= emacs-major-version 19)
 256   (defun elmo-maildir-make-unique-string ()
 257     "This function generates a string that can be used as a unique
 258 file name for maildir directories."
 259      (let ((cur-time (current-time)))
 260        (format "%.0f.%d_%d.%s"
 261               (+ (* (car cur-time)
 262                     (float 65536)) (cadr cur-time))
 263               (emacs-pid)
 264               (incf elmo-maildir-sequence-number-internal)
 265               (system-name)))))
 266  ((eq emacs-major-version 18)
 267   ;; A fake function for v18
 268   (defun elmo-maildir-make-unique-string ()
 269     "This function generates a string that can be used as a unique
 270 file name for maildir directories."
 271     (unless (fboundp 'float-to-string)
 272       (load-library "float"))
 273     (let ((time (current-time)))
 274       (format "%s%d.%d.%s"
 275               (substring
 276                (float-to-string
 277                 (f+ (f* (f (car time))
 278                         (f 65536))
 279                     (f (cadr time))))
 280                0 5)
 281               (cadr time)
 282               (% (abs (random t)) 10000); dummy pid
 283               (system-name))))))
 284
 285 (defun elmo-maildir-temporal-filename (basedir)
 286   (let ((filename (expand-file-name
 287                    (concat "tmp/" (elmo-maildir-make-unique-string))
 288                    basedir)))
 289     (unless (file-exists-p (file-name-directory filename))
 290       (make-directory (file-name-directory filename)))
 291     (while (file-exists-p filename)
 292       ;; (sleep-for 2) ; I don't want to wait.
 293       (setq filename
 294             (expand-file-name
 295              (concat "tmp/" (elmo-maildir-make-unique-string))
 296              basedir)))
 297     filename))
 298
 299 (defun elmo-maildir-append-msg (spec string &optional msg no-see)
 300   (let ((basedir (elmo-maildir-get-folder-directory spec))
 301         filename)
 302     (condition-case nil
 303         (with-temp-buffer
 304           (setq filename (elmo-maildir-temporal-filename basedir))
 305           (insert string)
 306           (as-binary-output-file
 307            (write-region (point-min) (point-max) filename nil 'no-msg))
 308           ;; add link from new.
 309           (elmo-add-name-to-file
 310            filename
 311            (expand-file-name
 312             (concat "new/" (file-name-nondirectory filename))
 313             basedir))
 314           t)
 315       ;; If an error occured, return nil.
 316       (error))))
 317
 318 (defun elmo-maildir-delete-msg (spec number loc-alist)
 319   (let ((dir (elmo-maildir-get-folder-directory spec))
 320         file)
 321     (setq file (elmo-maildir-number-to-filename dir number loc-alist))
 322     (if (and (file-writable-p file)
 323              (not (file-directory-p file)))
 324         (progn (delete-file file)
 325                t))))
 326
 327 (defun elmo-maildir-read-msg (spec number outbuf &optional msgdb)
 328   (save-excursion
 329     (let* ((loc-alist (if msgdb (elmo-msgdb-get-location msgdb)
 330                         (elmo-msgdb-location-load (elmo-msgdb-expand-path
 331                                                    nil spec))))
 332            (dir (elmo-maildir-get-folder-directory spec))
 333            (file (elmo-maildir-number-to-filename dir number loc-alist)))
 334       (set-buffer outbuf)
 335       (erase-buffer)
 336       (when (file-exists-p file)
 337         (as-binary-input-file (insert-file-contents file))
 338         (elmo-delete-cr-get-content-type)))))
 339
 340 (defun elmo-maildir-delete-msgs (spec msgs &optional msgdb)
 341   (let ((loc-alist (if msgdb (elmo-msgdb-get-location msgdb)
 342                      (elmo-msgdb-location-load (elmo-msgdb-expand-path
 343                                                 nil spec)))))
 344     (mapcar '(lambda (msg) (elmo-maildir-delete-msg spec msg
 345                                                     loc-alist))
 346             msgs)))
 347
 348 (defsubst elmo-maildir-list-folder-subr (spec &optional nonsort)
 349   (let* ((dir (elmo-maildir-get-folder-directory spec))
 350          (flist (elmo-list-folder-by-location
 351                  spec
 352                  (car (elmo-maildir-list-location dir))))
 353          (news (car (elmo-maildir-list-location dir "new"))))
 354     (if nonsort
 355         (cons (+ (or (elmo-max-of-list flist) 0) (length news))
 356               (+ (length flist) (length news)))
 357       (sort flist '<))))
 358
 359 (defun elmo-maildir-list-folder (spec)
 360   (elmo-maildir-update-current spec)
 361   (elmo-maildir-list-folder-subr spec))
 362
 363 (defun elmo-maildir-max-of-folder (spec)
 364   (elmo-maildir-list-folder-subr spec t))
 365
 366 (defalias 'elmo-maildir-check-validity 'elmo-localdir-check-validity)
 367
 368 (defalias 'elmo-maildir-sync-validity  'elmo-localdir-sync-validity)
 369
 370 (defun elmo-maildir-folder-exists-p (spec)
 371   (let ((basedir (elmo-maildir-get-folder-directory spec)))
 372     (and (file-directory-p (expand-file-name "new" basedir))
 373          (file-directory-p (expand-file-name "cur" basedir))
 374          (file-directory-p (expand-file-name "tmp" basedir)))))
 375
 376 (defun elmo-maildir-folder-creatable-p (spec)
 377   t)
 378
 379 (defun elmo-maildir-create-folder (spec)
 380   (let ((basedir (elmo-maildir-get-folder-directory spec)))
 381     (condition-case nil
 382         (progn
 383           (mapcar (function (lambda (dir)
 384                               (setq dir (expand-file-name dir basedir))
 385                               (or (file-directory-p dir)
 386                                   (progn
 387                                     (elmo-make-directory dir)
 388                                     (set-file-modes dir 448)))))
 389                   '("." "new" "cur" "tmp"))
 390           t)
 391       (error))))
 392
 393 (defun elmo-maildir-delete-folder (spec)
 394   (let ((basedir (elmo-maildir-get-folder-directory spec)))
 395     (condition-case nil
 396         (let ((tmp-files (directory-files
 397                           (expand-file-name "tmp" basedir)
 398                           t "[^.].*")))
 399           ;; Delete files in tmp.
 400           (and tmp-files (mapcar 'delete-file tmp-files))
 401           (mapcar
 402            (function
 403             (lambda (dir)
 404               (setq dir (expand-file-name dir basedir))
 405               (if (not (file-directory-p dir))
 406                   (error)
 407                 (elmo-delete-directory dir t))))
 408            '("new" "cur" "tmp" "."))
 409           t)
 410       (error))))
 411
 412 (defun elmo-maildir-search (spec condition &optional from-msgs msgdb)
 413   (save-excursion
 414     (let* ((msgs (or from-msgs (elmo-maildir-list-folder spec)))
 415            (loc-alist (if msgdb (elmo-msgdb-get-location msgdb)
 416                         (elmo-msgdb-location-load (elmo-msgdb-expand-path
 417                                                    nil spec))))
 418            (dir (elmo-maildir-get-folder-directory spec))
 419            (i 0)
 420            case-fold-search ret-val
 421            percent num
 422            (num (length msgs))
 423            msg-num)
 424       (while msgs
 425         (setq msg-num (car msgs))
 426         (if (elmo-file-field-condition-match
 427              (elmo-maildir-number-to-filename
 428               dir (car msgs) loc-alist)
 429              condition)
 430             (setq ret-val (append ret-val (list msg-num))))
 431         (setq i (1+ i))
 432         (setq percent (/ (* i 100) num))
 433         (elmo-display-progress
 434          'elmo-maildir-search "Searching..."
 435          percent)
 436         (setq msgs (cdr msgs)))
 437       ret-val)))
 438
 439 ;;; (maildir) -> maildir
 440 (defun elmo-maildir-copy-msgs (dst-spec msgs src-spec
 441                                         &optional loc-alist same-number)
 442   (let (srcfile)
 443     (while msgs
 444       (setq srcfile
 445             (elmo-maildir-get-msg-filename src-spec (car msgs) loc-alist))
 446       (elmo-copy-file
 447        ;; src file
 448        srcfile
 449        ;; dst file
 450        (expand-file-name
 451         (file-name-nondirectory srcfile)
 452         (concat (elmo-maildir-get-folder-directory dst-spec) "/cur")))
 453       (setq msgs (cdr msgs))))
 454   t)
 455
 456 (defun elmo-maildir-use-cache-p (spec number)
 457   nil)
 458
 459 (defun elmo-maildir-local-file-p (spec number)
 460   t)
 461
 462 (defun elmo-maildir-get-msg-filename (spec number &optional loc-alist)
 463   (elmo-maildir-number-to-filename
 464    (elmo-maildir-get-folder-directory spec)
 465    number (or loc-alist (elmo-msgdb-location-load
 466                          (elmo-msgdb-expand-path
 467                           nil spec)))))
 468
 469 (defalias 'elmo-maildir-sync-number-alist
 470   'elmo-generic-sync-number-alist)
 471 (defalias 'elmo-maildir-list-folder-unread
 472   'elmo-generic-list-folder-unread)
 473 (defalias 'elmo-maildir-list-folder-important
 474   'elmo-generic-list-folder-important)
 475
 476 (provide 'elmo-maildir)
 477
 478 ;;; elmo-maildir.el ends here