* elmo-util.el (elmo-with-progress-display): New macro.
[elisp/wanderlust.git] / 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
42 (defmacro elmo-set-buffer-multibyte (flag)
43   "Set the multibyte flag of the current buffer to FLAG."
44   (cond ((boundp 'MULE)
45          (list 'setq 'mc-flag flag))
46         ((featurep 'xemacs)
47          flag)
48         ((and (boundp 'emacs-major-version) (>= emacs-major-version 20))
49          (list 'set-buffer-multibyte flag))
50         (t
51          flag)))
52
53 (defvar elmo-work-buf-name " *elmo work*")
54 (defvar elmo-temp-buf-name " *elmo temp*")
55
56 (or (boundp 'default-enable-multibyte-characters)
57     (defvar default-enable-multibyte-characters (featurep 'mule)
58       "The mock variable except for Emacs 20."))
59
60 (defun elmo-base64-encode-string (string &optional no-line-break))
61 (defun elmo-base64-decode-string (string))
62
63 ;; base64 encoding/decoding
64 (require 'mel)
65 (fset 'elmo-base64-encode-string
66       (mel-find-function 'mime-encode-string "base64"))
67 (fset 'elmo-base64-decode-string
68       (mel-find-function 'mime-decode-string "base64"))
69
70 ;; Any Emacsen may have add-name-to-file(), because loadup.el requires it. :-p
71 ;; Check make-symbolic-link() instead.  -- 981002 by Fuji
72 (if (fboundp 'make-symbolic-link)  ;; xxx
73     (defalias 'elmo-add-name-to-file 'add-name-to-file)
74   (defun elmo-add-name-to-file
75     (filename newname &optional ok-if-already-exists)
76     (copy-file filename newname ok-if-already-exists t)))
77
78 (defmacro elmo-set-work-buf (&rest body)
79   "Execute BODY on work buffer.  Work buffer remains."
80   (` (save-excursion
81        (set-buffer (get-buffer-create elmo-work-buf-name))
82        (elmo-set-buffer-multibyte default-enable-multibyte-characters)
83        (erase-buffer)
84        (,@ body))))
85
86 (defmacro elmo-bind-directory (dir &rest body)
87   "Set current directory DIR and execute BODY."
88   (` (let ((default-directory (file-name-as-directory (, dir))))
89        (,@ body))))
90
91 (defun elmo-object-load (filename &optional mime-charset no-err)
92   "Load OBJECT from the file specified by FILENAME.
93 File content is decoded with MIME-CHARSET."
94     (if (not (file-readable-p filename))
95         nil
96       (elmo-set-work-buf
97        (as-binary-input-file
98         (insert-file-contents filename))
99        (when mime-charset
100          (elmo-set-buffer-multibyte default-enable-multibyte-characters)
101          (decode-mime-charset-region (point-min) (point-max) mime-charset))
102        (condition-case nil
103            (read (current-buffer))
104          (error (unless no-err
105                   (message "Warning: Loading object from %s failed."
106                            filename)
107                   (elmo-object-save filename nil))
108                 nil)))))
109
110 (defsubst elmo-save-buffer (filename &optional mime-charset)
111   "Save current buffer to the file specified by FILENAME.
112 Directory of the file is created if it doesn't exist.
113 File content is encoded with MIME-CHARSET."
114   (let ((dir (directory-file-name (file-name-directory filename))))
115     (if (file-directory-p dir)
116         () ; ok.
117       (unless (file-exists-p dir)
118         (elmo-make-directory dir)))
119     (if (file-writable-p filename)
120         (progn
121           (when mime-charset
122 ;;;         (elmo-set-buffer-multibyte default-enable-multibyte-characters)
123             (encode-mime-charset-region (point-min) (point-max) mime-charset))
124           (as-binary-output-file
125            (write-region (point-min) (point-max) filename nil 'no-msg)))
126       (message "%s is not writable." filename))))
127
128 (defun elmo-object-save (filename object &optional mime-charset)
129   "Save OBJECT to the file specified by FILENAME.
130 Directory of the file is created if it doesn't exist.
131 File content is encoded with MIME-CHARSET."
132   (elmo-set-work-buf
133    (let (print-length print-level)
134      (prin1 object (current-buffer)))
135 ;;;(princ "\n" (current-buffer))
136    (elmo-save-buffer filename mime-charset)))
137
138 ;;; Search Condition
139
140 (defconst elmo-condition-atom-regexp "[^/ \")|&]*")
141
142 (defun elmo-read-search-condition (default)
143   "Read search condition string interactively."
144   (elmo-read-search-condition-internal "Search by" default))
145
146 (defun elmo-read-search-condition-internal (prompt default)
147   (let* ((completion-ignore-case t)
148          (field (completing-read
149                  (format "%s (%s): " prompt default)
150                  (mapcar 'list
151                          (append '("AND" "OR"
152                                    "Last" "First" "Flag"
153                                    "From" "Subject" "To" "Cc" "Body"
154                                    "Since" "Before" "ToCc"
155                                    "!From" "!Subject" "!To" "!Cc" "!Body"
156                                    "!Since" "!Before" "!ToCc")
157                                  elmo-msgdb-extra-fields))))
158          value)
159     (setq field (if (string= field "")
160                     (setq field default)
161                   field))
162     (cond
163      ((or (string= field "AND") (string= field "OR"))
164       (concat "("
165               (elmo-read-search-condition-internal
166                (concat field "(1) Search by") default)
167               (if (string= field "AND") "&" "|")
168               (elmo-read-search-condition-internal
169                (concat field "(2) Search by") default)
170               ")"))
171      ((string-match "Since\\|Before" field)
172       (let ((default (format-time-string "%Y-%m-%d")))
173         (setq value (completing-read
174                      (format "Value for '%s' [%s]: " field default)
175                      (mapcar (function
176                               (lambda (x)
177                                 (list (format "%s" (car x)))))
178                              elmo-date-descriptions)))
179         (concat (downcase field) ":"
180                 (if (equal value "") default value))))
181      ((string= field "Flag")
182       (setq value (completing-read
183                    (format "Value for '%s': " field)
184                    (mapcar 'list
185                            '("unread" "important" "answered" "digest" "any"))))
186       (unless (string-match (concat "^" elmo-condition-atom-regexp "$")
187                             value)
188         (setq value (prin1-to-string value)))
189       (concat (downcase field) ":" value))
190      (t
191       (setq value (read-from-minibuffer (format "Value for '%s': " field)))
192       (unless (string-match (concat "^" elmo-condition-atom-regexp "$")
193                             value)
194         (setq value (prin1-to-string value)))
195       (concat (downcase field) ":" value)))))
196
197 (defsubst elmo-condition-parse-error ()
198   (error "Syntax error in '%s'" (buffer-string)))
199
200 (defun elmo-parse-search-condition (condition)
201   "Parse CONDITION.
202 Return value is a cons cell of (STRUCTURE . REST)"
203   (with-temp-buffer
204     (insert condition)
205     (goto-char (point-min))
206     (cons (elmo-condition-parse) (buffer-substring (point) (point-max)))))
207
208 ;; condition    ::= or-expr
209 (defun elmo-condition-parse ()
210   (or (elmo-condition-parse-or-expr)
211       (elmo-condition-parse-error)))
212
213 ;; or-expr      ::= and-expr /
214 ;;                  and-expr "|" or-expr
215 (defun elmo-condition-parse-or-expr ()
216   (let ((left (elmo-condition-parse-and-expr)))
217     (if (looking-at "| *")
218         (progn
219           (goto-char (match-end 0))
220           (list 'or left (elmo-condition-parse-or-expr)))
221       left)))
222
223 ;; and-expr     ::= primitive /
224 ;;                  primitive "&" and-expr
225 (defun elmo-condition-parse-and-expr ()
226   (let ((left (elmo-condition-parse-primitive)))
227     (if (looking-at "& *")
228         (progn
229           (goto-char (match-end 0))
230           (list 'and left (elmo-condition-parse-and-expr)))
231       left)))
232
233 ;; primitive    ::= "(" expr ")" /
234 ;;                  ["!"] search-key SPACE* ":" SPACE* search-value
235 (defun elmo-condition-parse-primitive ()
236   (cond
237    ((looking-at "( *")
238     (goto-char (match-end 0))
239     (prog1 (elmo-condition-parse)
240       (unless (looking-at ") *")
241         (elmo-condition-parse-error))
242       (goto-char (match-end 0))))
243 ;; search-key   ::= [A-Za-z-]+
244 ;;                 ;; "since" / "before" / "last" / "first" /
245 ;;                 ;; "body" / "mark" / field-name
246    ((looking-at "\\(!\\)? *\\([A-Za-z-]+\\) *: *")
247     (goto-char (match-end 0))
248     (let ((search-key (vector
249                        (if (match-beginning 1) 'unmatch 'match)
250                        (elmo-match-buffer 2)
251                        (elmo-condition-parse-search-value))))
252       ;; syntax sugar.
253       (if (string= (aref search-key 1) "tocc")
254           (if (eq (aref search-key 0) 'match)
255               (list 'or
256                     (vector 'match "to" (aref search-key 2))
257                     (vector 'match "cc" (aref search-key 2)))
258             (list 'and
259                   (vector 'unmatch "to" (aref search-key 2))
260                   (vector 'unmatch "cc" (aref search-key 2))))
261         search-key)))))
262
263 ;; search-value ::= quoted / time / number / atom
264 ;; quoted       ::= <elisp string expression>
265 ;; time         ::= "yesterday" / "lastweek" / "lastmonth" / "lastyear" /
266 ;;                   number SPACE* "daysago" /
267 ;;                   number "-" month "-" number  ; ex. 10-May-2000
268 ;;                   number "-" number "-" number  ; ex. 2000-05-10
269 ;; number       ::= [0-9]+
270 ;; month        ::= "Jan" / "Feb" / "Mar" / "Apr" / "May" / "Jun" /
271 ;;                  "Jul" / "Aug" / "Sep" / "Oct" / "Nov" / "Dec"
272 ;; atom         ::= ATOM_CHARS*
273 ;; SPACE        ::= <ascii space character, 0x20>
274 ;; ATOM_CHARS   ::= <any character except specials>
275 ;; specials     ::= SPACE / <"> / </> / <)> / <|> / <&>
276 ;;                  ;; These characters should be quoted.
277 (defun elmo-condition-parse-search-value ()
278   (cond
279    ((looking-at "\"")
280     (read (current-buffer)))
281    ((or (looking-at "yesterday") (looking-at "lastweek")
282         (looking-at "lastmonth") (looking-at "lastyear")
283         (looking-at "[0-9]+ *daysago")
284         (looking-at "[0-9]+-[A-Za-z]+-[0-9]+")
285         (looking-at "[0-9]+-[0-9]+-[0-9]+")
286         (looking-at "[0-9]+")
287         (looking-at elmo-condition-atom-regexp))
288     (prog1 (elmo-match-buffer 0)
289       (goto-char (match-end 0))))
290    (t (error "Syntax error '%s'" (buffer-string)))))
291
292 ;;;
293 (defsubst elmo-buffer-replace (regexp &optional newtext)
294   (goto-char (point-min))
295   (while (re-search-forward regexp nil t)
296     (replace-match (or newtext ""))))
297
298 (defsubst elmo-delete-char (char string &optional unibyte)
299   (save-match-data
300     (elmo-set-work-buf
301      (let ((coding-system-for-read 'no-conversion)
302            (coding-system-for-write 'no-conversion))
303        (if unibyte (elmo-set-buffer-multibyte nil))
304        (insert string)
305        (goto-char (point-min))
306        (while (search-forward (char-to-string char) nil t)
307          (replace-match ""))
308        (buffer-string)))))
309
310 (defsubst elmo-delete-cr-buffer ()
311   "Delete CR from buffer."
312   (save-excursion
313     (goto-char (point-min))
314     (while (search-forward "\r\n" nil t)
315       (replace-match "\n")) ))
316
317 (defsubst elmo-delete-cr-get-content-type ()
318   (save-excursion
319     (goto-char (point-min))
320     (while (search-forward "\r\n" nil t)
321       (replace-match "\n"))
322     (goto-char (point-min))
323     (or (std11-field-body "content-type")
324         t)))
325
326 (defun elmo-delete-cr (string)
327   (save-match-data
328     (elmo-set-work-buf
329      (insert string)
330      (goto-char (point-min))
331      (while (search-forward "\r\n" nil t)
332        (replace-match "\n"))
333      (buffer-string))))
334
335 (defun elmo-uniq-list (lst)
336   "Distractively uniqfy elements of LST."
337   (let ((tmp lst))
338     (while tmp (setq tmp
339                      (setcdr tmp
340                              (and (cdr tmp)
341                                   (delete (car tmp)
342                                           (cdr tmp)))))))
343   lst)
344
345 (defun elmo-list-insert (list element after)
346   (let* ((match (memq after list))
347          (rest (and match (cdr (memq after list)))))
348     (if match
349         (progn
350           (setcdr match (list element))
351           (nconc list rest))
352       (nconc list (list element)))))
353
354 (defun elmo-string-partial-p (string)
355   (and (stringp string) (string-match "message/partial" string)))
356
357 (defun elmo-get-file-string (filename &optional remove-final-newline)
358   (elmo-set-work-buf
359    (let (insert-file-contents-pre-hook   ; To avoid autoconv-xmas...
360          insert-file-contents-post-hook)
361      (when (file-exists-p filename)
362        (if filename
363            (as-binary-input-file (insert-file-contents filename)))
364        (when (and remove-final-newline
365                   (> (buffer-size) 0)
366                   (= (char-after (1- (point-max))) ?\n))
367          (goto-char (point-max))
368          (delete-backward-char 1))
369        (buffer-string)))))
370
371 (defun elmo-save-string (string filename)
372   (if string
373       (elmo-set-work-buf
374        (as-binary-output-file
375         (insert string)
376         (write-region (point-min) (point-max)
377                       filename nil 'no-msg))
378        )))
379
380 (defun elmo-max-of-list (nlist)
381   (let ((l nlist)
382         (max-num 0))
383     (while l
384       (if (< max-num (car l))
385           (setq max-num (car l)))
386       (setq l (cdr l)))
387     max-num))
388
389 (defun elmo-concat-path (path filename)
390   (if (not (string= path ""))
391       (if (string= elmo-path-sep (substring path (- (length path) 1)))
392           (concat path filename)
393         (concat path elmo-path-sep filename))
394     filename))
395
396 (defvar elmo-passwd-alist nil)
397
398 (defun elmo-passwd-alist-load ()
399   (save-excursion
400     (let ((filename (expand-file-name elmo-passwd-alist-file-name
401                                       elmo-msgdb-directory))
402           (tmp-buffer (get-buffer-create " *elmo-passwd-alist-tmp*"))
403           insert-file-contents-pre-hook ; To avoid autoconv-xmas...
404           insert-file-contents-post-hook
405           ret-val)
406       (if (not (file-readable-p filename))
407           ()
408         (set-buffer tmp-buffer)
409         (insert-file-contents filename)
410         (setq ret-val
411               (condition-case nil
412                   (read (current-buffer))
413                 (error nil nil))))
414       (kill-buffer tmp-buffer)
415       ret-val)))
416
417 (defun elmo-passwd-alist-clear ()
418   "Clear password cache."
419   (interactive)
420   (setq elmo-passwd-alist nil))
421
422 (defun elmo-passwd-alist-save ()
423   "Save password into file."
424   (interactive)
425   (save-excursion
426     (let ((filename (expand-file-name elmo-passwd-alist-file-name
427                                       elmo-msgdb-directory))
428           (tmp-buffer (get-buffer-create " *elmo-passwd-alist-tmp*"))
429           print-length print-level)
430       (set-buffer tmp-buffer)
431       (erase-buffer)
432       (prin1 elmo-passwd-alist tmp-buffer)
433       (princ "\n" tmp-buffer)
434 ;;;   (if (and (file-exists-p filename)
435 ;;;            (not (equal 384 (file-modes filename))))
436 ;;;       (error "%s is not safe.chmod 600 %s!" filename filename))
437       (if (file-writable-p filename)
438           (progn
439             (write-region (point-min) (point-max)
440                           filename nil 'no-msg)
441             (set-file-modes filename 384))
442         (message "%s is not writable." filename))
443       (kill-buffer tmp-buffer))))
444
445 (defun elmo-get-passwd (key)
446   "Get password from password pool."
447   (let (pair pass)
448     (if (not elmo-passwd-alist)
449         (setq elmo-passwd-alist (elmo-passwd-alist-load)))
450     (setq pair (assoc key elmo-passwd-alist))
451     (if pair
452         (elmo-base64-decode-string (cdr pair))
453       (setq pass (elmo-read-passwd (format "Password for %s: "
454                                            key) t))
455       (setq elmo-passwd-alist
456             (append elmo-passwd-alist
457                     (list (cons key
458                                 (elmo-base64-encode-string pass)))))
459       (if elmo-passwd-life-time
460           (run-with-timer elmo-passwd-life-time nil
461                           (` (lambda () (elmo-remove-passwd (, key))))))
462       pass)))
463
464 (defun elmo-remove-passwd (key)
465   "Remove password from password pool (for failure)."
466   (let (pass-cons)
467     (if (setq pass-cons (assoc key elmo-passwd-alist))
468         (progn
469           (unwind-protect
470               (fillarray (cdr pass-cons) 0))
471           (setq elmo-passwd-alist
472                 (delete pass-cons elmo-passwd-alist))))))
473
474 (defmacro elmo-read-char-exclusive ()
475   (cond ((featurep 'xemacs)
476          '(let ((table (quote ((backspace . ?\C-h) (delete . ?\C-?)
477                                (left . ?\C-h))))
478                 event key)
479             (while (not
480                     (and
481                      (key-press-event-p (setq event (next-command-event)))
482                      (setq key (or (event-to-character event)
483                                    (cdr (assq (event-key event) table)))))))
484             key))
485         ((fboundp 'read-char-exclusive)
486          '(read-char-exclusive))
487         (t
488          '(read-char))))
489
490 (defun elmo-read-passwd (prompt &optional stars)
491   "Read a single line of text from user without echoing, and return it."
492   (let ((ans "")
493         (c 0)
494         (echo-keystrokes 0)
495         (cursor-in-echo-area t)
496         (log-message-max-size 0)
497         message-log-max done msg truncate)
498     (while (not done)
499       (if (or (not stars) (string= "" ans))
500           (setq msg prompt)
501         (setq msg (concat prompt (make-string (length ans) ?.)))
502         (setq truncate
503               (1+ (- (length msg) (window-width (minibuffer-window)))))
504         (and (> truncate 0)
505              (setq msg (concat "$" (substring msg (1+ truncate))))))
506       (message "%s" msg)
507       (setq c (elmo-read-char-exclusive))
508       (cond ((= c ?\C-g)
509              (setq quit-flag t
510                    done t))
511             ((or (= c ?\r) (= c ?\n) (= c ?\e))
512              (setq done t))
513             ((= c ?\C-u)
514              (setq ans ""))
515             ((and (/= c ?\b) (/= c ?\177))
516              (setq ans (concat ans (char-to-string c))))
517             ((> (length ans) 0)
518              (setq ans (substring ans 0 -1)))))
519     (if quit-flag
520         (prog1
521             (setq quit-flag nil)
522           (message "Quit")
523           (beep t))
524       (message "")
525       ans)))
526
527 (defun elmo-string-to-list (string)
528   (elmo-set-work-buf
529    (insert string)
530    (goto-char (point-min))
531    (insert "(")
532    (goto-char (point-max))
533    (insert ")")
534    (goto-char (point-min))
535    (read (current-buffer))))
536
537 (defun elmo-list-to-string (list)
538   (let ((tlist list)
539         str)
540     (if (listp tlist)
541         (progn
542           (setq str "(")
543           (while (car tlist)
544             (setq str
545                   (concat str
546                           (if (symbolp (car tlist))
547                               (symbol-name (car tlist))
548                             (car tlist))))
549             (if (cdr tlist)
550                 (setq str
551                       (concat str " ")))
552             (setq tlist (cdr tlist)))
553           (setq str
554                 (concat str ")")))
555       (setq str
556             (if (symbolp tlist)
557                 (symbol-name tlist)
558               tlist)))
559     str))
560
561
562 (defun elmo-plug-on-by-servers (alist &optional servers)
563   (let ((server-list (or servers elmo-plug-on-servers)))
564     (catch 'plugged
565       (while server-list
566         (if (elmo-plugged-p (car server-list))
567             (throw 'plugged t))
568         (setq server-list (cdr server-list))))))
569
570 (defun elmo-plug-on-by-exclude-servers (alist &optional servers)
571   (let ((server-list (or servers elmo-plug-on-exclude-servers))
572         server other-servers)
573     (while alist
574       (when (and (not (member (setq server (caaar alist)) server-list))
575                  (not (member server other-servers)))
576         (push server other-servers))
577       (setq alist (cdr alist)))
578     (elmo-plug-on-by-servers alist other-servers)))
579
580 (defun elmo-plugged-p (&optional server port stream-type alist label-exp)
581   (let ((alist (or alist elmo-plugged-alist))
582         plugged-info)
583     (cond ((and (not port) (not server))
584            (cond ((eq elmo-plugged-condition 'one)
585                   (if alist
586                       (catch 'plugged
587                         (while alist
588                           (if (nth 2 (car alist))
589                               (throw 'plugged t))
590                           (setq alist (cdr alist))))
591                     elmo-plugged))
592                  ((eq elmo-plugged-condition 'all)
593                   (if alist
594                       (catch 'plugged
595                         (while alist
596                           (if (not (nth 2 (car alist)))
597                               (throw 'plugged nil))
598                           (setq alist (cdr alist)))
599                         t)
600                     elmo-plugged))
601                  ((functionp elmo-plugged-condition)
602                   (funcall elmo-plugged-condition alist))
603                  (t ;; independent
604                   elmo-plugged)))
605           ((not port) ;; server
606            (catch 'plugged
607              (while alist
608                (when (string= server (caaar alist))
609                  (if (nth 2 (car alist))
610                      (throw 'plugged t)))
611                (setq alist (cdr alist)))))
612           (t
613            (setq plugged-info (assoc (list server port stream-type) alist))
614            (if (not plugged-info)
615                ;; add elmo-plugged-alist automatically
616                (progn
617                  (elmo-set-plugged elmo-plugged server port stream-type
618                                    nil nil nil label-exp)
619                  elmo-plugged)
620              (if (and elmo-auto-change-plugged
621                       (> elmo-auto-change-plugged 0)
622                       (nth 3 plugged-info)  ;; time
623                       (elmo-time-expire (nth 3 plugged-info)
624                                         elmo-auto-change-plugged))
625                  t
626                (nth 2 plugged-info)))))))
627
628 (defun elmo-set-plugged (plugged &optional server port stream-type time
629                                  alist label-exp add)
630   (let ((alist (or alist elmo-plugged-alist))
631         label plugged-info)
632     (cond ((and (not port) (not server))
633            (setq elmo-plugged plugged)
634            ;; set plugged all element of elmo-plugged-alist.
635            (while alist
636              (setcdr (cdar alist) (list plugged time))
637              (setq alist (cdr alist))))
638           ((not port)
639            ;; set plugged all port of server
640            (while alist
641              (when (string= server (caaar alist))
642                (setcdr (cdar alist) (list plugged time)))
643              (setq alist (cdr alist))))
644           (t
645            ;; set plugged one port of server
646            (setq plugged-info (assoc (list server port stream-type) alist))
647            (setq label (if label-exp
648                            (eval label-exp)
649                          (nth 1 plugged-info)))
650            (if plugged-info
651                ;; if add is non-nil, don't reset plug state.
652                (unless add
653                  (setcdr plugged-info (list label plugged time)))
654              (setq alist
655                    (setq elmo-plugged-alist
656                          (nconc
657                           elmo-plugged-alist
658                           (list
659                            (list (list server port stream-type)
660                                  label plugged time))))))))
661     alist))
662
663 (defun elmo-delete-plugged (&optional server port alist)
664   (let* ((alist (or alist elmo-plugged-alist))
665          (alist2 alist))
666     (cond ((and (not port) (not server))
667            (setq alist nil))
668           ((not port)
669            ;; delete plugged all port of server
670            (while alist2
671              (when (string= server (caaar alist2))
672                (setq alist (delete (car alist2) alist)))
673              (setq alist2 (cdr alist2))))
674           (t
675            ;; delete plugged one port of server
676            (setq alist
677                  (delete (assoc (cons server port) alist) alist))))
678     alist))
679
680 (defun elmo-disk-usage (path)
681   "Get disk usage (bytes) in PATH."
682   (let ((file-attr
683          (condition-case () (file-attributes path) (error nil))))
684     (if file-attr
685         (if (nth 0 file-attr) ; directory
686             (let ((files (condition-case ()
687                              (directory-files path t "^[^\\.]")
688                            (error nil)))
689                   (result 0.0))
690               ;; (result (nth 7 file-attr))) ... directory size
691               (while files
692                 (setq result (+ result (or (elmo-disk-usage (car files)) 0)))
693                 (setq files (cdr files)))
694               result)
695           (float (nth 7 file-attr)))
696       0)))
697
698 (defun elmo-get-last-accessed-time (path &optional dir)
699   "Return the last accessed time of PATH."
700   (let ((last-accessed (nth 4 (file-attributes (or (and dir
701                                                         (expand-file-name
702                                                          path dir))
703                                                    path)))))
704     (if last-accessed
705         (setq last-accessed (+ (* (nth 0 last-accessed)
706                                   (float 65536)) (nth 1 last-accessed)))
707       0)))
708
709 (defun elmo-get-last-modification-time (path &optional dir)
710   "Return the last accessed time of PATH."
711   (let ((last-modified (nth 5 (file-attributes (or (and dir
712                                                         (expand-file-name
713                                                          path dir))
714                                                    path)))))
715     (setq last-modified (+ (* (nth 0 last-modified)
716                               (float 65536)) (nth 1 last-modified)))))
717
718 (defun elmo-make-directory (path &optional mode)
719   "Create directory recursively."
720   (let ((parent (directory-file-name (file-name-directory path))))
721     (if (null (file-directory-p parent))
722         (elmo-make-directory parent))
723     (make-directory path)
724     (set-file-modes path (or mode
725                              (+ (* 64 7) (* 8 0) 0))))) ; chmod 0700
726
727 (defun elmo-delete-directory (path &optional no-hierarchy)
728   "Delete directory recursively."
729   (if (stringp path) ; nil is not permitted.
730   (let ((dirent (directory-files path))
731         relpath abspath hierarchy)
732     (while dirent
733       (setq relpath (car dirent)
734             dirent (cdr dirent)
735             abspath (expand-file-name relpath path))
736       (when (not (string-match "^\\.\\.?$" relpath))
737         (if (eq (nth 0 (file-attributes abspath)) t)
738             (if no-hierarchy
739                 (setq hierarchy t)
740               (elmo-delete-directory abspath no-hierarchy))
741           (delete-file abspath))))
742     (unless hierarchy
743       (delete-directory path)))))
744
745 (defun elmo-delete-match-files (path regexp &optional remove-if-empty)
746   "Delete directory files specified by PATH.
747 If optional REMOVE-IF-EMPTY is non-nil, delete directory itself if
748 the directory becomes empty after deletion."
749   (when (stringp path) ; nil is not permitted.
750     (dolist (file (directory-files path t regexp))
751       (delete-file file))
752     (if remove-if-empty
753         (ignore-errors 
754           (delete-directory path) ; should be removed if empty.
755           ))))
756
757 (defun elmo-list-filter (l1 l2)
758   "Rerurn a list from L2 in which each element is a member of L1."
759   (elmo-delete-if (lambda (x) (not (memq x l1))) l2))
760
761 (defsubst elmo-list-delete-if-smaller (list number)
762   (let ((ret-val (copy-sequence list)))
763     (while list
764       (if (< (car list) number)
765           (setq ret-val (delq (car list) ret-val)))
766       (setq list (cdr list)))
767     ret-val))
768
769 (defun elmo-list-diff (list1 list2 &optional mes)
770   (if mes
771       (message "%s" mes))
772   (let ((clist1 (copy-sequence list1))
773         (clist2 (copy-sequence list2)))
774     (while list2
775       (setq clist1 (delq (car list2) clist1))
776       (setq list2 (cdr list2)))
777     (while list1
778       (setq clist2 (delq (car list1) clist2))
779       (setq list1 (cdr list1)))
780     (if mes
781         (message "%sdone" mes))
782     (list clist1 clist2)))
783
784 (defun elmo-list-bigger-diff (list1 list2 &optional mes)
785   "Returns a list (- +). + is bigger than max of LIST1, in LIST2."
786   (if (null list2)
787       (cons list1  nil)
788     (let* ((l1 list1)
789            (l2 list2)
790            (max-of-l2 (or (nth (max 0 (1- (length l2))) l2) 0))
791            diff1 num i percent
792            )
793       (setq i 0)
794       (setq num (+ (length l1)))
795       (while l1
796         (if (memq (car l1) l2)
797             (if (eq (car l1) (car l2))
798                 (setq l2 (cdr l2))
799               (delq (car l1) l2))
800           (if (> (car l1) max-of-l2)
801               (setq diff1 (nconc diff1 (list (car l1))))))
802         (if mes
803             (progn
804               (setq i (+ i 1))
805               (setq percent (/ (* i 100) num))
806               (if (eq (% percent 5) 0)
807                   (elmo-display-progress
808                    'elmo-list-bigger-diff "%s%d%%" percent mes))))
809         (setq l1 (cdr l1)))
810       (cons diff1 (list l2)))))
811
812 (defmacro elmo-filter-condition-p (filter)
813   `(or (vectorp ,filter) (consp ,filter)))
814
815 (defmacro elmo-filter-type (filter)
816   (` (aref (, filter) 0)))
817
818 (defmacro elmo-filter-key (filter)
819   (` (aref (, filter) 1)))
820
821 (defmacro elmo-filter-value (filter)
822   (` (aref (, filter) 2)))
823
824 (defsubst elmo-buffer-field-primitive-condition-match (condition
825                                                        number
826                                                        number-list)
827   (let (result)
828     (goto-char (point-min))
829     (cond
830      ((string= (elmo-filter-key condition) "last")
831       (setq result (<= (length (memq number number-list))
832                        (string-to-int (elmo-filter-value condition)))))
833      ((string= (elmo-filter-key condition) "first")
834       (setq result (< (- (length number-list)
835                          (length (memq number number-list)))
836                       (string-to-int (elmo-filter-value condition)))))
837      ((string= (elmo-filter-key condition) "since")
838       (let ((field-date (elmo-date-make-sortable-string
839                          (timezone-fix-time
840                           (std11-field-body "date")
841                           (current-time-zone) nil)))
842             (specified-date (elmo-date-make-sortable-string
843                              (elmo-date-get-datevec
844                               (elmo-filter-value condition)))))
845         (setq result
846               (or (string= field-date specified-date)
847                   (string< specified-date field-date)))))
848      ((string= (elmo-filter-key condition) "before")
849       (setq result
850             (string<
851              (elmo-date-make-sortable-string
852               (timezone-fix-time
853                (std11-field-body "date")
854                (current-time-zone) nil))
855              (elmo-date-make-sortable-string
856               (elmo-date-get-datevec
857                (elmo-filter-value condition))))))
858      ((string= (elmo-filter-key condition) "body")
859       (and (re-search-forward "^$" nil t)          ; goto body
860            (setq result (search-forward (elmo-filter-value condition)
861                                         nil t))))
862      (t
863       (let ((fval (std11-field-body (elmo-filter-key condition))))
864         (if (eq (length fval) 0) (setq fval nil))
865         (if fval (setq fval (eword-decode-string fval)))
866         (setq result (and fval (string-match
867                                 (elmo-filter-value condition) fval))))))
868     (if (eq (elmo-filter-type condition) 'unmatch)
869         (setq result (not result)))
870     result))
871
872 (defun elmo-condition-in-msgdb-p-internal (condition fields)
873   (cond
874    ((vectorp condition)
875     (if (not (member (elmo-filter-key condition) fields))
876         (throw 'found t)))
877    ((or (eq (car condition) 'and)
878         (eq (car condition) 'or))
879     (elmo-condition-in-msgdb-p-internal (nth 1 condition) fields)
880     (elmo-condition-in-msgdb-p-internal (nth 2 condition) fields))))
881
882 (defun elmo-condition-in-msgdb-p (condition)
883   (not (catch 'found
884          (elmo-condition-in-msgdb-p-internal condition
885                                              (append
886                                               elmo-msgdb-extra-fields
887                                               '("last" "first" "from"
888                                                 "subject" "to" "cc" "since"
889                                                 "before"))))))
890
891 (defun elmo-buffer-field-condition-match (condition number number-list)
892   (cond
893    ((vectorp condition)
894     (elmo-buffer-field-primitive-condition-match
895      condition number number-list))
896    ((eq (car condition) 'and)
897     (and (elmo-buffer-field-condition-match
898           (nth 1 condition) number number-list)
899          (elmo-buffer-field-condition-match
900           (nth 2 condition) number number-list)))
901    ((eq (car condition) 'or)
902     (or (elmo-buffer-field-condition-match
903          (nth 1 condition) number number-list)
904         (elmo-buffer-field-condition-match
905          (nth 2 condition) number number-list)))))
906
907 (defsubst elmo-file-field-primitive-condition-match (file
908                                                      condition
909                                                      number
910                                                      number-list)
911   (let (result)
912     (goto-char (point-min))
913     (cond
914      ((string= (elmo-filter-key condition) "last")
915       (setq result (<= (length (memq number number-list))
916                        (string-to-int (elmo-filter-value condition))))
917       (if (eq (elmo-filter-type condition) 'unmatch)
918           (setq result (not result))))
919      ((string= (elmo-filter-key condition) "first")
920       (setq result (< (- (length number-list)
921                          (length (memq number number-list)))
922                       (string-to-int (elmo-filter-value condition))))
923       (if (eq (elmo-filter-type condition) 'unmatch)
924           (setq result (not result))))
925      (t
926       (elmo-set-work-buf
927        (as-binary-input-file (insert-file-contents file))
928        (elmo-set-buffer-multibyte default-enable-multibyte-characters)
929        ;; Should consider charset?
930        (decode-mime-charset-region (point-min)(point-max) elmo-mime-charset)
931        (setq result
932              (elmo-buffer-field-primitive-condition-match
933               condition number number-list)))))
934     result))
935
936 (defun elmo-file-field-condition-match (file condition number number-list)
937   (cond
938    ((vectorp condition)
939     (elmo-file-field-primitive-condition-match
940      file condition number number-list))
941    ((eq (car condition) 'and)
942     (and (elmo-file-field-condition-match
943           file (nth 1 condition) number number-list)
944          (elmo-file-field-condition-match
945           file (nth 2 condition) number number-list)))
946    ((eq (car condition) 'or)
947     (or (elmo-file-field-condition-match
948          file (nth 1 condition) number number-list)
949         (elmo-file-field-condition-match
950          file (nth 2 condition) number number-list)))))
951
952 (defmacro elmo-get-hash-val (string hashtable)
953   `(and (stringp ,string)
954         ,hashtable
955         (let ((sym (intern-soft ,string ,hashtable)))
956           (if (boundp sym)
957               (symbol-value sym)))))
958
959 (defmacro elmo-set-hash-val (string value hashtable)
960   (list 'set (list '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 &rest 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 ;;;
1606 ;; parsistent mark handling
1607 ;; (for global!)
1608 ;; (FIXME: this should be treated in the msgdb.)
1609
1610 (defvar elmo-msgdb-global-mark-alist nil)
1611
1612 (defun elmo-msgdb-global-mark-delete (msgid)
1613   (let* ((path (expand-file-name
1614                 elmo-msgdb-global-mark-filename
1615                 elmo-msgdb-directory))
1616          (malist (or elmo-msgdb-global-mark-alist
1617                      (setq elmo-msgdb-global-mark-alist
1618                            (elmo-object-load path))))
1619          match)
1620     (when (setq match (assoc msgid malist))
1621       (setq elmo-msgdb-global-mark-alist
1622             (delete match elmo-msgdb-global-mark-alist))
1623       (elmo-object-save path elmo-msgdb-global-mark-alist))))
1624
1625 (defun elmo-msgdb-global-mark-set (msgid mark)
1626   (let* ((path (expand-file-name
1627                 elmo-msgdb-global-mark-filename
1628                 elmo-msgdb-directory))
1629          (malist (or elmo-msgdb-global-mark-alist
1630                      (setq elmo-msgdb-global-mark-alist
1631                            (elmo-object-load path))))
1632          match)
1633     (if (setq match (assoc msgid malist))
1634         (setcdr match mark)
1635       (setq elmo-msgdb-global-mark-alist
1636             (nconc elmo-msgdb-global-mark-alist
1637                    (list (cons msgid mark)))))
1638     (elmo-object-save path elmo-msgdb-global-mark-alist)))
1639
1640 (defun elmo-msgdb-global-mark-get (msgid)
1641   (cdr (assoc msgid (or elmo-msgdb-global-mark-alist
1642                         (setq elmo-msgdb-global-mark-alist
1643                               (elmo-object-load
1644                                (expand-file-name
1645                                 elmo-msgdb-global-mark-filename
1646                                 elmo-msgdb-directory)))))))
1647
1648 ;;; File cache.
1649 (defmacro elmo-make-file-cache (path status)
1650   "PATH is the cache file name.
1651 STATUS is one of 'section, 'entire or nil.
1652  nil means no cache exists.
1653 'section means partial section cache exists.
1654 'entire means entire cache exists.
1655 If the cache is partial file-cache, TYPE is 'partial."
1656   (` (cons (, path) (, status))))
1657
1658 (defmacro elmo-file-cache-path (file-cache)
1659   "Returns the file path of the FILE-CACHE."
1660   (` (car (, file-cache))))
1661
1662 (defmacro elmo-file-cache-status (file-cache)
1663   "Returns the status of the FILE-CACHE."
1664   (` (cdr (, file-cache))))
1665
1666 (defsubst elmo-cache-to-msgid (filename)
1667   (concat "<" (elmo-recover-string-from-filename filename) ">"))
1668
1669 (defsubst elmo-cache-get-path-subr (msgid)
1670   (let ((chars '(?0 ?1 ?2 ?3 ?4 ?5 ?6 ?7 ?8 ?9 ?A ?B ?C ?D ?E ?F))
1671         (clist (string-to-char-list msgid))
1672         (sum 0))
1673     (while clist
1674       (setq sum (+ sum (car clist)))
1675       (setq clist (cdr clist)))
1676     (format "%c%c"
1677             (nth (% (/ sum 16) 2) chars)
1678             (nth (% sum 16) chars))))
1679
1680 ;;;
1681 (defun elmo-file-cache-get-path (msgid &optional section)
1682   "Get cache path for MSGID.
1683 If optional argument SECTION is specified, partial cache path is returned."
1684   (if (setq msgid (elmo-msgid-to-cache msgid))
1685       (expand-file-name
1686        (if section
1687            (format "%s/%s/%s/%s"
1688                    elmo-cache-directory
1689                    (elmo-cache-get-path-subr msgid)
1690                    msgid
1691                    section)
1692          (format "%s/%s/%s"
1693                  elmo-cache-directory
1694                  (elmo-cache-get-path-subr msgid)
1695                  msgid)))))
1696
1697 (defmacro elmo-file-cache-expand-path (path section)
1698   "Return file name for the file-cache corresponds to the section.
1699 PATH is the file-cache path.
1700 SECTION is the section string."
1701   (` (expand-file-name (or (, section) "") (, path))))
1702
1703 (defun elmo-file-cache-delete (path)
1704   "Delete a cache on PATH."
1705   (unless (elmo-msgdb-global-mark-get
1706            (elmo-cache-to-msgid (file-name-nondirectory path)))
1707     (when (file-exists-p path)
1708       (if (file-directory-p path)
1709           (progn
1710             (dolist (file (directory-files path t "^[^\\.]"))
1711               (delete-file file))
1712             (delete-directory path))
1713         (delete-file path))
1714       t)))
1715
1716 (defun elmo-file-cache-exists-p (msgid)
1717   "Returns 'section or 'entire if a cache which corresponds to MSGID exists."
1718   (elmo-file-cache-status (elmo-file-cache-get msgid)))
1719
1720 (defun elmo-file-cache-save (cache-path section)
1721   "Save current buffer as cache on PATH.
1722 Return t if cache is saved successfully."
1723   (condition-case nil
1724       (let ((path (if section (expand-file-name section cache-path)
1725                     cache-path))
1726             files dir)
1727         (if (and (null section)
1728                  (file-directory-p path))
1729             (progn
1730               (setq files (directory-files path t "^[^\\.]"))
1731               (while files
1732                 (delete-file (car files))
1733                 (setq files (cdr files)))
1734               (delete-directory path))
1735           (if (and section
1736                    (not (file-directory-p cache-path)))
1737               (delete-file cache-path)))
1738         (when path
1739           (setq dir (directory-file-name (file-name-directory path)))
1740           (if (not (file-exists-p dir))
1741               (elmo-make-directory dir))
1742           (write-region-as-binary (point-min) (point-max)
1743                                   path nil 'no-msg)
1744           t))
1745     ;; ignore error
1746     (error)))
1747
1748 (defun elmo-file-cache-load (cache-path section)
1749   "Load cache on PATH into the current buffer.
1750 Return t if cache is loaded successfully."
1751   (condition-case nil
1752       (let (cache-file)
1753         (when (and cache-path
1754                    (if (elmo-cache-path-section-p cache-path)
1755                        section
1756                      (null section))
1757                    (setq cache-file (elmo-file-cache-expand-path
1758                                      cache-path
1759                                      section))
1760                    (file-exists-p cache-file))
1761           (insert-file-contents-as-binary cache-file)
1762           t))
1763     ;; igore error
1764     (error)))
1765
1766 (defun elmo-cache-path-section-p (path)
1767   "Return non-nil when PATH is `section' cache path."
1768   (file-directory-p path))
1769
1770 (defun elmo-file-cache-get (msgid &optional section)
1771   "Returns the current file-cache object associated with MSGID.
1772 MSGID is the message-id of the message.
1773 If optional argument SECTION is specified, get partial file-cache object
1774 associated with SECTION."
1775   (if msgid
1776       (let ((path (elmo-cache-get-path msgid)))
1777         (if (and path (file-exists-p path))
1778             (if (elmo-cache-path-section-p path)
1779                 (if section
1780                     (if (file-exists-p (setq path (expand-file-name
1781                                                    section path)))
1782                         (cons path 'section))
1783                   ;; section is not specified but sectional.
1784                   (cons path 'section))
1785               ;; not directory.
1786               (unless section
1787                 (cons path 'entire)))
1788           ;; no cache.
1789           (cons path nil)))))
1790
1791 ;;;
1792 ;; Expire cache.
1793
1794 (defun elmo-cache-expire ()
1795   (interactive)
1796   (let* ((completion-ignore-case t)
1797          (method (completing-read (format "Expire by (%s): "
1798                                           elmo-cache-expire-default-method)
1799                                   '(("size" . "size")
1800                                     ("age" . "age")))))
1801     (if (string= method "")
1802         (setq method elmo-cache-expire-default-method))
1803     (funcall (intern (concat "elmo-cache-expire-by-" method)))))
1804
1805 (defun elmo-read-float-value-from-minibuffer (prompt &optional initial)
1806   (let ((str (read-from-minibuffer prompt initial)))
1807     (cond
1808      ((string-match "[0-9]*\\.[0-9]+" str)
1809       (string-to-number str))
1810      ((string-match "[0-9]+" str)
1811       (string-to-number (concat str ".0")))
1812      (t (error "%s is not number" str)))))
1813
1814 (defun elmo-cache-expire-by-size (&optional kbytes)
1815   "Expire cache file by size.
1816 If KBYTES is kilo bytes (This value must be float)."
1817   (interactive)
1818   (let ((size (or kbytes
1819                   (and (interactive-p)
1820                        (elmo-read-float-value-from-minibuffer
1821                         "Enter cache disk size (Kbytes): "
1822                         (number-to-string
1823                          (if (integerp elmo-cache-expire-default-size)
1824                              (float elmo-cache-expire-default-size)
1825                            elmo-cache-expire-default-size))))
1826                   (if (integerp elmo-cache-expire-default-size)
1827                       (float elmo-cache-expire-default-size))))
1828         (count 0)
1829         (Kbytes 1024)
1830         total beginning)
1831     (message "Checking disk usage...")
1832     (setq total (/ (elmo-disk-usage
1833                     elmo-cache-directory) Kbytes))
1834     (setq beginning total)
1835     (message "Checking disk usage...done")
1836     (let ((cfl (elmo-cache-get-sorted-cache-file-list))
1837           (deleted 0)
1838           oldest
1839           cur-size cur-file)
1840       (while (and (<= size total)
1841                   (setq oldest (elmo-cache-get-oldest-cache-file-entity cfl)))
1842         (setq cur-file (expand-file-name (car (cdr oldest)) (car oldest)))
1843         (setq cur-size (/ (elmo-disk-usage cur-file) Kbytes))
1844         (when (elmo-file-cache-delete cur-file)
1845           (setq count (+ count 1))
1846           (message "%d cache(s) are expired." count))
1847         (setq deleted (+ deleted cur-size))
1848         (setq total (- total cur-size)))
1849       (message "%d cache(s) are expired from disk (%d Kbytes/%d Kbytes)."
1850                count deleted beginning))))
1851
1852 (defun elmo-cache-make-file-entity (filename path)
1853   (cons filename (elmo-get-last-accessed-time filename path)))
1854
1855 (defun elmo-cache-get-oldest-cache-file-entity (cache-file-list)
1856   (let ((cfl cache-file-list)
1857         flist firsts oldest-entity wonlist)
1858     (while cfl
1859       (setq flist (cdr (car cfl)))
1860       (setq firsts (append firsts (list
1861                                    (cons (car (car cfl))
1862                                          (car flist)))))
1863       (setq cfl (cdr cfl)))
1864 ;;; (prin1 firsts)
1865     (while firsts
1866       (if (and (not oldest-entity)
1867                (cdr (cdr (car firsts))))
1868           (setq oldest-entity (car firsts)))
1869       (if (and (cdr (cdr (car firsts)))
1870                (cdr (cdr oldest-entity))
1871                (> (cdr (cdr oldest-entity)) (cdr (cdr (car firsts)))))
1872           (setq oldest-entity (car firsts)))
1873       (setq firsts (cdr firsts)))
1874     (setq wonlist (assoc (car oldest-entity) cache-file-list))
1875     (and wonlist
1876          (setcdr wonlist (delete (car (cdr wonlist)) (cdr wonlist))))
1877     oldest-entity))
1878
1879 (defun elmo-cache-get-sorted-cache-file-list ()
1880   (let ((dirs (directory-files
1881                elmo-cache-directory
1882                t "^[^\\.]"))
1883         (i 0) num
1884         elist
1885         ret-val)
1886     (setq num (length dirs))
1887     (message "Collecting cache info...")
1888     (while dirs
1889       (setq elist (mapcar (lambda (x)
1890                             (elmo-cache-make-file-entity x (car dirs)))
1891                           (directory-files (car dirs) nil "^[^\\.]")))
1892       (setq ret-val (append ret-val
1893                             (list (cons
1894                                    (car dirs)
1895                                    (sort
1896                                     elist
1897                                     (lambda (x y)
1898                                       (< (cdr x)
1899                                          (cdr y))))))))
1900       (when (> num elmo-display-progress-threshold)
1901         (setq i (+ i 1))
1902         (elmo-display-progress
1903          'elmo-cache-get-sorted-cache-file-list "Collecting cache info..."
1904          (/ (* i 100) num)))
1905       (setq dirs (cdr dirs)))
1906     (message "Collecting cache info...done")
1907     ret-val))
1908
1909 (defun elmo-cache-expire-by-age (&optional days)
1910   (let ((age (or (and days (int-to-string days))
1911                  (and (interactive-p)
1912                       (read-from-minibuffer
1913                        (format "Enter days (%s): "
1914                                elmo-cache-expire-default-age)))
1915                  (int-to-string elmo-cache-expire-default-age)))
1916         (dirs (directory-files
1917                elmo-cache-directory
1918                t "^[^\\.]"))
1919         (count 0)
1920         curtime)
1921     (if (string= age "")
1922         (setq age elmo-cache-expire-default-age)
1923       (setq age (string-to-int age)))
1924     (setq curtime (current-time))
1925     (setq curtime (+ (* (nth 0 curtime)
1926                         (float 65536)) (nth 1 curtime)))
1927     (while dirs
1928       (let ((files (directory-files (car dirs) t "^[^\\.]"))
1929             (limit-age (* age 86400)))
1930         (while files
1931           (when (> (- curtime (elmo-get-last-accessed-time (car files)))
1932                    limit-age)
1933             (when (elmo-file-cache-delete (car files))
1934               (setq count (+ 1 count))
1935               (message "%d cache file(s) are expired." count)))
1936           (setq files (cdr files))))
1937       (setq dirs (cdr dirs)))))
1938
1939 ;;;
1940 ;; msgid to path.
1941 (defun elmo-msgid-to-cache (msgid)
1942   (save-match-data
1943     (when (and msgid
1944                (string-match "<\\(.+\\)>$" msgid))
1945       (elmo-replace-string-as-filename (elmo-match-string 1 msgid)))))
1946
1947 (defun elmo-cache-get-path (msgid &optional folder number)
1948   "Get path for cache file associated with MSGID, FOLDER, and NUMBER."
1949   (if (setq msgid (elmo-msgid-to-cache msgid))
1950       (expand-file-name
1951        (expand-file-name
1952         (if folder
1953             (format "%s/%s/%s@%s"
1954                     (elmo-cache-get-path-subr msgid)
1955                     msgid
1956                     (or number "")
1957                     (elmo-safe-filename folder))
1958           (format "%s/%s"
1959                   (elmo-cache-get-path-subr msgid)
1960                   msgid))
1961         elmo-cache-directory))))
1962
1963 ;;;
1964 ;; Warnings.
1965
1966 (static-if (fboundp 'display-warning)
1967     (defmacro elmo-warning (&rest args)
1968       "Display a warning with `elmo' group."
1969       `(display-warning 'elmo (format ,@args)))
1970   (defconst elmo-warning-buffer-name "*elmo warning*")
1971   (defun elmo-warning (&rest args)
1972     "Display a warning. ARGS are passed to `format'."
1973     (with-current-buffer (get-buffer-create elmo-warning-buffer-name)
1974       (goto-char (point-max))
1975       (funcall 'insert (apply 'format (append args '("\n"))))
1976       (ignore-errors (recenter 1))
1977       (display-buffer elmo-warning-buffer-name))))
1978
1979 (defvar elmo-obsolete-variable-alist nil)
1980
1981 (defcustom elmo-obsolete-variable-show-warnings t
1982   "Show warning window if obsolete variable is treated."
1983   :type 'boolean
1984   :group 'elmo)
1985
1986 (defun elmo-define-obsolete-variable (obsolete var)
1987   "Define obsolete variable.
1988 OBSOLETE is a symbol for obsolete variable.
1989 VAR is a symbol for new variable.
1990 Definition is stored in `elmo-obsolete-variable-alist'."
1991   (let ((pair (assq var elmo-obsolete-variable-alist)))
1992     (if pair
1993         (setcdr pair obsolete)
1994       (setq elmo-obsolete-variable-alist
1995             (cons (cons var obsolete)
1996                   elmo-obsolete-variable-alist)))))
1997
1998 (defun elmo-resque-obsolete-variable (obsolete var)
1999   "Resque obsolete variable OBSOLETE as VAR.
2000 If `elmo-obsolete-variable-show-warnings' is non-nil, show warning message."
2001   (when (boundp obsolete)
2002     (static-if (and (fboundp 'defvaralias)
2003                     (subrp (symbol-function 'defvaralias)))
2004         (defvaralias var obsolete)
2005       (set var (symbol-value obsolete)))
2006     (if elmo-obsolete-variable-show-warnings
2007         (elmo-warning "%s is obsolete. Use %s instead."
2008                       (symbol-name obsolete)
2009                       (symbol-name var)))))
2010
2011 (defun elmo-resque-obsolete-variables (&optional alist)
2012   "Resque obsolete variables in ALIST.
2013 ALIST is a list of cons cell of
2014 \(OBSOLETE-VARIABLE-SYMBOL . NEW-VARIABLE-SYMBOL\).
2015 If ALIST is nil, `elmo-obsolete-variable-alist' is used."
2016   (dolist (pair elmo-obsolete-variable-alist)
2017     (elmo-resque-obsolete-variable (cdr pair)
2018                                    (car pair))))
2019
2020 ;;; Queue.
2021 (defvar elmo-dop-queue-filename "queue"
2022   "*Disconnected operation queue is saved in this file.")
2023
2024 (defun elmo-dop-queue-load ()
2025   (setq elmo-dop-queue
2026         (elmo-object-load
2027          (expand-file-name elmo-dop-queue-filename
2028                            elmo-msgdb-directory))))
2029
2030 (defun elmo-dop-queue-save ()
2031   (elmo-object-save
2032    (expand-file-name elmo-dop-queue-filename
2033                      elmo-msgdb-directory)
2034    elmo-dop-queue))
2035
2036 (if (and (fboundp 'regexp-opt)
2037          (not (featurep 'xemacs)))
2038     (defalias 'elmo-regexp-opt 'regexp-opt)
2039   (defun elmo-regexp-opt (strings &optional paren)
2040     "Return a regexp to match a string in STRINGS.
2041 Each string should be unique in STRINGS and should not contain any regexps,
2042 quoted or not.  If optional PAREN is non-nil, ensure that the returned regexp
2043 is enclosed by at least one regexp grouping construct."
2044     (let ((open-paren (if paren "\\(" "")) (close-paren (if paren "\\)" "")))
2045       (concat open-paren (mapconcat 'regexp-quote strings "\\|")
2046               close-paren))))
2047
2048 (require 'product)
2049 (product-provide (provide 'elmo-util) (require 'elmo-version))
2050
2051 ;;; elmo-util.el ends here