1 ;;; nnmbox.el --- mail mbox access for Gnus
3 ;; Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003,
4 ;; 2004, 2005, 2006, 2007 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 3, 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., 51 Franklin Street, Fifth Floor,
20 ;; Boston, MA 02110-1301, USA.
24 ;; For an overview of what the interface functions do, please see the
34 (eval-when-compile (require 'cl
))
38 (defvoo nnmbox-mbox-file
(expand-file-name "~/mbox")
39 "The name of the mail box file in the user's home directory.")
41 (defvoo nnmbox-active-file
(expand-file-name "~/.mbox-active")
42 "The name of the active file for the mail box.")
44 (defvoo nnmbox-get-new-mail t
45 "If non-nil, nnmbox will check the incoming mail file and split the mail.")
47 (defvoo nnmbox-prepare-save-mail-hook nil
48 "Hook run narrowed to an article before saving.")
52 (defconst nnmbox-version
"nnmbox 1.0"
55 (defvoo nnmbox-current-group nil
56 "Current nnmbox news group directory.")
58 (defvar nnmbox-mbox-buffer nil
)
60 (defvoo nnmbox-status-string
"")
62 (defvoo nnmbox-group-alist nil
)
63 (defvoo nnmbox-active-timestamp nil
)
65 (defvoo nnmbox-file-coding-system mm-binary-coding-system
)
66 (defvoo nnmbox-file-coding-system-for-write nil
)
67 (defvoo nnmbox-active-file-coding-system mm-binary-coding-system
)
68 (defvoo nnmbox-active-file-coding-system-for-write nil
)
70 (defvar nnmbox-group-building-active-articles nil
)
71 (defvar nnmbox-group-active-articles nil
)
74 ;;; Interface functions
76 (nnoo-define-basics nnmbox
)
78 (deffoo nnmbox-retrieve-headers
(sequence &optional newsgroup server fetch-old
)
80 (set-buffer nntp-server-buffer
)
82 (let ((number (length sequence
))
85 (nnmbox-possibly-change-newsgroup newsgroup server
)
87 (setq article
(car sequence
))
88 (set-buffer nnmbox-mbox-buffer
)
89 (when (nnmbox-find-article article
)
93 (concat "^" message-unix-mail-delimiter
) nil t
)
95 (search-forward "\n\n" nil t
)
96 (setq stop
(1- (point)))
97 (set-buffer nntp-server-buffer
)
98 (insert (format "221 %d Article retrieved.\n" article
))
99 (insert-buffer-substring nnmbox-mbox-buffer start stop
)
100 (goto-char (point-max))
102 (setq sequence
(cdr sequence
))
103 (setq count
(1+ count
))
104 (and (numberp nnmail-large-newsgroup
)
105 (> number nnmail-large-newsgroup
)
107 (nnheader-message 5 "nnmbox: Receiving headers... %d%%"
108 (/ (* count
100) number
))))
110 (and (numberp nnmail-large-newsgroup
)
111 (> number nnmail-large-newsgroup
)
112 (nnheader-message 5 "nnmbox: Receiving headers...done"))
114 (set-buffer nntp-server-buffer
)
115 (nnheader-fold-continuation-lines)
118 (deffoo nnmbox-open-server
(server &optional defs
)
119 (nnoo-change-server 'nnmbox server defs
)
122 ((not (file-exists-p nnmbox-mbox-file
))
123 (nnmbox-close-server)
124 (nnheader-report 'nnmbox
"No such file: %s" nnmbox-mbox-file
))
125 ((file-directory-p nnmbox-mbox-file
)
126 (nnmbox-close-server)
127 (nnheader-report 'nnmbox
"Not a regular file: %s" nnmbox-mbox-file
))
129 (nnheader-report 'nnmbox
"Opened server %s using mbox %s" server
133 (deffoo nnmbox-close-server
(&optional server
)
134 (when (and nnmbox-mbox-buffer
135 (buffer-name nnmbox-mbox-buffer
))
136 (kill-buffer nnmbox-mbox-buffer
))
137 (nnoo-close-server 'nnmbox server
)
140 (deffoo nnmbox-server-opened
(&optional server
)
141 (and (nnoo-current-server-p 'nnmbox server
)
143 (buffer-name nnmbox-mbox-buffer
)
145 (buffer-name nntp-server-buffer
)))
147 (deffoo nnmbox-request-article
(article &optional newsgroup server buffer
)
148 (nnmbox-possibly-change-newsgroup newsgroup server
)
150 (set-buffer nnmbox-mbox-buffer
)
151 (when (nnmbox-find-article article
)
153 (re-search-backward (concat "^" message-unix-mail-delimiter
) nil t
)
156 (setq stop
(if (re-search-forward (concat "^"
157 message-unix-mail-delimiter
)
161 (let ((nntp-server-buffer (or buffer nntp-server-buffer
)))
162 (set-buffer nntp-server-buffer
)
164 (insert-buffer-substring nnmbox-mbox-buffer start stop
)
165 (goto-char (point-min))
166 (while (looking-at "From ")
168 (insert "X-From-Line: ")
170 (if (numberp article
)
171 (cons nnmbox-current-group article
)
172 (nnmbox-article-group-number nil
)))))))
174 (deffoo nnmbox-request-group
(group &optional server dont-check
)
175 (nnmbox-possibly-change-newsgroup nil server
)
176 (let ((active (cadr (assoc group nnmbox-group-alist
))))
179 (null (nnmbox-possibly-change-newsgroup group server
)))
180 (nnheader-report 'nnmbox
"No such group: %s" group
))
182 (nnheader-report 'nnmbox
"Selected group %s" group
)
183 (nnheader-insert ""))
185 (nnheader-report 'nnmbox
"Selected group %s" group
)
186 (nnheader-insert "211 %d %d %d %s\n"
187 (1+ (- (cdr active
) (car active
)))
188 (car active
) (cdr active
) group
)))))
190 (defun nnmbox-save-buffer ()
191 (let ((coding-system-for-write
192 (or nnmbox-file-coding-system-for-write
193 nnmbox-file-coding-system
)))
196 (defun nnmbox-save-active (group-alist active-file
)
197 (let ((nnmail-active-file-coding-system
198 (or nnmbox-active-file-coding-system-for-write
199 nnmbox-active-file-coding-system
)))
200 (nnmail-save-active group-alist active-file
)))
202 (deffoo nnmbox-request-scan
(&optional group server
)
203 (nnmbox-possibly-change-newsgroup group server
)
209 (set-buffer nnmbox-mbox-buffer
)
210 (nnmbox-save-buffer)))
211 (file-name-directory nnmbox-mbox-file
)
215 (let ((in-buf (current-buffer)))
216 (set-buffer nnmbox-mbox-buffer
)
217 (goto-char (point-max))
218 (insert-buffer-substring in-buf
)))
219 (nnmbox-save-active nnmbox-group-alist nnmbox-active-file
))))
221 (deffoo nnmbox-close-group
(group &optional server
)
224 (deffoo nnmbox-request-create-group
(group &optional server args
)
225 (nnmail-activate 'nnmbox
)
226 (unless (assoc group nnmbox-group-alist
)
227 (push (list group
(cons 1 0))
229 (nnmbox-save-active nnmbox-group-alist nnmbox-active-file
))
232 (deffoo nnmbox-request-list
(&optional server
)
234 (let ((nnmail-file-coding-system
235 nnmbox-active-file-coding-system
))
236 (nnmail-find-file nnmbox-active-file
))
237 (setq nnmbox-group-alist
(nnmail-get-active))
240 (deffoo nnmbox-request-newgroups
(date &optional server
)
241 (nnmbox-request-list server
))
243 (deffoo nnmbox-request-list-newsgroups
(&optional server
)
244 (nnheader-report 'nnmbox
"LIST NEWSGROUPS is not implemented."))
246 (deffoo nnmbox-request-expire-articles
247 (articles newsgroup
&optional server force
)
248 (nnmbox-possibly-change-newsgroup newsgroup server
)
251 (nnmail-activate 'nnmbox
)
254 (set-buffer nnmbox-mbox-buffer
)
255 (while (and articles is-old
)
256 (when (nnmbox-find-article (car articles
))
258 (nnmail-expired-article-p
261 (point) (progn (end-of-line) (point))) force
))
263 (unless (eq nnmail-expiry-target
'delete
)
265 (nnmbox-request-article (car articles
)
268 (let ((nnml-current-directory nil
))
269 (nnmail-expiry-target-group
270 nnmail-expiry-target newsgroup
)))
271 (nnmbox-possibly-change-newsgroup newsgroup server
))
272 (nnheader-message 5 "Deleting article %d in %s..."
273 (car articles
) newsgroup
)
274 (nnmbox-delete-mail))
275 (push (car articles
) rest
)))
276 (setq articles
(cdr articles
)))
278 ;; Find the lowest active article in this group.
279 (let ((active (nth 1 (assoc newsgroup nnmbox-group-alist
))))
280 (while (and (not (nnmbox-find-article (car active
)))
281 (<= (car active
) (cdr active
)))
282 (setcar active
(1+ (car active
)))))
283 (nnmbox-save-active nnmbox-group-alist nnmbox-active-file
)
284 (nconc rest articles
))))
286 (deffoo nnmbox-request-move-article
287 (article group server accept-form
&optional last
)
288 (let ((buf (get-buffer-create " *nnmbox move*"))
291 (nnmbox-request-article article group server
)
295 (insert-buffer-substring nntp-server-buffer
)
296 (goto-char (point-min))
297 (while (re-search-forward
299 (save-excursion (search-forward "\n\n" nil t
) (point)) t
)
301 (setq result
(eval accept-form
))
305 (nnmbox-possibly-change-newsgroup group server
)
306 (set-buffer nnmbox-mbox-buffer
)
307 (when (nnmbox-find-article article
)
308 (nnmbox-delete-mail))
309 (and last
(nnmbox-save-buffer))))
312 (deffoo nnmbox-request-accept-article
(group &optional server last
)
313 (nnmbox-possibly-change-newsgroup group server
)
314 (nnmail-check-syntax)
315 (let ((buf (current-buffer))
318 (nnmail-activate 'nnmbox
)
320 (insert-buffer-substring buf
)
321 (goto-char (point-min))
322 (cond (;; The From line may have been quoted by movemail.
323 (looking-at (concat ">" message-unix-mail-delimiter
))
326 ((looking-at "X-From-Line: ")
327 (replace-match "From ")
330 (insert "From nobody " (current-time-string) "\n")))
331 (narrow-to-region (point)
332 (if (search-forward "\n\n" nil
'move
)
335 (while (re-search-backward "^X-Gnus-Newsgroup: " nil t
)
336 (delete-region (point) (progn (forward-line 1) (point))))
337 (when nnmail-cache-accepted-message-ids
338 (nnmail-cache-insert (message-fetch-field "message-id")
340 (message-fetch-field "subject")
341 (message-fetch-field "from")))
343 (setq result
(if (stringp group
)
344 (list (cons group
(nnmbox-active-number group
)))
345 (nnmail-article-group 'nnmbox-active-number
)))
347 (if (and (null result
)
348 (yes-or-no-p "Moved to `junk' group; delete article? "))
350 (setq result
(car (nnmbox-save-mail result
))))
351 (setq cont
(buffer-string))))
352 (with-current-buffer nnmbox-mbox-buffer
353 (goto-char (point-max))
356 (when nnmail-cache-accepted-message-ids
357 (nnmail-cache-close))
358 (nnmbox-save-active nnmbox-group-alist nnmbox-active-file
)
359 (nnmbox-save-buffer))))
362 (deffoo nnmbox-request-replace-article
(article group buffer
)
363 (nnmbox-possibly-change-newsgroup group
)
365 (set-buffer nnmbox-mbox-buffer
)
366 (if (not (nnmbox-find-article article
))
368 (nnmbox-delete-mail t t
)
371 (insert-buffer-substring buffer
)
372 (goto-char (point-min))
373 (when (looking-at "X-From-Line:")
374 (delete-region (point) (progn (forward-line 1) (point))))
375 (while (re-search-forward (concat "^" message-unix-mail-delimiter
)
377 (goto-char (match-beginning 0))
379 (goto-char (point-max))
386 (deffoo nnmbox-request-delete-group
(group &optional force server
)
387 (nnmbox-possibly-change-newsgroup group server
)
388 ;; Delete all articles in GROUP.
390 () ; Don't delete the articles.
392 (set-buffer nnmbox-mbox-buffer
)
393 (goto-char (point-min))
394 ;; Delete all articles in this group.
395 (let ((ident (concat "\nX-Gnus-Newsgroup: " nnmbox-current-group
":"))
397 (while (search-forward ident nil t
)
399 (nnmbox-delete-mail))
401 (nnmbox-save-buffer)))))
402 ;; Remove the group from all structures.
403 (setq nnmbox-group-alist
404 (delq (assoc group nnmbox-group-alist
) nnmbox-group-alist
)
405 nnmbox-current-group nil
)
406 ;; Save the active file.
407 (nnmbox-save-active nnmbox-group-alist nnmbox-active-file
)
410 (deffoo nnmbox-request-rename-group
(group new-name
&optional server
)
411 (nnmbox-possibly-change-newsgroup group server
)
413 (set-buffer nnmbox-mbox-buffer
)
414 (goto-char (point-min))
415 (let ((ident (concat "\nX-Gnus-Newsgroup: " nnmbox-current-group
":"))
416 (new-ident (concat "\nX-Gnus-Newsgroup: " new-name
":"))
418 (while (search-forward ident nil t
)
419 (replace-match new-ident t t
)
422 (nnmbox-save-buffer))))
423 (let ((entry (assoc group nnmbox-group-active-articles
)))
425 (setcar entry new-name
)))
426 (let ((entry (assoc group nnmbox-group-alist
)))
428 (setcar entry new-name
))
429 (setq nnmbox-current-group nil
)
430 ;; Save the new group alist.
431 (nnmbox-save-active nnmbox-group-alist nnmbox-active-file
)
435 ;;; Internal functions.
437 ;; If FORCE, delete article no matter how many X-Gnus-Newsgroup
438 ;; headers there are. If LEAVE-DELIM, don't delete the Unix mbox
440 (defun nnmbox-delete-mail (&optional force leave-delim
)
441 ;; Delete the current X-Gnus-Newsgroup line.
442 ;; First delete record of active article, unless the article is being
443 ;; replaced, indicated by FORCE being non-nil.
445 (nnmbox-record-deleted-article (nnmbox-article-group-number t
)))
448 ;; Beginning of the article.
453 (re-search-backward (concat "^" message-unix-mail-delimiter
) nil t
)
454 (if leave-delim
(progn (forward-line 1) (point))
457 (or (and (re-search-forward (concat "^" message-unix-mail-delimiter
)
461 (goto-char (point-min))
462 ;; Only delete the article if no other group owns it as well.
464 (not (re-search-forward "^X-Gnus-Newsgroup: " nil t
))
465 (search-backward "\n\n" nil t
))
466 (delete-region (point-min) (point-max))))))
468 (defun nnmbox-possibly-change-newsgroup (newsgroup &optional server
)
470 (not (nnmbox-server-opened server
)))
471 (nnmbox-open-server server
))
472 (when (or (not nnmbox-mbox-buffer
)
473 (not (buffer-name nnmbox-mbox-buffer
)))
475 (when (not nnmbox-group-alist
)
476 (nnmail-activate 'nnmbox
))
478 (when (assoc newsgroup nnmbox-group-alist
)
479 (setq nnmbox-current-group newsgroup
))
482 (defun nnmbox-article-string (article)
483 (if (numberp article
)
484 (concat "\nX-Gnus-Newsgroup: " nnmbox-current-group
":"
485 (int-to-string article
) " ")
486 (concat "\nMessage-ID: " article
)))
488 (defun nnmbox-article-group-number (this-line)
492 (goto-char (point-min)))
493 (when (re-search-forward "^X-Gnus-Newsgroup: +\\([^:]+\\):\\([0-9]+\\) "
495 (cons (buffer-substring (match-beginning 1) (match-end 1))
497 (buffer-substring (match-beginning 2) (match-end 2)))))))
499 (defun nnmbox-in-header-p (pos)
500 "Return non-nil if POS is in the header of an article."
503 (re-search-backward (concat "^" message-unix-mail-delimiter
) nil t
)
504 (search-forward "\n\n" nil t
)
507 (defun nnmbox-find-article (article)
508 "Leaves point on the relevant X-Gnus-Newsgroup line if found."
509 ;; Check that article is in the active range first, to avoid an
510 ;; expensive exhaustive search if it isn't.
511 (if (and (numberp article
)
512 (not (nnmbox-is-article-active-p article
)))
514 (let ((art-string (nnmbox-article-string article
))
516 ;; There is the possibility that the X-Gnus-Newsgroup line appears
517 ;; in the body of an article (for instance, if an article has been
518 ;; forwarded from someone using Gnus as their mailer), so check
519 ;; that the line is actually part of the article header.
520 (or (and (search-forward art-string nil t
)
521 (nnmbox-in-header-p (point)))
523 (goto-char (point-min))
524 (while (and (not found
)
525 (search-forward art-string nil t
))
526 (setq found
(nnmbox-in-header-p (point))))
529 (defun nnmbox-record-active-article (group-art)
530 (let* ((group (car group-art
))
531 (article (cdr group-art
))
533 (or (assoc group nnmbox-group-active-articles
)
536 nnmbox-group-active-articles
)
537 (car nnmbox-group-active-articles
)))))
538 ;; add article to index, either by building complete list
539 ;; in reverse order, or as a list of ranges.
540 (if (not nnmbox-group-building-active-articles
)
541 (setcdr entry
(gnus-add-to-range (cdr entry
) (list article
)))
542 (when (memq article
(cdr entry
))
543 (switch-to-buffer nnmbox-mbox-buffer
)
544 (error "Article %s:%d already exists!" group article
))
545 (when (and (cadr entry
) (< article
(cadr entry
)))
546 (switch-to-buffer nnmbox-mbox-buffer
)
547 (error "Article %s:%d out of order" group article
))
548 (setcdr entry
(cons article
(cdr entry
))))))
550 (defun nnmbox-record-deleted-article (group-art)
551 (let* ((group (car group-art
))
552 (article (cdr group-art
))
554 (or (assoc group nnmbox-group-active-articles
)
557 nnmbox-group-active-articles
)
558 (car nnmbox-group-active-articles
)))))
559 ;; remove article from index
560 (setcdr entry
(gnus-remove-from-range (cdr entry
) (list article
)))))
562 (defun nnmbox-is-article-active-p (article)
563 (gnus-member-of-range
565 (cdr (assoc nnmbox-current-group
566 nnmbox-group-active-articles
))))
568 (defun nnmbox-save-mail (group-art)
569 "Called narrowed to an article."
570 (let ((delim (concat "^" message-unix-mail-delimiter
)))
571 (goto-char (point-min))
572 ;; This might come from somewhere else.
573 (if (looking-at delim
)
575 (insert "From nobody " (current-time-string) "\n"))
576 ;; Quote all "From " lines in the article.
577 (while (re-search-forward delim nil t
)
578 (goto-char (match-beginning 0))
580 (goto-char (point-max))
583 (nnmail-insert-lines)
584 (nnmail-insert-xref group-art
)
585 (nnmbox-insert-newsgroup-line group-art
)
586 (let ((alist group-art
))
588 (nnmbox-record-active-article (car alist
))
589 (setq alist
(cdr alist
))))
590 (run-hooks 'nnmail-prepare-save-mail-hook
)
591 (run-hooks 'nnmbox-prepare-save-mail-hook
)
594 (defun nnmbox-insert-newsgroup-line (group-art)
596 (goto-char (point-min))
597 (when (search-forward "\n\n" nil t
)
600 (insert (format "X-Gnus-Newsgroup: %s:%d %s\n"
601 (caar group-art
) (cdar group-art
)
602 (current-time-string)))
603 (setq group-art
(cdr group-art
))))
606 (defun nnmbox-active-number (group)
607 ;; Find the next article number in GROUP.
608 (let ((active (cadr (assoc group nnmbox-group-alist
))))
610 (setcdr active
(1+ (cdr active
)))
611 ;; This group is new, so we create a new entry for it.
612 ;; This might be a bit naughty... creating groups on the drop of
613 ;; a hat, but I don't know...
614 (push (list group
(setq active
(cons 1 1)))
618 (defun nnmbox-create-mbox ()
619 (when (not (file-exists-p nnmbox-mbox-file
))
620 (let ((nnmail-file-coding-system
621 (or nnmbox-file-coding-system-for-write
622 nnmbox-file-coding-system
))
623 (dir (file-name-directory nnmbox-mbox-file
)))
624 (and dir
(gnus-make-directory dir
))
625 (nnmail-write-region (point-min) (point-min)
626 nnmbox-mbox-file t
'nomesg
))))
628 (defun nnmbox-read-mbox ()
629 (nnmail-activate 'nnmbox
)
631 (if (and nnmbox-mbox-buffer
632 (buffer-name nnmbox-mbox-buffer
)
634 (set-buffer nnmbox-mbox-buffer
)
635 (= (buffer-size) (nnheader-file-size nnmbox-mbox-file
))))
638 (let ((delim (concat "^" message-unix-mail-delimiter
))
639 (alist nnmbox-group-alist
)
640 (nnmbox-group-building-active-articles t
)
641 start end end-header number
)
642 (set-buffer (setq nnmbox-mbox-buffer
643 (let ((nnheader-file-coding-system
644 nnmbox-file-coding-system
))
645 (nnheader-find-file-noselect
646 nnmbox-mbox-file t t
))))
647 (mm-enable-multibyte)
648 (buffer-disable-undo)
650 ;; Go through the group alist and compare against the mbox file.
652 (goto-char (point-max))
653 (when (and (re-search-backward
654 (format "^X-Gnus-Newsgroup: %s:\\([0-9]+\\) "
659 (match-beginning 1) (match-end 1))))
661 (setcdr (cadar alist
) number
))
662 (setq alist
(cdr alist
)))
664 ;; Examine all articles for our private X-Gnus-Newsgroup
665 ;; headers. This is done primarily as a consistency check, but
666 ;; it is convenient for building an index of the articles
667 ;; present, to avoid costly searches for missing articles
668 ;; (eg. when expiring articles).
669 (goto-char (point-min))
670 (setq nnmbox-group-active-articles nil
)
671 (while (re-search-forward delim nil t
)
672 (setq start
(match-beginning 0))
674 (search-forward "\n\n" nil t
)
675 (setq end-header
(point))
677 (re-search-forward delim nil t
)
680 (if (search-forward "\nX-Gnus-Newsgroup: " end-header t
)
681 ;; Build a list of articles in each group, remembering
682 ;; that each article may be in more than one group.
684 (nnmbox-record-active-article (nnmbox-article-group-number t
))
685 (while (search-forward "\nX-Gnus-Newsgroup: " end-header t
)
686 (nnmbox-record-active-article (nnmbox-article-group-number t
))))
687 ;; The article is either new, or for some other reason
688 ;; hasn't got our private headers, so add them now. The
689 ;; only situation I've encountered when the X-Gnus-Newsgroup
690 ;; header is missing is if the article contains a forwarded
691 ;; message which does contain that header line (earlier
692 ;; versions of Gnus didn't restrict their search to the
693 ;; headers). In this case, there is an Xref line which
694 ;; provides the relevant information to construct the
695 ;; missing header(s).
698 (narrow-to-region start end
)
699 (if (re-search-forward "\nXref: [^ ]+" end-header t
)
700 ;; generate headers from Xref:
702 (while (re-search-forward " \\([^:]+\\):\\([0-9]+\\)" end-header t
)
703 (push (cons (match-string 1)
704 (string-to-number (match-string 2))) alist
))
705 (nnmbox-insert-newsgroup-line alist
))
706 ;; this is really a new article
708 (nnmail-article-group 'nnmbox-active-number
))))))
710 ;; put article lists in order
711 (setq alist nnmbox-group-active-articles
)
713 (setcdr (car alist
) (gnus-compress-sequence (nreverse (cdar alist
))))
714 (setq alist
(cdr alist
)))))))
718 ;;; arch-tag: 611dd95f-be37-413a-b3ae-8b059ba93659
719 ;;; nnmbox.el ends here