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