elmo/elmo-util.el

   1 ;;; elmo-util.el --- Utilities 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 (eval-when-compile (require 'cl))
  33 (require 'elmo-vars)
  34 (require 'elmo-date)
  35 (require 'mcharset)
  36 (require 'pces)
  37 (require 'std11)
  38 (require 'eword-decode)
  39 (require 'utf7)
  40 (require 'poem)
  41 (require 'emu)
  42
  43 (eval-and-compile
  44   (autoload 'md5 "md5"))
  45
  46 (defvar elmo-work-buf-name " *elmo work*")
  47 (defvar elmo-temp-buf-name " *elmo temp*")
  48
  49 (or (boundp 'default-enable-multibyte-characters)
  50     (defvar default-enable-multibyte-characters (featurep 'mule)
  51       "The mock variable except for Emacs 20."))
  52
  53 (defun elmo-base64-encode-string (string &optional no-line-break))
  54 (defun elmo-base64-decode-string (string))
  55
  56 ;; base64 encoding/decoding
  57 (require 'mel)
  58 (fset 'elmo-base64-encode-string
  59       (mel-find-function 'mime-encode-string "base64"))
  60 (fset 'elmo-base64-decode-string
  61       (mel-find-function 'mime-decode-string "base64"))
  62
  63 ;; Any Emacsen may have add-name-to-file(), because loadup.el requires it. :-p
  64 ;; Check make-symbolic-link() instead.  -- 981002 by Fuji
  65 (if (fboundp 'make-symbolic-link)  ;; xxx
  66     (defalias 'elmo-add-name-to-file 'add-name-to-file)
  67   (defun elmo-add-name-to-file
  68     (filename newname &optional ok-if-already-exists)
  69     (copy-file filename newname ok-if-already-exists t)))
  70
  71 (defmacro elmo-set-work-buf (&rest body)
  72   "Execute BODY on work buffer.  Work buffer remains."
  73   (` (save-excursion
  74        (set-buffer (get-buffer-create elmo-work-buf-name))
  75        (set-buffer-multibyte default-enable-multibyte-characters)
  76        (erase-buffer)
  77        (,@ body))))
  78
  79 (put 'elmo-set-work-buf 'lisp-indent-function 0)
  80 (def-edebug-spec elmo-set-work-buf t)
  81
  82 (defmacro elmo-bind-directory (dir &rest body)
  83   "Set current directory DIR and execute BODY."
  84   (` (let ((default-directory (file-name-as-directory (, dir))))
  85        (,@ body))))
  86
  87 (put 'elmo-bind-directory 'lisp-indent-function 1)
  88 (def-edebug-spec elmo-bind-directory
  89   (form &rest form))
  90
  91 (defconst elmo-multibyte-buffer-name " *elmo-multibyte-buffer*")
  92
  93 (defmacro elmo-with-enable-multibyte (&rest body)
  94   "Evaluate BODY with `default-enable-multibyte-character'."
  95   `(with-current-buffer (get-buffer-create elmo-multibyte-buffer-name)
  96      ,@body))
  97
  98 (put 'elmo-with-enable-multibyte 'lisp-indent-function 0)
  99 (def-edebug-spec elmo-with-enable-multibyte t)
 100
 101 (eval-when-compile
 102   (unless (fboundp 'coding-system-base)
 103     (defalias 'coding-system-base 'ignore))
 104   (unless (fboundp 'coding-system-name)
 105     (defalias 'coding-system-name 'ignore))
 106   (unless (fboundp 'find-file-coding-system-for-read-from-filename)
 107     (defalias 'find-file-coding-system-for-read-from-filename 'ignore))
 108   (unless (fboundp 'find-operation-coding-system)
 109     (defalias 'find-operation-coding-system 'ignore)))
 110
 111 (defun elmo-set-auto-coding (&optional filename)
 112   "Find coding system used to decode the contents of the current buffer.
 113 This function looks for the coding system magic cookie or examines the
 114 coding system specified by `file-coding-system-alist' being associated
 115 with FILENAME which defaults to `buffer-file-name'."
 116   (cond
 117    ((boundp 'set-auto-coding-function) ;; Emacs
 118     (if filename
 119         (or (funcall (symbol-value 'set-auto-coding-function)
 120                      filename (- (point-max) (point-min)))
 121             (car (find-operation-coding-system 'insert-file-contents
 122                                                filename)))
 123       (let (auto-coding-alist)
 124         (condition-case nil
 125             (funcall (symbol-value 'set-auto-coding-function)
 126                      nil (- (point-max) (point-min)))
 127           (error nil)))))
 128    ((featurep 'file-coding) ;; XEmacs
 129     (let ((case-fold-search t)
 130           (end (point-at-eol))
 131           codesys start)
 132       (or
 133        (and (re-search-forward "-\\*-+[\t ]*" end t)
 134             (progn
 135               (setq start (match-end 0))
 136               (re-search-forward "[\t ]*-+\\*-" end t))
 137             (progn
 138               (setq end (match-beginning 0))
 139               (goto-char start)
 140               (or (looking-at "coding:[\t ]*\\([^\t ;]+\\)")
 141                   (re-search-forward
 142                    "[\t ;]+coding:[\t ]*\\([^\t ;]+\\)"
 143                    end t)))
 144             (find-coding-system (setq codesys
 145                                       (intern (match-string 1))))
 146             codesys)
 147        (and (re-search-forward "^[\t ]*;+[\t ]*Local[\t ]+Variables:"
 148                                nil t)
 149             (progn
 150               (setq start (match-end 0))
 151               (re-search-forward "^[\t ]*;+[\t ]*End:" nil t))
 152             (progn
 153               (setq end (match-beginning 0))
 154               (goto-char start)
 155               (re-search-forward
 156                "^[\t ]*;+[\t ]*coding:[\t ]*\\([^\t\n\r ]+\\)"
 157                end t))
 158             (find-coding-system (setq codesys
 159                                       (intern (match-string 1))))
 160             codesys)
 161        (and (progn
 162               (goto-char (point-min))
 163               (setq case-fold-search nil)
 164               (re-search-forward "^;;;coding system: "
 165                                  ;;(+ (point-min) 3000) t))
 166                                  nil t))
 167             (looking-at "[^\t\n\r ]+")
 168             (find-coding-system
 169              (setq codesys (intern (match-string 0))))
 170             codesys)
 171        (and filename
 172             (setq codesys
 173                   (find-file-coding-system-for-read-from-filename
 174                    filename))
 175             (coding-system-name (coding-system-base codesys))))))))
 176
 177 (defun elmo-object-load (filename &optional mime-charset no-err)
 178   "Load OBJECT from the file specified by FILENAME.
 179 File content is decoded with MIME-CHARSET."
 180   (if (not (file-readable-p filename))
 181       nil
 182     (with-temp-buffer
 183       (insert-file-contents-as-binary filename)
 184       (let ((coding-system (or (elmo-set-auto-coding)
 185                                (mime-charset-to-coding-system
 186                                 mime-charset))))
 187         (when coding-system
 188           (decode-coding-region (point-min) (point-max) coding-system)))
 189       (goto-char (point-min))
 190       (condition-case nil
 191           (read (current-buffer))
 192         (error (unless no-err
 193                  (message "Warning: Loading object from %s failed."
 194                           filename)
 195                  (elmo-object-save filename nil mime-charset))
 196                nil)))))
 197
 198 (defsubst elmo-save-buffer (filename &optional mime-charset)
 199   "Save current buffer to the file specified by FILENAME.
 200 Directory of the file is created if it doesn't exist.
 201 File content is encoded with MIME-CHARSET."
 202   (let ((dir (directory-file-name (file-name-directory filename))))
 203     (if (file-directory-p dir)
 204         () ; ok.
 205       (unless (file-exists-p dir)
 206         (elmo-make-directory dir)))
 207     (if (file-writable-p filename)
 208         (progn
 209           (when mime-charset
 210 ;;;         (set-buffer-multibyte default-enable-multibyte-characters)
 211             (encode-mime-charset-region (point-min) (point-max) mime-charset))
 212           (as-binary-output-file
 213            (write-region (point-min) (point-max) filename nil 'no-msg)))
 214       (message "%s is not writable." filename))))
 215
 216 (defun elmo-object-save (filename object &optional mime-charset)
 217   "Save OBJECT to the file specified by FILENAME.
 218 Directory of the file is created if it doesn't exist.
 219 File content is encoded with MIME-CHARSET."
 220   (with-temp-buffer
 221     (let (print-length print-level)
 222       (prin1 object (current-buffer)))
 223     (when mime-charset
 224       (let ((coding (mime-charset-to-coding-system
 225                      (or (detect-mime-charset-region (point-min) (point-max))
 226                          mime-charset))))
 227         (goto-char (point-min))
 228         (insert ";;; -*- mode: emacs-lisp; coding: "
 229                 (symbol-name coding) " -*-\n")
 230         (encode-coding-region (point-min) (point-max) coding)))
 231     (elmo-save-buffer filename)))
 232
 233 ;;; Search Condition
 234
 235 (defconst elmo-condition-atom-regexp "[^/ \")|&]*")
 236
 237 (defsubst elmo-condition-parse-error ()
 238   (error "Syntax error in '%s'" (buffer-string)))
 239
 240 (defun elmo-parse-search-condition (condition)
 241   "Parse CONDITION.
 242 Return value is a cons cell of (STRUCTURE . REST)"
 243   (with-temp-buffer
 244     (insert condition)
 245     (goto-char (point-min))
 246     (cons (elmo-condition-parse) (buffer-substring (point) (point-max)))))
 247
 248 ;; condition    ::= or-expr
 249 (defun elmo-condition-parse ()
 250   (or (elmo-condition-parse-or-expr)
 251       (elmo-condition-parse-error)))
 252
 253 ;; or-expr      ::= and-expr /
 254 ;;                  and-expr "|" or-expr
 255 (defun elmo-condition-parse-or-expr ()
 256   (let ((left (elmo-condition-parse-and-expr)))
 257     (if (looking-at "| *")
 258         (progn
 259           (goto-char (match-end 0))
 260           (list 'or left (elmo-condition-parse-or-expr)))
 261       left)))
 262
 263 ;; and-expr     ::= primitive /
 264 ;;                  primitive "&" and-expr
 265 (defun elmo-condition-parse-and-expr ()
 266   (let ((left (elmo-condition-parse-primitive)))
 267     (if (looking-at "& *")
 268         (progn
 269           (goto-char (match-end 0))
 270           (list 'and left (elmo-condition-parse-and-expr)))
 271       left)))
 272
 273 ;; primitive    ::= "(" expr ")" /
 274 ;;                  ["!"] search-key SPACE* ":" SPACE* search-value
 275 (defun elmo-condition-parse-primitive ()
 276   (cond
 277    ((looking-at "( *")
 278     (goto-char (match-end 0))
 279     (prog1 (elmo-condition-parse)
 280       (unless (looking-at ") *")
 281         (elmo-condition-parse-error))
 282       (goto-char (match-end 0))))
 283 ;; search-key   ::= [A-Za-z-]+
 284 ;;                 ;; "since" / "before" / "last" / "first" /
 285 ;;                 ;; "body" / "flag" / field-name
 286    ((looking-at "\\(!\\)? *\\([A-Za-z-]+\\) *: *")
 287     (goto-char (match-end 0))
 288     (let ((search-key (vector
 289                        (if (match-beginning 1) 'unmatch 'match)
 290                        (downcase (elmo-match-buffer 2))
 291                        (elmo-condition-parse-search-value))))
 292       ;; syntax sugar.
 293       (if (string= (aref search-key 1) "tocc")
 294           (if (eq (aref search-key 0) 'match)
 295               (list 'or
 296                     (vector 'match "to" (aref search-key 2))
 297                     (vector 'match "cc" (aref search-key 2)))
 298             (list 'and
 299                   (vector 'unmatch "to" (aref search-key 2))
 300                   (vector 'unmatch "cc" (aref search-key 2))))
 301         search-key)))))
 302
 303 ;; search-value ::= quoted / time / number / atom
 304 ;; quoted       ::= <elisp string expression>
 305 ;; time         ::= "yesterday" / "lastweek" / "lastmonth" / "lastyear" /
 306 ;;                   number SPACE* "daysago" /
 307 ;;                   number "-" month "-" number  ; ex. 10-May-2000
 308 ;;                   number "-" number "-" number  ; ex. 2000-05-10
 309 ;; number       ::= [0-9]+
 310 ;; month        ::= "Jan" / "Feb" / "Mar" / "Apr" / "May" / "Jun" /
 311 ;;                  "Jul" / "Aug" / "Sep" / "Oct" / "Nov" / "Dec"
 312 ;; atom         ::= ATOM_CHARS*
 313 ;; SPACE        ::= <ascii space character, 0x20>
 314 ;; ATOM_CHARS   ::= <any character except specials>
 315 ;; specials     ::= SPACE / <"> / </> / <)> / <|> / <&>
 316 ;;                  ;; These characters should be quoted.
 317 (defun elmo-condition-parse-search-value ()
 318   (cond
 319    ((looking-at "\"")
 320     (read (current-buffer)))
 321    ((or (looking-at elmo-condition-atom-regexp)
 322         (looking-at "yesterday") (looking-at "lastweek")
 323         (looking-at "lastmonth") (looking-at "lastyear")
 324         (looking-at "[0-9]+ *daysago")
 325         (looking-at "[0-9]+-[A-Za-z]+-[0-9]+")
 326         (looking-at "[0-9]+-[0-9]+-[0-9]+")
 327         (looking-at "[0-9]+"))
 328     (prog1 (elmo-match-buffer 0)
 329       (goto-char (match-end 0))))
 330    (t (error "Syntax error '%s'" (buffer-string)))))
 331
 332 (defmacro elmo-filter-condition-p (filter)
 333   `(or (vectorp ,filter) (consp ,filter)))
 334
 335 (defmacro elmo-filter-type (filter)
 336   `(aref ,filter 0))
 337
 338 (defmacro elmo-filter-key (filter)
 339   `(aref ,filter 1))
 340
 341 (defmacro elmo-filter-value (filter)
 342   `(aref ,filter 2))
 343
 344 (defun elmo-condition-match (condition match-primitive args)
 345   (cond
 346    ((vectorp condition)
 347     (if (eq (elmo-filter-type condition) 'unmatch)
 348         (not (apply match-primitive condition args))
 349       (apply match-primitive condition args)))
 350    ((eq (car condition) 'and)
 351     (let ((lhs (elmo-condition-match (nth 1 condition) match-primitive args)))
 352       (cond
 353        ((elmo-filter-condition-p lhs)
 354         (let ((rhs (elmo-condition-match (nth 2 condition)
 355                                          match-primitive args)))
 356           (cond ((elmo-filter-condition-p rhs)
 357                  (list 'and lhs rhs))
 358                 (rhs
 359                  lhs))))
 360        (lhs
 361         (elmo-condition-match (nth 2 condition) match-primitive args)))))
 362    ((eq (car condition) 'or)
 363     (let ((lhs (elmo-condition-match (nth 1 condition) match-primitive args)))
 364       (cond
 365        ((elmo-filter-condition-p lhs)
 366         (let ((rhs (elmo-condition-match (nth 2 condition)
 367                                          match-primitive args)))
 368           (cond ((elmo-filter-condition-p rhs)
 369                  (list 'or lhs rhs))
 370                 (rhs
 371                  t)
 372                 (t
 373                  lhs))))
 374        (lhs
 375         t)
 376        (t
 377         (elmo-condition-match (nth 2 condition) match-primitive args)))))))
 378
 379 (defun elmo-condition-optimize (condition)
 380   (cond
 381    ((vectorp condition)
 382     (let ((key (elmo-filter-key condition)))
 383       (cond ((cdr (assoc key '(("first" . 0)
 384                                ("last"  . 0)
 385                                ("flag"  . 1)
 386                                ("body"  . 5)))))
 387             ((member key '("since" "before" "from" "subject" "to" "cc"))
 388              2)
 389             ((member key elmo-msgdb-extra-fields)
 390              3)
 391             (t
 392              4))))
 393    (t
 394     (let ((weight-l (elmo-condition-optimize (nth 1 condition)))
 395           (weight-r (elmo-condition-optimize (nth 2 condition))))
 396       (if (> weight-l weight-r)
 397           (let ((lhs (nth 1 condition)))
 398             (setcar (nthcdr 1 condition) (nth 2 condition))
 399             (setcar (nthcdr 2 condition) lhs)
 400             weight-l)
 401         weight-r)))))
 402
 403 ;;;
 404 (defsubst elmo-buffer-replace (regexp &optional newtext)
 405   (goto-char (point-min))
 406   (while (re-search-forward regexp nil t)
 407     (replace-match (or newtext ""))))
 408
 409 (defsubst elmo-delete-char (char string &optional unibyte)
 410   (save-match-data
 411     (elmo-set-work-buf
 412      (let ((coding-system-for-read 'no-conversion)
 413            (coding-system-for-write 'no-conversion))
 414        (if unibyte (set-buffer-multibyte nil))
 415        (insert string)
 416        (goto-char (point-min))
 417        (while (search-forward (char-to-string char) nil t)
 418          (replace-match ""))
 419        (buffer-string)))))
 420
 421 (defsubst elmo-delete-cr-buffer ()
 422   "Delete CR from buffer."
 423   (save-excursion
 424     (goto-char (point-min))
 425     (while (search-forward "\r\n" nil t)
 426       (replace-match "\n")) ))
 427
 428 (defsubst elmo-delete-cr-get-content-type ()
 429   (save-excursion
 430     (goto-char (point-min))
 431     (while (search-forward "\r\n" nil t)
 432       (replace-match "\n"))
 433     (goto-char (point-min))
 434     (or (std11-field-body "content-type")
 435         t)))
 436
 437 (defun elmo-delete-cr (string)
 438   (save-match-data
 439     (elmo-set-work-buf
 440      (insert string)
 441      (goto-char (point-min))
 442      (while (search-forward "\r\n" nil t)
 443        (replace-match "\n"))
 444      (buffer-string))))
 445
 446 (defun elmo-last (list)
 447   (and list (nth (1- (length list)) list)))
 448
 449 (defun elmo-set-list (vars vals)
 450   (while vars
 451     (when (car vars)
 452       (set (car vars) (car vals)))
 453     (setq vars (cdr vars)
 454           vals (cdr vals))))
 455
 456 (defun elmo-uniq-list (lst &optional delete-function)
 457   "Distractively uniqfy elements of LST."
 458   (setq delete-function (or delete-function #'delete))
 459   (let ((tmp lst))
 460     (while tmp
 461       (setq tmp
 462             (setcdr tmp
 463                     (and (cdr tmp)
 464                          (funcall delete-function
 465                                   (car tmp)
 466                                   (cdr tmp)))))))
 467   lst)
 468
 469 (defun elmo-uniq-sorted-list (list &optional equal-function)
 470   "Distractively uniqfy elements of sorted LIST."
 471   (setq equal-function (or equal-function #'equal))
 472   (let ((list list))
 473     (while list
 474       (while (funcall equal-function (car list) (cadr list))
 475         (setcdr list (cddr list)))
 476       (setq list (cdr list))))
 477   list)
 478
 479 (defun elmo-list-insert (list element after)
 480   (let* ((match (memq after list))
 481          (rest (and match (cdr (memq after list)))))
 482     (if match
 483         (progn
 484           (setcdr match (list element))
 485           (nconc list rest))
 486       (nconc list (list element)))))
 487
 488 (defun elmo-get-file-string (filename &optional remove-final-newline)
 489   (elmo-set-work-buf
 490    (let (insert-file-contents-pre-hook   ; To avoid autoconv-xmas...
 491          insert-file-contents-post-hook)
 492      (when (file-exists-p filename)
 493        (if filename
 494            (as-binary-input-file (insert-file-contents filename)))
 495        (when (and remove-final-newline
 496                   (> (buffer-size) 0)
 497                   (= (char-after (1- (point-max))) ?\n))
 498          (goto-char (point-max))
 499          (delete-backward-char 1))
 500        (buffer-string)))))
 501
 502 (defun elmo-save-string (string filename)
 503   (if string
 504       (elmo-set-work-buf
 505        (as-binary-output-file
 506         (insert string)
 507         (write-region (point-min) (point-max)
 508                       filename nil 'no-msg))
 509        )))
 510
 511 (defun elmo-max-of-list (nlist)
 512   (let ((l nlist)
 513         (max-num 0))
 514     (while l
 515       (if (< max-num (car l))
 516           (setq max-num (car l)))
 517       (setq l (cdr l)))
 518     max-num))
 519
 520 (defun elmo-concat-path (path filename)
 521   (if (not (string= path ""))
 522       (elmo-replace-in-string
 523        (if (string= elmo-path-sep (substring path (- (length path) 1)))
 524            (concat path filename)
 525          (concat path elmo-path-sep filename))
 526        (concat (regexp-quote elmo-path-sep)(regexp-quote elmo-path-sep))
 527        elmo-path-sep)
 528     filename))
 529
 530 (defvar elmo-passwd-alist nil)
 531
 532 (defun elmo-passwd-alist-load ()
 533   (with-temp-buffer
 534     (let ((filename (expand-file-name elmo-passwd-alist-file-name
 535                                       elmo-msgdb-directory))
 536           insert-file-contents-pre-hook ; To avoid autoconv-xmas...
 537           insert-file-contents-post-hook
 538           ret-val)
 539       (if (not (file-readable-p filename))
 540           ()
 541         (insert-file-contents filename)
 542         (condition-case nil
 543             (read (current-buffer))
 544           (error nil nil))))))
 545
 546 (defun elmo-passwd-alist-clear ()
 547   "Clear password cache."
 548   (interactive)
 549   (dolist (pair elmo-passwd-alist)
 550     (when (stringp (cdr-safe pair))
 551       (fillarray (cdr pair) 0)))
 552   (setq elmo-passwd-alist nil))
 553
 554 (defun elmo-passwd-alist-save ()
 555   "Save password into file."
 556   (interactive)
 557   (with-temp-buffer
 558     (let ((filename (expand-file-name elmo-passwd-alist-file-name
 559                                       elmo-msgdb-directory))
 560           print-length print-level)
 561       (prin1 elmo-passwd-alist (current-buffer))
 562       (princ "\n" (current-buffer))
 563 ;;;   (if (and (file-exists-p filename)
 564 ;;;            (not (equal 384 (file-modes filename))))
 565 ;;;       (error "%s is not safe.chmod 600 %s!" filename filename))
 566       (if (file-writable-p filename)
 567           (progn
 568             (write-region (point-min) (point-max)
 569                           filename nil 'no-msg)
 570             (set-file-modes filename 384))
 571         (message "%s is not writable." filename)))))
 572
 573 (defun elmo-get-passwd (key)
 574   "Get password from password pool."
 575   (let (pair pass)
 576     (if (not elmo-passwd-alist)
 577         (setq elmo-passwd-alist (elmo-passwd-alist-load)))
 578     (setq pair (assoc key elmo-passwd-alist))
 579     (if pair
 580         (elmo-base64-decode-string (cdr pair))
 581       (setq pass (elmo-read-passwd (format "Password for %s: "
 582                                            key) t))
 583       (setq elmo-passwd-alist
 584             (append elmo-passwd-alist
 585                     (list (cons key
 586                                 (elmo-base64-encode-string pass)))))
 587       (if elmo-passwd-life-time
 588           (run-with-timer elmo-passwd-life-time nil
 589                           (` (lambda () (elmo-remove-passwd (, key))))))
 590       pass)))
 591
 592 (defun elmo-remove-passwd (key)
 593   "Remove password from password pool (for failure)."
 594   (let (pass-cons)
 595     (while (setq pass-cons (assoc key elmo-passwd-alist))
 596       (unwind-protect
 597           (fillarray (cdr pass-cons) 0)
 598         (setq elmo-passwd-alist
 599               (delete pass-cons elmo-passwd-alist))))))
 600
 601 (defmacro elmo-read-char-exclusive ()
 602   (cond ((featurep 'xemacs)
 603          '(let ((table (quote ((backspace . ?\C-h) (delete . ?\C-?)
 604                                (left . ?\C-h))))
 605                 event key)
 606             (while (not
 607                     (and
 608                      (key-press-event-p (setq event (next-command-event)))
 609                      (setq key (or (event-to-character event)
 610                                    (cdr (assq (event-key event) table)))))))
 611             key))
 612         ((fboundp 'read-char-exclusive)
 613          '(read-char-exclusive))
 614         (t
 615          '(read-char))))
 616
 617 (defun elmo-read-passwd (prompt &optional stars)
 618   "Read a single line of text from user without echoing, and return it."
 619   (let ((ans "")
 620         (c 0)
 621         (echo-keystrokes 0)
 622         (cursor-in-echo-area t)
 623         (log-message-max-size 0)
 624         message-log-max done msg truncate)
 625     (while (not done)
 626       (if (or (not stars) (string= "" ans))
 627           (setq msg prompt)
 628         (setq msg (concat prompt (make-string (length ans) ?.)))
 629         (setq truncate
 630               (1+ (- (length msg) (window-width (minibuffer-window)))))
 631         (and (> truncate 0)
 632              (setq msg (concat "$" (substring msg (1+ truncate))))))
 633       (message "%s" msg)
 634       (setq c (elmo-read-char-exclusive))
 635       (cond ((= c ?\C-g)
 636              (setq quit-flag t
 637                    done t))
 638             ((or (= c ?\r) (= c ?\n) (= c ?\e))
 639              (setq done t))
 640             ((= c ?\C-u)
 641              (setq ans ""))
 642             ((and (/= c ?\b) (/= c ?\177))
 643              (setq ans (concat ans (char-to-string c))))
 644             ((> (length ans) 0)
 645              (setq ans (substring ans 0 -1)))))
 646     (if quit-flag
 647         (prog1
 648             (setq quit-flag nil)
 649           (message "Quit")
 650           (beep t))
 651       (message "")
 652       ans)))
 653
 654 (defun elmo-string-to-list (string)
 655   (elmo-set-work-buf
 656    (insert string)
 657    (goto-char (point-min))
 658    (insert "(")
 659    (goto-char (point-max))
 660    (insert ")")
 661    (goto-char (point-min))
 662    (read (current-buffer))))
 663
 664 (defun elmo-list-to-string (list)
 665   (let ((tlist list)
 666         str)
 667     (if (listp tlist)
 668         (progn
 669           (setq str "(")
 670           (while (car tlist)
 671             (setq str
 672                   (concat str
 673                           (if (symbolp (car tlist))
 674                               (symbol-name (car tlist))
 675                             (car tlist))))
 676             (if (cdr tlist)
 677                 (setq str
 678                       (concat str " ")))
 679             (setq tlist (cdr tlist)))
 680           (setq str
 681                 (concat str ")")))
 682       (setq str
 683             (if (symbolp tlist)
 684                 (symbol-name tlist)
 685               tlist)))
 686     str))
 687
 688
 689 (defun elmo-plug-on-by-servers (alist &optional servers)
 690   (let ((server-list (or servers elmo-plug-on-servers)))
 691     (catch 'plugged
 692       (while server-list
 693         (if (elmo-plugged-p (car server-list))
 694             (throw 'plugged t))
 695         (setq server-list (cdr server-list))))))
 696
 697 (defun elmo-plug-on-by-exclude-servers (alist &optional servers)
 698   (let ((server-list (or servers elmo-plug-on-exclude-servers))
 699         server other-servers)
 700     (while alist
 701       (when (and (not (member (setq server (caaar alist)) server-list))
 702                  (not (member server other-servers)))
 703         (push server other-servers))
 704       (setq alist (cdr alist)))
 705     (elmo-plug-on-by-servers alist other-servers)))
 706
 707 (defun elmo-plugged-p (&optional server port stream-type alist label-exp)
 708   (let ((alist (or alist elmo-plugged-alist))
 709         plugged-info)
 710     (cond ((and (not port) (not server))
 711            (cond ((eq elmo-plugged-condition 'one)
 712                   (if alist
 713                       (catch 'plugged
 714                         (while alist
 715                           (if (nth 2 (car alist))
 716                               (throw 'plugged t))
 717                           (setq alist (cdr alist))))
 718                     elmo-plugged))
 719                  ((eq elmo-plugged-condition 'all)
 720                   (if alist
 721                       (catch 'plugged
 722                         (while alist
 723                           (if (not (nth 2 (car alist)))
 724                               (throw 'plugged nil))
 725                           (setq alist (cdr alist)))
 726                         t)
 727                     elmo-plugged))
 728                  ((functionp elmo-plugged-condition)
 729                   (funcall elmo-plugged-condition alist))
 730                  (t ;; independent
 731                   elmo-plugged)))
 732           ((not port) ;; server
 733            (catch 'plugged
 734              (while alist
 735                (when (string= server (caaar alist))
 736                  (if (nth 2 (car alist))
 737                      (throw 'plugged t)))
 738                (setq alist (cdr alist)))))
 739           (t
 740            (setq plugged-info (assoc (list server port stream-type) alist))
 741            (if (not plugged-info)
 742                ;; add elmo-plugged-alist automatically
 743                (progn
 744                  (elmo-set-plugged elmo-plugged server port stream-type
 745                                    nil nil nil label-exp)
 746                  elmo-plugged)
 747              (if (and elmo-auto-change-plugged
 748                       (> elmo-auto-change-plugged 0)
 749                       (nth 3 plugged-info)  ;; time
 750                       (elmo-time-expire (nth 3 plugged-info)
 751                                         elmo-auto-change-plugged))
 752                  t
 753                (nth 2 plugged-info)))))))
 754
 755 (defun elmo-set-plugged (plugged &optional server port stream-type time
 756                                  alist label-exp add)
 757   (let ((alist (or alist elmo-plugged-alist))
 758         label plugged-info)
 759     (cond ((and (not port) (not server))
 760            (setq elmo-plugged plugged)
 761            ;; set plugged all element of elmo-plugged-alist.
 762            (while alist
 763              (setcdr (cdar alist) (list plugged time))
 764              (setq alist (cdr alist))))
 765           ((not port)
 766            ;; set plugged all port of server
 767            (while alist
 768              (when (string= server (caaar alist))
 769                (setcdr (cdar alist) (list plugged time)))
 770              (setq alist (cdr alist))))
 771           (t
 772            ;; set plugged one port of server
 773            (setq plugged-info (assoc (list server port stream-type) alist))
 774            (setq label (if label-exp
 775                            (eval label-exp)
 776                          (nth 1 plugged-info)))
 777            (if plugged-info
 778                ;; if add is non-nil, don't reset plug state.
 779                (unless add
 780                  (setcdr plugged-info (list label plugged time)))
 781              (setq alist
 782                    (setq elmo-plugged-alist
 783                          (nconc
 784                           elmo-plugged-alist
 785                           (list
 786                            (list (list server port stream-type)
 787                                  label plugged time))))))))
 788     alist))
 789
 790 (defun elmo-delete-plugged (&optional server port alist)
 791   (let* ((alist (or alist elmo-plugged-alist))
 792          (alist2 alist))
 793     (cond ((and (not port) (not server))
 794            (setq alist nil))
 795           ((not port)
 796            ;; delete plugged all port of server
 797            (while alist2
 798              (when (string= server (caaar alist2))
 799                (setq alist (delete (car alist2) alist)))
 800              (setq alist2 (cdr alist2))))
 801           (t
 802            ;; delete plugged one port of server
 803            (setq alist
 804                  (delete (assoc (cons server port) alist) alist))))
 805     alist))
 806
 807 (defun elmo-disk-usage (path)
 808   "Get disk usage (bytes) in PATH."
 809   (let ((file-attr
 810          (condition-case () (file-attributes path) (error nil))))
 811     (if file-attr
 812         (if (nth 0 file-attr) ; directory
 813             (let ((files (condition-case ()
 814                              (directory-files path t "^[^\\.]")
 815                            (error nil)))
 816                   (result 0.0))
 817               ;; (result (nth 7 file-attr))) ... directory size
 818               (while files
 819                 (setq result (+ result (or (elmo-disk-usage (car files)) 0)))
 820                 (setq files (cdr files)))
 821               result)
 822           (float (nth 7 file-attr)))
 823       0)))
 824
 825 (defun elmo-get-last-accessed-time (path &optional dir)
 826   "Return the last accessed time of PATH."
 827   (let ((last-accessed (nth 4 (file-attributes (or (and dir
 828                                                         (expand-file-name
 829                                                          path dir))
 830                                                    path)))))
 831     (if last-accessed
 832         (setq last-accessed (+ (* (nth 0 last-accessed)
 833                                   (float 65536)) (nth 1 last-accessed)))
 834       0)))
 835
 836 (defun elmo-get-last-modification-time (path &optional dir)
 837   "Return the last accessed time of PATH."
 838   (let ((last-modified (nth 5 (file-attributes (or (and dir
 839                                                         (expand-file-name
 840                                                          path dir))
 841                                                    path)))))
 842     (setq last-modified (+ (* (nth 0 last-modified)
 843                               (float 65536)) (nth 1 last-modified)))))
 844
 845 (defun elmo-make-directory (path &optional mode)
 846   "Create directory recursively."
 847   (let ((parent (directory-file-name (file-name-directory path))))
 848     (if (null (file-directory-p parent))
 849         (elmo-make-directory parent))
 850     (make-directory path)
 851     (set-file-modes path (or mode
 852                              (+ (* 64 7) (* 8 0) 0))))) ; chmod 0700
 853
 854 (defun elmo-delete-directory (path &optional no-hierarchy)
 855   "Delete directory recursively."
 856   (if (stringp path) ; nil is not permitted.
 857   (let ((dirent (directory-files path))
 858         relpath abspath hierarchy)
 859     (while dirent
 860       (setq relpath (car dirent)
 861             dirent (cdr dirent)
 862             abspath (expand-file-name relpath path))
 863       (when (not (string-match "^\\.\\.?$" relpath))
 864         (if (eq (nth 0 (file-attributes abspath)) t)
 865             (if no-hierarchy
 866                 (setq hierarchy t)
 867               (elmo-delete-directory abspath no-hierarchy))
 868           (delete-file abspath))))
 869     (unless hierarchy
 870       (delete-directory path)))))
 871
 872 (defun elmo-delete-match-files (path regexp &optional remove-if-empty)
 873   "Delete directory files specified by PATH.
 874 If optional REMOVE-IF-EMPTY is non-nil, delete directory itself if
 875 the directory becomes empty after deletion."
 876   (when (stringp path) ; nil is not permitted.
 877     (dolist (file (directory-files path t regexp))
 878       (delete-file file))
 879     (if remove-if-empty
 880         (ignore-errors
 881           (delete-directory path) ; should be removed if empty.
 882           ))))
 883
 884 (defun elmo-list-filter (l1 l2)
 885   "Rerurn a list from L2 in which each element is a member of L1."
 886   (elmo-delete-if (lambda (x) (not (memq x l1))) l2))
 887
 888 (defsubst elmo-list-delete-if-smaller (list number)
 889   (let ((ret-val (copy-sequence list)))
 890     (while list
 891       (if (< (car list) number)
 892           (setq ret-val (delq (car list) ret-val)))
 893       (setq list (cdr list)))
 894     ret-val))
 895
 896 (defun elmo-list-diff (list1 list2)
 897   (let ((clist1 (sort (copy-sequence list1) #'<))
 898         (clist2 (sort (copy-sequence list2) #'<))
 899         list1-only list2-only)
 900     (while (or clist1 clist2)
 901       (cond
 902        ((null clist1)
 903         (while clist2
 904           (setq list2-only (cons (car clist2) list2-only))
 905           (setq clist2 (cdr clist2))))
 906        ((null clist2)
 907         (while clist1
 908           (setq list1-only (cons (car clist1) list1-only))
 909           (setq clist1 (cdr clist1))))
 910        ((< (car clist1) (car clist2))
 911         (while (and clist1 (< (car clist1) (car clist2)))
 912           (setq list1-only (cons (car clist1) list1-only))
 913           (setq clist1 (cdr clist1))))
 914        ((< (car clist2) (car clist1))
 915         (while (and clist2 (< (car clist2) (car clist1)))
 916           (setq list2-only (cons (car clist2) list2-only))
 917           (setq clist2 (cdr clist2))))
 918        ((= (car clist1) (car clist2))
 919         (setq clist1 (cdr clist1)
 920               clist2 (cdr clist2)))))
 921     (list list1-only list2-only)))
 922
 923 (defun elmo-list-diff-nonsortable (list1 list2)
 924   (let ((clist1 (copy-sequence list1))
 925         (clist2 (copy-sequence list2)))
 926     (while list2
 927       (setq clist1 (delq (car list2) clist1))
 928       (setq list2 (cdr list2)))
 929     (while list1
 930       (setq clist2 (delq (car list1) clist2))
 931       (setq list1 (cdr list1)))
 932     (list clist1 clist2)))
 933
 934 (defun elmo-list-bigger-diff (list1 list2 &optional mes)
 935   "Returns a list (- +). + is bigger than max of LIST1, in LIST2."
 936   (if (null list2)
 937       (cons list1  nil)
 938     (let* ((l1 list1)
 939            (l2 list2)
 940            (max-of-l2 (or (nth (max 0 (1- (length l2))) l2) 0))
 941            diff1 num i percent
 942            )
 943       (setq i 0)
 944       (setq num (+ (length l1)))
 945       (while l1
 946         (if (memq (car l1) l2)
 947             (if (eq (car l1) (car l2))
 948                 (setq l2 (cdr l2))
 949               (delq (car l1) l2))
 950           (if (> (car l1) max-of-l2)
 951               (setq diff1 (nconc diff1 (list (car l1))))))
 952         (if mes
 953             (progn
 954               (setq i (+ i 1))
 955               (setq percent (/ (* i 100) num))
 956               (if (eq (% percent 5) 0)
 957                   (elmo-display-progress
 958                    'elmo-list-bigger-diff "%s%d%%" percent mes))))
 959         (setq l1 (cdr l1)))
 960       (cons diff1 (list l2)))))
 961
 962 (defmacro elmo-get-hash-val (string hashtable)
 963   (static-if (fboundp 'unintern)
 964       `(symbol-value (intern-soft ,string ,hashtable))
 965     `(let ((sym (intern-soft ,string ,hashtable)))
 966        (and (boundp sym)
 967             (symbol-value sym)))))
 968
 969 (defmacro elmo-set-hash-val (string value hashtable)
 970   `(set (intern ,string ,hashtable) ,value))
 971
 972 (defmacro elmo-clear-hash-val (string hashtable)
 973   (static-if (fboundp 'unintern)
 974       (list 'unintern string hashtable)
 975     (list 'makunbound (list 'intern string hashtable))))
 976
 977 (defmacro elmo-unintern (string)
 978   "`unintern' symbol named STRING,  When can use `unintern'.
 979 Emacs 19.28 or earlier does not have `unintern'."
 980   (static-if (fboundp 'unintern)
 981       (list 'unintern string)))
 982
 983 (defun elmo-make-hash (&optional hashsize)
 984   "Make a new hash table which have HASHSIZE size."
 985   (make-vector
 986    (if hashsize
 987        (max
 988         ;; Prime numbers as lengths tend to result in good
 989         ;; hashing; lengths one less than a power of two are
 990         ;; also good.
 991         (min
 992          (let ((i 1))
 993            (while (< (- i 1) hashsize)
 994              (setq i (* 2 i)))
 995            (- i 1))
 996          elmo-hash-maximum-size)
 997         elmo-hash-minimum-size)
 998      elmo-hash-minimum-size)
 999    0))
1000
1001 (defsubst elmo-mime-string (string)
1002   "Normalize MIME encoded STRING."
1003   (and string
1004        (elmo-with-enable-multibyte
1005          (encode-mime-charset-string
1006           (or (ignore-errors
1007                (eword-decode-and-unfold-unstructured-field-body string))
1008               string)
1009           elmo-mime-charset))))
1010
1011 (defsubst elmo-collect-field (beg end downcase-field-name)
1012   (save-excursion
1013     (save-restriction
1014       (narrow-to-region beg end)
1015       (goto-char (point-min))
1016       (let ((regexp (concat "\\(" std11-field-head-regexp "\\)[ \t]*"))
1017             dest name body)
1018         (while (re-search-forward regexp nil t)
1019           (setq name (buffer-substring-no-properties
1020                       (match-beginning 1)(1- (match-end 1))))
1021           (if downcase-field-name
1022               (setq name (downcase name)))
1023           (setq body (buffer-substring-no-properties
1024                       (match-end 0) (std11-field-end)))
1025           (or (assoc name dest)
1026               (setq dest (cons (cons name body) dest))))
1027         dest))))
1028
1029 (defsubst elmo-collect-field-from-string (string downcase-field-name)
1030   (with-temp-buffer
1031     (insert string)
1032     (goto-char (point-min))
1033     (let ((regexp (concat "\\(" std11-field-head-regexp "\\)[ \t]*"))
1034           dest name body)
1035       (while (re-search-forward regexp nil t)
1036         (setq name (buffer-substring-no-properties
1037                     (match-beginning 1)(1- (match-end 1))))
1038         (if downcase-field-name
1039             (setq name (downcase name)))
1040         (setq body (buffer-substring-no-properties
1041                     (match-end 0) (std11-field-end)))
1042         (or (assoc name dest)
1043             (setq dest (cons (cons name body) dest))))
1044       dest)))
1045
1046 (defun elmo-safe-filename (filename)
1047   (let* ((replace-alist '(("/" . " ")
1048                           (":" . "__")
1049                           ("|" . "_or_")
1050                           ("\"" . "_Q_")))
1051          (regexp (concat "["
1052                          (regexp-quote (mapconcat 'car replace-alist ""))
1053                          "]"))
1054          (rest filename)
1055          converted)
1056     (while (string-match regexp rest)
1057       (setq converted (concat converted
1058                               (substring rest 0 (match-beginning 0))
1059                               (cdr (assoc (substring rest
1060                                                      (match-beginning 0)
1061                                                      (match-end 0))
1062                                           replace-alist)))
1063             rest (substring rest (match-end 0))))
1064     (concat converted rest)))
1065
1066 (defvar elmo-filename-replace-chars nil)
1067
1068 (defsubst elmo-replace-string-as-filename (msgid)
1069   "Replace string as filename."
1070   (setq msgid (elmo-replace-in-string msgid " " "  "))
1071   (if (null elmo-filename-replace-chars)
1072       (setq elmo-filename-replace-chars
1073             (regexp-quote (mapconcat
1074                            'car elmo-filename-replace-string-alist ""))))
1075   (while (string-match (concat "[" elmo-filename-replace-chars "]")
1076                        msgid)
1077     (setq msgid (concat
1078                  (substring msgid 0 (match-beginning 0))
1079                  (cdr (assoc
1080                        (substring msgid
1081                                   (match-beginning 0) (match-end 0))
1082                        elmo-filename-replace-string-alist))
1083                  (substring msgid (match-end 0)))))
1084   msgid)
1085
1086 (defsubst elmo-recover-string-from-filename (filename)
1087   "Recover string from FILENAME."
1088   (let (tmp result)
1089     (while (string-match " " filename)
1090       (setq tmp (substring filename
1091                            (match-beginning 0)
1092                            (+ (match-end 0) 1)))
1093       (if (string= tmp "  ")
1094           (setq tmp " ")
1095         (setq tmp (car (rassoc tmp
1096                                elmo-filename-replace-string-alist))))
1097       (setq result
1098             (concat result
1099                     (substring filename 0 (match-beginning 0))
1100                     tmp))
1101       (setq filename (substring filename (+ (match-end 0) 1))))
1102     (concat result filename)))
1103
1104 (defsubst elmo-copy-file (src dst &optional ok-if-already-exists)
1105   (condition-case err
1106       (elmo-add-name-to-file src dst ok-if-already-exists)
1107     (error (copy-file src dst ok-if-already-exists t))))
1108
1109 (defsubst elmo-buffer-exists-p (buffer)
1110   (if (bufferp buffer)
1111       (buffer-live-p buffer)
1112     (get-buffer buffer)))
1113
1114 (defsubst elmo-kill-buffer (buffer)
1115   (when (elmo-buffer-exists-p buffer)
1116     (kill-buffer buffer)))
1117
1118 (defun elmo-delete-if (pred lst)
1119   "Return new list contain items which don't satisfy PRED in LST."
1120   (let (result)
1121     (while lst
1122       (unless (funcall pred (car lst))
1123         (setq result (cons (car lst) result)))
1124       (setq lst (cdr lst)))
1125     (nreverse result)))
1126
1127 (defun elmo-list-delete (list1 list2 &optional delete-function)
1128   "Delete by side effect any occurrences equal to elements of LIST1 from LIST2.
1129 Return the modified LIST2.  Deletion is done with `delete'.
1130 Write `(setq foo (elmo-list-delete bar foo))' to be sure of changing
1131 the value of `foo'.
1132 If optional DELETE-FUNCTION is speficied, it is used as delete procedure."
1133   (setq delete-function (or delete-function 'delete))
1134   (while list1
1135     (setq list2 (funcall delete-function (car list1) list2))
1136     (setq list1 (cdr list1)))
1137   list2)
1138
1139 (defun elmo-list-member (list1 list2)
1140   "If any element of LIST1 is member of LIST2, return t."
1141   (catch 'done
1142     (while list1
1143       (if (member (car list1) list2)
1144           (throw 'done t))
1145       (setq list1 (cdr list1)))))
1146
1147 (defun elmo-count-matches (regexp beg end)
1148   (let ((count 0))
1149     (save-excursion
1150       (goto-char beg)
1151       (while (re-search-forward regexp end t)
1152         (setq count (1+ count)))
1153       count)))
1154
1155 (if (fboundp 'display-error)
1156     (defalias 'elmo-display-error 'display-error)
1157   (defun elmo-display-error (error-object stream)
1158     "A tiny function to display ERROR-OBJECT to the STREAM."
1159     (let ((first t)
1160           (errobj error-object)
1161           err-mes)
1162       (while errobj
1163         (setq err-mes (concat err-mes (format
1164                                        (if (stringp (car errobj))
1165                                            "%s"
1166                                          "%S")
1167                                        (car errobj))))
1168         (setq errobj (cdr errobj))
1169         (if errobj (setq err-mes (concat err-mes (if first ": " ", "))))
1170         (setq first nil))
1171       (princ err-mes stream))))
1172
1173 (if (fboundp 'define-error)
1174     (defalias 'elmo-define-error 'define-error)
1175   (defun elmo-define-error (error doc &optional parents)
1176     (or parents
1177         (setq parents 'error))
1178     (let ((conds (get parents 'error-conditions)))
1179       (or conds
1180           (error "Not an error symbol: %s" error))
1181       (setplist error
1182                 (list 'error-message doc
1183                       'error-conditions (cons error conds))))))
1184
1185 (cond ((fboundp 'progress-feedback-with-label)
1186        (defalias 'elmo-display-progress 'progress-feedback-with-label))
1187       ((fboundp 'lprogress-display)
1188        (defalias 'elmo-display-progress 'lprogress-display))
1189       (t
1190        (defun elmo-display-progress (label format &optional value &rest args)
1191          "Print a progress message."
1192          (if (and (null format) (null args))
1193              (message nil)
1194            (apply (function message) (concat format " %d%%")
1195                   (nconc args (list value)))))))
1196
1197 (defvar elmo-progress-counter-alist nil)
1198
1199 (defmacro elmo-progress-counter-value (counter)
1200   (` (aref (cdr (, counter)) 0)))
1201
1202 (defmacro elmo-progress-counter-all-value (counter)
1203   (` (aref (cdr (, counter)) 1)))
1204
1205 (defmacro elmo-progress-counter-format (counter)
1206   (` (aref (cdr (, counter)) 2)))
1207
1208 (defmacro elmo-progress-counter-set-value (counter value)
1209   (` (aset (cdr (, counter)) 0 (, value))))
1210
1211 (defun elmo-progress-set (label all-value &optional format)
1212   (unless (assq label elmo-progress-counter-alist)
1213     (setq elmo-progress-counter-alist
1214           (cons (cons label (vector 0 all-value (or format "")))
1215                 elmo-progress-counter-alist))))
1216
1217 (defun elmo-progress-clear (label)
1218   (let ((counter (assq label elmo-progress-counter-alist)))
1219     (when counter
1220       (elmo-display-progress label
1221                              (elmo-progress-counter-format counter)
1222                              100)
1223       (setq elmo-progress-counter-alist
1224             (delq counter elmo-progress-counter-alist)))))
1225
1226 (defun elmo-progress-notify (label &optional value op &rest args)
1227   (let ((counter (assq label elmo-progress-counter-alist)))
1228     (when counter
1229       (let* ((value (or value 1))
1230              (cur-value (elmo-progress-counter-value counter))
1231              (all-value (elmo-progress-counter-all-value counter))
1232              (new-value (if (eq op 'set) value (+ cur-value value)))
1233              (cur-rate (/ (* cur-value 100) all-value))
1234              (new-rate (/ (* new-value 100) all-value)))
1235         (elmo-progress-counter-set-value counter new-value)
1236         (unless (= cur-rate new-rate)
1237           (apply 'elmo-display-progress
1238                  label
1239                  (elmo-progress-counter-format counter)
1240                  new-rate
1241                  args))
1242         (when (>= new-rate 100)
1243           (elmo-progress-clear label))))))
1244
1245 (put 'elmo-with-progress-display 'lisp-indent-function '2)
1246 (def-edebug-spec elmo-with-progress-display
1247   (form (symbolp form &optional form) &rest form))
1248
1249 (defmacro elmo-with-progress-display (condition spec &rest body)
1250   "Evaluate BODY with progress gauge if CONDITION is non-nil.
1251 SPEC is a list as followed (LABEL MAX-VALUE [FORMAT])."
1252   (let ((label (car spec))
1253         (max-value (cadr spec))
1254         (fmt (caddr spec)))
1255     `(unwind-protect
1256          (progn
1257            (when ,condition
1258              (elmo-progress-set (quote ,label) ,max-value ,fmt))
1259            ,@body)
1260        (elmo-progress-clear (quote ,label)))))
1261
1262 (defun elmo-time-expire (before-time diff-time)
1263   (let* ((current (current-time))
1264          (rest (when (< (nth 1 current) (nth 1 before-time))
1265                  (expt 2 16)))
1266          diff)
1267     (setq diff
1268           (list (- (+ (car current) (if rest -1 0)) (car before-time))
1269                 (- (+ (or rest 0) (nth 1 current)) (nth 1 before-time))))
1270     (and (eq (car diff) 0)
1271          (< diff-time (nth 1 diff)))))
1272
1273 (if (fboundp 'std11-fetch-field)
1274     (defalias 'elmo-field-body 'std11-fetch-field) ;;no narrow-to-region
1275   (defalias 'elmo-field-body 'std11-field-body))
1276
1277 (defun elmo-unfold-field-body (name)
1278   (let ((value (elmo-field-body name)))
1279     (and value
1280          (std11-unfold-string value))))
1281
1282 (defun elmo-decoded-field-body (field-name &optional mode)
1283   (let ((field-body (elmo-field-body field-name)))
1284     (and field-body
1285          (or (ignore-errors
1286               (elmo-with-enable-multibyte
1287                 (mime-decode-field-body field-body field-name mode)))
1288              field-body))))
1289
1290 (defun elmo-address-quote-specials (word)
1291   "Make quoted string of WORD if needed."
1292   (let ((lal (std11-lexical-analyze word)))
1293     (if (or (assq 'specials lal)
1294             (assq 'domain-literal lal))
1295         (prin1-to-string word)
1296       word)))
1297
1298 (defmacro elmo-string (string)
1299   "STRING without text property."
1300   (` (let ((obj (copy-sequence (, string))))
1301        (and obj (set-text-properties 0 (length obj) nil obj))
1302        obj)))
1303
1304 (defun elmo-flatten (list-of-list)
1305   "Flatten LIST-OF-LIST."
1306   (unless (null list-of-list)
1307     (append (if (and (car list-of-list)
1308                      (listp (car list-of-list)))
1309                 (car list-of-list)
1310               (list (car list-of-list)))
1311             (elmo-flatten (cdr list-of-list)))))
1312
1313 (defun elmo-y-or-n-p (prompt &optional auto default)
1314   "Same as `y-or-n-p'.
1315 But if optional argument AUTO is non-nil, DEFAULT is returned."
1316   (if auto
1317       default
1318     (y-or-n-p prompt)))
1319
1320 (defun elmo-string-member (string slist)
1321   (catch 'found
1322     (dolist (element slist)
1323       (cond ((null element))
1324             ((stringp element)
1325              (when (string= string element)
1326                (throw 'found t)))
1327             ((symbolp element)
1328              (when (string= string (symbol-value element))
1329                (throw 'found t)))))))
1330
1331 (static-cond ((fboundp 'member-ignore-case)
1332        (defalias 'elmo-string-member-ignore-case 'member-ignore-case))
1333       ((fboundp 'compare-strings)
1334        (defun elmo-string-member-ignore-case (elt list)
1335          "Like `member', but ignores differences in case and text representation.
1336 ELT must be a string.  Upper-case and lower-case letters are treated as equal.
1337 Unibyte strings are converted to multibyte for comparison."
1338          (while (and list (not (eq t (compare-strings elt 0 nil (car list) 0 nil t))))
1339            (setq list (cdr list)))
1340          list))
1341       (t
1342        (defun elmo-string-member-ignore-case (elt list)
1343          "Like `member', but ignores differences in case and text representation.
1344 ELT must be a string.  Upper-case and lower-case letters are treated as equal."
1345          (let ((str (downcase elt)))
1346            (while (and list (not (string= str (downcase (car list)))))
1347              (setq list (cdr list)))
1348            list))))
1349
1350 (defun elmo-string-match-member (str list &optional case-ignore)
1351   (let ((case-fold-search case-ignore))
1352     (catch 'member
1353       (while list
1354         (if (string-match (car list) str)
1355             (throw 'member (car list)))
1356         (setq list (cdr list))))))
1357
1358 (defun elmo-string-matched-member (str list &optional case-ignore)
1359   (let ((case-fold-search case-ignore))
1360     (catch 'member
1361       (while list
1362         (if (string-match str (car list))
1363             (throw 'member (car list)))
1364         (setq list (cdr list))))))
1365
1366 (defsubst elmo-string-delete-match (string pos)
1367   (concat (substring string
1368                      0 (match-beginning pos))
1369           (substring string
1370                      (match-end pos)
1371                      (length string))))
1372
1373 (defun elmo-string-match-assoc (key alist &optional case-ignore)
1374   (let ((case-fold-search case-ignore)
1375         a)
1376     (catch 'loop
1377       (while alist
1378         (setq a (car alist))
1379         (if (and (consp a)
1380                  (stringp (car a))
1381                  (string-match key (car a)))
1382             (throw 'loop a))
1383         (setq alist (cdr alist))))))
1384
1385 (defun elmo-string-matched-assoc (key alist &optional case-ignore)
1386   (let ((case-fold-search case-ignore)
1387         a)
1388     (catch 'loop
1389       (while alist
1390         (setq a (car alist))
1391         (if (and (consp a)
1392                  (stringp (car a))
1393                  (string-match (car a) key))
1394             (throw 'loop a))
1395         (setq alist (cdr alist))))))
1396
1397 (defun elmo-string-assoc (key alist)
1398   (let (a)
1399     (catch 'loop
1400       (while alist
1401         (setq a (car alist))
1402         (if (and (consp a)
1403                  (stringp (car a))
1404                  (string= key (car a)))
1405             (throw 'loop a))
1406         (setq alist (cdr alist))))))
1407
1408 (defun elmo-string-assoc-all (key alist)
1409   (let (matches)
1410     (while alist
1411       (if (string= key (car (car alist)))
1412           (setq matches
1413                 (cons (car alist)
1414                       matches)))
1415       (setq alist (cdr alist)))
1416     matches))
1417
1418 (defun elmo-string-rassoc (key alist)
1419   (let (a)
1420     (catch 'loop
1421       (while alist
1422         (setq a (car alist))
1423         (if (and (consp a)
1424                  (stringp (cdr a))
1425                  (string= key (cdr a)))
1426             (throw 'loop a))
1427         (setq alist (cdr alist))))))
1428
1429 (defun elmo-string-rassoc-all (key alist)
1430   (let (matches)
1431     (while alist
1432       (if (string= key (cdr (car alist)))
1433           (setq matches
1434                 (cons (car alist)
1435                       matches)))
1436       (setq alist (cdr alist)))
1437     matches))
1438
1439 (defun elmo-expand-newtext (newtext original)
1440   (let ((len (length newtext))
1441         (pos 0)
1442         c expanded beg N did-expand)
1443     (while (< pos len)
1444       (setq beg pos)
1445       (while (and (< pos len)
1446                   (not (= (aref newtext pos) ?\\)))
1447         (setq pos (1+ pos)))
1448       (unless (= beg pos)
1449         (push (substring newtext beg pos) expanded))
1450       (when (< pos len)
1451         ;; We hit a \; expand it.
1452         (setq did-expand t
1453               pos (1+ pos)
1454               c (aref newtext pos))
1455         (if (not (or (= c ?\&)
1456                      (and (>= c ?1)
1457                           (<= c ?9))))
1458             ;; \ followed by some character we don't expand.
1459             (push (char-to-string c) expanded)
1460           ;; \& or \N
1461           (if (= c ?\&)
1462               (setq N 0)
1463             (setq N (- c ?0)))
1464           (when (match-beginning N)
1465             (push (substring original (match-beginning N) (match-end N))
1466                   expanded))))
1467       (setq pos (1+ pos)))
1468     (if did-expand
1469         (apply (function concat) (nreverse expanded))
1470       newtext)))
1471
1472 ;;; Folder parser utils.
1473 (defconst elmo-quoted-specials-list '(?\\ ?\"))
1474
1475 (defun elmo-quoted-token (string)
1476   (concat "\""
1477           (std11-wrap-as-quoted-pairs string elmo-quoted-specials-list)
1478           "\""))
1479
1480 (defun elmo-token-valid-p (token requirement)
1481   (cond ((null requirement))
1482         ((stringp requirement)
1483          (string-match requirement token))
1484         ((functionp requirement)
1485          (funcall requirement token))))
1486
1487 (defun elmo-parse-token (string &optional seps requirement)
1488   "Parse atom from STRING using SEPS as a string of separator char list."
1489   (let ((len (length string))
1490         (seps (and seps (string-to-char-list seps)))
1491         (i 0)
1492         (sep nil)
1493         content c in)
1494     (if (eq len 0)
1495         (cons "" "")
1496       (while (and (< i len) (or in (null sep)))
1497         (setq c (aref string i))
1498         (cond
1499          ((and in (eq c ?\\))
1500           (setq i (1+ i)
1501                 content (cons (aref string i) content)
1502                 i (1+ i)))
1503          ((eq c ?\")
1504           (setq in (not in)
1505                 i (1+ i)))
1506          (in (setq content (cons c content)
1507                    i (1+ i)))
1508          ((memq c seps)
1509           (setq sep c))
1510          (t (setq content (cons c content)
1511                   i (1+ i)))))
1512       (if in (error "Parse error in quoted"))
1513       (let ((atom (if (null content)
1514                       ""
1515                     (char-list-to-string (nreverse content)))))
1516         (if (elmo-token-valid-p atom requirement)
1517             (cons atom (substring string i))
1518           (cons "" string))))))
1519
1520 (defun elmo-parse-prefixed-element (prefix string &optional seps requirement)
1521   (let (parsed)
1522     (if (and (not (eq (length string) 0))
1523              (eq (aref string 0) prefix)
1524              (setq parsed (elmo-parse-token (substring string 1) seps))
1525              (elmo-token-valid-p (car parsed) requirement))
1526         parsed
1527       (cons "" string))))
1528
1529 (defun elmo-collect-separators (spec)
1530   (when (listp spec)
1531     (let ((result (elmo-collect-separators-internal spec)))
1532       (and result
1533            (char-list-to-string (elmo-uniq-list result #'delq))))))
1534
1535 (defun elmo-collect-separators-internal (specs)
1536   (let (separators)
1537     (while specs
1538       (let ((spec (car specs)))
1539         (cond
1540          ((listp spec)
1541           (setq separators (nconc (elmo-collect-separators-internal spec)
1542                                   separators)
1543                 specs (cdr specs)))
1544          ((characterp spec)
1545           (setq separators (cons spec separators)
1546                 specs nil))
1547          (t
1548           (setq specs nil)))))
1549     separators))
1550
1551 (defun elmo-collect-trail-separators (element specs)
1552   (cond
1553    ((symbolp specs)
1554     (eq specs element))
1555    ((vectorp specs)
1556     (eq (aref specs 0) element))
1557    ((listp specs)
1558     (let (spec result)
1559       (while (setq spec (car specs))
1560         (if (setq result (elmo-collect-trail-separators element spec))
1561             (setq result (concat (if (stringp result) result)
1562                                  (elmo-collect-separators (cdr specs)))
1563                   specs nil)
1564           (setq specs (cdr specs))))
1565       result))))
1566
1567 (defun elmo-parse-separated-tokens (string spec)
1568   (let ((result (elmo-parse-separated-tokens-internal string spec)))
1569     (if (eq (car result) t)
1570         (cons nil (cdr result))
1571       result)))
1572
1573 (defun elmo-parse-separated-tokens-internal (string spec &optional separators)
1574   (cond
1575    ((symbolp spec)
1576     (let ((parse (elmo-parse-token string separators)))
1577       (cons (list (cons spec (car parse))) (cdr parse))))
1578    ((vectorp spec)
1579     (let ((parse (elmo-parse-token string separators)))
1580       (if (elmo-token-valid-p (car parse) (aref spec 1))
1581           (cons (list (cons (aref spec 0) (car parse))) (cdr parse))
1582         (cons nil string))))
1583    ((characterp spec)
1584     (if (and (> (length string) 0)
1585              (eq (aref string 0) spec))
1586         (cons t (substring string 1))
1587       (cons nil string)))
1588    ((listp spec)
1589     (catch 'unmatch
1590       (let ((rest string)
1591             result tokens)
1592         (while spec
1593           (setq result (elmo-parse-separated-tokens-internal
1594                         rest
1595                         (car spec)
1596                         (concat (elmo-collect-separators (cdr spec))
1597                                 separators)))
1598           (cond ((null (car result))
1599                  (throw 'unmatch (cons t string)))
1600                 ((eq t (car result)))
1601                 (t
1602                  (setq tokens (nconc (car result) tokens))))
1603           (setq rest (cdr result)
1604                 spec (cdr spec)))
1605         (cons (or tokens t) rest))))))
1606
1607 (defun elmo-quote-syntactical-element (value element syntax)
1608   (let ((separators (elmo-collect-trail-separators element syntax)))
1609     (if (and separators
1610              (string-match (concat "[" separators "]") value))
1611         (elmo-quoted-token value)
1612       value)))
1613
1614 ;;; Number set defined by OKAZAKI Tetsurou <okazaki@be.to>
1615 ;;
1616 ;; number          ::= [0-9]+
1617 ;; beg             ::= number
1618 ;; end             ::= number
1619 ;; number-range    ::= "(" beg " . " end ")"      ;; cons cell
1620 ;; number-set-elem ::= number / number-range
1621 ;; number-set      ::= "(" *number-set-elem ")"   ;; list
1622
1623 (defun elmo-number-set-member (number number-set)
1624   "Return non-nil if NUMBER is an element of NUMBER-SET.
1625 The value is actually the tail of NUMBER-RANGE whose car contains NUMBER."
1626   (or (memq number number-set)
1627       (let (found)
1628         (while (and number-set (not found))
1629           (if (and (consp (car number-set))
1630                    (and (<= (car (car number-set)) number)
1631                         (<= number (cdr (car number-set)))))
1632               (setq found t)
1633             (setq number-set (cdr number-set))))
1634         number-set)))
1635
1636 (defun elmo-number-set-append-list (number-set list)
1637   "Append LIST of numbers to the NUMBER-SET.
1638 NUMBER-SET is altered."
1639   (let ((appended number-set))
1640     (while list
1641       (setq appended (elmo-number-set-append appended (car list)))
1642       (setq list (cdr list)))
1643     appended))
1644
1645 (defun elmo-number-set-append (number-set number)
1646   "Append NUMBER to the NUMBER-SET.
1647 NUMBER-SET is altered."
1648   (let ((number-set-1 number-set)
1649         found elem)
1650     (while (and number-set (not found))
1651       (setq elem (car number-set))
1652       (cond
1653        ((and (consp elem)
1654              (eq (+ 1 (cdr elem)) number))
1655         (setcdr elem number)
1656         (setq found t))
1657        ((and (integerp elem)
1658              (eq (+ 1 elem) number))
1659         (setcar number-set (cons elem number))
1660         (setq found t))
1661        ((or (and (integerp elem) (eq elem number))
1662             (and (consp elem)
1663                  (<= (car elem) number)
1664                  (<= number (cdr elem))))
1665         (setq found t)))
1666       (setq number-set (cdr number-set)))
1667     (if (not found)
1668         (setq number-set-1 (nconc number-set-1 (list number))))
1669     number-set-1))
1670
1671 (defun elmo-number-set-delete-list (number-set list)
1672   "Delete LIST of numbers from the NUMBER-SET.
1673 NUMBER-SET is altered."
1674   (let ((deleted number-set))
1675     (dolist (number list)
1676       (setq deleted (elmo-number-set-delete deleted number)))
1677     deleted))
1678
1679 (defun elmo-number-set-delete (number-set number)
1680   "Delete NUMBER from the NUMBER-SET.
1681 NUMBER-SET is altered."
1682   (let* ((curr number-set)
1683          (top (cons 'dummy number-set))
1684          (prev top)
1685          elem found)
1686     (while (and curr (not found))
1687       (setq elem (car curr))
1688       (if (consp elem)
1689           (cond
1690            ((eq (car elem) number)
1691             (if (eq (cdr elem) (1+ number))
1692                 (setcar curr (cdr elem))
1693               (setcar elem (1+ number)))
1694             (setq found t))
1695            ((eq (cdr elem) number)
1696             (if (eq (car elem) (1- number))
1697                 (setcar curr (car elem))
1698               (setcdr elem (1- number)))
1699             (setq found t))
1700            ((and (> number (car elem))
1701                  (< number (cdr elem)))
1702             (setcdr
1703              prev
1704              (nconc
1705               (list
1706                ;; (beg . (1- number))
1707                (let ((new (cons (car elem) (1- number))))
1708                  (if (eq (car new) (cdr new))
1709                      (car new)
1710                    new))
1711                ;; ((1+ number) . end)
1712                (let ((new (cons (1+ number) (cdr elem))))
1713                  (if (eq (car new) (cdr new))
1714                      (car new)
1715                    new)))
1716               (cdr curr)))))
1717         (when (eq elem number)
1718           (setcdr prev (cdr curr))
1719           (setq found t)))
1720       (setq prev curr
1721             curr (cdr curr)))
1722     (cdr top)))
1723
1724 (defun elmo-make-number-list (beg end)
1725   (let (number-list i)
1726     (setq i end)
1727     (while (>= i beg)
1728       (setq number-list (cons i number-list))
1729       (setq i (1- i)))
1730     number-list))
1731
1732 (defun elmo-number-set-to-number-list (number-set)
1733   "Return a number list which corresponds to NUMBER-SET."
1734   (let ((number-list (list 'dummy))
1735         elem)
1736     (while number-set
1737       (setq elem (car number-set))
1738       (cond
1739        ((consp elem)
1740         (nconc number-list (elmo-make-number-list (car elem) (cdr elem))))
1741        ((integerp elem)
1742         (nconc number-list (list elem))))
1743       (setq number-set (cdr number-set)))
1744     (cdr number-list)))
1745
1746 (defcustom elmo-list-subdirectories-ignore-regexp "^\\(\\.\\.?\\|[0-9]+\\)$"
1747   "*Regexp to filter subfolders."
1748   :type 'regexp
1749   :group 'elmo)
1750
1751 (defun elmo-list-subdirectories-1 (basedir curdir one-level)
1752   (let ((root (zerop (length curdir)))
1753         (w32-get-true-file-link-count t) ; for Meadow
1754         attr dirs dir)
1755     (catch 'done
1756       (dolist (file (directory-files (setq dir (expand-file-name curdir basedir))))
1757         (when (and (not (string-match
1758                          elmo-list-subdirectories-ignore-regexp
1759                          file))
1760                    (car (setq attr (file-attributes
1761                                     (expand-file-name file dir)))))
1762           (when (eq one-level 'check) (throw 'done t))
1763           (let ((relpath
1764                  (concat curdir (and (not root) elmo-path-sep) file))
1765                 subdirs)
1766             (setq dirs (nconc dirs
1767                               (if (if elmo-have-link-count (< 2 (nth 1 attr))
1768                                     (setq subdirs
1769                                           (elmo-list-subdirectories-1
1770                                            basedir
1771                                            relpath
1772                                            (if one-level 'check))))
1773                                   (if one-level
1774                                       (list (list relpath))
1775                                     (cons relpath
1776                                           (or subdirs
1777                                               (elmo-list-subdirectories-1
1778                                                basedir
1779                                                relpath
1780                                                nil))))
1781                                 (list relpath)))))))
1782       dirs)))
1783
1784 (defun elmo-list-subdirectories (directory file one-level)
1785   (let ((subdirs (elmo-list-subdirectories-1 directory file one-level)))
1786     (if (zerop (length file))
1787         subdirs
1788       (cons file subdirs))))
1789
1790 (defun elmo-mapcar-list-of-list (func list-of-list)
1791   (mapcar
1792    (lambda (x)
1793      (cond ((listp x) (elmo-mapcar-list-of-list func x))
1794            (t (funcall func x))))
1795    list-of-list))
1796
1797 (defun elmo-map-recursive (function object)
1798   (if (consp object)
1799       (let* ((prev (list 'dummy))
1800              (result prev))
1801         (while (consp object)
1802           (setq prev (setcdr prev (list (elmo-map-recursive function
1803                                                             (car object))))
1804                 object (cdr object)))
1805         (when object
1806           (setcdr prev (funcall function object)))
1807         (cdr result))
1808     (funcall function object)))
1809
1810 (defun elmo-parse (string regexp &optional matchn)
1811   (or matchn (setq matchn 1))
1812   (let (list)
1813     (store-match-data nil)
1814     (while (string-match regexp string (match-end 0))
1815       (setq list (cons (substring string (match-beginning matchn)
1816                                   (match-end matchn)) list)))
1817     (nreverse list)))
1818
1819 ;;; File cache.
1820 (defmacro elmo-make-file-cache (path status)
1821   "PATH is the cache file name.
1822 STATUS is one of 'section, 'entire or nil.
1823  nil means no cache exists.
1824 'section means partial section cache exists.
1825 'entire means entire cache exists.
1826 If the cache is partial file-cache, TYPE is 'partial."
1827   (` (cons (, path) (, status))))
1828
1829 (defmacro elmo-file-cache-path (file-cache)
1830   "Returns the file path of the FILE-CACHE."
1831   (` (car (, file-cache))))
1832
1833 (defmacro elmo-file-cache-status (file-cache)
1834   "Returns the status of the FILE-CACHE."
1835   (` (cdr (, file-cache))))
1836
1837 (defsubst elmo-cache-to-msgid (filename)
1838   (concat "<" (elmo-recover-string-from-filename filename) ">"))
1839
1840 (defsubst elmo-cache-get-path-subr (msgid)
1841   (let ((chars '(?0 ?1 ?2 ?3 ?4 ?5 ?6 ?7 ?8 ?9 ?A ?B ?C ?D ?E ?F))
1842         (clist (string-to-char-list msgid))
1843         (sum 0))
1844     (while clist
1845       (setq sum (+ sum (car clist)))
1846       (setq clist (cdr clist)))
1847     (format "%c%c"
1848             (nth (% (/ sum 16) 2) chars)
1849             (nth (% sum 16) chars))))
1850
1851 ;;;
1852 (defun elmo-file-cache-get-path (msgid &optional section)
1853   "Get cache path for MSGID.
1854 If optional argument SECTION is specified, partial cache path is returned."
1855   (if (setq msgid (elmo-msgid-to-cache msgid))
1856       (expand-file-name
1857        (if section
1858            (format "%s/%s/%s/%s"
1859                    elmo-cache-directory
1860                    (elmo-cache-get-path-subr msgid)
1861                    msgid
1862                    section)
1863          (format "%s/%s/%s"
1864                  elmo-cache-directory
1865                  (elmo-cache-get-path-subr msgid)
1866                  msgid)))))
1867
1868 (defmacro elmo-file-cache-expand-path (path section)
1869   "Return file name for the file-cache corresponds to the section.
1870 PATH is the file-cache path.
1871 SECTION is the section string."
1872   (` (expand-file-name (or (, section) "") (, path))))
1873
1874 (defun elmo-file-cache-delete (path)
1875   "Delete a cache on PATH."
1876   (when (file-exists-p path)
1877     (if (file-directory-p path)
1878         (progn
1879           (dolist (file (directory-files path t "^[^\\.]"))
1880             (delete-file file))
1881           (delete-directory path))
1882       (delete-file path))
1883     t))
1884
1885 (defun elmo-file-cache-exists-p (msgid)
1886   "Returns 'section or 'entire if a cache which corresponds to MSGID exists."
1887   (elmo-file-cache-status (elmo-file-cache-get msgid)))
1888
1889 (defun elmo-file-cache-save (cache-path section)
1890   "Save current buffer as cache on PATH.
1891 Return t if cache is saved successfully."
1892   (condition-case nil
1893       (let ((path (if section (expand-file-name section cache-path)
1894                     cache-path))
1895             files dir)
1896         (if (and (null section)
1897                  (file-directory-p path))
1898             (progn
1899               (setq files (directory-files path t "^[^\\.]"))
1900               (while files
1901                 (delete-file (car files))
1902                 (setq files (cdr files)))
1903               (delete-directory path))
1904           (if (and section
1905                    (not (file-directory-p cache-path)))
1906               (delete-file cache-path)))
1907         (when path
1908           (setq dir (directory-file-name (file-name-directory path)))
1909           (if (not (file-exists-p dir))
1910               (elmo-make-directory dir))
1911           (write-region-as-binary (point-min) (point-max)
1912                                   path nil 'no-msg)
1913           t))
1914     ;; ignore error
1915     (error)))
1916
1917 (defun elmo-file-cache-load (cache-path section)
1918   "Load cache on PATH into the current buffer.
1919 Return t if cache is loaded successfully."
1920   (condition-case nil
1921       (let (cache-file)
1922         (when (and cache-path
1923                    (if (elmo-cache-path-section-p cache-path)
1924                        section
1925                      (null section))
1926                    (setq cache-file (elmo-file-cache-expand-path
1927                                      cache-path
1928                                      section))
1929                    (file-exists-p cache-file))
1930           (insert-file-contents-as-binary cache-file)
1931           t))
1932     ;; igore error
1933     (error)))
1934
1935 (defun elmo-cache-path-section-p (path)
1936   "Return non-nil when PATH is `section' cache path."
1937   (file-directory-p path))
1938
1939 (defun elmo-file-cache-get (msgid &optional section)
1940   "Returns the current file-cache object associated with MSGID.
1941 MSGID is the message-id of the message.
1942 If optional argument SECTION is specified, get partial file-cache object
1943 associated with SECTION."
1944   (if msgid
1945       (let ((path (elmo-cache-get-path msgid)))
1946         (if (and path (file-exists-p path))
1947             (if (elmo-cache-path-section-p path)
1948                 (if section
1949                     (if (file-exists-p (setq path (expand-file-name
1950                                                    section path)))
1951                         (cons path 'section))
1952                   ;; section is not specified but sectional.
1953                   (cons path 'section))
1954               ;; not directory.
1955               (unless section
1956                 (cons path 'entire)))
1957           ;; no cache.
1958           (cons path nil)))))
1959
1960 ;;;
1961 ;; Expire cache.
1962
1963 (defun elmo-cache-expire ()
1964   (interactive)
1965   (let* ((completion-ignore-case t)
1966          (method (completing-read (format "Expire by (%s): "
1967                                           elmo-cache-expire-default-method)
1968                                   '(("size" . "size")
1969                                     ("age" . "age"))
1970                                   nil t)))
1971     (when (string= method "")
1972       (setq method elmo-cache-expire-default-method))
1973     (funcall (intern (concat "elmo-cache-expire-by-" method)))))
1974
1975 (defun elmo-read-float-value-from-minibuffer (prompt &optional initial)
1976   (let ((str (read-from-minibuffer prompt initial)))
1977     (cond
1978      ((string-match "[0-9]*\\.[0-9]+" str)
1979       (string-to-number str))
1980      ((string-match "[0-9]+" str)
1981       (string-to-number (concat str ".0")))
1982      (t (error "%s is not number" str)))))
1983
1984 (defun elmo-cache-expire-by-size (&optional kbytes)
1985   "Expire cache file by size.
1986 If KBYTES is kilo bytes (This value must be float)."
1987   (interactive)
1988   (let ((size (or kbytes
1989                   (and (interactive-p)
1990                        (elmo-read-float-value-from-minibuffer
1991                         "Enter cache disk size (Kbytes): "
1992                         (number-to-string
1993                          (if (integerp elmo-cache-expire-default-size)
1994                              (float elmo-cache-expire-default-size)
1995                            elmo-cache-expire-default-size))))
1996                   (if (integerp elmo-cache-expire-default-size)
1997                       (float elmo-cache-expire-default-size))))
1998         (count 0)
1999         (Kbytes 1024)
2000         total beginning)
2001     (message "Checking disk usage...")
2002     (setq total (/ (elmo-disk-usage
2003                     elmo-cache-directory) Kbytes))
2004     (setq beginning total)
2005     (message "Checking disk usage...done")
2006     (let ((cfl (elmo-cache-get-sorted-cache-file-list))
2007           (deleted 0)
2008           oldest
2009           cur-size cur-file)
2010       (while (and (<= size total)
2011                   (setq oldest (elmo-cache-get-oldest-cache-file-entity cfl)))
2012         (setq cur-file (expand-file-name (car (cdr oldest)) (car oldest)))
2013         (setq cur-size (/ (elmo-disk-usage cur-file) Kbytes))
2014         (when (elmo-file-cache-delete cur-file)
2015           (setq count (+ count 1))
2016           (message "%d cache(s) are expired." count))
2017         (setq deleted (+ deleted cur-size))
2018         (setq total (- total cur-size)))
2019       (message "%d cache(s) are expired from disk (%d Kbytes/%d Kbytes)."
2020                count deleted beginning))))
2021
2022 (defun elmo-cache-make-file-entity (filename path)
2023   (cons filename (elmo-get-last-accessed-time filename path)))
2024
2025 (defun elmo-cache-get-oldest-cache-file-entity (cache-file-list)
2026   (let ((cfl cache-file-list)
2027         flist firsts oldest-entity wonlist)
2028     (while cfl
2029       (setq flist (cdr (car cfl)))
2030       (setq firsts (append firsts (list
2031                                    (cons (car (car cfl))
2032                                          (car flist)))))
2033       (setq cfl (cdr cfl)))
2034 ;;; (prin1 firsts)
2035     (while firsts
2036       (if (and (not oldest-entity)
2037                (cdr (cdr (car firsts))))
2038           (setq oldest-entity (car firsts)))
2039       (if (and (cdr (cdr (car firsts)))
2040                (cdr (cdr oldest-entity))
2041                (> (cdr (cdr oldest-entity)) (cdr (cdr (car firsts)))))
2042           (setq oldest-entity (car firsts)))
2043       (setq firsts (cdr firsts)))
2044     (setq wonlist (assoc (car oldest-entity) cache-file-list))
2045     (and wonlist
2046          (setcdr wonlist (delete (car (cdr wonlist)) (cdr wonlist))))
2047     oldest-entity))
2048
2049 (defun elmo-cache-get-sorted-cache-file-list ()
2050   (let ((dirs (directory-files
2051                elmo-cache-directory
2052                t "^[^\\.]"))
2053         (i 0) num
2054         elist
2055         ret-val)
2056     (setq num (length dirs))
2057     (message "Collecting cache info...")
2058     (while dirs
2059       (setq elist (mapcar (lambda (x)
2060                             (elmo-cache-make-file-entity x (car dirs)))
2061                           (directory-files (car dirs) nil "^[^\\.]")))
2062       (setq ret-val (append ret-val
2063                             (list (cons
2064                                    (car dirs)
2065                                    (sort
2066                                     elist
2067                                     (lambda (x y)
2068                                       (< (cdr x)
2069                                          (cdr y))))))))
2070       (when (> num elmo-display-progress-threshold)
2071         (setq i (+ i 1))
2072         (elmo-display-progress
2073          'elmo-cache-get-sorted-cache-file-list "Collecting cache info..."
2074          (/ (* i 100) num)))
2075       (setq dirs (cdr dirs)))
2076     (message "Collecting cache info...done")
2077     ret-val))
2078
2079 (defun elmo-cache-expire-by-age (&optional days)
2080   (let ((age (or (and days (int-to-string days))
2081                  (and (interactive-p)
2082                       (read-from-minibuffer
2083                        (format "Enter days (%s): "
2084                                elmo-cache-expire-default-age)))
2085                  (int-to-string elmo-cache-expire-default-age)))
2086         (dirs (directory-files
2087                elmo-cache-directory
2088                t "^[^\\.]"))
2089         (count 0)
2090         curtime)
2091     (if (string= age "")
2092         (setq age elmo-cache-expire-default-age)
2093       (setq age (string-to-int age)))
2094     (setq curtime (current-time))
2095     (setq curtime (+ (* (nth 0 curtime)
2096                         (float 65536)) (nth 1 curtime)))
2097     (while dirs
2098       (let ((files (directory-files (car dirs) t "^[^\\.]"))
2099             (limit-age (* age 86400)))
2100         (while files
2101           (when (> (- curtime (elmo-get-last-accessed-time (car files)))
2102                    limit-age)
2103             (when (elmo-file-cache-delete (car files))
2104               (setq count (+ 1 count))
2105               (message "%d cache file(s) are expired." count)))
2106           (setq files (cdr files))))
2107       (setq dirs (cdr dirs)))))
2108
2109 ;;;
2110 ;; msgid to path.
2111 (defun elmo-msgid-to-cache (msgid)
2112   (save-match-data
2113     (when (and msgid
2114                (string-match "<\\(.+\\)>$" msgid))
2115       (elmo-replace-string-as-filename (elmo-match-string 1 msgid)))))
2116
2117 (defun elmo-cache-get-path (msgid &optional folder number)
2118   "Get path for cache file associated with MSGID, FOLDER, and NUMBER."
2119   (if (setq msgid (elmo-msgid-to-cache msgid))
2120       (expand-file-name
2121        (expand-file-name
2122         (if folder
2123             (format "%s/%s/%s@%s"
2124                     (elmo-cache-get-path-subr msgid)
2125                     msgid
2126                     (or number "")
2127                     (elmo-safe-filename folder))
2128           (format "%s/%s"
2129                   (elmo-cache-get-path-subr msgid)
2130                   msgid))
2131         elmo-cache-directory))))
2132
2133 ;;;
2134 ;; Warnings.
2135
2136 (static-if (fboundp 'display-warning)
2137     (defmacro elmo-warning (&rest args)
2138       "Display a warning with `elmo' group."
2139       `(display-warning 'elmo (format ,@args)))
2140   (defconst elmo-warning-buffer-name "*elmo warning*")
2141   (defun elmo-warning (&rest args)
2142     "Display a warning. ARGS are passed to `format'."
2143     (with-current-buffer (get-buffer-create elmo-warning-buffer-name)
2144       (goto-char (point-max))
2145       (funcall 'insert (apply 'format (append args '("\n"))))
2146       (ignore-errors (recenter 1))
2147       (display-buffer elmo-warning-buffer-name))))
2148
2149 (defvar elmo-obsolete-variable-alist nil)
2150
2151 (defcustom elmo-obsolete-variable-show-warnings t
2152   "Show warning window if obsolete variable is treated."
2153   :type 'boolean
2154   :group 'elmo)
2155
2156 (defun elmo-define-obsolete-variable (obsolete var)
2157   "Define obsolete variable.
2158 OBSOLETE is a symbol for obsolete variable.
2159 VAR is a symbol for new variable.
2160 Definition is stored in `elmo-obsolete-variable-alist'."
2161   (let ((pair (assq var elmo-obsolete-variable-alist)))
2162     (if pair
2163         (setcdr pair obsolete)
2164       (setq elmo-obsolete-variable-alist
2165             (cons (cons var obsolete)
2166                   elmo-obsolete-variable-alist)))))
2167
2168 (defun elmo-resque-obsolete-variable (obsolete var)
2169   "Resque obsolete variable OBSOLETE as VAR.
2170 If `elmo-obsolete-variable-show-warnings' is non-nil, show warning message."
2171   (when (boundp obsolete)
2172     (static-if (and (fboundp 'defvaralias)
2173                     (subrp (symbol-function 'defvaralias)))
2174         (defvaralias var obsolete)
2175       (set var (symbol-value obsolete)))
2176     (if elmo-obsolete-variable-show-warnings
2177         (elmo-warning "%s is obsolete. Use %s instead."
2178                       (symbol-name obsolete)
2179                       (symbol-name var)))))
2180
2181 (defun elmo-resque-obsolete-variables (&optional alist)
2182   "Resque obsolete variables in ALIST.
2183 ALIST is a list of cons cell of
2184 \(OBSOLETE-VARIABLE-SYMBOL . NEW-VARIABLE-SYMBOL\).
2185 If ALIST is nil, `elmo-obsolete-variable-alist' is used."
2186   (dolist (pair elmo-obsolete-variable-alist)
2187     (elmo-resque-obsolete-variable (cdr pair)
2188                                    (car pair))))
2189
2190 (defsubst elmo-msgdb-get-last-message-id (string)
2191   (if string
2192       (save-match-data
2193         (let (beg)
2194           (elmo-set-work-buf
2195            (insert string)
2196            (goto-char (point-max))
2197            (when (search-backward "<" nil t)
2198              (setq beg (point))
2199              (if (search-forward ">" nil t)
2200                  (elmo-replace-in-string
2201                   (buffer-substring beg (point)) "\n[ \t]*" ""))))))))
2202
2203 (defun elmo-msgdb-get-message-id-from-buffer ()
2204   (let ((msgid (elmo-field-body "message-id")))
2205     (if msgid
2206         (if (string-match "<\\(.+\\)>$" msgid)
2207             msgid
2208           (concat "<" msgid ">"))       ; Invaild message-id.
2209       ;; no message-id, so put dummy msgid.
2210       (concat "<"
2211               (if (elmo-unfold-field-body "date")
2212                   (timezone-make-date-sortable (elmo-unfold-field-body "date"))
2213                 (md5 (string-as-unibyte (buffer-string))))
2214               (nth 1 (eword-extract-address-components
2215                       (or (elmo-field-body "from") "nobody"))) ">"))))
2216
2217 (defun elmo-msgdb-get-references-from-buffer ()
2218   (if elmo-msgdb-prefer-in-reply-to-for-parent
2219       (or (elmo-msgdb-get-last-message-id (elmo-field-body "in-reply-to"))
2220           (elmo-msgdb-get-last-message-id (elmo-field-body "references")))
2221     (or (elmo-msgdb-get-last-message-id (elmo-field-body "references"))
2222         (elmo-msgdb-get-last-message-id (elmo-field-body "in-reply-to")))))
2223
2224 (defsubst elmo-msgdb-insert-file-header (file)
2225   "Insert the header of the article."
2226   (let ((beg 0)
2227         insert-file-contents-pre-hook   ; To avoid autoconv-xmas...
2228         insert-file-contents-post-hook
2229         format-alist)
2230     (when (file-exists-p file)
2231       ;; Read until header separator is found.
2232       (while (and (eq elmo-msgdb-file-header-chop-length
2233                       (nth 1
2234                            (insert-file-contents-as-binary
2235                             file nil beg
2236                             (incf beg elmo-msgdb-file-header-chop-length))))
2237                   (prog1 (not (search-forward "\n\n" nil t))
2238                     (goto-char (point-max))))))))
2239
2240 ;;
2241 ;; overview handling
2242 ;;
2243 (defun elmo-multiple-field-body (name &optional boundary)
2244   (save-excursion
2245     (save-restriction
2246       (std11-narrow-to-header boundary)
2247       (goto-char (point-min))
2248       (let ((case-fold-search t)
2249             (field-body nil))
2250         (while (re-search-forward (concat "^" name ":[ \t]*") nil t)
2251           (setq field-body
2252                 (nconc field-body
2253                        (list (buffer-substring-no-properties
2254                               (match-end 0) (std11-field-end))))))
2255         field-body))))
2256
2257 (defun elmo-parse-addresses (string)
2258   (if (null string)
2259       ()
2260     (elmo-set-work-buf
2261       (let (list start s char)
2262         (insert string)
2263         (goto-char (point-min))
2264         (skip-chars-forward "\t\f\n\r ")
2265         (setq start (point))
2266         (while (not (eobp))
2267           (skip-chars-forward "^\"\\,(")
2268           (setq char (following-char))
2269           (cond ((= char ?\\)
2270                  (forward-char 1)
2271                  (if (not (eobp))
2272                      (forward-char 1)))
2273                 ((= char ?,)
2274                  (setq s (buffer-substring start (point)))
2275                  (if (or (null (string-match "^[\t\f\n\r ]+$" s))
2276                          (not (string= s "")))
2277                      (setq list (cons s list)))
2278                  (skip-chars-forward ",\t\f\n\r ")
2279                  (setq start (point)))
2280                 ((= char ?\")
2281                  (re-search-forward "[^\\]\"" nil 0))
2282                 ((= char ?\()
2283                  (let ((parens 1))
2284                    (forward-char 1)
2285                    (while (and (not (eobp)) (not (zerop parens)))
2286                      (re-search-forward "[()]" nil 0)
2287                      (cond ((or (eobp)
2288                                 (= (char-after (- (point) 2)) ?\\)))
2289                            ((= (preceding-char) ?\()
2290                             (setq parens (1+ parens)))
2291                            (t
2292                             (setq parens (1- parens)))))))))
2293         (setq s (buffer-substring start (point)))
2294         (if (and (null (string-match "^[\t\f\n\r ]+$" s))
2295                  (not (string= s "")))
2296             (setq list (cons s list)))
2297         (nreverse list)))))
2298
2299 ;;; Queue.
2300 (defvar elmo-dop-queue-filename "queue"
2301   "*Disconnected operation queue is saved in this file.")
2302
2303 (defun elmo-dop-queue-load ()
2304   (setq elmo-dop-queue
2305         (elmo-object-load
2306          (expand-file-name elmo-dop-queue-filename
2307                            elmo-msgdb-directory))))
2308
2309 (defun elmo-dop-queue-save ()
2310   (elmo-object-save
2311    (expand-file-name elmo-dop-queue-filename
2312                      elmo-msgdb-directory)
2313    elmo-dop-queue))
2314
2315 (if (and (fboundp 'regexp-opt)
2316          (not (featurep 'xemacs)))
2317     (defalias 'elmo-regexp-opt 'regexp-opt)
2318   (defun elmo-regexp-opt (strings &optional paren)
2319     "Return a regexp to match a string in STRINGS.
2320 Each string should be unique in STRINGS and should not contain any regexps,
2321 quoted or not.  If optional PAREN is non-nil, ensure that the returned regexp
2322 is enclosed by at least one regexp grouping construct."
2323     (let ((open-paren (if paren "\\(" "")) (close-paren (if paren "\\)" "")))
2324       (concat open-paren (mapconcat 'regexp-quote strings "\\|")
2325               close-paren))))
2326
2327 (require 'product)
2328 (product-provide (provide 'elmo-util) (require 'elmo-version))
2329
2330 ;;; elmo-util.el ends here