(elmo-safe-plist-get): New alias or macro.
[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)
259                                       elmo-archive-method-alist))))))
260
261 (defmacro elmo-archive-get-suffix (type)
262   (` (cdr (assq (, type)
263                 elmo-archive-suffix-alist))))
264
265 (defmacro elmo-archive-get-regexp (type)
266   (` (cdr (assq (, type)
267                 elmo-archive-file-regexp-alist))))
268
269 (defsubst elmo-archive-call-process (prog args &optional output)
270   (= (apply 'call-process prog nil output nil args) 0))
271
272 (defsubst elmo-archive-call-method (method args &optional output)
273   (cond
274    ((functionp method)
275     (funcall method args output))
276    (t
277     (elmo-archive-call-process
278      (car method) (append (cdr method) args) output))))
279
280 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
281 ;;; Scan Folder
282
283 (defsubst elmo-archive-list-folder-subr (folder &optional nonsort)
284   "*Returns list of number-file(int, not string) in archive FILE.
285 TYPE specifies the archiver's symbol."
286   (let* ((type (elmo-archive-folder-archive-type-internal folder))
287          (prefix (elmo-archive-folder-archive-prefix-internal folder))
288          (file (elmo-archive-get-archive-name folder))
289          (method (elmo-archive-get-method type 'ls))
290          (args (list file))
291          (file-regexp (format (elmo-archive-get-regexp type)
292                               (elmo-concat-path (regexp-quote prefix) "")))
293          (killed (elmo-folder-killed-list-internal folder))
294          numbers buf file-list header-end)
295     (if (file-exists-p file)
296         (with-temp-buffer
297           (unless (elmo-archive-call-method method args t)
298             (error "%s exited abnormally!" method))
299           (goto-char (point-min))
300           (when (re-search-forward elmo-archive-header-regexp nil t)
301             (forward-line 1)
302             (setq header-end (point))
303             (when (re-search-forward elmo-archive-header-regexp nil t)
304               (beginning-of-line)
305               (narrow-to-region header-end (point))
306               (goto-char (point-min))))
307           (while (and (re-search-forward file-regexp nil t)
308                       (not (eobp)))  ; for GNU tar 981010
309             (setq file-list (nconc file-list (list (string-to-int
310                                                     (match-string 1)))))))
311       (error "%s does not exist" file))
312     (if nonsort
313         (cons (or (elmo-max-of-list file-list) 0)
314               (if killed
315                   (- (length file-list)
316                      (elmo-msgdb-killed-list-length killed))
317                 (length file-list)))
318       (setq numbers (sort file-list '<))
319       (elmo-living-messages numbers killed))))
320
321 (luna-define-method elmo-folder-list-messages-internal ((folder
322                                                          elmo-archive-folder)
323                                                         &optional nohide)
324   (elmo-archive-list-folder-subr folder))
325
326 (luna-define-method elmo-folder-status ((folder elmo-archive-folder))
327   (elmo-archive-list-folder-subr folder t))
328
329 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
330 ;;; Folder related functions
331
332 (defsubst elmo-archive-get-archive-directory (folder)
333   ;; allow fullpath. return format is "/foo/bar/".
334   (if (file-name-absolute-p (elmo-archive-folder-archive-name-internal folder))
335       (if (find-file-name-handler
336            (elmo-archive-folder-archive-name-internal folder)
337            'copy-file)
338           (elmo-archive-folder-archive-name-internal folder)
339         (expand-file-name (elmo-archive-folder-archive-name-internal folder)))
340     (expand-file-name (elmo-archive-folder-archive-name-internal folder)
341                       elmo-archive-folder-path)))
342
343 (defun elmo-archive-get-archive-name (folder)
344   (let ((dir (elmo-archive-get-archive-directory folder))
345         (suffix (elmo-archive-get-suffix
346                  (elmo-archive-folder-archive-type-internal
347                   folder)))
348         filename dbdir)
349     (unless suffix
350       (error "Unknown archiver type: %s"
351              (elmo-archive-folder-archive-type-internal folder)))
352     (if elmo-archive-treat-file
353         (if (string-match (concat (regexp-quote suffix) "$")
354                           (elmo-archive-folder-archive-name-internal folder))
355             (expand-file-name (elmo-archive-folder-archive-name-internal
356                                folder)
357                               elmo-archive-folder-path)
358           (expand-file-name (concat (elmo-archive-folder-archive-name-internal
359                                      folder)
360                                     suffix)
361                             elmo-archive-folder-path))
362       (if (string-match
363            "^\\(ange-ftp\\|efs\\)-"
364            (symbol-name (find-file-name-handler dir 'copy-file)))
365           ;; ange-ftp, efs
366           (progn
367             (setq filename (expand-file-name
368                             (concat elmo-archive-basename suffix)
369                             (setq dbdir
370                                   (elmo-folder-msgdb-path folder))))
371             (if (file-directory-p dbdir)
372                 (); ok.
373               (if (file-exists-p dbdir)
374                   (error "File %s already exists" dbdir)
375                 (elmo-make-directory dbdir)))
376             (if (not (file-exists-p filename))
377                 (copy-file
378                  (if (file-directory-p dir)
379                      (expand-file-name
380                       (concat elmo-archive-basename suffix)
381                       dir)
382                    dir)
383                  filename))
384             filename)
385         (if (or (not (file-exists-p dir))
386                 (file-directory-p dir))
387             (expand-file-name
388              (concat elmo-archive-basename suffix)
389              dir)
390           dir)))))
391
392 (luna-define-method elmo-folder-exists-p ((folder elmo-archive-folder))
393   (file-exists-p (elmo-archive-get-archive-name folder)))
394
395 (luna-define-method elmo-folder-creatable-p ((folder elmo-archive-folder))
396   t)
397
398 (luna-define-method elmo-folder-writable-p ((folder elmo-archive-folder))
399   t)
400
401 (luna-define-method elmo-folder-create ((folder elmo-archive-folder))
402   (let* ((dir (directory-file-name      ; remove tail slash.
403                (elmo-archive-get-archive-directory folder)))
404          (type (elmo-archive-folder-archive-type-internal folder))
405          (arc (elmo-archive-get-archive-name folder)))
406     (if elmo-archive-treat-file
407         (setq dir (directory-file-name (file-name-directory dir))))
408     (cond ((and (file-exists-p dir)
409                 (not (file-directory-p dir)))
410            ;; file exists
411            (error "Create folder failed; File \"%s\" exists" dir))
412           ((file-directory-p dir)
413            (if (file-exists-p arc)
414                t                        ; return value
415              (elmo-archive-create-file arc type folder)))
416           (t
417            (elmo-make-directory dir)
418            (elmo-archive-create-file arc type folder)
419            t))))
420
421 (defun elmo-archive-create-file (archive type folder)
422   (save-excursion
423     (let* ((tmp-dir (directory-file-name
424                      (elmo-folder-msgdb-path folder)))
425            (dummy elmo-archive-dummy-file)
426            (method (or (elmo-archive-get-method type 'create)
427                        (elmo-archive-get-method type 'mv)))
428            (args (list archive dummy)))
429       (when (null method)
430         (ding)
431         (error "WARNING: read-only mode: %s (method undefined)" type))
432       (cond
433        ((file-directory-p tmp-dir)
434         ()) ;nop
435        ((file-exists-p tmp-dir)
436         ;; file exists
437         (error "Create directory failed; File \"%s\" exists" tmp-dir))
438        (t
439         (elmo-make-directory tmp-dir)))
440       (elmo-bind-directory
441        tmp-dir
442        (write-region (point) (point) dummy nil 'no-msg)
443        (prog1
444            (elmo-archive-call-method method args)
445          (if (file-exists-p dummy)
446              (delete-file dummy)))
447        ))))
448
449 (luna-define-method elmo-folder-delete ((folder elmo-archive-folder))
450   (let ((msgs (and (elmo-folder-exists-p folder)
451                    (elmo-folder-list-messages folder))))
452     (when (yes-or-no-p (format "%sDelete msgdb and substance of \"%s\"? "
453                                (if (> (length msgs) 0)
454                                    (format "%d msg(s) exists. " (length msgs))
455                                  "")
456                                (elmo-folder-name-internal folder)))
457       (let ((arc (elmo-archive-get-archive-name folder)))
458         (if (not (file-exists-p arc))
459             (error "No such file: %s" arc)
460           (delete-file arc))
461         (elmo-msgdb-delete-path folder)
462         t))))
463
464 (luna-define-method elmo-folder-rename-internal ((folder elmo-archive-folder)
465                                                  new-folder)
466   (let* ((old-arc (elmo-archive-get-archive-name folder))
467          (new-arc (elmo-archive-get-archive-name new-folder))
468          (new-dir (directory-file-name
469                    (elmo-archive-get-archive-directory new-folder))))
470     (if elmo-archive-treat-file
471         (setq new-dir (directory-file-name (file-name-directory new-dir))))
472     (unless (and (eq (elmo-archive-folder-archive-type-internal folder)
473                      (elmo-archive-folder-archive-type-internal new-folder))
474                  (equal (elmo-archive-folder-archive-prefix-internal
475                          folder)
476                         (elmo-archive-folder-archive-prefix-internal
477                          new-folder)))
478       (error "Not same archive type and prefix"))
479     (unless (file-exists-p old-arc)
480       (error "No such file: %s" old-arc))
481     (when (file-exists-p new-arc)
482       (error "Already exists: %s" new-arc))
483     (unless (file-directory-p new-dir)
484       (elmo-make-directory new-dir))
485     (rename-file old-arc new-arc)
486     t))
487
488 (defun elmo-archive-folder-list-subfolders (folder one-level)
489   (if elmo-archive-treat-file
490       (let* ((path (elmo-archive-get-archive-directory folder))
491              (base-folder (or (elmo-archive-folder-archive-name-internal
492                                folder)
493                               ""))
494              (suffix (elmo-archive-folder-archive-type-internal folder))
495              (prefix (if (string=
496                           (elmo-archive-folder-archive-prefix-internal folder)
497                           "")
498                          ""
499                        (concat ";"
500                                (elmo-archive-folder-archive-prefix-internal
501                                 folder))))
502              (dir (if (file-directory-p path)
503                       path (file-name-directory path)))
504              (name (if (file-directory-p path)
505                        "" (file-name-nondirectory path)))
506              (flist (and (file-directory-p dir)
507                          (directory-files dir nil
508                                           (if (> (length name) 0)
509                                               (concat "^" name "[^A-z][^A-z]")
510                                             name)
511                                           nil)))
512              (regexp (format "^\\(.*\\)\\(%s\\)$"
513                              (mapconcat
514                               '(lambda (x) (regexp-quote (cdr x)))
515                               elmo-archive-suffix-alist
516                               "\\|"))))
517         (if (string-match "\\(.*\\)/$" base-folder) ; ends with '/'.
518             (setq base-folder (elmo-match-string 1 base-folder))
519           (unless (file-directory-p path)
520             (setq base-folder (or (file-name-directory base-folder) ""))))
521         (delq
522          nil
523          (mapcar
524           '(lambda (x)
525              (when (and (string-match regexp x)
526                         (eq suffix
527                             (car
528                              (rassoc (elmo-match-string 2 x)
529                                      elmo-archive-suffix-alist))))
530                (format "%s%s;%s%s"
531                        (elmo-folder-prefix-internal folder)
532                        (elmo-concat-path base-folder (elmo-match-string 1 x))
533                        suffix prefix)))
534           flist)))
535     (elmo-mapcar-list-of-list
536      (function (lambda (x)
537                  (if (file-exists-p
538                       (expand-file-name
539                        (concat elmo-archive-basename
540                                (elmo-archive-get-suffix
541                                 (elmo-archive-folder-archive-type-internal
542                                  folder)))
543                        (expand-file-name
544                         x
545                         (elmo-archive-folder-path folder))))
546                      (concat (elmo-folder-prefix-internal folder) x))))
547      (elmo-list-subdirectories
548       (elmo-archive-folder-path folder)
549       (or (elmo-archive-folder-dir-name-internal folder) "")
550       one-level))))
551
552 (luna-define-method elmo-folder-list-subfolders ((folder elmo-archive-folder)
553                                                  &optional one-level)
554   (elmo-archive-folder-list-subfolders folder one-level))
555
556 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
557 ;;; Article file related functions
558 ;;; read(extract) / append(move) / delete(delete) / query(list)
559
560 (defsubst elmo-archive-message-fetch-internal (folder number)
561   (let* ((type (elmo-archive-folder-archive-type-internal folder))
562          (arc (elmo-archive-get-archive-name folder))
563          (prefix (elmo-archive-folder-archive-prefix-internal folder))
564          (method (elmo-archive-get-method type 'cat))
565          (args (list arc (elmo-concat-path
566                           prefix (int-to-string number)))))
567     (and (file-exists-p arc)
568          (as-binary-process
569           (elmo-archive-call-method method args t))
570          (progn
571            (elmo-delete-cr-buffer)
572            t))))
573
574 (luna-define-method elmo-message-fetch-internal ((folder elmo-archive-folder)
575                                                  number strategy
576                                                  &optional section unseen)
577   (elmo-archive-message-fetch-internal folder number))
578
579 (luna-define-method elmo-folder-append-buffer ((folder elmo-archive-folder)
580                                                &optional flags number)
581   (elmo-archive-folder-append-buffer folder flags number))
582
583 ;; verrrrrry slow!!
584 (defun elmo-archive-folder-append-buffer (folder flags number)
585   (let* ((type (elmo-archive-folder-archive-type-internal folder))
586          (prefix (elmo-archive-folder-archive-prefix-internal folder))
587          (arc (elmo-archive-get-archive-name folder))
588          (method (elmo-archive-get-method type 'mv))
589          (next-num (or number
590                        (1+ (if (file-exists-p arc)
591                                (car
592                                 (elmo-folder-status folder)) 0))))
593          (tmp-dir (elmo-folder-msgdb-path folder))
594          (src-buffer (current-buffer))
595          dst-buffer
596          newfile)
597     (when (null method)
598       (ding)
599       (error "WARNING: read-only mode: %s (method undefined)" type))
600     (with-temp-buffer
601       (let ((tmp-dir (expand-file-name prefix tmp-dir)))
602         (when (not (file-directory-p tmp-dir))
603           (elmo-make-directory (directory-file-name tmp-dir))))
604       (setq newfile (elmo-concat-path
605                      prefix
606                      (int-to-string next-num)))
607       (elmo-bind-directory
608        tmp-dir
609        (if (and (or (functionp method) (car method))
610                 (file-writable-p newfile))
611            (progn
612              (setq dst-buffer (current-buffer))
613              (with-current-buffer src-buffer
614                (copy-to-buffer dst-buffer (point-min) (point-max)))
615              (as-binary-output-file
616                   (write-region (point-min) (point-max) newfile nil 'no-msg))
617              (when (elmo-archive-call-method method (list arc newfile))
618                (elmo-folder-preserve-flags
619                 folder
620                 (with-current-buffer src-buffer
621                   (elmo-msgdb-get-message-id-from-buffer))
622                 flags)
623                t))
624          nil)))))
625
626 (defun elmo-folder-append-messages-*-archive (folder
627                                               src-folder
628                                               numbers
629                                               same-number)
630   (let ((prefix (elmo-archive-folder-archive-prefix-internal folder)))
631     (cond
632      ((and same-number
633            (null prefix)
634            (elmo-folder-message-file-p src-folder)
635            (elmo-folder-message-file-number-p src-folder))
636       ;; same-number(localdir, localnews) -> archive
637       (unless (elmo-archive-append-files
638                folder
639                (elmo-folder-message-file-directory src-folder)
640                numbers)
641         (setq numbers nil))
642       (elmo-progress-notify 'elmo-folder-move-messages (length numbers))
643       numbers)
644      ((elmo-folder-message-make-temp-file-p src-folder)
645       ;; not-same-number (localdir, localnews), (archive maildir) -> archive
646       (let ((temp-dir (elmo-folder-message-make-temp-files
647                        src-folder
648                        numbers
649                        (unless same-number
650                          (1+ (if (file-exists-p (elmo-archive-get-archive-name
651                                                  folder))
652                                  (car (elmo-folder-status folder)) 0)))))
653             new-dir base-dir files)
654         (unwind-protect
655             (progn
656               (setq base-dir temp-dir)
657               (when (> (length prefix) 0)
658                 (when (file-name-directory prefix)
659                   (elmo-make-directory (file-name-directory prefix)))
660                 (rename-file
661                  temp-dir
662                  (setq new-dir
663                        (expand-file-name
664                         prefix
665                         ;; parent of temp-dir..(works in windows?)
666                         (expand-file-name ".." temp-dir))))
667                 ;; now temp-dir has name prefix.
668                 (setq temp-dir new-dir)
669                 ;; parent of prefix becomes base-dir.
670                 (setq base-dir (expand-file-name ".." temp-dir)))
671               (setq files
672                     (mapcar
673                      '(lambda (x) (elmo-concat-path prefix x))
674                      (directory-files temp-dir nil "^[^\\.]")))
675               (unless (elmo-archive-append-files folder
676                                                  base-dir
677                                                  files)
678                 (setq numbers nil)))
679           (elmo-delete-directory temp-dir)))
680       (elmo-progress-notify 'elmo-folder-move-messages (length numbers))
681       numbers)
682      (t
683       (elmo-folder-append-messages folder src-folder numbers same-number
684                                    'elmo-folder-append-messages-*-archive)))))
685
686 (luna-define-method elmo-folder-message-make-temp-file-p
687   ((folder elmo-archive-folder))
688   (let ((type (elmo-archive-folder-archive-type-internal folder)))
689     (or (elmo-archive-get-method type 'ext-pipe)
690         (elmo-archive-get-method type 'ext))))
691
692 (luna-define-method elmo-folder-message-make-temp-files
693   ((folder elmo-archive-folder) numbers
694    &optional start-number)
695   (elmo-archive-folder-message-make-temp-files folder numbers start-number))
696
697 (defun elmo-archive-folder-message-make-temp-files (folder
698                                                     numbers
699                                                     start-number)
700   (let* ((tmp-dir-src (elmo-folder-make-temporary-directory folder))
701          (tmp-dir-dst (elmo-folder-make-temporary-directory folder))
702          (arc     (elmo-archive-get-archive-name folder))
703          (type    (elmo-archive-folder-archive-type-internal folder))
704          (prefix  (elmo-archive-folder-archive-prefix-internal folder))
705          (p-method (elmo-archive-get-method type 'ext-pipe))
706          (n-method (elmo-archive-get-method type 'ext))
707          (tmp-msgs (mapcar (lambda (x) (elmo-concat-path
708                                         prefix
709                                         (int-to-string x))) numbers))
710          number)
711     ;; Expand files in the tmp-dir-src.
712     (elmo-bind-directory
713      tmp-dir-src
714      (cond
715       ((functionp n-method)
716        (funcall n-method (cons arc tmp-msgs)))
717       (p-method
718        (let ((p-prog (car p-method))
719              (p-prog-arg (cdr p-method)))
720          (elmo-archive-exec-msgs-subr1
721           p-prog (append p-prog-arg (list arc)) tmp-msgs)))
722       (t
723        (let ((n-prog (car n-method))
724              (n-prog-arg (cdr n-method)))
725          (elmo-archive-exec-msgs-subr2
726           n-prog (append n-prog-arg (list arc)) tmp-msgs
727           (length arc))))))
728     ;; Move files to the tmp-dir-dst.
729     (setq number start-number)
730     (dolist (tmp-file tmp-msgs)
731       (rename-file (expand-file-name
732                     tmp-file
733                     tmp-dir-src)
734                    (expand-file-name
735                     (if start-number
736                         (int-to-string number)
737                       (file-name-nondirectory tmp-file))
738                     tmp-dir-dst))
739       (if start-number (incf number)))
740     ;; Remove tmp-dir-src.
741     (elmo-delete-directory tmp-dir-src)
742     ;; tmp-dir-dst is the return directory.
743     tmp-dir-dst))
744
745 (defun elmo-archive-append-files (folder dir &optional files)
746   (let* ((dst-type (elmo-archive-folder-archive-type-internal folder))
747          (arc (elmo-archive-get-archive-name folder))
748          (prefix (elmo-archive-folder-archive-prefix-internal folder))
749          (p-method (elmo-archive-get-method dst-type 'cp-pipe))
750          (n-method (elmo-archive-get-method dst-type 'cp))
751          src tmp newfile)
752     (unless (elmo-folder-exists-p folder) (elmo-folder-create folder))
753     (unless files (setq files (directory-files dir nil "^[^\\.]")))
754     (when (null (or p-method n-method))
755       (ding)
756       (error "WARNING: read-only mode: %s (method undefined)" dst-type))
757     (save-excursion
758       (elmo-bind-directory
759        dir
760        (cond
761         ((functionp n-method)
762          (funcall n-method (cons arc files)))
763         (p-method
764          (let ((p-prog (car p-method))
765                (p-prog-arg (cdr p-method)))
766            (elmo-archive-exec-msgs-subr1
767             p-prog (append p-prog-arg (list arc)) files)))
768         (t
769          (let ((n-prog (car n-method))
770                (n-prog-arg (cdr n-method)))
771            (elmo-archive-exec-msgs-subr2
772             n-prog (append n-prog-arg (list arc)) files (length arc)))))))))
773
774 (luna-define-method elmo-folder-delete-messages-internal ((folder
775                                                            elmo-archive-folder)
776                                                           numbers)
777   (let* ((type (elmo-archive-folder-archive-type-internal folder))
778          (prefix (elmo-archive-folder-archive-prefix-internal folder))
779          (arc (elmo-archive-get-archive-name folder))
780          (p-method (elmo-archive-get-method type 'rm-pipe))
781          (n-method (elmo-archive-get-method type 'rm))
782          (numbers (mapcar '(lambda (x) (elmo-concat-path
783                                         prefix
784                                         (int-to-string x)))
785                           numbers)))
786     (cond ((functionp n-method)
787            (funcall n-method (cons arc numbers)))
788           (p-method
789            (let ((p-prog (car p-method))
790                  (p-prog-arg (cdr p-method)))
791              (elmo-archive-exec-msgs-subr1
792               p-prog (append p-prog-arg (list arc)) numbers)))
793           (n-method
794            (let ((n-prog (car n-method))
795                  (n-prog-arg (cdr n-method)))
796              (elmo-archive-exec-msgs-subr2
797               n-prog (append n-prog-arg (list arc)) numbers (length arc))))
798           (t
799            (ding)
800            (error "WARNING: not delete: %s (method undefined)" type)))))
801
802 (defun elmo-archive-exec-msgs-subr1 (prog args msgs)
803   (with-temp-buffer
804     (insert (mapconcat 'concat msgs "\n")) ;string
805     (= 0 (apply 'call-process-region (point-min) (point-max)
806                 prog nil nil nil args))))
807
808 (defun elmo-archive-exec-msgs-subr2 (prog args msgs arc-length)
809   (let ((max-len (- elmo-archive-cmdstr-max-length arc-length))
810         (n (length msgs))
811         rest i sum)
812     (setq rest msgs) ;string
813     (setq i 1)
814     (setq sum 0)
815     (catch 'done
816       (while (and rest (<= i n))
817         (mapcar '(lambda (x)
818                    (let* ((len (length x))
819                           (files (member x (reverse rest))))
820                      ;; total(previous) + current + white space
821                      (if (<= max-len (+ sum len 1))
822                          (progn
823                            (unless
824                                (elmo-archive-call-process
825                                 prog (append args files))
826                              (throw 'done nil))
827                            (setq sum 0) ;; reset
828                            (setq rest (nthcdr i rest)))
829                        (setq sum (+ sum len 1)))
830                      (setq i (1+ i)))) msgs))
831       (throw 'done
832              (or (not rest)
833                  (elmo-archive-call-process prog (append args rest))))
834       )))
835
836 (defsubst elmo-archive-article-exists-p (arc msg type)
837   (if (not elmo-archive-check-existance-strict)
838       t ; nop
839     (save-excursion ; added 980915
840       (let* ((method (elmo-archive-get-method type 'ls))
841              (args (list arc msg))
842              (buf (get-buffer-create " *ELMO ARCHIVE query*"))
843              (error-msg "\\(no file\\|0 files\\)")
844              ret-val)
845         (set-buffer buf)
846         (erase-buffer)
847         (elmo-archive-call-method method args t)
848         ;; pointer: point-max
849         (setq ret-val (not (re-search-backward error-msg nil t)))
850         (kill-buffer buf)
851         ret-val))))
852
853 (defun elmo-archive-tgz-common-func (args exec-type &optional copy)
854   (let* ((arc (car args))
855          (tmp-msgs (cdr args))
856          (decompress (elmo-archive-get-method 'tgz 'decompress))
857          (compress (elmo-archive-get-method 'tgz 'compress))
858          (exec (elmo-archive-get-method 'tgz exec-type))
859          (suffix (elmo-archive-get-suffix 'tgz))
860          (tar-suffix (elmo-archive-get-suffix 'tar))
861          arc-tar ret-val
862          )
863     (when (null (and decompress compress exec))
864       (ding)
865       (error "WARNING: special method undefined: %s of %s"
866              (or (if (null decompress) 'decompress)
867                  (if (null compress) 'compress)
868                  (if (null exec) exec-type))
869              'tgz))
870     (unless tar-suffix
871       (ding)
872       (error "WARNING: `tar' suffix undefined"))
873     (if (string-match (concat (regexp-quote suffix) "$") arc)
874         (setq arc-tar
875               (concat (substring arc 0 (match-beginning 0)) tar-suffix))
876       (error "%s: not match suffix [%s]" arc suffix))
877     (and
878      ;; decompress
879      (elmo-archive-call-process
880       (car decompress) (append (cdr decompress) (list arc)))
881      ;; append (or delete)
882      (elmo-archive-exec-msgs-subr2
883       (car exec) (append (cdr exec) (list arc-tar)) tmp-msgs (length arc-tar))
884      ;; compress
885      (setq ret-val
886            (elmo-archive-call-process
887             (car compress) (append (cdr compress) (list arc-tar)))))
888     ;; delete temporary messages
889     (if (and (not copy)
890              (eq exec-type 'append))
891         (while tmp-msgs
892           (if (file-exists-p (car tmp-msgs))
893               (delete-file (car tmp-msgs)))
894           (setq tmp-msgs (cdr tmp-msgs))))
895     ret-val))
896
897 (defun elmo-archive-tgz-cp-func (args &optional output)
898   (elmo-archive-tgz-common-func args 'append t))
899
900 (defun elmo-archive-tgz-mv-func (args &optional output)
901   (elmo-archive-tgz-common-func args 'append))
902
903 (defun elmo-archive-tgz-rm-func (args &optional output)
904   (elmo-archive-tgz-common-func args 'delete))
905
906 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
907 ;;; MessageDB functions (from elmo-localdir.el)
908
909 (defsubst elmo-archive-msgdb-create-entity-subr (msgdb number)
910   (let (header-end)
911     (set-buffer-multibyte default-enable-multibyte-characters)
912     (goto-char (point-min))
913     (if (re-search-forward "\\(^--.*$\\)\\|\\(\n\n\\)" nil t)
914         (setq header-end (point))
915       (setq header-end (point-max)))
916     (narrow-to-region (point-min) header-end)
917     (elmo-msgdb-create-message-entity-from-buffer
918      (elmo-msgdb-message-entity-handler msgdb) number)))
919
920 ;; verrrry slow!!
921 (defsubst elmo-archive-msgdb-create-entity (msgdb
922                                             method
923                                             archive number type
924                                             &optional prefix)
925   (let* ((msg (elmo-concat-path prefix (int-to-string number)))
926          (arg-list (list archive msg)))
927     (when (elmo-archive-article-exists-p archive msg type)
928       ;; insert article.
929       (as-binary-process
930        (elmo-archive-call-method method arg-list t))
931       (elmo-archive-msgdb-create-entity-subr msgdb number))))
932
933 (luna-define-method elmo-folder-msgdb-create ((folder elmo-archive-folder)
934                                               numbers flag-table)
935   (when numbers
936     (save-excursion ;; 981005
937       (elmo-with-progress-display (elmo-folder-create-msgdb (length numbers))
938           "Creating msgdb"
939         (if (and elmo-archive-use-izip-agent
940                  (elmo-archive-get-method
941                   (elmo-archive-folder-archive-type-internal folder)
942                   'cat-headers))
943             (elmo-archive-msgdb-create-as-numlist-subr2
944              folder numbers flag-table)
945           (elmo-archive-msgdb-create-as-numlist-subr1
946            folder numbers flag-table))))))
947
948 (defun elmo-archive-msgdb-create-as-numlist-subr1 (folder numlist flag-table)
949   (let* ((type (elmo-archive-folder-archive-type-internal folder))
950          (file (elmo-archive-get-archive-name folder))
951          (method (elmo-archive-get-method type 'cat))
952          (new-msgdb (elmo-make-msgdb))
953          entity message-id flags)
954     (with-temp-buffer
955       (while numlist
956         (erase-buffer)
957         (setq entity
958               (elmo-archive-msgdb-create-entity
959                new-msgdb
960                method file (car numlist) type
961                (elmo-archive-folder-archive-prefix-internal folder)))
962         (when entity
963           (setq message-id (elmo-message-entity-field entity 'message-id)
964                 flags (elmo-flag-table-get flag-table message-id))
965           (elmo-global-flags-set flags folder (car numlist) message-id)
966           (elmo-msgdb-append-entity new-msgdb entity flags))
967         (elmo-progress-notify 'elmo-folder-msgdb-create)
968         (setq numlist (cdr numlist)))
969       new-msgdb)))
970
971 ;;; info-zip agent
972 (defun elmo-archive-msgdb-create-as-numlist-subr2 (folder
973                                                    numlist
974                                                    flag-table)
975   (let* ((delim1 elmo-mmdf-delimiter)           ;; MMDF
976          (delim2 elmo-unixmail-delimiter)       ;; UNIX Mail
977          (type (elmo-archive-folder-archive-type-internal folder))
978          (prefix (elmo-archive-folder-archive-prefix-internal folder))
979          (method (elmo-archive-get-method type 'cat-headers))
980          (prog (car method))
981          (args (cdr method))
982          (arc (elmo-archive-get-archive-name folder))
983          (new-msgdb (elmo-make-msgdb))
984          n msgs case-fold-search)
985     (with-temp-buffer
986       (while numlist
987         (setq n (min (1- elmo-archive-fetch-headers-volume)
988                      (1- (length numlist))))
989         (setq msgs (reverse (memq (nth n numlist) (reverse numlist))))
990         (setq numlist (nthcdr (1+ n) numlist))
991         (erase-buffer)
992         (insert
993          (mapconcat
994           'concat
995           (mapcar '(lambda (x) (elmo-concat-path prefix (int-to-string x))) msgs)
996           "\n"))
997         (as-binary-process (apply 'call-process-region
998                                   (point-min) (point-max)
999                                   prog t t nil (append args (list arc))))
1000         (goto-char (point-min))
1001         (cond
1002          ((looking-at delim1)   ;; MMDF
1003           (elmo-msgdb-append
1004            new-msgdb
1005            (elmo-archive-parse-mmdf folder msgs flag-table)))
1006 ;;;      ((looking-at delim2)   ;; UNIX MAIL
1007 ;;;       (elmo-msgdb-append
1008 ;;;        new-msgdb
1009 ;;;        (elmo-archive-parse-unixmail msgs flag-table)))
1010          (t                     ;; unknown format
1011           (error "Unknown format!")))
1012         (elmo-progress-notify 'elmo-folder-msgdb-create)))
1013     new-msgdb))
1014
1015 (defun elmo-archive-parse-mmdf (folder msgs flag-table)
1016   (let ((delim elmo-mmdf-delimiter)
1017         (new-msgdb (elmo-make-msgdb))
1018         number sp ep rest entity
1019         message-id flags)
1020     (goto-char (point-min))
1021     (setq rest msgs)
1022     (while (and rest (re-search-forward delim nil t)
1023                 (not (eobp)))
1024       (setq number (car rest))
1025       (setq sp (1+ (point)))
1026       (setq ep (prog2 (re-search-forward delim)
1027                    (1+ (- (point) (length delim)))))
1028       (if (>= sp ep)                    ; no article!
1029           ()                            ; nop
1030         (save-excursion
1031           (narrow-to-region sp ep)
1032           (setq entity (elmo-archive-msgdb-create-entity-subr new-msgdb number)
1033                 message-id (elmo-message-entity-field entity 'message-id)
1034                 flags (elmo-flag-table-get flag-table message-id))
1035           (elmo-global-flags-set flags folder number message-id)
1036           (elmo-msgdb-append-entity new-msgdb entity flags)
1037           (widen)))
1038       (forward-line 1)
1039       (setq rest (cdr rest)))
1040     new-msgdb))
1041
1042
1043 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1044 ;;; Search functions
1045
1046 (defsubst elmo-archive-field-condition-match (folder number number-list
1047                                                      condition prefix)
1048   (save-excursion
1049     (let* ((type (elmo-archive-folder-archive-type-internal folder))
1050            (arc (elmo-archive-get-archive-name folder))
1051            (method (elmo-archive-get-method type 'cat))
1052            (args (list arc (elmo-concat-path prefix (int-to-string number)))))
1053       (elmo-set-work-buf
1054        (when (file-exists-p arc)
1055          (as-binary-process
1056           (elmo-archive-call-method method args t))
1057          (set-buffer-multibyte default-enable-multibyte-characters)
1058          (decode-mime-charset-region (point-min)(point-max) elmo-mime-charset)
1059          (elmo-message-buffer-match-condition condition number))))))
1060
1061 (luna-define-method elmo-folder-search ((folder elmo-archive-folder)
1062                                         condition &optional from-msgs)
1063   (let* (;;(args (elmo-string-to-list key))
1064          ;; XXX: I don't know whether `elmo-archive-list-folder'
1065          ;;      updates match-data.
1066          ;; (msgs (or from-msgs (elmo-archive-list-folder spec)))
1067          (msgs (or from-msgs (elmo-folder-list-messages folder)))
1068          (case-fold-search nil)
1069          ret-val)
1070     (elmo-with-progress-display (elmo-folder-search (length msgs)) "Searching"
1071       (dolist (number msgs)
1072         (when (elmo-archive-field-condition-match
1073                folder number msgs
1074                condition
1075                (elmo-archive-folder-archive-prefix-internal folder))
1076           (setq ret-val (cons number ret-val)))
1077         (elmo-progress-notify 'elmo-folder-search)))
1078     (nreverse ret-val)))
1079
1080 ;;; method(alist)
1081 (if (null elmo-archive-method-alist)
1082     (let ((mlist elmo-archive-method-list) ; from mew-highlight.el
1083           method type str)
1084       (while mlist
1085         (setq method (car mlist))
1086         (setq mlist (cdr mlist))
1087         (setq str (symbol-name method))
1088         (string-match "elmo-archive-\\([^-].*\\)-method-alist$" str)
1089         (setq type (intern-soft
1090                     (elmo-match-string 1 str)))
1091         (setq elmo-archive-method-alist
1092               (cons (cons type
1093                           (symbol-value method))
1094                     elmo-archive-method-alist)))))
1095
1096 ;;; valid suffix(list)
1097 (if (null elmo-archive-suffixes)
1098     (let ((slist elmo-archive-suffix-alist)
1099           tmp)
1100       (while slist
1101         (setq tmp (car slist))
1102         (setq elmo-archive-suffixes
1103               (nconc elmo-archive-suffixes (list (cdr tmp))))
1104         (setq slist (cdr slist)))))
1105
1106 (luna-define-method elmo-message-use-cache-p ((folder elmo-archive-folder)
1107                                               number)
1108   elmo-archive-use-cache)
1109
1110 ;;; End
1111 (run-hooks 'elmo-archive-load-hook)
1112
1113 (require 'product)
1114 (product-provide (provide 'elmo-archive) (require 'elmo-version))
1115
1116 ;;; elmo-archive.el ends here