be810a92b10b7a2bb34672d08689f3ad8f304fdd
[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-directory))
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-directory))
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-directory))
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       (if (eq (elmo-filter-type condition) 'unmatch)
902           (setq result (not result))))
903      ((string= (elmo-filter-key condition) "first")
904       (setq result (< (- (length number-list)
905                          (length (memq number number-list)))
906                       (string-to-int (elmo-filter-value condition))))
907       (if (eq (elmo-filter-type condition) 'unmatch)
908           (setq result (not result))))
909      (t
910       (elmo-set-work-buf
911        (as-binary-input-file (insert-file-contents file))
912        (elmo-set-buffer-multibyte default-enable-multibyte-characters)
913        ;; Should consider charset?
914        (decode-mime-charset-region (point-min)(point-max) elmo-mime-charset)
915        (setq result
916              (elmo-buffer-field-primitive-condition-match
917               condition number number-list)))))
918     result))
919
920 (defun elmo-file-field-condition-match (file condition number number-list)
921   (cond
922    ((vectorp condition)
923     (elmo-file-field-primitive-condition-match
924      file condition number number-list))
925    ((eq (car condition) 'and)
926     (and (elmo-file-field-condition-match
927           file (nth 1 condition) number number-list)
928          (elmo-file-field-condition-match
929           file (nth 2 condition) number number-list)))
930    ((eq (car condition) 'or)
931     (or (elmo-file-field-condition-match
932          file (nth 1 condition) number number-list)
933         (elmo-file-field-condition-match
934          file (nth 2 condition) number number-list)))))
935
936 (defmacro elmo-get-hash-val (string hashtable)
937   (let ((sym (list 'intern-soft string hashtable)))
938     (list 'if (list 'boundp sym)
939        (list 'symbol-value sym))))
940
941 (defmacro elmo-set-hash-val (string value hashtable)
942   (list 'set (list 'intern string hashtable) value))
943
944 (defmacro elmo-clear-hash-val (string hashtable)
945   (static-if (fboundp 'unintern)
946       (list 'unintern string hashtable)
947     (list 'makunbound (list 'intern string hashtable))))
948
949 (defmacro elmo-unintern (string)
950   "`unintern' symbol named STRING,  When can use `unintern'.
951 Emacs 19.28 or earlier does not have `unintern'."
952   (static-if (fboundp 'unintern)
953       (list 'unintern string)))
954
955 (defun elmo-make-hash (&optional hashsize)
956   "Make a new hash table which have HASHSIZE size."
957   (make-vector
958    (if hashsize
959        (max
960         ;; Prime numbers as lengths tend to result in good
961         ;; hashing; lengths one less than a power of two are
962         ;; also good.
963         (min
964          (let ((i 1))
965            (while (< (- i 1) hashsize)
966              (setq i (* 2 i)))
967            (- i 1))
968          elmo-hash-maximum-size)
969         elmo-hash-minimum-size)
970      elmo-hash-minimum-size)
971    0))
972
973 (defsubst elmo-mime-string (string)
974   "Normalize MIME encoded STRING."
975     (and string
976          (let (str)
977            (elmo-set-work-buf
978             (elmo-set-buffer-multibyte default-enable-multibyte-characters)
979             (setq str (eword-decode-string
980                        (decode-mime-charset-string string elmo-mime-charset)))
981             (setq str (encode-mime-charset-string str elmo-mime-charset))
982             (elmo-set-buffer-multibyte nil)
983             str))))
984
985 (defsubst elmo-collect-field (beg end downcase-field-name)
986   (save-excursion
987     (save-restriction
988       (narrow-to-region beg end)
989       (goto-char (point-min))
990       (let ((regexp (concat "\\(" std11-field-head-regexp "\\)[ \t]*"))
991             dest name body)
992         (while (re-search-forward regexp nil t)
993           (setq name (buffer-substring-no-properties
994                       (match-beginning 1)(1- (match-end 1))))
995           (if downcase-field-name
996               (setq name (downcase name)))
997           (setq body (buffer-substring-no-properties
998                       (match-end 0) (std11-field-end)))
999           (or (assoc name dest)
1000               (setq dest (cons (cons name body) dest))))
1001         dest))))
1002
1003 (defsubst elmo-collect-field-from-string (string downcase-field-name)
1004   (with-temp-buffer
1005     (insert string)
1006     (goto-char (point-min))
1007     (let ((regexp (concat "\\(" std11-field-head-regexp "\\)[ \t]*"))
1008           dest name body)
1009       (while (re-search-forward regexp nil t)
1010         (setq name (buffer-substring-no-properties
1011                     (match-beginning 1)(1- (match-end 1))))
1012         (if downcase-field-name
1013             (setq name (downcase name)))
1014         (setq body (buffer-substring-no-properties
1015                     (match-end 0) (std11-field-end)))
1016         (or (assoc name dest)
1017             (setq dest (cons (cons name body) dest))))
1018       dest)))
1019
1020 (defun elmo-safe-filename (folder)
1021   (elmo-replace-in-string
1022    (elmo-replace-in-string
1023     (elmo-replace-in-string folder "/" " ")
1024     ":" "__")
1025    "|" "_or_"))
1026
1027 (defvar elmo-filename-replace-chars nil)
1028
1029 (defsubst elmo-replace-string-as-filename (msgid)
1030   "Replace string as filename."
1031   (setq msgid (elmo-replace-in-string msgid " " "  "))
1032   (if (null elmo-filename-replace-chars)
1033       (setq elmo-filename-replace-chars
1034             (regexp-quote (mapconcat
1035                            'car elmo-filename-replace-string-alist ""))))
1036   (while (string-match (concat "[" elmo-filename-replace-chars "]")
1037                        msgid)
1038     (setq msgid (concat
1039                  (substring msgid 0 (match-beginning 0))
1040                  (cdr (assoc
1041                        (substring msgid
1042                                   (match-beginning 0) (match-end 0))
1043                        elmo-filename-replace-string-alist))
1044                  (substring msgid (match-end 0)))))
1045   msgid)
1046
1047 (defsubst elmo-recover-string-from-filename (filename)
1048   "Recover string from FILENAME."
1049   (let (tmp result)
1050     (while (string-match " " filename)
1051       (setq tmp (substring filename
1052                            (match-beginning 0)
1053                            (+ (match-end 0) 1)))
1054       (if (string= tmp "  ")
1055           (setq tmp " ")
1056         (setq tmp (car (rassoc tmp
1057                                elmo-filename-replace-string-alist))))
1058       (setq result
1059             (concat result
1060                     (substring filename 0 (match-beginning 0))
1061                     tmp))
1062       (setq filename (substring filename (+ (match-end 0) 1))))
1063     (concat result filename)))
1064
1065 (defsubst elmo-copy-file (src dst &optional ok-if-already-exists)
1066   (condition-case err
1067       (elmo-add-name-to-file src dst ok-if-already-exists)
1068     (error (copy-file src dst ok-if-already-exists t))))
1069
1070 (defsubst elmo-buffer-exists-p (buffer)
1071   (if (bufferp buffer)
1072       (buffer-live-p buffer)
1073     (get-buffer buffer)))
1074
1075 (defsubst elmo-kill-buffer (buffer)
1076   (when (elmo-buffer-exists-p buffer)
1077     (kill-buffer buffer)))
1078
1079 (defun elmo-delete-if (pred lst)
1080   "Return new list contain items which don't satisfy PRED in LST."
1081   (let (result)
1082     (while lst
1083       (unless (funcall pred (car lst))
1084         (setq result (nconc result (list (car lst)))))
1085       (setq lst (cdr lst)))
1086     result))
1087
1088 (defun elmo-list-delete (list1 list2)
1089   "Delete by side effect any occurrences equal to elements of LIST1 from LIST2.
1090 Return the modified LIST2.  Deletion is done with `delete'.
1091 Write `(setq foo (elmo-list-delete bar foo))' to be sure of changing
1092 the value of `foo'."
1093   (while list1
1094     (setq list2 (delete (car list1) list2))
1095     (setq list1 (cdr list1)))
1096   list2)
1097
1098 (defun elmo-list-member (list1 list2)
1099   "If any element of LIST1 is member of LIST2, return t."
1100   (catch 'done
1101     (while list1
1102       (if (member (car list1) list2)
1103           (throw 'done t))
1104       (setq list1 (cdr list1)))))
1105
1106 (defun elmo-count-matches (regexp beg end)
1107   (let ((count 0))
1108     (save-excursion
1109       (goto-char beg)
1110       (while (re-search-forward regexp end t)
1111         (setq count (1+ count)))
1112       count)))
1113
1114 (if (fboundp 'display-error)
1115     (defalias 'elmo-display-error 'display-error)
1116   (defun elmo-display-error (error-object stream)
1117     "A tiny function to display ERROR-OBJECT to the STREAM."
1118     (let ((first t)
1119           (errobj error-object)
1120           err-mes)
1121       (while errobj
1122         (setq err-mes (concat err-mes (format
1123                                        (if (stringp (car errobj))
1124                                            "%s"
1125                                          "%S")
1126                                        (car errobj))))
1127         (setq errobj (cdr errobj))
1128         (if errobj (setq err-mes (concat err-mes (if first ": " ", "))))
1129         (setq first nil))
1130       (princ err-mes stream))))
1131
1132 (if (fboundp 'define-error)
1133     (defalias 'elmo-define-error 'define-error)
1134   (defun elmo-define-error (error doc &optional parents)
1135     (or parents
1136         (setq parents 'error))
1137     (let ((conds (get parents 'error-conditions)))
1138       (or conds
1139           (error "Not an error symbol: %s" error))
1140       (setplist error
1141                 (list 'error-message doc
1142                       'error-conditions (cons error conds))))))
1143
1144 (cond ((fboundp 'progress-feedback-with-label)
1145        (defalias 'elmo-display-progress 'progress-feedback-with-label))
1146       ((fboundp 'lprogress-display)
1147        (defalias 'elmo-display-progress 'lprogress-display))
1148       (t
1149        (defun elmo-display-progress (label format &optional value &rest args)
1150          "Print a progress message."
1151          (if (and (null format) (null args))
1152              (message nil)
1153            (apply (function message) (concat format " %d%%")
1154                   (nconc args (list value)))))))
1155
1156 (defvar elmo-progress-counter-alist nil)
1157
1158 (defmacro elmo-progress-counter-value (counter)
1159   (` (aref (cdr (, counter)) 0)))
1160
1161 (defmacro elmo-progress-counter-all-value (counter)
1162   (` (aref (cdr (, counter)) 1)))
1163
1164 (defmacro elmo-progress-counter-format (counter)
1165   (` (aref (cdr (, counter)) 2)))
1166
1167 (defmacro elmo-progress-counter-set-value (counter value)
1168   (` (aset (cdr (, counter)) 0 (, value))))
1169
1170 (defun elmo-progress-set (label all-value &optional format)
1171   (unless (assq label elmo-progress-counter-alist)
1172     (setq elmo-progress-counter-alist
1173           (cons (cons label (vector 0 all-value (or format "")))
1174                 elmo-progress-counter-alist))))
1175
1176 (defun elmo-progress-clear (label)
1177   (let ((counter (assq label elmo-progress-counter-alist)))
1178     (when counter
1179       (elmo-display-progress label "" 100)
1180       (setq elmo-progress-counter-alist
1181             (delq counter elmo-progress-counter-alist)))))
1182
1183 (defun elmo-progress-notify (label &optional value op &rest args)
1184   (let ((counter (assq label elmo-progress-counter-alist)))
1185     (when counter
1186       (let* ((value (or value 1))
1187              (cur-value (elmo-progress-counter-value counter))
1188              (all-value (elmo-progress-counter-all-value counter))
1189              (new-value (if (eq op 'set) value (+ cur-value value)))
1190              (cur-rate (/ (* cur-value 100) all-value))
1191              (new-rate (/ (* new-value 100) all-value)))
1192         (elmo-progress-counter-set-value counter new-value)
1193         (unless (= cur-rate new-rate)
1194           (apply 'elmo-display-progress
1195                  label
1196                  (elmo-progress-counter-format counter)
1197                  new-rate
1198                  args))
1199         (when (>= new-rate 100)
1200           (elmo-progress-clear label))))))
1201
1202 (defun elmo-time-expire (before-time diff-time)
1203   (let* ((current (current-time))
1204          (rest (when (< (nth 1 current) (nth 1 before-time))
1205                  (expt 2 16)))
1206          diff)
1207     (setq diff
1208           (list (- (+ (car current) (if rest -1 0)) (car before-time))
1209                 (- (+ (or rest 0) (nth 1 current)) (nth 1 before-time))))
1210     (and (eq (car diff) 0)
1211          (< diff-time (nth 1 diff)))))
1212
1213 (if (fboundp 'std11-fetch-field)
1214     (defalias 'elmo-field-body 'std11-fetch-field) ;;no narrow-to-region
1215   (defalias 'elmo-field-body 'std11-field-body))
1216
1217 (defun elmo-address-quote-specials (word)
1218   "Make quoted string of WORD if needed."
1219   (let ((lal (std11-lexical-analyze word)))
1220     (if (or (assq 'specials lal)
1221             (assq 'domain-literal lal))
1222         (prin1-to-string word)
1223       word)))
1224
1225 (defmacro elmo-string (string)
1226   "STRING without text property."
1227   (` (let ((obj (copy-sequence (, string))))
1228        (set-text-properties 0 (length obj) nil obj)
1229        obj)))
1230
1231 (defun elmo-flatten (list-of-list)
1232   "Flatten LIST-OF-LIST."
1233   (unless (null list-of-list)
1234     (append (if (and (car list-of-list)
1235                      (listp (car list-of-list)))
1236                 (car list-of-list)
1237               (list (car list-of-list)))
1238             (elmo-flatten (cdr list-of-list)))))
1239
1240 (defun elmo-y-or-n-p (prompt &optional auto default)
1241   "Same as `y-or-n-p'.
1242 But if optional argument AUTO is non-nil, DEFAULT is returned."
1243   (if auto
1244       default
1245     (y-or-n-p prompt)))
1246
1247 (defun elmo-string-member (string slist)
1248   "Return t if STRING is a member of the SLIST."
1249   (catch 'found
1250     (while slist
1251       (if (and (stringp (car slist))
1252                (string= string (car slist)))
1253           (throw 'found t))
1254       (setq slist (cdr slist)))))
1255
1256 (defun elmo-string-match-member (str list &optional case-ignore)
1257   (let ((case-fold-search case-ignore))
1258     (catch 'member
1259       (while list
1260         (if (string-match (car list) str)
1261             (throw 'member (car list)))
1262         (setq list (cdr list))))))
1263
1264 (defun elmo-string-matched-member (str list &optional case-ignore)
1265   (let ((case-fold-search case-ignore))
1266     (catch 'member
1267       (while list
1268         (if (string-match str (car list))
1269             (throw 'member (car list)))
1270         (setq list (cdr list))))))
1271
1272 (defsubst elmo-string-delete-match (string pos)
1273   (concat (substring string
1274                      0 (match-beginning pos))
1275           (substring string
1276                      (match-end pos)
1277                      (length string))))
1278
1279 (defun elmo-string-match-assoc (key alist &optional case-ignore)
1280   (let ((case-fold-search case-ignore)
1281         a)
1282     (catch 'loop
1283       (while alist
1284         (setq a (car alist))
1285         (if (and (consp a)
1286                  (stringp (car a))
1287                  (string-match key (car a)))
1288             (throw 'loop a))
1289         (setq alist (cdr alist))))))
1290
1291 (defun elmo-string-matched-assoc (key alist &optional case-ignore)
1292   (let ((case-fold-search case-ignore)
1293         a)
1294     (catch 'loop
1295       (while alist
1296         (setq a (car alist))
1297         (if (and (consp a)
1298                  (stringp (car a))
1299                  (string-match (car a) key))
1300             (throw 'loop a))
1301         (setq alist (cdr alist))))))
1302
1303 (defun elmo-string-assoc (key alist)
1304   (let (a)
1305     (catch 'loop
1306       (while alist
1307         (setq a (car alist))
1308         (if (and (consp a)
1309                  (stringp (car a))
1310                  (string= key (car a)))
1311             (throw 'loop a))
1312         (setq alist (cdr alist))))))
1313
1314 (defun elmo-string-assoc-all (key alist)
1315   (let (matches)
1316     (while alist
1317       (if (string= key (car (car alist)))
1318           (setq matches
1319                 (cons (car alist)
1320                       matches)))
1321       (setq alist (cdr alist)))
1322     matches))
1323
1324 (defun elmo-string-rassoc (key alist)
1325   (let (a)
1326     (catch 'loop
1327       (while alist
1328         (setq a (car alist))
1329         (if (and (consp a)
1330                  (stringp (cdr a))
1331                  (string= key (cdr a)))
1332             (throw 'loop a))
1333         (setq alist (cdr alist))))))
1334
1335 (defun elmo-string-rassoc-all (key alist)
1336   (let (matches)
1337     (while alist
1338       (if (string= key (cdr (car alist)))
1339           (setq matches
1340                 (cons (car alist)
1341                       matches)))
1342       (setq alist (cdr alist)))
1343     matches))
1344
1345 ;;; Folder parser utils.
1346 (defun elmo-parse-token (string &optional seps)
1347   "Parse atom from STRING using SEPS as a string of separator char list."
1348   (let ((len (length string))
1349         (seps (and seps (string-to-char-list seps)))
1350         (i 0)
1351         (sep nil)
1352         content c in)
1353     (if (eq len 0)
1354         (cons "" "")
1355       (while (and (< i len) (or in (null sep)))
1356         (setq c (aref string i))
1357         (cond
1358          ((and in (eq c ?\\))
1359           (setq i (1+ i)
1360                 content (cons (aref string i) content)
1361                 i (1+ i)))
1362          ((eq c ?\")
1363           (setq in (not in)
1364                 i (1+ i)))
1365          (in (setq content (cons c content)
1366                    i (1+ i)))
1367          ((memq c seps)
1368           (setq sep c))
1369          (t (setq content (cons c content)
1370                   i (1+ i)))))
1371       (if in (error "Parse error in quoted"))
1372       (cons (if (null content) "" (char-list-to-string (nreverse content)))
1373             (substring string i)))))
1374
1375 (defun elmo-parse-prefixed-element (prefix string &optional seps)
1376   (if (and (not (eq (length string) 0))
1377            (eq (aref string 0) prefix))
1378       (elmo-parse-token (substring string 1) seps)
1379     (cons "" string)))
1380
1381 ;;; Number set defined by OKAZAKI Tetsurou <okazaki@be.to>
1382 ;;
1383 ;; number          ::= [0-9]+
1384 ;; beg             ::= number
1385 ;; end             ::= number
1386 ;; number-range    ::= "(" beg " . " end ")"      ;; cons cell
1387 ;; number-set-elem ::= number / number-range
1388 ;; number-set      ::= "(" *number-set-elem ")"   ;; list
1389
1390 (defun elmo-number-set-member (number number-set)
1391   "Return non-nil if NUMBER is an element of NUMBER-SET.
1392 The value is actually the tail of NUMBER-RANGE whose car contains NUMBER."
1393   (or (memq number number-set)
1394       (let (found)
1395         (while (and number-set (not found))
1396           (if (and (consp (car number-set))
1397                    (and (<= (car (car number-set)) number)
1398                         (<= number (cdr (car number-set)))))
1399               (setq found t)
1400             (setq number-set (cdr number-set))))
1401         number-set)))
1402
1403 (defun elmo-number-set-append-list (number-set list)
1404   "Append LIST of numbers to the NUMBER-SET.
1405 NUMBER-SET is altered."
1406   (let ((appended number-set))
1407     (while list
1408       (setq appended (elmo-number-set-append appended (car list)))
1409       (setq list (cdr list)))
1410     appended))
1411
1412 (defun elmo-number-set-append (number-set number)
1413   "Append NUMBER to the NUMBER-SET.
1414 NUMBER-SET is altered."
1415   (let ((number-set-1 number-set)
1416         found elem)
1417     (while (and number-set (not found))
1418       (setq elem (car number-set))
1419       (cond
1420        ((and (consp elem)
1421              (eq (+ 1 (cdr elem)) number))
1422         (setcdr elem number)
1423         (setq found t))
1424        ((and (integerp elem)
1425              (eq (+ 1 elem) number))
1426         (setcar number-set (cons elem number))
1427         (setq found t))
1428        ((or (and (integerp elem) (eq elem number))
1429             (and (consp elem)
1430                  (<= (car elem) number)
1431                  (<= number (cdr elem))))
1432         (setq found t)))
1433       (setq number-set (cdr number-set)))
1434     (if (not found)
1435         (setq number-set-1 (nconc number-set-1 (list number))))
1436     number-set-1))
1437
1438 (defun elmo-number-set-to-number-list (number-set)
1439   "Return a number list which corresponds to NUMBER-SET."
1440   (let (number-list elem i)
1441     (while number-set
1442       (setq elem (car number-set))
1443       (cond
1444        ((consp elem)
1445         (setq i (car elem))
1446         (while (<= i (cdr elem))
1447           (setq number-list (cons i number-list))
1448           (incf i)))
1449        ((integerp elem)
1450         (setq number-list (cons elem number-list))))
1451       (setq number-set (cdr number-set)))
1452     (nreverse number-list)))
1453
1454 (defcustom elmo-list-subdirectories-ignore-regexp "^\\(\\.\\.?\\|[0-9]+\\)$"
1455   "*Regexp to filter subfolders."
1456   :type 'regexp
1457   :group 'elmo)
1458
1459 (defun elmo-list-subdirectories-1 (basedir curdir one-level)
1460   (let ((root (zerop (length curdir)))
1461         (w32-get-true-file-link-count t) ; for Meadow
1462         attr dirs dir)
1463     (catch 'done
1464       (dolist (file (directory-files (setq dir (expand-file-name curdir basedir))))
1465         (when (and (not (string-match
1466                          elmo-list-subdirectories-ignore-regexp
1467                          file))
1468                    (car (setq attr (file-attributes
1469                                     (expand-file-name file dir)))))
1470           (when (eq one-level 'check) (throw 'done t))
1471           (let ((relpath
1472                  (concat curdir (and (not root) elmo-path-sep) file))
1473                 subdirs)
1474             (setq dirs (nconc dirs
1475                               (if (if elmo-have-link-count (< 2 (nth 1 attr))
1476                                     (setq subdirs
1477                                           (elmo-list-subdirectories-1
1478                                            basedir
1479                                            relpath
1480                                            (if one-level 'check))))
1481                                   (if one-level
1482                                       (list (list relpath))
1483                                     (cons relpath
1484                                           (or subdirs
1485                                               (elmo-list-subdirectories-1
1486                                                basedir
1487                                                relpath
1488                                                nil))))
1489                                 (list relpath)))))))
1490       dirs)))
1491
1492 (defun elmo-list-subdirectories (directory file one-level)
1493   (let ((subdirs (elmo-list-subdirectories-1 directory file one-level)))
1494     (if (zerop (length file))
1495         subdirs
1496       (cons file subdirs))))
1497
1498 (defun elmo-mapcar-list-of-list (func list-of-list)
1499   (mapcar
1500    (lambda (x)
1501      (cond ((listp x) (elmo-mapcar-list-of-list func x))
1502            (t (funcall func x))))
1503    list-of-list))
1504
1505 (defun elmo-parse (string regexp &optional matchn)
1506   (or matchn (setq matchn 1))
1507   (let (list)
1508     (store-match-data nil)
1509     (while (string-match regexp string (match-end 0))
1510       (setq list (cons (substring string (match-beginning matchn)
1511                                   (match-end matchn)) list)))
1512     (nreverse list)))
1513
1514 ;;; File cache.
1515 (defmacro elmo-make-file-cache (path status)
1516   "PATH is the cache file name.
1517 STATUS is one of 'section, 'entire or nil.
1518  nil means no cache exists.
1519 'section means partial section cache exists.
1520 'entire means entire cache exists.
1521 If the cache is partial file-cache, TYPE is 'partial."
1522   (` (cons (, path) (, status))))
1523
1524 (defmacro elmo-file-cache-path (file-cache)
1525   "Returns the file path of the FILE-CACHE."
1526   (` (car (, file-cache))))
1527
1528 (defmacro elmo-file-cache-status (file-cache)
1529   "Returns the status of the FILE-CACHE."
1530   (` (cdr (, file-cache))))
1531
1532 (defsubst elmo-cache-to-msgid (filename)
1533   (concat "<" (elmo-recover-string-from-filename filename) ">"))
1534
1535 (defsubst elmo-cache-get-path-subr (msgid)
1536   (let ((chars '(?0 ?1 ?2 ?3 ?4 ?5 ?6 ?7 ?8 ?9 ?A ?B ?C ?D ?E ?F))
1537         (clist (string-to-char-list msgid))
1538         (sum 0))
1539     (while clist
1540       (setq sum (+ sum (car clist)))
1541       (setq clist (cdr clist)))
1542     (format "%c%c"
1543             (nth (% (/ sum 16) 2) chars)
1544             (nth (% sum 16) chars))))
1545
1546 (defun elmo-file-cache-get-path (msgid &optional section)
1547   "Get cache path for MSGID.
1548 If optional argument SECTION is specified, partial cache path is returned."
1549   (if (setq msgid (elmo-msgid-to-cache msgid))
1550       (expand-file-name
1551        (if section
1552            (format "%s/%s/%s/%s"
1553                    elmo-cache-directory
1554                    (elmo-cache-get-path-subr msgid)
1555                    msgid
1556                    section)
1557          (format "%s/%s/%s"
1558                  elmo-cache-directory
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-file-cache-load (cache-path section)
1614   "Load cache on PATH into the current buffer.
1615 Return t if cache is loaded successfully."
1616   (condition-case nil
1617       (let (cache-file)
1618         (when (and cache-path
1619                    (if (elmo-cache-path-section-p cache-path)
1620                        section
1621                      (null section))
1622                    (setq cache-file (elmo-file-cache-expand-path
1623                                      cache-path
1624                                      section))
1625                    (file-exists-p cache-file))
1626           (insert-file-contents-as-binary cache-file)
1627           t))
1628     ;; igore error
1629     (error)))
1630
1631 (defun elmo-cache-path-section-p (path)
1632   "Return non-nil when PATH is `section' cache path."
1633   (file-directory-p path))
1634
1635 (defun elmo-file-cache-get (msgid &optional section)
1636   "Returns the current file-cache object associated with MSGID.
1637 MSGID is the message-id of the message.
1638 If optional argument SECTION is specified, get partial file-cache object
1639 associated with SECTION."
1640   (if msgid
1641       (let ((path (elmo-cache-get-path msgid)))
1642         (if (and path (file-exists-p path))
1643             (if (elmo-cache-path-section-p path)
1644                 (if section
1645                     (if (file-exists-p (setq path (expand-file-name
1646                                                    section path)))
1647                         (cons path 'section))
1648                   ;; section is not specified but sectional.
1649                   (cons path 'section))
1650               ;; not directory.
1651               (unless section
1652                 (cons path 'entire)))
1653           ;; no cache.
1654           (cons path nil)))))
1655
1656 ;;;
1657 ;; Expire cache.
1658
1659 (defun elmo-cache-expire ()
1660   (interactive)
1661   (let* ((completion-ignore-case t)
1662          (method (completing-read (format "Expire by (%s): "
1663                                           elmo-cache-expire-default-method)
1664                                   '(("size" . "size")
1665                                     ("age" . "age")))))
1666     (if (string= method "")
1667         (setq method elmo-cache-expire-default-method))
1668     (funcall (intern (concat "elmo-cache-expire-by-" method)))))
1669
1670 (defun elmo-read-float-value-from-minibuffer (prompt &optional initial)
1671   (let ((str (read-from-minibuffer prompt initial)))
1672     (cond
1673      ((string-match "[0-9]*\\.[0-9]+" str)
1674       (string-to-number str))
1675      ((string-match "[0-9]+" str)
1676       (string-to-number (concat str ".0")))
1677      (t (error "%s is not number" str)))))
1678
1679 (defun elmo-cache-expire-by-size (&optional kbytes)
1680   "Expire cache file by size.
1681 If KBYTES is kilo bytes (This value must be float)."
1682   (interactive)
1683   (let ((size (or kbytes
1684                   (and (interactive-p)
1685                        (elmo-read-float-value-from-minibuffer
1686                         "Enter cache disk size (Kbytes): "
1687                         (number-to-string
1688                          (if (integerp elmo-cache-expire-default-size)
1689                              (float elmo-cache-expire-default-size)
1690                            elmo-cache-expire-default-size))))
1691                   (if (integerp elmo-cache-expire-default-size)
1692                       (float elmo-cache-expire-default-size))))
1693         (count 0)
1694         (Kbytes 1024)
1695         total beginning)
1696     (message "Checking disk usage...")
1697     (setq total (/ (elmo-disk-usage
1698                     elmo-cache-directory) Kbytes))
1699     (setq beginning total)
1700     (message "Checking disk usage...done")
1701     (let ((cfl (elmo-cache-get-sorted-cache-file-list))
1702           (deleted 0)
1703           oldest
1704           cur-size cur-file)
1705       (while (and (<= size total)
1706                   (setq oldest (elmo-cache-get-oldest-cache-file-entity cfl)))
1707         (setq cur-file (expand-file-name (car (cdr oldest)) (car oldest)))
1708         (setq cur-size (/ (elmo-disk-usage cur-file) Kbytes))
1709         (when (elmo-file-cache-delete cur-file)
1710           (setq count (+ count 1))
1711           (message "%d cache(s) are expired." count))
1712         (setq deleted (+ deleted cur-size))
1713         (setq total (- total cur-size)))
1714       (message "%d cache(s) are expired from disk (%d Kbytes/%d Kbytes)."
1715                count deleted beginning))))
1716
1717 (defun elmo-cache-make-file-entity (filename path)
1718   (cons filename (elmo-get-last-accessed-time filename path)))
1719
1720 (defun elmo-cache-get-oldest-cache-file-entity (cache-file-list)
1721   (let ((cfl cache-file-list)
1722         flist firsts oldest-entity wonlist)
1723     (while cfl
1724       (setq flist (cdr (car cfl)))
1725       (setq firsts (append firsts (list
1726                                    (cons (car (car cfl))
1727                                          (car flist)))))
1728       (setq cfl (cdr cfl)))
1729 ;;; (prin1 firsts)
1730     (while firsts
1731       (if (and (not oldest-entity)
1732                (cdr (cdr (car firsts))))
1733           (setq oldest-entity (car firsts)))
1734       (if (and (cdr (cdr (car firsts)))
1735                (cdr (cdr oldest-entity))
1736                (> (cdr (cdr oldest-entity)) (cdr (cdr (car firsts)))))
1737           (setq oldest-entity (car firsts)))
1738       (setq firsts (cdr firsts)))
1739     (setq wonlist (assoc (car oldest-entity) cache-file-list))
1740     (and wonlist
1741          (setcdr wonlist (delete (car (cdr wonlist)) (cdr wonlist))))
1742     oldest-entity))
1743
1744 (defun elmo-cache-get-sorted-cache-file-list ()
1745   (let ((dirs (directory-files
1746                elmo-cache-directory
1747                t "^[^\\.]"))
1748         (i 0) num
1749         elist
1750         ret-val)
1751     (setq num (length dirs))
1752     (message "Collecting cache info...")
1753     (while dirs
1754       (setq elist (mapcar (lambda (x)
1755                             (elmo-cache-make-file-entity x (car dirs)))
1756                           (directory-files (car dirs) nil "^[^\\.]")))
1757       (setq ret-val (append ret-val
1758                             (list (cons
1759                                    (car dirs)
1760                                    (sort
1761                                     elist
1762                                     (lambda (x y)
1763                                       (< (cdr x)
1764                                          (cdr y))))))))
1765       (when (> num elmo-display-progress-threshold)
1766         (setq i (+ i 1))
1767         (elmo-display-progress
1768          'elmo-cache-get-sorted-cache-file-list "Collecting cache info..."
1769          (/ (* i 100) num)))
1770       (setq dirs (cdr dirs)))
1771     (message "Collecting cache info...done")
1772     ret-val))
1773
1774 (defun elmo-cache-expire-by-age (&optional days)
1775   (let ((age (or (and days (int-to-string days))
1776                  (and (interactive-p)
1777                       (read-from-minibuffer
1778                        (format "Enter days (%s): "
1779                                elmo-cache-expire-default-age)))
1780                  (int-to-string elmo-cache-expire-default-age)))
1781         (dirs (directory-files
1782                elmo-cache-directory
1783                t "^[^\\.]"))
1784         (count 0)
1785         curtime)
1786     (if (string= age "")
1787         (setq age elmo-cache-expire-default-age)
1788       (setq age (string-to-int age)))
1789     (setq curtime (current-time))
1790     (setq curtime (+ (* (nth 0 curtime)
1791                         (float 65536)) (nth 1 curtime)))
1792     (while dirs
1793       (let ((files (directory-files (car dirs) t "^[^\\.]"))
1794             (limit-age (* age 86400)))
1795         (while files
1796           (when (> (- curtime (elmo-get-last-accessed-time (car files)))
1797                    limit-age)
1798             (when (elmo-file-cache-delete (car files))
1799               (setq count (+ 1 count))
1800               (message "%d cache file(s) are expired." count)))
1801           (setq files (cdr files))))
1802       (setq dirs (cdr dirs)))))
1803
1804 ;;;
1805 ;; msgid to path.
1806 (defun elmo-msgid-to-cache (msgid)
1807   (save-match-data
1808     (when (and msgid
1809                (string-match "<\\(.+\\)>$" msgid))
1810       (elmo-replace-string-as-filename (elmo-match-string 1 msgid)))))
1811
1812 (defun elmo-cache-get-path (msgid &optional folder number)
1813   "Get path for cache file associated with MSGID, FOLDER, and NUMBER."
1814   (if (setq msgid (elmo-msgid-to-cache msgid))
1815       (expand-file-name
1816        (expand-file-name
1817         (if folder
1818             (format "%s/%s/%s@%s"
1819                     (elmo-cache-get-path-subr msgid)
1820                     msgid
1821                     (or number "")
1822                     (elmo-safe-filename folder))
1823           (format "%s/%s"
1824                   (elmo-cache-get-path-subr msgid)
1825                   msgid))
1826         elmo-cache-directory))))
1827
1828 ;;;
1829 ;; Warnings.
1830
1831 (defconst elmo-warning-buffer-name "*elmo warning*")
1832
1833 (defun elmo-warning (&rest args)
1834   "Display a warning, making warning message by passing all args to `insert'."
1835   (with-current-buffer (get-buffer-create elmo-warning-buffer-name)
1836     (goto-char (point-max))
1837     (apply 'insert (append args '("\n")))
1838     (recenter 1))
1839   (display-buffer elmo-warning-buffer-name))
1840
1841 (defvar elmo-obsolete-variable-alist nil)
1842
1843 (defcustom elmo-obsolete-variable-show-warnings t
1844   "Show warning window if obsolete variable is treated."
1845   :type 'boolean
1846   :group 'elmo)
1847
1848 (defun elmo-define-obsolete-variable (obsolete var)
1849   "Define obsolete variable.
1850 OBSOLETE is a symbol for obsolete variable.
1851 VAR is a symbol for new variable.
1852 Definition is stored in `elmo-obsolete-variable-alist'."
1853   (let ((pair (assq var elmo-obsolete-variable-alist)))
1854     (if pair
1855         (setcdr pair obsolete)
1856       (setq elmo-obsolete-variable-alist
1857             (cons (cons var obsolete)
1858                   elmo-obsolete-variable-alist)))))
1859
1860 (defun elmo-resque-obsolete-variable (obsolete var)
1861   "Resque obsolete variable OBSOLETE as VAR.
1862 If `elmo-obsolete-variable-show-warnings' is non-nil, show warning message."
1863   (when (boundp obsolete)
1864     (static-if (and (fboundp 'defvaralias)
1865                     (subrp (symbol-function 'defvaralias)))
1866         (defvaralias var obsolete)
1867       (set var (symbol-value obsolete)))
1868     (if elmo-obsolete-variable-show-warnings
1869         (elmo-warning (format "%s is obsolete. Use %s instead."
1870                               (symbol-name obsolete)
1871                               (symbol-name var))))))
1872
1873 (defun elmo-resque-obsolete-variables (&optional alist)
1874   "Resque obsolete variables in ALIST.
1875 ALIST is a list of cons cell of
1876 \(OBSOLETE-VARIABLE-SYMBOL . NEW-VARIABLE-SYMBOL\).
1877 If ALIST is nil, `elmo-obsolete-variable-alist' is used."
1878   (dolist (pair elmo-obsolete-variable-alist)
1879     (elmo-resque-obsolete-variable (cdr pair)
1880                                    (car pair))))
1881
1882 ;;; Queue.
1883 (defvar elmo-dop-queue-filename "queue"
1884   "*Disconnected operation queue is saved in this file.")
1885
1886 (defun elmo-dop-queue-load ()
1887   (setq elmo-dop-queue
1888         (elmo-object-load
1889          (expand-file-name elmo-dop-queue-filename
1890                            elmo-msgdb-directory))))
1891
1892 (defun elmo-dop-queue-save ()
1893   (elmo-object-save
1894    (expand-file-name elmo-dop-queue-filename
1895                      elmo-msgdb-directory)
1896    elmo-dop-queue))
1897
1898 (require 'product)
1899 (product-provide (provide 'elmo-util) (require 'elmo-version))
1900
1901 ;;; elmo-util.el ends here