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