1 ;;; nnmbox.el --- mail mbox access for Gnus
3 ;; Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002
4 ;; Free Software Foundation, Inc.
6 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
7 ;; Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
8 ;; Keywords: news, mail
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 2, or (at your option)
17 ;; You should have received a copy of the GNU General Public License
18 ;; along with GNU Emacs; see the file COPYING. If not, write to the
19 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 ;; Boston, MA 02111-1307, USA.
24 ;; For an overview of what the interface functions do, please see the
29 (eval-when-compile (require 'cl))
30 (eval-when-compile (require 'static))
40 (defvoo nnmbox-mbox-file (expand-file-name "~/mbox")
41 "The name of the mail box file in the user's home directory.")
43 (defvoo nnmbox-active-file (expand-file-name "~/.mbox-active")
44 "The name of the active file for the mail box.")
46 (defvoo nnmbox-get-new-mail t
47 "If non-nil, nnmbox will check the incoming mail file and split the mail.")
49 (defvoo nnmbox-prepare-save-mail-hook nil
50 "Hook run narrowed to an article before saving.")
54 (defconst nnmbox-version "nnmbox 1.0"
57 (defvoo nnmbox-current-group nil
58 "Current nnmbox news group directory.")
60 (defconst nnmbox-mbox-buffer nil)
62 (defvoo nnmbox-status-string "")
64 (defvoo nnmbox-group-alist nil)
65 (defvoo nnmbox-active-timestamp nil)
67 (defvoo nnmbox-file-coding-system 'binary)
68 (defvoo nnmbox-file-coding-system-for-write nil)
69 (defvoo nnmbox-active-file-coding-system 'binary)
70 (defvoo nnmbox-active-file-coding-system-for-write nil)
72 (defvar nnmbox-group-building-active-articles nil)
73 (defvar nnmbox-group-active-articles nil)
76 ;;; Interface functions
78 (nnoo-define-basics nnmbox)
80 (deffoo nnmbox-retrieve-headers (sequence &optional newsgroup server fetch-old)
82 (set-buffer nntp-server-buffer)
84 (let ((number (length sequence))
87 (nnmbox-possibly-change-newsgroup newsgroup server)
89 (setq article (car sequence))
90 (set-buffer nnmbox-mbox-buffer)
91 (when (nnmbox-find-article article)
95 (concat "^" message-unix-mail-delimiter) nil t)
97 (search-forward "\n\n" nil t)
98 (setq stop (1- (point)))
99 (set-buffer nntp-server-buffer)
100 (insert (format "221 %d Article retrieved.\n" article))
101 (insert-buffer-substring nnmbox-mbox-buffer start stop)
102 (goto-char (point-max))
104 (setq sequence (cdr sequence))
105 (setq count (1+ count))
106 (and (numberp nnmail-large-newsgroup)
107 (> number nnmail-large-newsgroup)
109 (nnheader-message 5 "nnmbox: Receiving headers... %d%%"
110 (/ (* count 100) number))))
112 (and (numberp nnmail-large-newsgroup)
113 (> number nnmail-large-newsgroup)
114 (nnheader-message 5 "nnmbox: Receiving headers...done"))
116 (set-buffer nntp-server-buffer)
117 (nnheader-fold-continuation-lines)
120 (deffoo nnmbox-open-server (server &optional defs)
121 (nnoo-change-server 'nnmbox server defs)
124 ((not (file-exists-p nnmbox-mbox-file))
125 (nnmbox-close-server)
126 (nnheader-report 'nnmbox "No such file: %s" nnmbox-mbox-file))
127 ((file-directory-p nnmbox-mbox-file)
128 (nnmbox-close-server)
129 (nnheader-report 'nnmbox "Not a regular file: %s" nnmbox-mbox-file))
131 (nnheader-report 'nnmbox "Opened server %s using mbox %s" server
135 (deffoo nnmbox-close-server (&optional server)
136 (when (and nnmbox-mbox-buffer
137 (buffer-name nnmbox-mbox-buffer))
138 (kill-buffer nnmbox-mbox-buffer))
139 (nnoo-close-server 'nnmbox server)
142 (deffoo nnmbox-server-opened (&optional server)
143 (and (nnoo-current-server-p 'nnmbox server)
145 (buffer-name nnmbox-mbox-buffer)
147 (buffer-name nntp-server-buffer)))
149 (deffoo nnmbox-request-article (article &optional newsgroup server buffer)
150 (nnmbox-possibly-change-newsgroup newsgroup server)
152 (set-buffer nnmbox-mbox-buffer)
153 (when (nnmbox-find-article article)
155 (re-search-backward (concat "^" message-unix-mail-delimiter) nil t)
158 (or (and (re-search-forward
159 (concat "^" message-unix-mail-delimiter) nil t)
161 (goto-char (point-max)))
163 (let ((nntp-server-buffer (or buffer nntp-server-buffer)))
164 (set-buffer nntp-server-buffer)
166 (insert-buffer-substring nnmbox-mbox-buffer start stop)
167 (goto-char (point-min))
168 (while (looking-at "From ")
170 (insert "X-From-Line: ")
172 (if (numberp article)
173 (cons nnmbox-current-group article)
174 (nnmbox-article-group-number nil)))))))
176 (deffoo nnmbox-request-group (group &optional server dont-check)
177 (nnmbox-possibly-change-newsgroup nil server)
178 (let ((active (cadr (assoc group nnmbox-group-alist))))
181 (null (nnmbox-possibly-change-newsgroup group server)))
182 (nnheader-report 'nnmbox "No such group: %s" group))
184 (nnheader-report 'nnmbox "Selected group %s" group)
185 (nnheader-insert ""))
187 (nnheader-report 'nnmbox "Selected group %s" group)
188 (nnheader-insert "211 %d %d %d %s\n"
189 (1+ (- (cdr active) (car active)))
190 (car active) (cdr active) group)))))
192 (static-if (boundp 'MULE)
193 (defun nnmbox-save-buffer ()
194 (let ((output-coding-system
195 (or nnmbox-file-coding-system-for-write
196 nnmbox-file-coding-system)))
198 (defun nnmbox-save-buffer ()
199 (let ((coding-system-for-write
200 (or nnmbox-file-coding-system-for-write
201 nnmbox-file-coding-system)))
205 (defun nnmbox-save-active (group-alist active-file)
206 (let ((nnmail-active-file-coding-system
207 (or nnmbox-active-file-coding-system-for-write
208 nnmbox-active-file-coding-system)))
209 (nnmail-save-active group-alist active-file)))
211 (deffoo nnmbox-request-scan (&optional group server)
212 (nnmbox-possibly-change-newsgroup group server)
218 (set-buffer nnmbox-mbox-buffer)
219 (nnmbox-save-buffer)))
220 (file-name-directory nnmbox-mbox-file)
224 (let ((in-buf (current-buffer)))
225 (set-buffer nnmbox-mbox-buffer)
226 (goto-char (point-max))
227 (insert-buffer-substring in-buf)))
228 (nnmbox-save-active nnmbox-group-alist nnmbox-active-file))))
230 (deffoo nnmbox-close-group (group &optional server)
233 (deffoo nnmbox-request-create-group (group &optional server args)
234 (nnmail-activate 'nnmbox)
235 (unless (assoc group nnmbox-group-alist)
236 (push (list group (cons 1 0))
238 (nnmbox-save-active nnmbox-group-alist nnmbox-active-file))
241 (deffoo nnmbox-request-list (&optional server)
243 (let ((nnmail-file-coding-system
244 nnmbox-active-file-coding-system))
245 (nnmail-find-file nnmbox-active-file))
246 (setq nnmbox-group-alist (nnmail-get-active))
249 (deffoo nnmbox-request-newgroups (date &optional server)
250 (nnmbox-request-list server))
252 (deffoo nnmbox-request-list-newsgroups (&optional server)
253 (nnheader-report 'nnmbox "LIST NEWSGROUPS is not implemented."))
255 (deffoo nnmbox-request-expire-articles
256 (articles newsgroup &optional server force)
257 (nnmbox-possibly-change-newsgroup newsgroup server)
260 (nnmail-activate 'nnmbox)
263 (set-buffer nnmbox-mbox-buffer)
264 (while (and articles is-old)
265 (when (nnmbox-find-article (car articles))
267 (nnmail-expired-article-p
270 (point) (progn (end-of-line) (point))) force))
272 (unless (eq nnmail-expiry-target 'delete)
274 (nnmbox-request-article (car articles)
277 (let ((nnml-current-directory nil))
278 (nnmail-expiry-target-group
279 nnmail-expiry-target newsgroup)))
280 (nnmbox-possibly-change-newsgroup newsgroup server))
281 (nnheader-message 5 "Deleting article %d in %s..."
282 (car articles) newsgroup)
283 (nnmbox-delete-mail))
284 (push (car articles) rest)))
285 (setq articles (cdr articles)))
287 ;; Find the lowest active article in this group.
288 (let ((active (nth 1 (assoc newsgroup nnmbox-group-alist))))
289 (while (and (not (nnmbox-find-article (car active)))
290 (<= (car active) (cdr active)))
291 (setcar active (1+ (car active)))))
292 (nnmbox-save-active nnmbox-group-alist nnmbox-active-file)
293 (nconc rest articles))))
295 (deffoo nnmbox-request-move-article
296 (article group server accept-form &optional last)
297 (let ((buf (get-buffer-create " *nnmbox move*"))
300 (nnmbox-request-article article group server)
304 (insert-buffer-substring nntp-server-buffer)
305 (goto-char (point-min))
306 (while (re-search-forward
308 (save-excursion (search-forward "\n\n" nil t) (point)) t)
309 (delete-region (progn (beginning-of-line) (point))
310 (progn (forward-line 1) (point))))
311 (setq result (eval accept-form))
315 (nnmbox-possibly-change-newsgroup group server)
316 (set-buffer nnmbox-mbox-buffer)
317 (when (nnmbox-find-article article)
318 (nnmbox-delete-mail))
319 (and last (nnmbox-save-buffer))))
322 (deffoo nnmbox-request-accept-article (group &optional server last)
323 (nnmbox-possibly-change-newsgroup group server)
324 (nnmail-check-syntax)
325 (let ((buf (current-buffer))
327 (goto-char (point-min))
328 ;; The From line may have been quoted by movemail.
329 (when (looking-at (concat ">" message-unix-mail-delimiter))
331 (if (looking-at "X-From-Line: ")
332 (replace-match "From ")
333 (insert "From nobody " (current-time-string) "\n"))
335 (nnmail-activate 'nnmbox)
338 (goto-char (point-min))
339 (search-forward "\n\n" nil t)
341 (while (re-search-backward "^X-Gnus-Newsgroup: " nil t)
342 (delete-region (point) (progn (forward-line 1) (point))))
343 (when nnmail-cache-accepted-message-ids
344 (nnmail-cache-insert (nnmail-fetch-field "message-id") group))
345 (setq result (if (stringp group)
346 (list (cons group (nnmbox-active-number group)))
347 (nnmail-article-group 'nnmbox-active-number)))
348 (if (and (null result)
349 (yes-or-no-p "Moved to `junk' group; delete article? "))
351 (setq result (car (nnmbox-save-mail result)))))
353 (set-buffer nnmbox-mbox-buffer)
354 (goto-char (point-max))
355 (insert-buffer-substring buf)
357 (when nnmail-cache-accepted-message-ids
358 (nnmail-cache-close))
359 (nnmbox-save-active nnmbox-group-alist nnmbox-active-file)
360 (nnmbox-save-buffer))))
363 (deffoo nnmbox-request-replace-article (article group buffer)
364 (nnmbox-possibly-change-newsgroup group)
366 (set-buffer nnmbox-mbox-buffer)
367 (if (not (nnmbox-find-article article))
369 (nnmbox-delete-mail t t)
370 (insert-buffer-substring buffer)
374 (deffoo nnmbox-request-delete-group (group &optional force server)
375 (nnmbox-possibly-change-newsgroup group server)
376 ;; Delete all articles in GROUP.
378 () ; Don't delete the articles.
380 (set-buffer nnmbox-mbox-buffer)
381 (goto-char (point-min))
382 ;; Delete all articles in this group.
383 (let ((ident (concat "\nX-Gnus-Newsgroup: " nnmbox-current-group ":"))
385 (while (search-forward ident nil t)
387 (nnmbox-delete-mail))
389 (nnmbox-save-buffer)))))
390 ;; Remove the group from all structures.
391 (setq nnmbox-group-alist
392 (delq (assoc group nnmbox-group-alist) nnmbox-group-alist)
393 nnmbox-current-group nil)
394 ;; Save the active file.
395 (nnmbox-save-active nnmbox-group-alist nnmbox-active-file)
398 (deffoo nnmbox-request-rename-group (group new-name &optional server)
399 (nnmbox-possibly-change-newsgroup group server)
401 (set-buffer nnmbox-mbox-buffer)
402 (goto-char (point-min))
403 (let ((ident (concat "\nX-Gnus-Newsgroup: " nnmbox-current-group ":"))
404 (new-ident (concat "\nX-Gnus-Newsgroup: " new-name ":"))
406 (while (search-forward ident nil t)
407 (replace-match new-ident t t)
410 (nnmbox-save-buffer))))
411 (let ((entry (assoc group nnmbox-group-active-articles)))
413 (setcar entry new-name)))
414 (let ((entry (assoc group nnmbox-group-alist)))
416 (setcar entry new-name))
417 (setq nnmbox-current-group nil)
418 ;; Save the new group alist.
419 (nnmbox-save-active nnmbox-group-alist nnmbox-active-file)
423 ;;; Internal functions.
425 ;; If FORCE, delete article no matter how many X-Gnus-Newsgroup
426 ;; headers there are. If LEAVE-DELIM, don't delete the Unix mbox
428 (defun nnmbox-delete-mail (&optional force leave-delim)
429 ;; Delete the current X-Gnus-Newsgroup line.
430 ;; First delete record of active article, unless the article is being
431 ;; replaced, indicated by FORCE being non-nil.
433 (nnmbox-record-deleted-article (nnmbox-article-group-number t)))
436 (progn (beginning-of-line) (point))
437 (progn (forward-line 1) (point))))
438 ;; Beginning of the article.
443 (re-search-backward (concat "^" message-unix-mail-delimiter) nil t)
444 (if leave-delim (progn (forward-line 1) (point))
445 (match-beginning 0)))
448 (or (and (re-search-forward (concat "^" message-unix-mail-delimiter)
450 (if (and (not (bobp)) leave-delim)
451 (progn (forward-line -2) (point))
452 (match-beginning 0)))
454 (goto-char (point-min))
455 ;; Only delete the article if no other group owns it as well.
456 (when (or force (not (re-search-forward "^X-Gnus-Newsgroup: " nil t)))
457 (delete-region (point-min) (point-max))))))
459 (defun nnmbox-possibly-change-newsgroup (newsgroup &optional server)
461 (not (nnmbox-server-opened server)))
462 (nnmbox-open-server server))
463 (when (or (not nnmbox-mbox-buffer)
464 (not (buffer-name nnmbox-mbox-buffer)))
466 (when (not nnmbox-group-alist)
467 (nnmail-activate 'nnmbox))
469 (when (assoc newsgroup nnmbox-group-alist)
470 (setq nnmbox-current-group newsgroup))
473 (defun nnmbox-article-string (article)
474 (if (numberp article)
475 (concat "\nX-Gnus-Newsgroup: " nnmbox-current-group ":"
476 (int-to-string article) " ")
477 (concat "\nMessage-ID: " article)))
479 (defun nnmbox-article-group-number (this-line)
483 (goto-char (point-min)))
484 (when (re-search-forward "^X-Gnus-Newsgroup: +\\([^:]+\\):\\([0-9]+\\) "
486 (cons (buffer-substring (match-beginning 1) (match-end 1))
488 (buffer-substring (match-beginning 2) (match-end 2)))))))
490 (defun nnmbox-in-header-p (pos)
491 "Return non-nil if POS is in the header of an article."
494 (re-search-backward (concat "^" message-unix-mail-delimiter) nil t)
495 (search-forward "\n\n" nil t)
498 (defun nnmbox-find-article (article)
499 "Leaves point on the relevant X-Gnus-Newsgroup line if found."
500 ;; Check that article is in the active range first, to avoid an
501 ;; expensive exhaustive search if it isn't.
502 (if (and (numberp article)
503 (not (nnmbox-is-article-active-p article)))
505 (let ((art-string (nnmbox-article-string article))
507 ;; There is the possibility that the X-Gnus-Newsgroup line appears
508 ;; in the body of an article (for instance, if an article has been
509 ;; forwarded from someone using Gnus as their mailer), so check
510 ;; that the line is actually part of the article header.
511 (or (and (search-forward art-string nil t)
512 (nnmbox-in-header-p (point)))
514 (goto-char (point-min))
515 (while (and (not found)
516 (search-forward art-string nil t))
517 (setq found (nnmbox-in-header-p (point))))
520 (defun nnmbox-record-active-article (group-art)
521 (let* ((group (car group-art))
522 (article (cdr group-art))
524 (or (assoc group nnmbox-group-active-articles)
527 nnmbox-group-active-articles)
528 (car nnmbox-group-active-articles)))))
529 ;; add article to index, either by building complete list
530 ;; in reverse order, or as a list of ranges.
531 (if (not nnmbox-group-building-active-articles)
532 (setcdr entry (gnus-add-to-range (cdr entry) (list article)))
533 (when (memq article (cdr entry))
534 (switch-to-buffer nnmbox-mbox-buffer)
535 (error "Article %s:%d already exists!" group article))
536 (when (and (cadr entry) (< article (cadr entry)))
537 (switch-to-buffer nnmbox-mbox-buffer)
538 (error "Article %s:%d out of order" group article))
539 (setcdr entry (cons article (cdr entry))))))
541 (defun nnmbox-record-deleted-article (group-art)
542 (let* ((group (car group-art))
543 (article (cdr group-art))
545 (or (assoc group nnmbox-group-active-articles)
548 nnmbox-group-active-articles)
549 (car nnmbox-group-active-articles)))))
550 ;; remove article from index
551 (setcdr entry (gnus-remove-from-range (cdr entry) (list article)))))
553 (defun nnmbox-is-article-active-p (article)
554 (gnus-member-of-range
556 (cdr (assoc nnmbox-current-group
557 nnmbox-group-active-articles))))
559 (defun nnmbox-save-mail (group-art)
560 "Called narrowed to an article."
561 (let ((delim (concat "^" message-unix-mail-delimiter)))
562 (goto-char (point-min))
563 ;; This might come from somewhere else.
564 (unless (looking-at delim)
565 (insert "From nobody " (current-time-string) "\n")
566 (goto-char (point-min)))
567 ;; Quote all "From " lines in the article.
569 (while (re-search-forward delim nil t)
572 (nnmail-insert-lines)
573 (nnmail-insert-xref group-art)
574 (nnmbox-insert-newsgroup-line group-art)
575 (let ((alist group-art))
577 (nnmbox-record-active-article (car alist))
578 (setq alist (cdr alist))))
579 (run-hooks 'nnmail-prepare-save-mail-hook)
580 (run-hooks 'nnmbox-prepare-save-mail-hook)
583 (defun nnmbox-insert-newsgroup-line (group-art)
585 (goto-char (point-min))
586 (when (search-forward "\n\n" nil t)
589 (insert (format "X-Gnus-Newsgroup: %s:%d %s\n"
590 (caar group-art) (cdar group-art)
591 (current-time-string)))
592 (setq group-art (cdr group-art))))
595 (defun nnmbox-active-number (group)
596 ;; Find the next article number in GROUP.
597 (let ((active (cadr (assoc group nnmbox-group-alist))))
599 (setcdr active (1+ (cdr active)))
600 ;; This group is new, so we create a new entry for it.
601 ;; This might be a bit naughty... creating groups on the drop of
602 ;; a hat, but I don't know...
603 (push (list group (setq active (cons 1 1)))
607 (defun nnmbox-create-mbox ()
608 (when (not (file-exists-p nnmbox-mbox-file))
609 (let ((nnmail-file-coding-system
610 (or nnmbox-file-coding-system-for-write
611 nnmbox-file-coding-system))
612 (dir (file-name-directory nnmbox-mbox-file)))
613 (and dir (gnus-make-directory dir))
614 (nnmail-write-region (point-min) (point-min)
615 nnmbox-mbox-file t 'nomesg))))
617 (defun nnmbox-read-mbox ()
618 (nnmail-activate 'nnmbox)
620 (if (and nnmbox-mbox-buffer
621 (buffer-name nnmbox-mbox-buffer)
623 (set-buffer nnmbox-mbox-buffer)
624 (= (buffer-size) (nnheader-file-size nnmbox-mbox-file))))
627 (let ((delim (concat "^" message-unix-mail-delimiter))
628 (alist nnmbox-group-alist)
629 (nnmbox-group-building-active-articles t)
630 start end end-header number)
631 (set-buffer (setq nnmbox-mbox-buffer
632 (let ((nnheader-file-coding-system
633 nnmbox-file-coding-system))
634 (nnheader-find-file-noselect
635 nnmbox-mbox-file t t))))
636 (buffer-disable-undo)
638 ;; Go through the group alist and compare against the mbox file.
640 (goto-char (point-max))
641 (when (and (re-search-backward
642 (format "^X-Gnus-Newsgroup: %s:\\([0-9]+\\) "
647 (match-beginning 1) (match-end 1))))
649 (setcdr (cadar alist) number))
650 (setq alist (cdr alist)))
652 ;; Examine all articles for our private X-Gnus-Newsgroup
653 ;; headers. This is done primarily as a consistency check, but
654 ;; it is convenient for building an index of the articles
655 ;; present, to avoid costly searches for missing articles
656 ;; (eg. when expiring articles).
657 (goto-char (point-min))
658 (setq nnmbox-group-active-articles nil)
659 (while (re-search-forward delim nil t)
660 (setq start (match-beginning 0))
662 (search-forward "\n\n" nil t)
663 (setq end-header (point))
665 (re-search-forward delim nil t)
668 (if (search-forward "\nX-Gnus-Newsgroup: " end-header t)
669 ;; Build a list of articles in each group, remembering
670 ;; that each article may be in more than one group.
672 (nnmbox-record-active-article (nnmbox-article-group-number t))
673 (while (search-forward "\nX-Gnus-Newsgroup: " end-header t)
674 (nnmbox-record-active-article (nnmbox-article-group-number t))))
675 ;; The article is either new, or for some other reason
676 ;; hasn't got our private headers, so add them now. The
677 ;; only situation I've encountered when the X-Gnus-Newsgroup
678 ;; header is missing is if the article contains a forwarded
679 ;; message which does contain that header line (earlier
680 ;; versions of Gnus didn't restrict their search to the
681 ;; headers). In this case, there is an Xref line which
682 ;; provides the relevant information to construct the
683 ;; missing header(s).
686 (narrow-to-region start end)
687 (if (re-search-forward "\nXref: [^ ]+" end-header t)
688 ;; generate headers from Xref:
690 (while (re-search-forward " \\([^:]+\\):\\([0-9]+\\)" end-header t)
691 (push (cons (match-string 1)
692 (string-to-int (match-string 2))) alist))
693 (nnmbox-insert-newsgroup-line alist))
694 ;; this is really a new article
696 (nnmail-article-group 'nnmbox-active-number))))))
698 ;; put article lists in order
699 (setq alist nnmbox-group-active-articles)
701 (setcdr (car alist) (gnus-compress-sequence (nreverse (cdar alist))))
702 (setq alist (cdr alist)))))))
706 ;;; nnmbox.el ends here