This commit was manufactured by cvs2svn to create branch 'elmo-imap4-new-
[elisp/wanderlust.git] / elmo / elmo-archive.el
1 ;;; elmo-archive.el --- Archive folder of ELMO. -*- coding: euc-japan -*-
2
3 ;; Copyright (C) 1998,1999,2000 OKUNISHI Fujikazu <fuji0924@mbox.kyoto-inet.or.jp>
4 ;; Copyright (C) 1998,1999,2000 Yuuichi Teranishi <teranisi@gohome.org>
5
6 ;; Author: OKUNISHI Fujikazu <fuji0924@mbox.kyoto-inet.or.jp>
7 ;;      Yuuichi Teranishi <teranisi@gohome.org>
8 ;; Keywords: mail, net news
9 ;; Created: Sep 13, 1998
10
11 ;; This file is part of ELMO (Elisp Library for Message Orchestration).
12
13 ;; This program is free software; you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation; either version 2, or (at your option)
16 ;; any later version.
17 ;;
18 ;; This program is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21 ;; GNU General Public License for more details.
22 ;;
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
25 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
26 ;; Boston, MA 02111-1307, USA.
27 ;;
28
29 ;;; Commentary:
30 ;;
31 ;; TODO:
32 ;; Info-Zip ÀìÍÑ¥¨¡¼¥¸¥§¥ó¥È¤òÍѤ¤¤¿ÆüËܸ측º÷¡ÊOS/2 ÀìÍÑ¡Ë¡£
33
34 ;;; Code:
35 ;;
36 (eval-when-compile (require 'cl))
37
38 (require 'elmo)
39 (require 'elmo-msgdb)
40
41 ;;; User vars.
42 (defvar elmo-archive-lha-dos-compatible
43   (memq system-type '(OS/2 emx windows-nt))
44   "*If non-nil, regard your LHA as compatible to DOS version.")
45
46 (defvar elmo-archive-use-izip-agent (memq system-type '(OS/2 emx))
47   "*If non-nil, use the special agent in fetching headers.")
48
49 (defvar elmo-archive-folder-path "~/Mail"
50   "*Base directory for archive folders.")
51
52 (defvar elmo-archive-basename "elmo-archive"
53   "*Common basename of archive folder file, w/o suffix.")
54
55 (defvar elmo-archive-cmdstr-max-length 8000 ; SASAKI Osamu's suggestion
56   "*Command line string limitation under OS/2, exactly 8190 bytes.")
57
58 (defvar elmo-archive-fetch-headers-volume 50
59   "*Quantity of article headers to fetch per once.")
60
61 (defvar elmo-archive-dummy-file ".elmo-archive"
62   "*Name of dummy file that will be appended when the folder is null.")
63
64 (defvar elmo-archive-check-existance-strict t
65   "*Check existance of archive contents if non-nil.")
66
67 (defvar elmo-archive-load-hook nil
68   "*Hook called after loading elmo-archive.el.")
69
70 (defvar elmo-archive-treat-file nil
71   "*Treat archive folder as a file if non-nil.")
72
73 ;;; User variables for elmo-archive.
74 (defvar elmo-archive-default-type 'zip
75   "*Default archiver type.  The value must be a symbol.")
76
77 (defvar elmo-archive-use-cache nil
78   "Use cache in archive folder.")
79
80 ;;; ELMO Local directory folder
81 (eval-and-compile
82   (luna-define-class elmo-archive-folder (elmo-folder)
83                      (archive-name archive-type archive-prefix dir-name))
84   (luna-define-internal-accessors 'elmo-archive-folder))
85
86 (luna-define-generic elmo-archive-folder-path (folder)
87   "Return local directory path of the FOLDER.")
88
89 (luna-define-method elmo-archive-folder-path ((folder elmo-archive-folder))
90   elmo-archive-folder-path)
91
92 (luna-define-method elmo-folder-initialize ((folder
93                                              elmo-archive-folder)
94                                             name)
95   (elmo-archive-folder-set-dir-name-internal folder name)
96   (when (string-match
97          "^\\([^;]*\\);?\\([^;]*\\);?\\([^;]*\\)$"
98          name)
99     ;; Drive letter is OK!
100     (or (elmo-archive-folder-set-archive-name-internal
101          folder (elmo-match-string 1 name))
102         (elmo-archive-folder-set-archive-name-internal
103          folder ""))
104     (or (elmo-archive-folder-set-archive-type-internal
105          folder (intern-soft (elmo-match-string 2 name)))
106         (elmo-archive-folder-set-archive-type-internal
107          folder elmo-archive-default-type))
108     (or (elmo-archive-folder-set-archive-prefix-internal
109          folder (elmo-match-string 3 name))
110         (elmo-archive-folder-set-archive-prefix-internal
111          folder "")))
112   folder)
113
114 (luna-define-method elmo-folder-expand-msgdb-path ((folder
115                                                     elmo-archive-folder))
116   ;; For compatibility
117   (expand-file-name
118    (elmo-replace-string-as-filename
119     (elmo-folder-name-internal folder))
120    (expand-file-name (concat (symbol-name (elmo-folder-type-internal folder))
121                              "/"
122                              (symbol-name
123                               (elmo-archive-folder-archive-type-internal
124                                folder)))
125                      elmo-msgdb-directory)))
126
127 ;;; MMDF parser -- info-zip agent w/ REXX
128 (defvar elmo-mmdf-delimiter "^\01\01\01\01$"
129   "*Regular expression of MMDF delimiter.")
130
131 (defvar elmo-unixmail-delimiter "^From \\([^ \t]+\\) \\(.+\\)"
132   "*Regular expression of UNIX Mail delimiter.")
133
134 (defvar elmo-archive-header-regexp "^[ \t]*[-=][-=][-=][-=]"
135   "*Common regexp of the delimiter in listing archive.") ; marche
136
137 (defvar elmo-archive-file-regexp-alist
138   (append
139    (if elmo-archive-lha-dos-compatible
140        '((lha . "^%s\\([0-9]+\\)$"))    ; OS/2,DOS w/  "-x"
141      '((lha . "^.*[ \t]%s\\([0-9]+\\)$")))
142    '((zip . "^.*[ \t]%s\\([0-9]+\\)$")
143      (zoo . "^.*[ \t]%s\\([0-9]+\\)$")
144      (tar . "^%s\\([0-9]+\\)$")         ; ok
145      (tgz . "^%s\\([0-9]+\\)$")         ; ok
146      (rar . "^[ \t]%s\\([0-9]+\\)$"))))
147
148 (defvar elmo-archive-suffix-alist
149   '((lha . ".lzh")                      ; default
150 ;;;     (lha . ".lzs")
151     (zip . ".zip")
152     (zoo . ".zoo")
153 ;;;     (arc . ".arc")
154 ;;;     (arj . ".arj")
155     (rar . ".rar")
156     (tar . ".tar")
157     (tgz . ".tar.gz")))
158
159 ;;; lha
160 (defvar elmo-archive-lha-method-alist
161   (if elmo-archive-lha-dos-compatible
162       ;; OS/2
163       '((cp  . ("lha" "u" "-x"))
164         (mv  . ("lha" "m" "-x"))
165         (rm  . ("lha" "d"))
166         (ls  . ("lha" "l" "-x"))
167         (cat . ("lha" "p" "-n"))
168         (ext . ("lha" "x"))             ; "-x"
169         )
170     ;; some UN|X
171     '((cp  . ("lha" "u"))
172       (mv  . ("lha" "m"))
173       (rm  . ("lha" "d"))
174       (ls  . ("lha" "l"))
175       (cat . ("lha" "pq"))
176       (ext . ("lha" "x")))))
177
178 ;;; info-zip/unzip
179 (defvar elmo-archive-zip-method-alist
180   '((cp       . ("zip" "-9q"))
181     (cp-pipe  . ("zip" "-9q@"))
182     (mv       . ("zip" "-mDq9"))
183     (mv-pipe  . ("zip" "-mDq9@"))
184     (rm       . ("zip" "-dq"))
185     (rm-pipe  . ("zip" "-dq@"))
186     (ls       . ("unzip" "-lq"))
187     (cat      . ("unzip" "-pq"))
188     (ext      . ("unzip"))
189     (cat-headers . ("izwlagent" "--cat"))))
190
191 ;;; zoo
192 (defvar elmo-archive-zoo-method-alist
193   '((cp       . ("zoo" "aq"))
194     (cp-pipe  . ("zoo" "aqI"))
195     (mv       . ("zoo" "aMq"))
196     (mv-pipe  . ("zoo" "aMqI"))
197     (rm       . ("zoo" "Dq"))
198     (ls       . ("zoo" "l"))            ; normal
199     (cat      . ("zoo" "xpq"))
200     (ext      . ("zoo" "xq"))))
201
202 ;;; rar
203 (defvar elmo-archive-rar-method-alist
204   '((cp       . ("rar" "u" "-m5"))
205     (mv       . ("rar" "m" "-m5"))
206     (rm       . ("rar" "d"))
207     (ls       . ("rar" "v"))
208     (cat      . ("rar" "p" "-inul"))
209     (ext      . ("rar" "x"))))
210
211 ;;; GNU tar (*.tar)
212 (defvar elmo-archive-tar-method-alist
213   (if elmo-archive-lha-dos-compatible
214       '((ls   . ("gtar" "-tf"))
215         (cat  . ("gtar" "--posix Oxf"))
216         (ext  . ("gtar" "-xf"))
217 ;;;     (rm   . ("gtar" "--posix" "--delete" "-f")) ; well not work
218         )
219     '((ls    . ("gtar" "-tf"))
220       (cat   . ("gtar" "-Oxf"))
221       (ext   . ("gtar" "-xf"))
222 ;;;      (rm    . ("gtar" "--delete" "-f")) ; well not work
223       )))
224
225 ;;; GNU tar (*.tar.gz, *.tar.Z, *.tar.bz2)
226 (defvar elmo-archive-tgz-method-alist
227   '((ls         . ("gtar" "-ztf"))
228     (cat        . ("gtar" "-Ozxf"))
229     (create     . ("gtar" "-zcf"))
230 ;;;    (rm         . elmo-archive-tgz-rm-func)
231     (cp         . elmo-archive-tgz-cp-func)
232     (mv         . elmo-archive-tgz-mv-func)
233     (ext        . ("gtar" "-zxf"))
234     ;; tgz special method
235     (decompress . ("gzip" "-d"))
236     (compress   . ("gzip"))
237     (append     . ("gtar" "-uf"))
238 ;;;    (delete     . ("gtar" "--delete" "-f")) ; well not work
239     ))
240
241 (defvar elmo-archive-method-list
242   '(elmo-archive-lha-method-alist
243     elmo-archive-zip-method-alist
244     elmo-archive-zoo-method-alist
245 ;;;    elmo-archive-tar-method-alist
246     elmo-archive-tgz-method-alist
247 ;;;    elmo-archive-arc-method-alist
248 ;;;    elmo-archive-arj-method-alist
249     elmo-archive-rar-method-alist))
250
251 ;;; Internal vars.
252 (defvar elmo-archive-method-alist nil)
253 (defvar elmo-archive-suffixes nil)
254
255
256 ;;; Macro
257 (defmacro elmo-archive-get-method (type action)
258   `(cdr (assq ,action (cdr (assq ,type elmo-archive-method-alist)))))
259
260 (defmacro elmo-archive-get-suffix (type)
261   `(cdr (assq ,type elmo-archive-suffix-alist)))
262
263 (defmacro elmo-archive-get-regexp (type)
264   `(cdr (assq ,type elmo-archive-file-regexp-alist)))
265
266 (defsubst elmo-archive-call-process (prog args &optional output)
267   (= (apply 'call-process prog nil output nil args) 0))
268
269 (defsubst elmo-archive-call-method (method args &optional output)
270   (cond
271    ((functionp method)
272     (funcall method args output))
273    (t
274     (elmo-archive-call-process
275      (car method) (append (cdr method) args) output))))
276
277 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
278 ;;; Scan Folder
279
280 (defsubst elmo-archive-list-folder-subr (folder &optional nonsort)
281   "*Returns list of number-file(int, not string) in archive FILE.
282 TYPE specifies the archiver's symbol."
283   (let* ((type (elmo-archive-folder-archive-type-internal folder))
284          (prefix (elmo-archive-folder-archive-prefix-internal folder))
285          (file (elmo-archive-get-archive-name folder))
286          (method (elmo-archive-get-method type 'ls))
287          (args (list file))
288          (file-regexp (format (elmo-archive-get-regexp type)
289                               (elmo-concat-path (regexp-quote prefix) "")))
290          (killed (elmo-folder-killed-list-internal folder))
291          numbers buf file-list header-end)
292     (if (file-exists-p file)
293         (with-temp-buffer
294           (unless (elmo-archive-call-method method args t)
295             (error "%s exited abnormally!" method))
296           (goto-char (point-min))
297           (when (re-search-forward elmo-archive-header-regexp nil t)
298             (forward-line 1)
299             (setq header-end (point))
300             (when (re-search-forward elmo-archive-header-regexp nil t)
301               (beginning-of-line)
302               (narrow-to-region header-end (point))
303               (goto-char (point-min))))
304           (while (and (re-search-forward file-regexp nil t)
305                       (not (eobp)))  ; for GNU tar 981010
306             (setq file-list (nconc file-list (list (string-to-number
307                                                     (match-string 1)))))))
308       (error "%s does not exist" file))
309     (if nonsort
310         (cons (or (elmo-max-of-list file-list) 0)
311               (if killed
312                   (- (length file-list)
313                      (elmo-msgdb-killed-list-length killed))
314                 (length file-list)))
315       (setq numbers (sort file-list '<))
316       (elmo-living-messages numbers killed))))
317
318 (luna-define-method elmo-folder-list-messages-internal ((folder
319                                                          elmo-archive-folder)
320                                                         &optional nohide)
321   (elmo-archive-list-folder-subr folder))
322
323 (luna-define-method elmo-folder-status ((folder elmo-archive-folder))
324   (elmo-archive-list-folder-subr folder t))
325
326 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
327 ;;; Folder related functions
328
329 (defsubst elmo-archive-get-archive-directory (folder)
330   ;; allow fullpath. return format is "/foo/bar/".
331   (if (file-name-absolute-p (elmo-archive-folder-archive-name-internal folder))
332       (if (find-file-name-handler
333            (elmo-archive-folder-archive-name-internal folder)
334            'copy-file)
335           (elmo-archive-folder-archive-name-internal folder)
336         (expand-file-name (elmo-archive-folder-archive-name-internal folder)))
337     (expand-file-name (elmo-archive-folder-archive-name-internal folder)
338                       elmo-archive-folder-path)))
339
340 (defun elmo-archive-get-archive-name (folder)
341   (let ((dir (elmo-archive-get-archive-directory folder))
342         (suffix (elmo-archive-get-suffix
343                  (elmo-archive-folder-archive-type-internal
344                   folder)))
345         filename dbdir)
346     (unless suffix
347       (error "Unknown archiver type: %s"
348              (elmo-archive-folder-archive-type-internal folder)))
349     (if elmo-archive-treat-file
350         (if (string-match (concat (regexp-quote suffix) "$")
351                           (elmo-archive-folder-archive-name-internal folder))
352             (expand-file-name (elmo-archive-folder-archive-name-internal
353                                folder)
354                               elmo-archive-folder-path)
355           (expand-file-name (concat (elmo-archive-folder-archive-name-internal
356                                      folder)
357                                     suffix)
358                             elmo-archive-folder-path))
359       (if (string-match
360            "^\\(ange-ftp\\|efs\\)-"
361            (symbol-name (find-file-name-handler dir 'copy-file)))
362           ;; ange-ftp, efs
363           (progn
364             (setq filename (expand-file-name
365                             (concat elmo-archive-basename suffix)
366                             (setq dbdir
367                                   (elmo-folder-msgdb-path folder))))
368             (if (file-directory-p dbdir)
369                 (); ok.
370               (if (file-exists-p dbdir)
371                   (error "File %s already exists" dbdir)
372                 (elmo-make-directory dbdir)))
373             (if (not (file-exists-p filename))
374                 (copy-file
375                  (if (file-directory-p dir)
376                      (expand-file-name
377                       (concat elmo-archive-basename suffix)
378                       dir)
379                    dir)
380                  filename))
381             filename)
382         (if (or (not (file-exists-p dir))
383                 (file-directory-p dir))
384             (expand-file-name
385              (concat elmo-archive-basename suffix)
386              dir)
387           dir)))))
388
389 (luna-define-method elmo-folder-exists-p ((folder elmo-archive-folder))
390   (file-exists-p (elmo-archive-get-archive-name folder)))
391
392 (luna-define-method elmo-folder-creatable-p ((folder elmo-archive-folder))
393   t)
394
395 (luna-define-method elmo-folder-writable-p ((folder elmo-archive-folder))
396   t)
397
398 (luna-define-method elmo-folder-create ((folder elmo-archive-folder))
399   (let* ((dir (directory-file-name      ; remove tail slash.
400                (elmo-archive-get-archive-directory folder)))
401          (type (elmo-archive-folder-archive-type-internal folder))
402          (arc (elmo-archive-get-archive-name folder)))
403     (if elmo-archive-treat-file
404         (setq dir (directory-file-name (file-name-directory dir))))
405     (cond ((and (file-exists-p dir)
406                 (not (file-directory-p dir)))
407            ;; file exists
408            (error "Create folder failed; File \"%s\" exists" dir))
409           ((file-directory-p dir)
410            (if (file-exists-p arc)
411                t                        ; return value
412              (elmo-archive-create-file arc type folder)))
413           (t
414            (elmo-make-directory dir)
415            (elmo-archive-create-file arc type folder)
416            t))))
417
418 (defun elmo-archive-create-file (archive type folder)
419   (save-excursion
420     (let* ((tmp-dir (directory-file-name
421                      (elmo-folder-msgdb-path folder)))
422            (dummy elmo-archive-dummy-file)
423            (method (or (elmo-archive-get-method type 'create)
424                        (elmo-archive-get-method type 'mv)))
425            (args (list archive dummy)))
426       (when (null method)
427         (ding)
428         (error "WARNING: read-only mode: %s (method undefined)" type))
429       (cond
430        ((file-directory-p tmp-dir)
431         ())                             ; nop
432        ((file-exists-p tmp-dir)
433         ;; file exists
434         (error "Create directory failed; File \"%s\" exists" tmp-dir))
435        (t
436         (elmo-make-directory tmp-dir)))
437       (elmo-bind-directory tmp-dir
438         (write-region (point) (point) dummy nil 'no-msg)
439         (prog1
440             (elmo-archive-call-method method args)
441           (if (file-exists-p dummy)
442               (delete-file dummy)))
443         ))))
444
445 (luna-define-method elmo-folder-delete ((folder elmo-archive-folder))
446   (let ((msgs (and (elmo-folder-exists-p folder)
447                    (elmo-folder-list-messages folder))))
448     (when (yes-or-no-p (format "%sDelete msgdb and substance of \"%s\"? "
449                                (if (> (length msgs) 0)
450                                    (format "%d msg(s) exists. " (length msgs))
451                                  "")
452                                (elmo-folder-name-internal folder)))
453       (let ((arc (elmo-archive-get-archive-name folder)))
454         (if (not (file-exists-p arc))
455             (error "No such file: %s" arc)
456           (delete-file arc))
457         (elmo-msgdb-delete-path folder)
458         t))))
459
460 (luna-define-method elmo-folder-rename-internal ((folder elmo-archive-folder)
461                                                  new-folder)
462   (let* ((old-arc (elmo-archive-get-archive-name folder))
463          (new-arc (elmo-archive-get-archive-name new-folder))
464          (new-dir (directory-file-name
465                    (elmo-archive-get-archive-directory new-folder))))
466     (if elmo-archive-treat-file
467         (setq new-dir (directory-file-name (file-name-directory new-dir))))
468     (unless (and (eq (elmo-archive-folder-archive-type-internal folder)
469                      (elmo-archive-folder-archive-type-internal new-folder))
470                  (equal (elmo-archive-folder-archive-prefix-internal
471                          folder)
472                         (elmo-archive-folder-archive-prefix-internal
473                          new-folder)))
474       (error "Not same archive type and prefix"))
475     (unless (file-exists-p old-arc)
476       (error "No such file: %s" old-arc))
477     (when (file-exists-p new-arc)
478       (error "Already exists: %s" new-arc))
479     (unless (file-directory-p new-dir)
480       (elmo-make-directory new-dir))
481     (rename-file old-arc new-arc)
482     t))
483
484 (defun elmo-archive-folder-list-subfolders (folder one-level)
485   (if elmo-archive-treat-file
486       (let* ((path (elmo-archive-get-archive-directory folder))
487              (base-folder (or (elmo-archive-folder-archive-name-internal
488                                folder)
489                               ""))
490              (suffix (elmo-archive-folder-archive-type-internal folder))
491              (prefix (if (string=
492                           (elmo-archive-folder-archive-prefix-internal folder)
493                           "")
494                          ""
495                        (concat ";"
496                                (elmo-archive-folder-archive-prefix-internal
497                                 folder))))
498              (dir (if (file-directory-p path)
499                       path (file-name-directory path)))
500              (name (if (file-directory-p path)
501                        "" (file-name-nondirectory path)))
502              (flist (and (file-directory-p dir)
503                          (directory-files dir nil
504                                           (if (> (length name) 0)
505                                               (concat "^" name "[^A-z][^A-z]")
506                                             name)
507                                           nil)))
508              (regexp (format "^\\(.*\\)\\(%s\\)$"
509                              (mapconcat
510                               (lambda (x) (regexp-quote (cdr x)))
511                               elmo-archive-suffix-alist
512                               "\\|"))))
513         (if (string-match "\\(.*\\)/$" base-folder) ; ends with '/'.
514             (setq base-folder (elmo-match-string 1 base-folder))
515           (unless (file-directory-p path)
516             (setq base-folder (or (file-name-directory base-folder) ""))))
517         (delq
518          nil
519          (mapcar
520           (lambda (x)
521             (when (and (string-match regexp x)
522                        (eq suffix
523                            (car
524                             (rassoc (elmo-match-string 2 x)
525                                     elmo-archive-suffix-alist))))
526               (format "%s%s;%s%s"
527                       (elmo-folder-prefix-internal folder)
528                       (elmo-concat-path base-folder (elmo-match-string 1 x))
529                       suffix prefix)))
530           flist)))
531     (elmo-mapcar-list-of-list
532      (lambda (x)
533        (if (file-exists-p
534             (expand-file-name
535              (concat elmo-archive-basename
536                      (elmo-archive-get-suffix
537                       (elmo-archive-folder-archive-type-internal
538                        folder)))
539              (expand-file-name
540               x
541               (elmo-archive-folder-path folder))))
542            (concat (elmo-folder-prefix-internal folder) x)))
543      (elmo-list-subdirectories
544       (elmo-archive-folder-path folder)
545       (or (elmo-archive-folder-dir-name-internal folder) "")
546       one-level))))
547
548 (luna-define-method elmo-folder-list-subfolders ((folder elmo-archive-folder)
549                                                  &optional one-level)
550   (elmo-archive-folder-list-subfolders folder one-level))
551
552 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
553 ;;; Article file related functions
554 ;;; read(extract) / append(move) / delete(delete) / query(list)
555
556 (defsubst elmo-archive-message-fetch-internal (folder number)
557   (let* ((type (elmo-archive-folder-archive-type-internal folder))
558          (arc (elmo-archive-get-archive-name folder))
559          (prefix (elmo-archive-folder-archive-prefix-internal folder))
560          (method (elmo-archive-get-method type 'cat))
561          (args (list arc (elmo-concat-path
562                           prefix (number-to-string number)))))
563     (and (file-exists-p arc)
564          (as-binary-process
565           (elmo-archive-call-method method args t))
566          (progn
567            (elmo-delete-cr-buffer)
568            t))))
569
570 (luna-define-method elmo-message-fetch-internal ((folder elmo-archive-folder)
571                                                  number strategy
572                                                  &optional section unseen)
573   (elmo-archive-message-fetch-internal folder number))
574
575 (luna-define-method elmo-folder-append-buffer ((folder elmo-archive-folder)
576                                                &optional flags number)
577   (elmo-archive-folder-append-buffer folder flags number))
578
579 ;; verrrrrry slow!!
580 (defun elmo-archive-folder-append-buffer (folder flags number)
581   (let* ((type (elmo-archive-folder-archive-type-internal folder))
582          (prefix (elmo-archive-folder-archive-prefix-internal folder))
583          (arc (elmo-archive-get-archive-name folder))
584          (method (elmo-archive-get-method type 'mv))
585          (next-num (or number
586                        (1+ (if (file-exists-p arc)
587                                (car
588                                 (elmo-folder-status folder)) 0))))
589          (tmp-dir (elmo-folder-msgdb-path folder))
590          (src-buffer (current-buffer))
591          dst-buffer
592          newfile)
593     (when (null method)
594       (ding)
595       (error "WARNING: read-only mode: %s (method undefined)" type))
596     (with-temp-buffer
597       (let ((tmp-dir (expand-file-name prefix tmp-dir)))
598         (when (not (file-directory-p tmp-dir))
599           (elmo-make-directory (directory-file-name tmp-dir))))
600       (setq newfile (elmo-concat-path
601                      prefix
602                      (number-to-string next-num)))
603       (elmo-bind-directory tmp-dir
604         (if (and (or (functionp method) (car method))
605                  (file-writable-p newfile))
606             (progn
607               (setq dst-buffer (current-buffer))
608               (with-current-buffer src-buffer
609                 (copy-to-buffer dst-buffer (point-min) (point-max)))
610               (as-binary-output-file
611                (write-region (point-min) (point-max) newfile nil 'no-msg))
612               (when (elmo-archive-call-method method (list arc newfile))
613                 (elmo-folder-preserve-flags
614                  folder
615                  (with-current-buffer src-buffer
616                    (elmo-msgdb-get-message-id-from-buffer))
617                  flags)
618                 t))
619           nil)))))
620
621 (defun elmo-folder-append-messages-*-archive (folder
622                                               src-folder
623                                               numbers
624                                               same-number)
625   (let ((prefix (elmo-archive-folder-archive-prefix-internal folder)))
626     (cond
627      ((and same-number
628            (null prefix)
629            (elmo-folder-message-file-p src-folder)
630            (elmo-folder-message-file-number-p src-folder))
631       ;; same-number(localdir, localnews) -> archive
632       (unless (elmo-archive-append-files
633                folder
634                (elmo-folder-message-file-directory src-folder)
635                numbers)
636         (setq numbers nil))
637       (elmo-progress-notify 'elmo-folder-move-messages (length numbers))
638       numbers)
639      ((elmo-folder-message-make-temp-file-p src-folder)
640       ;; not-same-number (localdir, localnews), (archive maildir) -> archive
641       (let ((temp-dir (elmo-folder-message-make-temp-files
642                        src-folder
643                        numbers
644                        (unless same-number
645                          (1+ (if (file-exists-p (elmo-archive-get-archive-name
646                                                  folder))
647                                  (car (elmo-folder-status folder)) 0)))))
648             new-dir base-dir files)
649         (unwind-protect
650             (progn
651               (setq base-dir temp-dir)
652               (when (> (length prefix) 0)
653                 (when (file-name-directory prefix)
654                   (elmo-make-directory (file-name-directory prefix)))
655                 (rename-file
656                  temp-dir
657                  (setq new-dir
658                        (expand-file-name
659                         prefix
660                         ;; parent of temp-dir..(works in windows?)
661                         (expand-file-name ".." temp-dir))))
662                 ;; now temp-dir has name prefix.
663                 (setq temp-dir new-dir)
664                 ;; parent of prefix becomes base-dir.
665                 (setq base-dir (expand-file-name ".." temp-dir)))
666               (setq files
667                     (mapcar
668                      (lambda (x) (elmo-concat-path prefix x))
669                      (directory-files temp-dir nil "^[^\\.]")))
670               (unless (elmo-archive-append-files folder
671                                                  base-dir
672                                                  files)
673                 (setq numbers nil)))
674           (elmo-delete-directory temp-dir)))
675       (elmo-progress-notify 'elmo-folder-move-messages (length numbers))
676       numbers)
677      (t
678       (elmo-folder-append-messages folder src-folder numbers same-number
679                                    'elmo-folder-append-messages-*-archive)))))
680
681 (luna-define-method elmo-folder-message-make-temp-file-p
682   ((folder elmo-archive-folder))
683   (let ((type (elmo-archive-folder-archive-type-internal folder)))
684     (or (elmo-archive-get-method type 'ext-pipe)
685         (elmo-archive-get-method type 'ext))))
686
687 (luna-define-method elmo-folder-message-make-temp-files
688   ((folder elmo-archive-folder) numbers
689    &optional start-number)
690   (elmo-archive-folder-message-make-temp-files folder numbers start-number))
691
692 (defun elmo-archive-folder-message-make-temp-files (folder
693                                                     numbers
694                                                     start-number)
695   (let* ((tmp-dir-src (elmo-folder-make-temporary-directory folder))
696          (tmp-dir-dst (elmo-folder-make-temporary-directory folder))
697          (arc     (elmo-archive-get-archive-name folder))
698          (type    (elmo-archive-folder-archive-type-internal folder))
699          (prefix  (elmo-archive-folder-archive-prefix-internal folder))
700          (p-method (elmo-archive-get-method type 'ext-pipe))
701          (n-method (elmo-archive-get-method type 'ext))
702          (tmp-msgs (mapcar (lambda (x) (elmo-concat-path
703                                         prefix
704                                         (number-to-string x))) numbers))
705          number)
706     ;; Expand files in the tmp-dir-src.
707     (elmo-bind-directory tmp-dir-src
708       (cond
709        ((functionp n-method)
710         (funcall n-method (cons arc tmp-msgs)))
711        (p-method
712         (let ((p-prog (car p-method))
713               (p-prog-arg (cdr p-method)))
714           (elmo-archive-exec-msgs-subr1
715            p-prog (append p-prog-arg (list arc)) tmp-msgs)))
716        (t
717         (let ((n-prog (car n-method))
718               (n-prog-arg (cdr n-method)))
719           (elmo-archive-exec-msgs-subr2
720            n-prog (append n-prog-arg (list arc)) tmp-msgs
721            (length arc))))))
722     ;; Move files to the tmp-dir-dst.
723     (setq number start-number)
724     (dolist (tmp-file tmp-msgs)
725       (rename-file (expand-file-name
726                     tmp-file
727                     tmp-dir-src)
728                    (expand-file-name
729                     (if start-number
730                         (number-to-string number)
731                       (file-name-nondirectory tmp-file))
732                     tmp-dir-dst))
733       (if start-number (incf number)))
734     ;; Remove tmp-dir-src.
735     (elmo-delete-directory tmp-dir-src)
736     ;; tmp-dir-dst is the return directory.
737     tmp-dir-dst))
738
739 (defun elmo-archive-append-files (folder dir &optional files)
740   (let* ((dst-type (elmo-archive-folder-archive-type-internal folder))
741          (arc (elmo-archive-get-archive-name folder))
742          (prefix (elmo-archive-folder-archive-prefix-internal folder))
743          (p-method (elmo-archive-get-method dst-type 'cp-pipe))
744          (n-method (elmo-archive-get-method dst-type 'cp))
745          src tmp newfile)
746     (unless (elmo-folder-exists-p folder) (elmo-folder-create folder))
747     (unless files (setq files (directory-files dir nil "^[^\\.]")))
748     (when (null (or p-method n-method))
749       (ding)
750       (error "WARNING: read-only mode: %s (method undefined)" dst-type))
751     (save-excursion
752       (elmo-bind-directory dir
753         (cond
754          ((functionp n-method)
755           (funcall n-method (cons arc files)))
756          (p-method
757           (let ((p-prog (car p-method))
758                 (p-prog-arg (cdr p-method)))
759             (elmo-archive-exec-msgs-subr1
760              p-prog (append p-prog-arg (list arc)) files)))
761          (t
762           (let ((n-prog (car n-method))
763                 (n-prog-arg (cdr n-method)))
764             (elmo-archive-exec-msgs-subr2
765              n-prog (append n-prog-arg (list arc)) files (length arc)))))))))
766
767 (luna-define-method elmo-folder-delete-messages-internal ((folder
768                                                            elmo-archive-folder)
769                                                           numbers)
770   (let* ((type (elmo-archive-folder-archive-type-internal folder))
771          (prefix (elmo-archive-folder-archive-prefix-internal folder))
772          (arc (elmo-archive-get-archive-name folder))
773          (p-method (elmo-archive-get-method type 'rm-pipe))
774          (n-method (elmo-archive-get-method type 'rm))
775          (numbers (mapcar (lambda (x) (elmo-concat-path
776                                        prefix
777                                        (number-to-string x)))
778                           numbers)))
779     (cond ((functionp n-method)
780            (funcall n-method (cons arc numbers)))
781           (p-method
782            (let ((p-prog (car p-method))
783                  (p-prog-arg (cdr p-method)))
784              (elmo-archive-exec-msgs-subr1
785               p-prog (append p-prog-arg (list arc)) numbers)))
786           (n-method
787            (let ((n-prog (car n-method))
788                  (n-prog-arg (cdr n-method)))
789              (elmo-archive-exec-msgs-subr2
790               n-prog (append n-prog-arg (list arc)) numbers (length arc))))
791           (t
792            (ding)
793            (error "WARNING: not delete: %s (method undefined)" type)))))
794
795 (defun elmo-archive-exec-msgs-subr1 (prog args msgs)
796   (with-temp-buffer
797     (insert (mapconcat 'concat msgs "\n")) ;string
798     (= 0 (apply 'call-process-region (point-min) (point-max)
799                 prog nil nil nil args))))
800
801 (defun elmo-archive-exec-msgs-subr2 (prog args msgs arc-length)
802   (let ((max-len (- elmo-archive-cmdstr-max-length arc-length))
803         (n (length msgs))
804         rest i sum)
805     (setq rest msgs) ;string
806     (setq i 1)
807     (setq sum 0)
808     (catch 'done
809       (while (and rest (<= i n))
810         (mapc
811          (lambda (x)
812            (let* ((len (length x))
813                   (files (member x (reverse rest))))
814              ;; total(previous) + current + white space
815              (if (<= max-len (+ sum len 1))
816                  (progn
817                    (unless
818                        (elmo-archive-call-process
819                         prog (append args files))
820                      (throw 'done nil))
821                    (setq sum 0) ;; reset
822                    (setq rest (nthcdr i rest)))
823                (setq sum (+ sum len 1)))
824              (setq i (1+ i))))
825          msgs))
826       (throw 'done
827              (or (not rest)
828                  (elmo-archive-call-process prog (append args rest))))
829       )))
830
831 (defsubst elmo-archive-article-exists-p (arc msg type)
832   (if (not elmo-archive-check-existance-strict)
833       t ; nop
834     (save-excursion ; added 980915
835       (let* ((method (elmo-archive-get-method type 'ls))
836              (args (list arc msg))
837              (buf (get-buffer-create " *ELMO ARCHIVE query*"))
838              (error-msg "\\(no file\\|0 files\\)")
839              ret-val)
840         (set-buffer buf)
841         (erase-buffer)
842         (elmo-archive-call-method method args t)
843         ;; pointer: point-max
844         (setq ret-val (not (re-search-backward error-msg nil t)))
845         (kill-buffer buf)
846         ret-val))))
847
848 (defun elmo-archive-tgz-common-func (args exec-type &optional copy)
849   (let* ((arc (car args))
850          (tmp-msgs (cdr args))
851          (decompress (elmo-archive-get-method 'tgz 'decompress))
852          (compress (elmo-archive-get-method 'tgz 'compress))
853          (exec (elmo-archive-get-method 'tgz exec-type))
854          (suffix (elmo-archive-get-suffix 'tgz))
855          (tar-suffix (elmo-archive-get-suffix 'tar))
856          arc-tar ret-val
857          )
858     (when (null (and decompress compress exec))
859       (ding)
860       (error "WARNING: special method undefined: %s of %s"
861              (or (if (null decompress) 'decompress)
862                  (if (null compress) 'compress)
863                  (if (null exec) exec-type))
864              'tgz))
865     (unless tar-suffix
866       (ding)
867       (error "WARNING: `tar' suffix undefined"))
868     (if (string-match (concat (regexp-quote suffix) "$") arc)
869         (setq arc-tar
870               (concat (substring arc 0 (match-beginning 0)) tar-suffix))
871       (error "%s: not match suffix [%s]" arc suffix))
872     (and
873      ;; decompress
874      (elmo-archive-call-process
875       (car decompress) (append (cdr decompress) (list arc)))
876      ;; append (or delete)
877      (elmo-archive-exec-msgs-subr2
878       (car exec) (append (cdr exec) (list arc-tar)) tmp-msgs (length arc-tar))
879      ;; compress
880      (setq ret-val
881            (elmo-archive-call-process
882             (car compress) (append (cdr compress) (list arc-tar)))))
883     ;; delete temporary messages
884     (if (and (not copy)
885              (eq exec-type 'append))
886         (while tmp-msgs
887           (if (file-exists-p (car tmp-msgs))
888               (delete-file (car tmp-msgs)))
889           (setq tmp-msgs (cdr tmp-msgs))))
890     ret-val))
891
892 (defun elmo-archive-tgz-cp-func (args &optional output)
893   (elmo-archive-tgz-common-func args 'append t))
894
895 (defun elmo-archive-tgz-mv-func (args &optional output)
896   (elmo-archive-tgz-common-func args 'append))
897
898 (defun elmo-archive-tgz-rm-func (args &optional output)
899   (elmo-archive-tgz-common-func args 'delete))
900
901 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
902 ;;; MessageDB functions (from elmo-localdir.el)
903
904 (defsubst elmo-archive-msgdb-create-entity-subr (msgdb number)
905   (let (header-end)
906     (set-buffer-multibyte default-enable-multibyte-characters)
907     (goto-char (point-min))
908     (if (re-search-forward "\\(^--.*$\\)\\|\\(\n\n\\)" nil t)
909         (setq header-end (point))
910       (setq header-end (point-max)))
911     (narrow-to-region (point-min) header-end)
912     (elmo-msgdb-create-message-entity-from-buffer
913      (elmo-msgdb-message-entity-handler msgdb) number)))
914
915 ;; verrrry slow!!
916 (defsubst elmo-archive-msgdb-create-entity (msgdb
917                                             method
918                                             archive number type
919                                             &optional prefix)
920   (let* ((msg (elmo-concat-path prefix (number-to-string number)))
921          (arg-list (list archive msg)))
922     (when (elmo-archive-article-exists-p archive msg type)
923       ;; insert article.
924       (as-binary-process
925        (elmo-archive-call-method method arg-list t))
926       (elmo-archive-msgdb-create-entity-subr msgdb number))))
927
928 (luna-define-method elmo-folder-msgdb-create ((folder elmo-archive-folder)
929                                               numbers flag-table)
930   (when numbers
931     (save-excursion ;; 981005
932       (elmo-with-progress-display (elmo-folder-create-msgdb (length numbers))
933           "Creating msgdb"
934         (if (and elmo-archive-use-izip-agent
935                  (elmo-archive-get-method
936                   (elmo-archive-folder-archive-type-internal folder)
937                   'cat-headers))
938             (elmo-archive-msgdb-create-as-numlist-subr2
939              folder numbers flag-table)
940           (elmo-archive-msgdb-create-as-numlist-subr1
941            folder numbers flag-table))))))
942
943 (defun elmo-archive-msgdb-create-as-numlist-subr1 (folder numlist flag-table)
944   (let* ((type (elmo-archive-folder-archive-type-internal folder))
945          (file (elmo-archive-get-archive-name folder))
946          (method (elmo-archive-get-method type 'cat))
947          (new-msgdb (elmo-make-msgdb))
948          entity message-id flags)
949     (with-temp-buffer
950       (while numlist
951         (erase-buffer)
952         (setq entity
953               (elmo-archive-msgdb-create-entity
954                new-msgdb
955                method file (car numlist) type
956                (elmo-archive-folder-archive-prefix-internal folder)))
957         (when entity
958           (setq message-id (elmo-message-entity-field entity 'message-id)
959                 flags (elmo-flag-table-get flag-table message-id))
960           (elmo-global-flags-set flags folder (car numlist) message-id)
961           (elmo-msgdb-append-entity new-msgdb entity flags))
962         (elmo-progress-notify 'elmo-folder-msgdb-create)
963         (setq numlist (cdr numlist)))
964       new-msgdb)))
965
966 ;;; info-zip agent
967 (defun elmo-archive-msgdb-create-as-numlist-subr2 (folder
968                                                    numlist
969                                                    flag-table)
970   (let* ((delim1 elmo-mmdf-delimiter)           ;; MMDF
971          (delim2 elmo-unixmail-delimiter)       ;; UNIX Mail
972          (type (elmo-archive-folder-archive-type-internal folder))
973          (prefix (elmo-archive-folder-archive-prefix-internal folder))
974          (method (elmo-archive-get-method type 'cat-headers))
975          (prog (car method))
976          (args (cdr method))
977          (arc (elmo-archive-get-archive-name folder))
978          (new-msgdb (elmo-make-msgdb))
979          n msgs case-fold-search)
980     (with-temp-buffer
981       (while numlist
982         (setq n (min (1- elmo-archive-fetch-headers-volume)
983                      (1- (length numlist))))
984         (setq msgs (reverse (memq (nth n numlist) (reverse numlist))))
985         (setq numlist (nthcdr (1+ n) numlist))
986         (erase-buffer)
987         (insert
988          (mapconcat
989           'concat
990           (mapcar (lambda (x) (elmo-concat-path prefix (number-to-string x)))
991                   msgs)
992           "\n"))
993         (as-binary-process (apply 'call-process-region
994                                   (point-min) (point-max)
995                                   prog t t nil (append args (list arc))))
996         (goto-char (point-min))
997         (cond
998          ((looking-at delim1)   ;; MMDF
999           (elmo-msgdb-append
1000            new-msgdb
1001            (elmo-archive-parse-mmdf folder msgs flag-table)))
1002 ;;;      ((looking-at delim2)           ; UNIX MAIL
1003 ;;;       (elmo-msgdb-append
1004 ;;;        new-msgdb
1005 ;;;        (elmo-archive-parse-unixmail msgs flag-table)))
1006          (t                     ;; unknown format
1007           (error "Unknown format!")))
1008         (elmo-progress-notify 'elmo-folder-msgdb-create)))
1009     new-msgdb))
1010
1011 (defun elmo-archive-parse-mmdf (folder msgs flag-table)
1012   (let ((delim elmo-mmdf-delimiter)
1013         (new-msgdb (elmo-make-msgdb))
1014         number sp ep rest entity
1015         message-id flags)
1016     (goto-char (point-min))
1017     (setq rest msgs)
1018     (while (and rest (re-search-forward delim nil t)
1019                 (not (eobp)))
1020       (setq number (car rest))
1021       (setq sp (1+ (point)))
1022       (setq ep (prog2 (re-search-forward delim)
1023                    (1+ (- (point) (length delim)))))
1024       (if (>= sp ep)                    ; no article!
1025           ()                            ; nop
1026         (save-excursion
1027           (narrow-to-region sp ep)
1028           (setq entity (elmo-archive-msgdb-create-entity-subr new-msgdb number)
1029                 message-id (elmo-message-entity-field entity 'message-id)
1030                 flags (elmo-flag-table-get flag-table message-id))
1031           (elmo-global-flags-set flags folder number message-id)
1032           (elmo-msgdb-append-entity new-msgdb entity flags)
1033           (widen)))
1034       (forward-line 1)
1035       (setq rest (cdr rest)))
1036     new-msgdb))
1037
1038
1039 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1040 ;;; Search functions
1041
1042 (defsubst elmo-archive-field-condition-match (folder number number-list
1043                                                      condition prefix)
1044   (save-excursion
1045     (let* ((type (elmo-archive-folder-archive-type-internal folder))
1046            (arc (elmo-archive-get-archive-name folder))
1047            (method (elmo-archive-get-method type 'cat))
1048            (args (list arc (elmo-concat-path prefix (number-to-string number)))))
1049       (elmo-set-work-buf
1050         (when (file-exists-p arc)
1051           (as-binary-process
1052            (elmo-archive-call-method method args t))
1053           (set-buffer-multibyte default-enable-multibyte-characters)
1054           (decode-mime-charset-region (point-min)(point-max) elmo-mime-charset)
1055           (elmo-message-buffer-match-condition condition number))))))
1056
1057 (luna-define-method elmo-folder-search ((folder elmo-archive-folder)
1058                                         condition &optional from-msgs)
1059   (let* ((case-fold-search nil)
1060 ;;;      (args (elmo-string-to-list key))
1061 ;;; XXX: I don't know whether `elmo-archive-list-folder' updates match-data.
1062 ;;;      (msgs (or from-msgs (elmo-archive-list-folder spec)))
1063          (msgs (or from-msgs (elmo-folder-list-messages folder)))
1064          ret-val)
1065     (elmo-with-progress-display (elmo-folder-search (length msgs)) "Searching"
1066       (dolist (number msgs)
1067         (when (elmo-archive-field-condition-match
1068                folder number msgs
1069                condition
1070                (elmo-archive-folder-archive-prefix-internal folder))
1071           (setq ret-val (cons number ret-val)))
1072         (elmo-progress-notify 'elmo-folder-search)))
1073     (nreverse ret-val)))
1074
1075 ;;; method(alist)
1076 (if (null elmo-archive-method-alist)
1077     (let ((mlist elmo-archive-method-list) ; from mew-highlight.el
1078           method type str)
1079       (while mlist
1080         (setq method (car mlist))
1081         (setq mlist (cdr mlist))
1082         (setq str (symbol-name method))
1083         (string-match "elmo-archive-\\([^-].*\\)-method-alist$" str)
1084         (setq type (intern-soft
1085                     (elmo-match-string 1 str)))
1086         (setq elmo-archive-method-alist
1087               (cons (cons type
1088                           (symbol-value method))
1089                     elmo-archive-method-alist)))))
1090
1091 ;;; valid suffix(list)
1092 (if (null elmo-archive-suffixes)
1093     (let ((slist elmo-archive-suffix-alist)
1094           tmp)
1095       (while slist
1096         (setq tmp (car slist))
1097         (setq elmo-archive-suffixes
1098               (nconc elmo-archive-suffixes (list (cdr tmp))))
1099         (setq slist (cdr slist)))))
1100
1101 (luna-define-method elmo-message-use-cache-p ((folder elmo-archive-folder)
1102                                               number)
1103   elmo-archive-use-cache)
1104
1105 ;;; End
1106 (run-hooks 'elmo-archive-load-hook)
1107
1108 (require 'product)
1109 (product-provide (provide 'elmo-archive) (require 'elmo-version))
1110
1111 ;;; elmo-archive.el ends here