* elmo-util.el (elmo-mime-string): Eliminate needless binding;
[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 "%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       (let ((default (format-time-string "%Y-%m-%d")))
174         (setq value (completing-read
175                      (format "Value for '%s' [%s]: " field default)
176                      (mapcar (function
177                               (lambda (x)
178                                 (list (format "%s" (car x)))))
179                              elmo-date-descriptions)))
180         (concat (downcase field) ":"
181                 (if (equal value "") default value))))
182      (t
183       (setq value (read-from-minibuffer (format "Value for '%s': " field)))
184       (unless (string-match (concat "^" elmo-condition-atom-regexp "$")
185                             value)
186         (setq value (prin1-to-string value)))
187       (concat (downcase field) ":" value)))))
188
189 (defsubst elmo-condition-parse-error ()
190   (error "Syntax error in '%s'" (buffer-string)))
191
192 (defun elmo-parse-search-condition (condition)
193   "Parse CONDITION.
194 Return value is a cons cell of (STRUCTURE . REST)"
195   (with-temp-buffer
196     (insert condition)
197     (goto-char (point-min))
198     (cons (elmo-condition-parse) (buffer-substring (point) (point-max)))))
199
200 ;; condition    ::= or-expr
201 (defun elmo-condition-parse ()
202   (or (elmo-condition-parse-or-expr)
203       (elmo-condition-parse-error)))
204
205 ;; or-expr      ::= and-expr /
206 ;;                  and-expr "|" or-expr
207 (defun elmo-condition-parse-or-expr ()
208   (let ((left (elmo-condition-parse-and-expr)))
209     (if (looking-at "| *")
210         (progn
211           (goto-char (match-end 0))
212           (list 'or left (elmo-condition-parse-or-expr)))
213       left)))
214
215 ;; and-expr     ::= primitive /
216 ;;                  primitive "&" and-expr
217 (defun elmo-condition-parse-and-expr ()
218   (let ((left (elmo-condition-parse-primitive)))
219     (if (looking-at "& *")
220         (progn
221           (goto-char (match-end 0))
222           (list 'and left (elmo-condition-parse-and-expr)))
223       left)))
224
225 ;; primitive    ::= "(" expr ")" /
226 ;;                  ["!"] search-key SPACE* ":" SPACE* search-value
227 (defun elmo-condition-parse-primitive ()
228   (cond
229    ((looking-at "( *")
230     (goto-char (match-end 0))
231     (prog1 (elmo-condition-parse)
232       (unless (looking-at ") *")
233         (elmo-condition-parse-error))
234       (goto-char (match-end 0))))
235 ;; search-key   ::= [A-Za-z-]+
236 ;;                 ;; "since" / "before" / "last" / "first" /
237 ;;                 ;; "body" / field-name
238    ((looking-at "\\(!\\)? *\\([A-Za-z-]+\\) *: *")
239     (goto-char (match-end 0))
240     (let ((search-key (vector
241                        (if (match-beginning 1) 'unmatch 'match)
242                        (elmo-match-buffer 2)
243                        (elmo-condition-parse-search-value))))
244       ;; syntax sugar.
245       (if (string= (aref search-key 1) "tocc")
246           (if (eq (aref search-key 0) 'match)
247               (list 'or
248                     (vector 'match "to" (aref search-key 2))
249                     (vector 'match "cc" (aref search-key 2)))
250             (list 'and
251                   (vector 'unmatch "to" (aref search-key 2))
252                   (vector 'unmatch "cc" (aref search-key 2))))
253         search-key)))))
254
255 ;; search-value ::= quoted / time / number / atom
256 ;; quoted       ::= <elisp string expression>
257 ;; time         ::= "yesterday" / "lastweek" / "lastmonth" / "lastyear" /
258 ;;                   number SPACE* "daysago" /
259 ;;                   number "-" month "-" number  ; ex. 10-May-2000
260 ;;                   number "-" number "-" number  ; ex. 2000-05-10
261 ;; number       ::= [0-9]+
262 ;; month        ::= "Jan" / "Feb" / "Mar" / "Apr" / "May" / "Jun" /
263 ;;                  "Jul" / "Aug" / "Sep" / "Oct" / "Nov" / "Dec"
264 ;; atom         ::= ATOM_CHARS*
265 ;; SPACE        ::= <ascii space character, 0x20>
266 ;; ATOM_CHARS   ::= <any character except specials>
267 ;; specials     ::= SPACE / <"> / </> / <)> / <|> / <&>
268 ;;                  ;; These characters should be quoted.
269 (defun elmo-condition-parse-search-value ()
270   (cond
271    ((looking-at "\"")
272     (elmo-read (current-buffer)))
273    ((or (looking-at "yesterday") (looking-at "lastweek")
274         (looking-at "lastmonth") (looking-at "lastyear")
275         (looking-at "[0-9]+ *daysago")
276         (looking-at "[0-9]+-[A-Za-z]+-[0-9]+")
277         (looking-at "[0-9]+-[0-9]+-[0-9]+")
278         (looking-at "[0-9]+")
279         (looking-at elmo-condition-atom-regexp))
280     (prog1 (elmo-match-buffer 0)
281       (goto-char (match-end 0))))
282    (t (error "Syntax error '%s'" (buffer-string)))))
283
284 ;;;
285 (defsubst elmo-buffer-replace (regexp &optional newtext)
286   (goto-char (point-min))
287   (while (re-search-forward regexp nil t)
288     (replace-match (or newtext ""))))
289
290 (defsubst elmo-delete-char (char string &optional unibyte)
291   (save-match-data
292     (elmo-set-work-buf
293      (let ((coding-system-for-read 'no-conversion)
294            (coding-system-for-write 'no-conversion))
295        (if unibyte (elmo-set-buffer-multibyte nil))
296        (insert string)
297        (goto-char (point-min))
298        (while (search-forward (char-to-string char) nil t)
299          (replace-match ""))
300        (buffer-string)))))
301
302 (defsubst elmo-delete-cr-buffer ()
303   "Delete CR from buffer."
304   (save-excursion
305     (goto-char (point-min))
306     (while (search-forward "\r\n" nil t)
307       (replace-match "\n")) ))
308
309 (defsubst elmo-delete-cr-get-content-type ()
310   (save-excursion
311     (goto-char (point-min))
312     (while (search-forward "\r\n" nil t)
313       (replace-match "\n"))
314     (goto-char (point-min))
315     (or (std11-field-body "content-type")
316         t)))
317
318 (defun elmo-delete-cr (string)
319   (save-match-data
320     (elmo-set-work-buf
321      (insert string)
322      (goto-char (point-min))
323      (while (search-forward "\r\n" nil t)
324        (replace-match "\n"))
325      (buffer-string))))
326
327 (defun elmo-uniq-list (lst)
328   "Distractively uniqfy elements of LST."
329   (let ((tmp lst))
330     (while tmp (setq tmp
331                      (setcdr tmp
332                              (and (cdr tmp)
333                                   (delete (car tmp)
334                                           (cdr tmp)))))))
335   lst)
336
337 (defun elmo-list-insert (list element after)
338   (let* ((match (memq after list))
339          (rest (and match (cdr (memq after list)))))
340     (if match
341         (progn
342           (setcdr match (list element))
343           (nconc list rest))
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 "%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 &optional mode)
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     (set-file-modes path (or mode
715                              (+ (* 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-delete-match-files (path regexp &optional remove-if-empty)
736   "Delete directory files specified by PATH.
737 If optional REMOVE-IF-EMPTY is non-nil, delete directory itself if
738 the directory becomes empty after deletion."
739   (when (stringp path) ; nil is not permitted.
740     (dolist (file (directory-files path t regexp))
741       (delete-file file))
742     (if remove-if-empty
743         (ignore-errors 
744           (delete-directory path) ; should be removed if empty.
745           ))))
746
747 (defun elmo-list-filter (l1 l2)
748   "L1 is filter."
749   (if (eq l1 t)
750       ;; t means filter all.
751       nil
752     (if l1
753         (elmo-delete-if (lambda (x) (not (memq x l1))) l2)
754       ;; filter is nil
755       l2)))
756
757 (defsubst elmo-list-delete-if-smaller (list number)
758   (let ((ret-val (copy-sequence list)))
759     (while list
760       (if (< (car list) number)
761           (setq ret-val (delq (car list) ret-val)))
762       (setq list (cdr list)))
763     ret-val))
764
765 (defun elmo-list-diff (list1 list2 &optional mes)
766   (if mes
767       (message mes))
768   (let ((clist1 (copy-sequence list1))
769         (clist2 (copy-sequence list2)))
770     (while list2
771       (setq clist1 (delq (car list2) clist1))
772       (setq list2 (cdr list2)))
773     (while list1
774       (setq clist2 (delq (car list1) clist2))
775       (setq list1 (cdr list1)))
776     (if mes
777         (message (concat mes "done.")))
778     (list clist1 clist2)))
779
780 (defun elmo-list-bigger-diff (list1 list2 &optional mes)
781   "Returns a list (- +). + is bigger than max of LIST1, in LIST2."
782   (if (null list2)
783       (cons list1  nil)
784     (let* ((l1 list1)
785            (l2 list2)
786            (max-of-l2 (or (nth (max 0 (1- (length l2))) l2) 0))
787            diff1 num i percent
788            )
789       (setq i 0)
790       (setq num (+ (length l1)))
791       (while l1
792         (if (memq (car l1) l2)
793             (if (eq (car l1) (car l2))
794                 (setq l2 (cdr l2))
795               (delq (car l1) l2))
796           (if (> (car l1) max-of-l2)
797               (setq diff1 (nconc diff1 (list (car l1))))))
798         (if mes
799             (progn
800               (setq i (+ i 1))
801               (setq percent (/ (* i 100) num))
802               (if (eq (% percent 5) 0)
803                   (elmo-display-progress
804                    'elmo-list-bigger-diff "%s%d%%" percent mes))))
805         (setq l1 (cdr l1)))
806       (cons diff1 (list l2)))))
807
808 (defmacro elmo-filter-condition-p (filter)
809   `(or (vectorp ,filter) (consp ,filter)))
810
811 (defmacro elmo-filter-type (filter)
812   (` (aref (, filter) 0)))
813
814 (defmacro elmo-filter-key (filter)
815   (` (aref (, filter) 1)))
816
817 (defmacro elmo-filter-value (filter)
818   (` (aref (, filter) 2)))
819
820 (defsubst elmo-buffer-field-primitive-condition-match (condition
821                                                        number
822                                                        number-list)
823   (let (result)
824     (goto-char (point-min))
825     (cond
826      ((string= (elmo-filter-key condition) "last")
827       (setq result (<= (length (memq number number-list))
828                        (string-to-int (elmo-filter-value condition)))))
829      ((string= (elmo-filter-key condition) "first")
830       (setq result (< (- (length number-list)
831                          (length (memq number number-list)))
832                       (string-to-int (elmo-filter-value condition)))))
833      ((string= (elmo-filter-key condition) "since")
834       (let ((field-date (elmo-date-make-sortable-string
835                          (timezone-fix-time
836                           (std11-field-body "date")
837                           (current-time-zone) nil)))
838             (specified-date (elmo-date-make-sortable-string
839                              (elmo-date-get-datevec
840                               (elmo-filter-value condition)))))
841         (setq result
842               (or (string= field-date specified-date)
843                   (string< specified-date field-date)))))
844      ((string= (elmo-filter-key condition) "before")
845       (setq result
846             (string<
847              (elmo-date-make-sortable-string
848               (timezone-fix-time
849                (std11-field-body "date")
850                (current-time-zone) nil))
851              (elmo-date-make-sortable-string
852               (elmo-date-get-datevec
853                (elmo-filter-value condition))))))
854      ((string= (elmo-filter-key condition) "body")
855       (and (re-search-forward "^$" nil t)          ; goto body
856            (setq result (search-forward (elmo-filter-value condition)
857                                         nil t))))
858      (t
859       (let ((fval (std11-field-body (elmo-filter-key condition))))
860         (if (eq (length fval) 0) (setq fval nil))
861         (if fval (setq fval (eword-decode-string fval)))
862         (setq result (and fval (string-match
863                                 (elmo-filter-value condition) fval))))))
864     (if (eq (elmo-filter-type condition) 'unmatch)
865         (setq result (not result)))
866     result))
867
868 (defun elmo-condition-in-msgdb-p-internal (condition fields)
869   (cond
870    ((vectorp condition)
871     (if (not (member (elmo-filter-key condition) fields))
872         (throw 'found t)))
873    ((or (eq (car condition) 'and)
874         (eq (car condition) 'or))
875     (elmo-condition-in-msgdb-p-internal (nth 1 condition) fields)
876     (elmo-condition-in-msgdb-p-internal (nth 2 condition) fields))))
877
878 (defun elmo-condition-in-msgdb-p (condition)
879   (not (catch 'found
880          (elmo-condition-in-msgdb-p-internal condition
881                                              (append
882                                               elmo-msgdb-extra-fields
883                                               '("last" "first" "from"
884                                                 "subject" "to" "cc" "since"
885                                                 "before"))))))
886
887 (defun elmo-buffer-field-condition-match (condition number number-list)
888   (cond
889    ((vectorp condition)
890     (elmo-buffer-field-primitive-condition-match
891      condition number number-list))
892    ((eq (car condition) 'and)
893     (and (elmo-buffer-field-condition-match
894           (nth 1 condition) number number-list)
895          (elmo-buffer-field-condition-match
896           (nth 2 condition) number number-list)))
897    ((eq (car condition) 'or)
898     (or (elmo-buffer-field-condition-match
899          (nth 1 condition) number number-list)
900         (elmo-buffer-field-condition-match
901          (nth 2 condition) number number-list)))))
902
903 (defsubst elmo-file-field-primitive-condition-match (file
904                                                      condition
905                                                      number
906                                                      number-list)
907   (let (result)
908     (goto-char (point-min))
909     (cond
910      ((string= (elmo-filter-key condition) "last")
911       (setq result (<= (length (memq number number-list))
912                        (string-to-int (elmo-filter-value condition))))
913       (if (eq (elmo-filter-type condition) 'unmatch)
914           (setq result (not result))))
915      ((string= (elmo-filter-key condition) "first")
916       (setq result (< (- (length number-list)
917                          (length (memq number number-list)))
918                       (string-to-int (elmo-filter-value condition))))
919       (if (eq (elmo-filter-type condition) 'unmatch)
920           (setq result (not result))))
921      (t
922       (elmo-set-work-buf
923        (as-binary-input-file (insert-file-contents file))
924        (elmo-set-buffer-multibyte default-enable-multibyte-characters)
925        ;; Should consider charset?
926        (decode-mime-charset-region (point-min)(point-max) elmo-mime-charset)
927        (setq result
928              (elmo-buffer-field-primitive-condition-match
929               condition number number-list)))))
930     result))
931
932 (defun elmo-file-field-condition-match (file condition number number-list)
933   (cond
934    ((vectorp condition)
935     (elmo-file-field-primitive-condition-match
936      file condition number number-list))
937    ((eq (car condition) 'and)
938     (and (elmo-file-field-condition-match
939           file (nth 1 condition) number number-list)
940          (elmo-file-field-condition-match
941           file (nth 2 condition) number number-list)))
942    ((eq (car condition) 'or)
943     (or (elmo-file-field-condition-match
944          file (nth 1 condition) number number-list)
945         (elmo-file-field-condition-match
946          file (nth 2 condition) number number-list)))))
947
948 (defmacro elmo-get-hash-val (string hashtable)
949   `(and (stringp ,string)
950         (let ((sym (intern-soft ,string ,hashtable)))
951           (if (boundp sym)
952               (symbol-value sym)))))
953
954 (defmacro elmo-set-hash-val (string value hashtable)
955   (list 'set (list 'intern string hashtable) value))
956
957 (defmacro elmo-clear-hash-val (string hashtable)
958   (static-if (fboundp 'unintern)
959       (list 'unintern string hashtable)
960     (list 'makunbound (list 'intern string hashtable))))
961
962 (defmacro elmo-unintern (string)
963   "`unintern' symbol named STRING,  When can use `unintern'.
964 Emacs 19.28 or earlier does not have `unintern'."
965   (static-if (fboundp 'unintern)
966       (list 'unintern string)))
967
968 (defun elmo-make-hash (&optional hashsize)
969   "Make a new hash table which have HASHSIZE size."
970   (make-vector
971    (if hashsize
972        (max
973         ;; Prime numbers as lengths tend to result in good
974         ;; hashing; lengths one less than a power of two are
975         ;; also good.
976         (min
977          (let ((i 1))
978            (while (< (- i 1) hashsize)
979              (setq i (* 2 i)))
980            (- i 1))
981          elmo-hash-maximum-size)
982         elmo-hash-minimum-size)
983      elmo-hash-minimum-size)
984    0))
985
986 (defsubst elmo-mime-string (string)
987   "Normalize MIME encoded STRING."
988   (and string
989        (elmo-set-work-buf
990         (elmo-set-buffer-multibyte default-enable-multibyte-characters)
991         (setq string
992               (encode-mime-charset-string
993                (eword-decode-and-unfold-unstructured-field-body
994                 string)
995                elmo-mime-charset))
996         (elmo-set-buffer-multibyte nil)
997         string)))
998
999 (defsubst elmo-collect-field (beg end downcase-field-name)
1000   (save-excursion
1001     (save-restriction
1002       (narrow-to-region beg end)
1003       (goto-char (point-min))
1004       (let ((regexp (concat "\\(" std11-field-head-regexp "\\)[ \t]*"))
1005             dest name body)
1006         (while (re-search-forward regexp nil t)
1007           (setq name (buffer-substring-no-properties
1008                       (match-beginning 1)(1- (match-end 1))))
1009           (if downcase-field-name
1010               (setq name (downcase name)))
1011           (setq body (buffer-substring-no-properties
1012                       (match-end 0) (std11-field-end)))
1013           (or (assoc name dest)
1014               (setq dest (cons (cons name body) dest))))
1015         dest))))
1016
1017 (defsubst elmo-collect-field-from-string (string downcase-field-name)
1018   (with-temp-buffer
1019     (insert string)
1020     (goto-char (point-min))
1021     (let ((regexp (concat "\\(" std11-field-head-regexp "\\)[ \t]*"))
1022           dest name body)
1023       (while (re-search-forward regexp nil t)
1024         (setq name (buffer-substring-no-properties
1025                     (match-beginning 1)(1- (match-end 1))))
1026         (if downcase-field-name
1027             (setq name (downcase name)))
1028         (setq body (buffer-substring-no-properties
1029                     (match-end 0) (std11-field-end)))
1030         (or (assoc name dest)
1031             (setq dest (cons (cons name body) dest))))
1032       dest)))
1033
1034 (defun elmo-safe-filename (folder)
1035   (elmo-replace-in-string
1036    (elmo-replace-in-string
1037     (elmo-replace-in-string folder "/" " ")
1038     ":" "__")
1039    "|" "_or_"))
1040
1041 (defvar elmo-filename-replace-chars nil)
1042
1043 (defsubst elmo-replace-string-as-filename (msgid)
1044   "Replace string as filename."
1045   (setq msgid (elmo-replace-in-string msgid " " "  "))
1046   (if (null elmo-filename-replace-chars)
1047       (setq elmo-filename-replace-chars
1048             (regexp-quote (mapconcat
1049                            'car elmo-filename-replace-string-alist ""))))
1050   (while (string-match (concat "[" elmo-filename-replace-chars "]")
1051                        msgid)
1052     (setq msgid (concat
1053                  (substring msgid 0 (match-beginning 0))
1054                  (cdr (assoc
1055                        (substring msgid
1056                                   (match-beginning 0) (match-end 0))
1057                        elmo-filename-replace-string-alist))
1058                  (substring msgid (match-end 0)))))
1059   msgid)
1060
1061 (defsubst elmo-recover-string-from-filename (filename)
1062   "Recover string from FILENAME."
1063   (let (tmp result)
1064     (while (string-match " " filename)
1065       (setq tmp (substring filename
1066                            (match-beginning 0)
1067                            (+ (match-end 0) 1)))
1068       (if (string= tmp "  ")
1069           (setq tmp " ")
1070         (setq tmp (car (rassoc tmp
1071                                elmo-filename-replace-string-alist))))
1072       (setq result
1073             (concat result
1074                     (substring filename 0 (match-beginning 0))
1075                     tmp))
1076       (setq filename (substring filename (+ (match-end 0) 1))))
1077     (concat result filename)))
1078
1079 (defsubst elmo-copy-file (src dst &optional ok-if-already-exists)
1080   (condition-case err
1081       (elmo-add-name-to-file src dst ok-if-already-exists)
1082     (error (copy-file src dst ok-if-already-exists t))))
1083
1084 (defsubst elmo-buffer-exists-p (buffer)
1085   (if (bufferp buffer)
1086       (buffer-live-p buffer)
1087     (get-buffer buffer)))
1088
1089 (defsubst elmo-kill-buffer (buffer)
1090   (when (elmo-buffer-exists-p buffer)
1091     (kill-buffer buffer)))
1092
1093 (defun elmo-delete-if (pred lst)
1094   "Return new list contain items which don't satisfy PRED in LST."
1095   (let (result)
1096     (while lst
1097       (unless (funcall pred (car lst))
1098         (setq result (nconc result (list (car lst)))))
1099       (setq lst (cdr lst)))
1100     result))
1101
1102 (defun elmo-list-delete (list1 list2)
1103   "Delete by side effect any occurrences equal to elements of LIST1 from LIST2.
1104 Return the modified LIST2.  Deletion is done with `delete'.
1105 Write `(setq foo (elmo-list-delete bar foo))' to be sure of changing
1106 the value of `foo'."
1107   (while list1
1108     (setq list2 (delete (car list1) list2))
1109     (setq list1 (cdr list1)))
1110   list2)
1111
1112 (defun elmo-list-member (list1 list2)
1113   "If any element of LIST1 is member of LIST2, return t."
1114   (catch 'done
1115     (while list1
1116       (if (member (car list1) list2)
1117           (throw 'done t))
1118       (setq list1 (cdr list1)))))
1119
1120 (defun elmo-count-matches (regexp beg end)
1121   (let ((count 0))
1122     (save-excursion
1123       (goto-char beg)
1124       (while (re-search-forward regexp end t)
1125         (setq count (1+ count)))
1126       count)))
1127
1128 (if (fboundp 'display-error)
1129     (defalias 'elmo-display-error 'display-error)
1130   (defun elmo-display-error (error-object stream)
1131     "A tiny function to display ERROR-OBJECT to the STREAM."
1132     (let ((first t)
1133           (errobj error-object)
1134           err-mes)
1135       (while errobj
1136         (setq err-mes (concat err-mes (format
1137                                        (if (stringp (car errobj))
1138                                            "%s"
1139                                          "%S")
1140                                        (car errobj))))
1141         (setq errobj (cdr errobj))
1142         (if errobj (setq err-mes (concat err-mes (if first ": " ", "))))
1143         (setq first nil))
1144       (princ err-mes stream))))
1145
1146 (if (fboundp 'define-error)
1147     (defalias 'elmo-define-error 'define-error)
1148   (defun elmo-define-error (error doc &optional parents)
1149     (or parents
1150         (setq parents 'error))
1151     (let ((conds (get parents 'error-conditions)))
1152       (or conds
1153           (error "Not an error symbol: %s" error))
1154       (setplist error
1155                 (list 'error-message doc
1156                       'error-conditions (cons error conds))))))
1157
1158 (cond ((fboundp 'progress-feedback-with-label)
1159        (defalias 'elmo-display-progress 'progress-feedback-with-label))
1160       ((fboundp 'lprogress-display)
1161        (defalias 'elmo-display-progress 'lprogress-display))
1162       (t
1163        (defun elmo-display-progress (label format &optional value &rest args)
1164          "Print a progress message."
1165          (if (and (null format) (null args))
1166              (message nil)
1167            (apply (function message) (concat format " %d%%")
1168                   (nconc args (list value)))))))
1169
1170 (defvar elmo-progress-counter-alist nil)
1171
1172 (defmacro elmo-progress-counter-value (counter)
1173   (` (aref (cdr (, counter)) 0)))
1174
1175 (defmacro elmo-progress-counter-all-value (counter)
1176   (` (aref (cdr (, counter)) 1)))
1177
1178 (defmacro elmo-progress-counter-format (counter)
1179   (` (aref (cdr (, counter)) 2)))
1180
1181 (defmacro elmo-progress-counter-set-value (counter value)
1182   (` (aset (cdr (, counter)) 0 (, value))))
1183
1184 (defun elmo-progress-set (label all-value &optional format)
1185   (unless (assq label elmo-progress-counter-alist)
1186     (setq elmo-progress-counter-alist
1187           (cons (cons label (vector 0 all-value (or format "")))
1188                 elmo-progress-counter-alist))))
1189
1190 (defun elmo-progress-clear (label)
1191   (let ((counter (assq label elmo-progress-counter-alist)))
1192     (when counter
1193       (elmo-display-progress label
1194                              (elmo-progress-counter-format counter)
1195                              100)
1196       (setq elmo-progress-counter-alist
1197             (delq counter elmo-progress-counter-alist)))))
1198
1199 (defun elmo-progress-notify (label &optional value op &rest args)
1200   (let ((counter (assq label elmo-progress-counter-alist)))
1201     (when counter
1202       (let* ((value (or value 1))
1203              (cur-value (elmo-progress-counter-value counter))
1204              (all-value (elmo-progress-counter-all-value counter))
1205              (new-value (if (eq op 'set) value (+ cur-value value)))
1206              (cur-rate (/ (* cur-value 100) all-value))
1207              (new-rate (/ (* new-value 100) all-value)))
1208         (elmo-progress-counter-set-value counter new-value)
1209         (unless (= cur-rate new-rate)
1210           (apply 'elmo-display-progress
1211                  label
1212                  (elmo-progress-counter-format counter)
1213                  new-rate
1214                  args))
1215         (when (>= new-rate 100)
1216           (elmo-progress-clear label))))))
1217
1218 (defun elmo-time-expire (before-time diff-time)
1219   (let* ((current (current-time))
1220          (rest (when (< (nth 1 current) (nth 1 before-time))
1221                  (expt 2 16)))
1222          diff)
1223     (setq diff
1224           (list (- (+ (car current) (if rest -1 0)) (car before-time))
1225                 (- (+ (or rest 0) (nth 1 current)) (nth 1 before-time))))
1226     (and (eq (car diff) 0)
1227          (< diff-time (nth 1 diff)))))
1228
1229 (if (fboundp 'std11-fetch-field)
1230     (defalias 'elmo-field-body 'std11-fetch-field) ;;no narrow-to-region
1231   (defalias 'elmo-field-body 'std11-field-body))
1232
1233 (defun elmo-address-quote-specials (word)
1234   "Make quoted string of WORD if needed."
1235   (let ((lal (std11-lexical-analyze word)))
1236     (if (or (assq 'specials lal)
1237             (assq 'domain-literal lal))
1238         (prin1-to-string word)
1239       word)))
1240
1241 (defmacro elmo-string (string)
1242   "STRING without text property."
1243   (` (let ((obj (copy-sequence (, string))))
1244        (and obj (set-text-properties 0 (length obj) nil obj))
1245        obj)))
1246
1247 (defun elmo-flatten (list-of-list)
1248   "Flatten LIST-OF-LIST."
1249   (unless (null list-of-list)
1250     (append (if (and (car list-of-list)
1251                      (listp (car list-of-list)))
1252                 (car list-of-list)
1253               (list (car list-of-list)))
1254             (elmo-flatten (cdr list-of-list)))))
1255
1256 (defun elmo-y-or-n-p (prompt &optional auto default)
1257   "Same as `y-or-n-p'.
1258 But if optional argument AUTO is non-nil, DEFAULT is returned."
1259   (if auto
1260       default
1261     (y-or-n-p prompt)))
1262
1263 (defun elmo-string-member (string slist)
1264   "Return t if STRING is a member of the SLIST."
1265   (catch 'found
1266     (while slist
1267       (if (and (stringp (car slist))
1268                (string= string (car slist)))
1269           (throw 'found t))
1270       (setq slist (cdr slist)))))
1271
1272 (defun elmo-string-match-member (str list &optional case-ignore)
1273   (let ((case-fold-search case-ignore))
1274     (catch 'member
1275       (while list
1276         (if (string-match (car list) str)
1277             (throw 'member (car list)))
1278         (setq list (cdr list))))))
1279
1280 (defun elmo-string-matched-member (str list &optional case-ignore)
1281   (let ((case-fold-search case-ignore))
1282     (catch 'member
1283       (while list
1284         (if (string-match str (car list))
1285             (throw 'member (car list)))
1286         (setq list (cdr list))))))
1287
1288 (defsubst elmo-string-delete-match (string pos)
1289   (concat (substring string
1290                      0 (match-beginning pos))
1291           (substring string
1292                      (match-end pos)
1293                      (length string))))
1294
1295 (defun elmo-string-match-assoc (key alist &optional case-ignore)
1296   (let ((case-fold-search case-ignore)
1297         a)
1298     (catch 'loop
1299       (while alist
1300         (setq a (car alist))
1301         (if (and (consp a)
1302                  (stringp (car a))
1303                  (string-match key (car a)))
1304             (throw 'loop a))
1305         (setq alist (cdr alist))))))
1306
1307 (defun elmo-string-matched-assoc (key alist &optional case-ignore)
1308   (let ((case-fold-search case-ignore)
1309         a)
1310     (catch 'loop
1311       (while alist
1312         (setq a (car alist))
1313         (if (and (consp a)
1314                  (stringp (car a))
1315                  (string-match (car a) key))
1316             (throw 'loop a))
1317         (setq alist (cdr alist))))))
1318
1319 (defun elmo-string-assoc (key alist)
1320   (let (a)
1321     (catch 'loop
1322       (while alist
1323         (setq a (car alist))
1324         (if (and (consp a)
1325                  (stringp (car a))
1326                  (string= key (car a)))
1327             (throw 'loop a))
1328         (setq alist (cdr alist))))))
1329
1330 (defun elmo-string-assoc-all (key alist)
1331   (let (matches)
1332     (while alist
1333       (if (string= key (car (car alist)))
1334           (setq matches
1335                 (cons (car alist)
1336                       matches)))
1337       (setq alist (cdr alist)))
1338     matches))
1339
1340 (defun elmo-string-rassoc (key alist)
1341   (let (a)
1342     (catch 'loop
1343       (while alist
1344         (setq a (car alist))
1345         (if (and (consp a)
1346                  (stringp (cdr a))
1347                  (string= key (cdr a)))
1348             (throw 'loop a))
1349         (setq alist (cdr alist))))))
1350
1351 (defun elmo-string-rassoc-all (key alist)
1352   (let (matches)
1353     (while alist
1354       (if (string= key (cdr (car alist)))
1355           (setq matches
1356                 (cons (car alist)
1357                       matches)))
1358       (setq alist (cdr alist)))
1359     matches))
1360
1361 ;;; Folder parser utils.
1362 (defun elmo-parse-token (string &optional seps)
1363   "Parse atom from STRING using SEPS as a string of separator char list."
1364   (let ((len (length string))
1365         (seps (and seps (string-to-char-list seps)))
1366         (i 0)
1367         (sep nil)
1368         content c in)
1369     (if (eq len 0)
1370         (cons "" "")
1371       (while (and (< i len) (or in (null sep)))
1372         (setq c (aref string i))
1373         (cond
1374          ((and in (eq c ?\\))
1375           (setq i (1+ i)
1376                 content (cons (aref string i) content)
1377                 i (1+ i)))
1378          ((eq c ?\")
1379           (setq in (not in)
1380                 i (1+ i)))
1381          (in (setq content (cons c content)
1382                    i (1+ i)))
1383          ((memq c seps)
1384           (setq sep c))
1385          (t (setq content (cons c content)
1386                   i (1+ i)))))
1387       (if in (error "Parse error in quoted"))
1388       (cons (if (null content) "" (char-list-to-string (nreverse content)))
1389             (substring string i)))))
1390
1391 (defun elmo-parse-prefixed-element (prefix string &optional seps)
1392   (if (and (not (eq (length string) 0))
1393            (eq (aref string 0) prefix))
1394       (elmo-parse-token (substring string 1) seps)
1395     (cons "" string)))
1396
1397 ;;; Number set defined by OKAZAKI Tetsurou <okazaki@be.to>
1398 ;;
1399 ;; number          ::= [0-9]+
1400 ;; beg             ::= number
1401 ;; end             ::= number
1402 ;; number-range    ::= "(" beg " . " end ")"      ;; cons cell
1403 ;; number-set-elem ::= number / number-range
1404 ;; number-set      ::= "(" *number-set-elem ")"   ;; list
1405
1406 (defun elmo-number-set-member (number number-set)
1407   "Return non-nil if NUMBER is an element of NUMBER-SET.
1408 The value is actually the tail of NUMBER-RANGE whose car contains NUMBER."
1409   (or (memq number number-set)
1410       (let (found)
1411         (while (and number-set (not found))
1412           (if (and (consp (car number-set))
1413                    (and (<= (car (car number-set)) number)
1414                         (<= number (cdr (car number-set)))))
1415               (setq found t)
1416             (setq number-set (cdr number-set))))
1417         number-set)))
1418
1419 (defun elmo-number-set-append-list (number-set list)
1420   "Append LIST of numbers to the NUMBER-SET.
1421 NUMBER-SET is altered."
1422   (let ((appended number-set))
1423     (while list
1424       (setq appended (elmo-number-set-append appended (car list)))
1425       (setq list (cdr list)))
1426     appended))
1427
1428 (defun elmo-number-set-append (number-set number)
1429   "Append NUMBER to the NUMBER-SET.
1430 NUMBER-SET is altered."
1431   (let ((number-set-1 number-set)
1432         found elem)
1433     (while (and number-set (not found))
1434       (setq elem (car number-set))
1435       (cond
1436        ((and (consp elem)
1437              (eq (+ 1 (cdr elem)) number))
1438         (setcdr elem number)
1439         (setq found t))
1440        ((and (integerp elem)
1441              (eq (+ 1 elem) number))
1442         (setcar number-set (cons elem number))
1443         (setq found t))
1444        ((or (and (integerp elem) (eq elem number))
1445             (and (consp elem)
1446                  (<= (car elem) number)
1447                  (<= number (cdr elem))))
1448         (setq found t)))
1449       (setq number-set (cdr number-set)))
1450     (if (not found)
1451         (setq number-set-1 (nconc number-set-1 (list number))))
1452     number-set-1))
1453
1454 (defun elmo-number-set-to-number-list (number-set)
1455   "Return a number list which corresponds to NUMBER-SET."
1456   (let (number-list elem i)
1457     (while number-set
1458       (setq elem (car number-set))
1459       (cond
1460        ((consp elem)
1461         (setq i (car elem))
1462         (while (<= i (cdr elem))
1463           (setq number-list (cons i number-list))
1464           (incf i)))
1465        ((integerp elem)
1466         (setq number-list (cons elem number-list))))
1467       (setq number-set (cdr number-set)))
1468     (nreverse number-list)))
1469
1470 (defcustom elmo-list-subdirectories-ignore-regexp "^\\(\\.\\.?\\|[0-9]+\\)$"
1471   "*Regexp to filter subfolders."
1472   :type 'regexp
1473   :group 'elmo)
1474
1475 (defun elmo-list-subdirectories-1 (basedir curdir one-level)
1476   (let ((root (zerop (length curdir)))
1477         (w32-get-true-file-link-count t) ; for Meadow
1478         attr dirs dir)
1479     (catch 'done
1480       (dolist (file (directory-files (setq dir (expand-file-name curdir basedir))))
1481         (when (and (not (string-match
1482                          elmo-list-subdirectories-ignore-regexp
1483                          file))
1484                    (car (setq attr (file-attributes
1485                                     (expand-file-name file dir)))))
1486           (when (eq one-level 'check) (throw 'done t))
1487           (let ((relpath
1488                  (concat curdir (and (not root) elmo-path-sep) file))
1489                 subdirs)
1490             (setq dirs (nconc dirs
1491                               (if (if elmo-have-link-count (< 2 (nth 1 attr))
1492                                     (setq subdirs
1493                                           (elmo-list-subdirectories-1
1494                                            basedir
1495                                            relpath
1496                                            (if one-level 'check))))
1497                                   (if one-level
1498                                       (list (list relpath))
1499                                     (cons relpath
1500                                           (or subdirs
1501                                               (elmo-list-subdirectories-1
1502                                                basedir
1503                                                relpath
1504                                                nil))))
1505                                 (list relpath)))))))
1506       dirs)))
1507
1508 (defun elmo-list-subdirectories (directory file one-level)
1509   (let ((subdirs (elmo-list-subdirectories-1 directory file one-level)))
1510     (if (zerop (length file))
1511         subdirs
1512       (cons file subdirs))))
1513
1514 (defun elmo-mapcar-list-of-list (func list-of-list)
1515   (mapcar
1516    (lambda (x)
1517      (cond ((listp x) (elmo-mapcar-list-of-list func x))
1518            (t (funcall func x))))
1519    list-of-list))
1520
1521 (defun elmo-parse (string regexp &optional matchn)
1522   (or matchn (setq matchn 1))
1523   (let (list)
1524     (store-match-data nil)
1525     (while (string-match regexp string (match-end 0))
1526       (setq list (cons (substring string (match-beginning matchn)
1527                                   (match-end matchn)) list)))
1528     (nreverse list)))
1529
1530 ;;; File cache.
1531 (defmacro elmo-make-file-cache (path status)
1532   "PATH is the cache file name.
1533 STATUS is one of 'section, 'entire or nil.
1534  nil means no cache exists.
1535 'section means partial section cache exists.
1536 'entire means entire cache exists.
1537 If the cache is partial file-cache, TYPE is 'partial."
1538   (` (cons (, path) (, status))))
1539
1540 (defmacro elmo-file-cache-path (file-cache)
1541   "Returns the file path of the FILE-CACHE."
1542   (` (car (, file-cache))))
1543
1544 (defmacro elmo-file-cache-status (file-cache)
1545   "Returns the status of the FILE-CACHE."
1546   (` (cdr (, file-cache))))
1547
1548 (defsubst elmo-cache-to-msgid (filename)
1549   (concat "<" (elmo-recover-string-from-filename filename) ">"))
1550
1551 (defsubst elmo-cache-get-path-subr (msgid)
1552   (let ((chars '(?0 ?1 ?2 ?3 ?4 ?5 ?6 ?7 ?8 ?9 ?A ?B ?C ?D ?E ?F))
1553         (clist (string-to-char-list msgid))
1554         (sum 0))
1555     (while clist
1556       (setq sum (+ sum (car clist)))
1557       (setq clist (cdr clist)))
1558     (format "%c%c"
1559             (nth (% (/ sum 16) 2) chars)
1560             (nth (% sum 16) chars))))
1561
1562 (defun elmo-file-cache-get-path (msgid &optional section)
1563   "Get cache path for MSGID.
1564 If optional argument SECTION is specified, partial cache path is returned."
1565   (if (setq msgid (elmo-msgid-to-cache msgid))
1566       (expand-file-name
1567        (if section
1568            (format "%s/%s/%s/%s"
1569                    elmo-cache-directory
1570                    (elmo-cache-get-path-subr msgid)
1571                    msgid
1572                    section)
1573          (format "%s/%s/%s"
1574                  elmo-cache-directory
1575                  (elmo-cache-get-path-subr msgid)
1576                  msgid)))))
1577
1578 (defmacro elmo-file-cache-expand-path (path section)
1579   "Return file name for the file-cache corresponds to the section.
1580 PATH is the file-cache path.
1581 SECTION is the section string."
1582   (` (expand-file-name (or (, section) "") (, path))))
1583
1584 (defun elmo-file-cache-delete (path)
1585   "Delete a cache on PATH."
1586   (when (file-exists-p path)
1587     (if (file-directory-p path)
1588         (progn
1589           (dolist (file (directory-files path t "^[^\\.]"))
1590             (delete-file file))
1591           (delete-directory path))
1592       (delete-file path))
1593     t))
1594
1595 (defun elmo-file-cache-exists-p (msgid)
1596   "Returns 'section or 'entire if a cache which corresponds to MSGID exists."
1597   (elmo-file-cache-status (elmo-file-cache-get msgid)))
1598
1599 (defun elmo-file-cache-save (cache-path section)
1600   "Save current buffer as cache on PATH.
1601 Return t if cache is saved successfully."
1602   (condition-case nil
1603       (let ((path (if section (expand-file-name section cache-path)
1604                     cache-path))
1605             files dir)
1606         (if (and (null section)
1607                  (file-directory-p path))
1608             (progn
1609               (setq files (directory-files path t "^[^\\.]"))
1610               (while files
1611                 (delete-file (car files))
1612                 (setq files (cdr files)))
1613               (delete-directory path))
1614           (if (and section
1615                    (not (file-directory-p cache-path)))
1616               (delete-file cache-path)))
1617         (when path
1618           (setq dir (directory-file-name (file-name-directory path)))
1619           (if (not (file-exists-p dir))
1620               (elmo-make-directory dir))
1621           (write-region-as-binary (point-min) (point-max)
1622                                   path nil 'no-msg)
1623           t))
1624     ;; ignore error
1625     (error)))
1626
1627 (defun elmo-file-cache-load (cache-path section)
1628   "Load cache on PATH into the current buffer.
1629 Return t if cache is loaded successfully."
1630   (condition-case nil
1631       (let (cache-file)
1632         (when (and cache-path
1633                    (if (elmo-cache-path-section-p cache-path)
1634                        section
1635                      (null section))
1636                    (setq cache-file (elmo-file-cache-expand-path
1637                                      cache-path
1638                                      section))
1639                    (file-exists-p cache-file))
1640           (insert-file-contents-as-binary cache-file)
1641           t))
1642     ;; igore error
1643     (error)))
1644
1645 (defun elmo-cache-path-section-p (path)
1646   "Return non-nil when PATH is `section' cache path."
1647   (file-directory-p path))
1648
1649 (defun elmo-file-cache-get (msgid &optional section)
1650   "Returns the current file-cache object associated with MSGID.
1651 MSGID is the message-id of the message.
1652 If optional argument SECTION is specified, get partial file-cache object
1653 associated with SECTION."
1654   (if msgid
1655       (let ((path (elmo-cache-get-path msgid)))
1656         (if (and path (file-exists-p path))
1657             (if (elmo-cache-path-section-p path)
1658                 (if section
1659                     (if (file-exists-p (setq path (expand-file-name
1660                                                    section path)))
1661                         (cons path 'section))
1662                   ;; section is not specified but sectional.
1663                   (cons path 'section))
1664               ;; not directory.
1665               (unless section
1666                 (cons path 'entire)))
1667           ;; no cache.
1668           (cons path nil)))))
1669
1670 ;;;
1671 ;; Expire cache.
1672
1673 (defun elmo-cache-expire ()
1674   (interactive)
1675   (let* ((completion-ignore-case t)
1676          (method (completing-read (format "Expire by (%s): "
1677                                           elmo-cache-expire-default-method)
1678                                   '(("size" . "size")
1679                                     ("age" . "age")))))
1680     (if (string= method "")
1681         (setq method elmo-cache-expire-default-method))
1682     (funcall (intern (concat "elmo-cache-expire-by-" method)))))
1683
1684 (defun elmo-read-float-value-from-minibuffer (prompt &optional initial)
1685   (let ((str (read-from-minibuffer prompt initial)))
1686     (cond
1687      ((string-match "[0-9]*\\.[0-9]+" str)
1688       (string-to-number str))
1689      ((string-match "[0-9]+" str)
1690       (string-to-number (concat str ".0")))
1691      (t (error "%s is not number" str)))))
1692
1693 (defun elmo-cache-expire-by-size (&optional kbytes)
1694   "Expire cache file by size.
1695 If KBYTES is kilo bytes (This value must be float)."
1696   (interactive)
1697   (let ((size (or kbytes
1698                   (and (interactive-p)
1699                        (elmo-read-float-value-from-minibuffer
1700                         "Enter cache disk size (Kbytes): "
1701                         (number-to-string
1702                          (if (integerp elmo-cache-expire-default-size)
1703                              (float elmo-cache-expire-default-size)
1704                            elmo-cache-expire-default-size))))
1705                   (if (integerp elmo-cache-expire-default-size)
1706                       (float elmo-cache-expire-default-size))))
1707         (count 0)
1708         (Kbytes 1024)
1709         total beginning)
1710     (message "Checking disk usage...")
1711     (setq total (/ (elmo-disk-usage
1712                     elmo-cache-directory) Kbytes))
1713     (setq beginning total)
1714     (message "Checking disk usage...done")
1715     (let ((cfl (elmo-cache-get-sorted-cache-file-list))
1716           (deleted 0)
1717           oldest
1718           cur-size cur-file)
1719       (while (and (<= size total)
1720                   (setq oldest (elmo-cache-get-oldest-cache-file-entity cfl)))
1721         (setq cur-file (expand-file-name (car (cdr oldest)) (car oldest)))
1722         (setq cur-size (/ (elmo-disk-usage cur-file) Kbytes))
1723         (when (elmo-file-cache-delete cur-file)
1724           (setq count (+ count 1))
1725           (message "%d cache(s) are expired." count))
1726         (setq deleted (+ deleted cur-size))
1727         (setq total (- total cur-size)))
1728       (message "%d cache(s) are expired from disk (%d Kbytes/%d Kbytes)."
1729                count deleted beginning))))
1730
1731 (defun elmo-cache-make-file-entity (filename path)
1732   (cons filename (elmo-get-last-accessed-time filename path)))
1733
1734 (defun elmo-cache-get-oldest-cache-file-entity (cache-file-list)
1735   (let ((cfl cache-file-list)
1736         flist firsts oldest-entity wonlist)
1737     (while cfl
1738       (setq flist (cdr (car cfl)))
1739       (setq firsts (append firsts (list
1740                                    (cons (car (car cfl))
1741                                          (car flist)))))
1742       (setq cfl (cdr cfl)))
1743 ;;; (prin1 firsts)
1744     (while firsts
1745       (if (and (not oldest-entity)
1746                (cdr (cdr (car firsts))))
1747           (setq oldest-entity (car firsts)))
1748       (if (and (cdr (cdr (car firsts)))
1749                (cdr (cdr oldest-entity))
1750                (> (cdr (cdr oldest-entity)) (cdr (cdr (car firsts)))))
1751           (setq oldest-entity (car firsts)))
1752       (setq firsts (cdr firsts)))
1753     (setq wonlist (assoc (car oldest-entity) cache-file-list))
1754     (and wonlist
1755          (setcdr wonlist (delete (car (cdr wonlist)) (cdr wonlist))))
1756     oldest-entity))
1757
1758 (defun elmo-cache-get-sorted-cache-file-list ()
1759   (let ((dirs (directory-files
1760                elmo-cache-directory
1761                t "^[^\\.]"))
1762         (i 0) num
1763         elist
1764         ret-val)
1765     (setq num (length dirs))
1766     (message "Collecting cache info...")
1767     (while dirs
1768       (setq elist (mapcar (lambda (x)
1769                             (elmo-cache-make-file-entity x (car dirs)))
1770                           (directory-files (car dirs) nil "^[^\\.]")))
1771       (setq ret-val (append ret-val
1772                             (list (cons
1773                                    (car dirs)
1774                                    (sort
1775                                     elist
1776                                     (lambda (x y)
1777                                       (< (cdr x)
1778                                          (cdr y))))))))
1779       (when (> num elmo-display-progress-threshold)
1780         (setq i (+ i 1))
1781         (elmo-display-progress
1782          'elmo-cache-get-sorted-cache-file-list "Collecting cache info..."
1783          (/ (* i 100) num)))
1784       (setq dirs (cdr dirs)))
1785     (message "Collecting cache info...done")
1786     ret-val))
1787
1788 (defun elmo-cache-expire-by-age (&optional days)
1789   (let ((age (or (and days (int-to-string days))
1790                  (and (interactive-p)
1791                       (read-from-minibuffer
1792                        (format "Enter days (%s): "
1793                                elmo-cache-expire-default-age)))
1794                  (int-to-string elmo-cache-expire-default-age)))
1795         (dirs (directory-files
1796                elmo-cache-directory
1797                t "^[^\\.]"))
1798         (count 0)
1799         curtime)
1800     (if (string= age "")
1801         (setq age elmo-cache-expire-default-age)
1802       (setq age (string-to-int age)))
1803     (setq curtime (current-time))
1804     (setq curtime (+ (* (nth 0 curtime)
1805                         (float 65536)) (nth 1 curtime)))
1806     (while dirs
1807       (let ((files (directory-files (car dirs) t "^[^\\.]"))
1808             (limit-age (* age 86400)))
1809         (while files
1810           (when (> (- curtime (elmo-get-last-accessed-time (car files)))
1811                    limit-age)
1812             (when (elmo-file-cache-delete (car files))
1813               (setq count (+ 1 count))
1814               (message "%d cache file(s) are expired." count)))
1815           (setq files (cdr files))))
1816       (setq dirs (cdr dirs)))))
1817
1818 ;;;
1819 ;; msgid to path.
1820 (defun elmo-msgid-to-cache (msgid)
1821   (save-match-data
1822     (when (and msgid
1823                (string-match "<\\(.+\\)>$" msgid))
1824       (elmo-replace-string-as-filename (elmo-match-string 1 msgid)))))
1825
1826 (defun elmo-cache-get-path (msgid &optional folder number)
1827   "Get path for cache file associated with MSGID, FOLDER, and NUMBER."
1828   (if (setq msgid (elmo-msgid-to-cache msgid))
1829       (expand-file-name
1830        (expand-file-name
1831         (if folder
1832             (format "%s/%s/%s@%s"
1833                     (elmo-cache-get-path-subr msgid)
1834                     msgid
1835                     (or number "")
1836                     (elmo-safe-filename folder))
1837           (format "%s/%s"
1838                   (elmo-cache-get-path-subr msgid)
1839                   msgid))
1840         elmo-cache-directory))))
1841
1842 ;;;
1843 ;; Warnings.
1844
1845 (defconst elmo-warning-buffer-name "*elmo warning*")
1846
1847 (defun elmo-warning (&rest args)
1848   "Display a warning, making warning message by passing all args to `insert'."
1849   (with-current-buffer (get-buffer-create elmo-warning-buffer-name)
1850     (goto-char (point-max))
1851     (apply 'insert (append args '("\n")))
1852     (recenter 1))
1853   (display-buffer elmo-warning-buffer-name))
1854
1855 (defvar elmo-obsolete-variable-alist nil)
1856
1857 (defcustom elmo-obsolete-variable-show-warnings t
1858   "Show warning window if obsolete variable is treated."
1859   :type 'boolean
1860   :group 'elmo)
1861
1862 (defun elmo-define-obsolete-variable (obsolete var)
1863   "Define obsolete variable.
1864 OBSOLETE is a symbol for obsolete variable.
1865 VAR is a symbol for new variable.
1866 Definition is stored in `elmo-obsolete-variable-alist'."
1867   (let ((pair (assq var elmo-obsolete-variable-alist)))
1868     (if pair
1869         (setcdr pair obsolete)
1870       (setq elmo-obsolete-variable-alist
1871             (cons (cons var obsolete)
1872                   elmo-obsolete-variable-alist)))))
1873
1874 (defun elmo-resque-obsolete-variable (obsolete var)
1875   "Resque obsolete variable OBSOLETE as VAR.
1876 If `elmo-obsolete-variable-show-warnings' is non-nil, show warning message."
1877   (when (boundp obsolete)
1878     (static-if (and (fboundp 'defvaralias)
1879                     (subrp (symbol-function 'defvaralias)))
1880         (defvaralias var obsolete)
1881       (set var (symbol-value obsolete)))
1882     (if elmo-obsolete-variable-show-warnings
1883         (elmo-warning (format "%s is obsolete. Use %s instead."
1884                               (symbol-name obsolete)
1885                               (symbol-name var))))))
1886
1887 (defun elmo-resque-obsolete-variables (&optional alist)
1888   "Resque obsolete variables in ALIST.
1889 ALIST is a list of cons cell of
1890 \(OBSOLETE-VARIABLE-SYMBOL . NEW-VARIABLE-SYMBOL\).
1891 If ALIST is nil, `elmo-obsolete-variable-alist' is used."
1892   (dolist (pair elmo-obsolete-variable-alist)
1893     (elmo-resque-obsolete-variable (cdr pair)
1894                                    (car pair))))
1895
1896 ;;; Queue.
1897 (defvar elmo-dop-queue-filename "queue"
1898   "*Disconnected operation queue is saved in this file.")
1899
1900 (defun elmo-dop-queue-load ()
1901   (setq elmo-dop-queue
1902         (elmo-object-load
1903          (expand-file-name elmo-dop-queue-filename
1904                            elmo-msgdb-directory))))
1905
1906 (defun elmo-dop-queue-save ()
1907   (elmo-object-save
1908    (expand-file-name elmo-dop-queue-filename
1909                      elmo-msgdb-directory)
1910    elmo-dop-queue))
1911
1912 (require 'product)
1913 (product-provide (provide 'elmo-util) (require 'elmo-version))
1914
1915 ;;; elmo-util.el ends here