1 ;;; nnbabyl.el --- rmail mbox access for Gnus
3 ;; Copyright (C) 1995, 1996, 1997, 1998, 1099, 2000, 2001
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 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
25 ;; Boston, MA 02111-1307, USA.
29 ;; For an overview of what the interface functions do, please see the
38 5 "Ignore rmail errors from this file, you don't have rmail")))
41 (eval-when-compile (require 'cl))
43 (nnoo-declare nnbabyl)
45 (defvoo nnbabyl-mbox-file (expand-file-name "~/RMAIL")
46 "The name of the rmail box file in the users home directory.
48 This variable is a virtual server slot. See the Gnus manual for details.")
50 (defvoo nnbabyl-active-file (expand-file-name "~/.rmail-active")
51 "The name of the active file for the rmail box.
53 This variable is a virtual server slot. See the Gnus manual for details.")
55 (defvoo nnbabyl-get-new-mail t
56 "If non-nil, nnbabyl will check the incoming mail file and split the mail.
58 This variable is a virtual server slot. See the Gnus manual for details.")
61 (defvoo nnbabyl-prepare-save-mail-hook nil
62 "Hook run narrowed to an article before saving.
64 This variable is a virtual server slot. See the Gnus manual for details.")
68 (defvar nnbabyl-mail-delimiter "\^_")
70 (defconst nnbabyl-version "nnbabyl 1.0"
73 (defvoo nnbabyl-mbox-buffer nil)
74 (defvoo nnbabyl-current-group nil)
75 (defvoo nnbabyl-status-string "")
76 (defvoo nnbabyl-group-alist nil)
77 (defvoo nnbabyl-active-timestamp nil)
79 (defvoo nnbabyl-previous-buffer-mode nil)
82 (autoload 'gnus-set-text-properties "gnus-ems"))
86 ;;; Interface functions
88 (nnoo-define-basics nnbabyl)
90 (deffoo nnbabyl-retrieve-headers (articles &optional group server fetch-old)
92 (set-buffer nntp-server-buffer)
94 (let ((number (length articles))
96 (delim (concat "^" nnbabyl-mail-delimiter))
97 article art-string start stop)
98 (nnbabyl-possibly-change-newsgroup group server)
99 (while (setq article (pop articles))
100 (setq art-string (nnbabyl-article-string article))
101 (set-buffer nnbabyl-mbox-buffer)
103 (when (or (search-forward art-string nil t)
104 (search-backward art-string nil t))
105 (unless (re-search-backward delim nil t)
106 (goto-char (point-min)))
107 (while (and (not (looking-at ".+:"))
108 (zerop (forward-line 1))))
110 (search-forward "\n\n" nil t)
111 (setq stop (1- (point)))
112 (set-buffer nntp-server-buffer)
114 (princ article (current-buffer))
115 (insert " Article retrieved.\n")
116 (insert-buffer-substring nnbabyl-mbox-buffer start stop)
117 (goto-char (point-max))
119 (and (numberp nnmail-large-newsgroup)
120 (> number nnmail-large-newsgroup)
121 (zerop (% (incf count) 20))
122 (nnheader-message 5 "nnbabyl: Receiving headers... %d%%"
123 (/ (* count 100) number))))
125 (and (numberp nnmail-large-newsgroup)
126 (> number nnmail-large-newsgroup)
127 (nnheader-message 5 "nnbabyl: Receiving headers...done"))
129 (set-buffer nntp-server-buffer)
130 (nnheader-fold-continuation-lines)
133 (deffoo nnbabyl-open-server (server &optional defs)
134 (nnoo-change-server 'nnbabyl server defs)
135 (nnbabyl-create-mbox)
137 ((not (file-exists-p nnbabyl-mbox-file))
138 (nnbabyl-close-server)
139 (nnheader-report 'nnbabyl "No such file: %s" nnbabyl-mbox-file))
140 ((file-directory-p nnbabyl-mbox-file)
141 (nnbabyl-close-server)
142 (nnheader-report 'nnbabyl "Not a regular file: %s" nnbabyl-mbox-file))
144 (nnheader-report 'nnbabyl "Opened server %s using mbox %s" server
148 (deffoo nnbabyl-close-server (&optional server)
149 ;; Restore buffer mode.
150 (when (and (nnbabyl-server-opened)
151 nnbabyl-previous-buffer-mode)
153 (set-buffer nnbabyl-mbox-buffer)
155 (caar nnbabyl-previous-buffer-mode)
156 (cdar nnbabyl-previous-buffer-mode))
157 (funcall (cdr nnbabyl-previous-buffer-mode))))
158 (nnoo-close-server 'nnbabyl server)
159 (setq nnbabyl-mbox-buffer nil)
162 (deffoo nnbabyl-server-opened (&optional server)
163 (and (nnoo-current-server-p 'nnbabyl server)
165 (buffer-name nnbabyl-mbox-buffer)
167 (buffer-name nntp-server-buffer)))
169 (deffoo nnbabyl-request-article (article &optional newsgroup server buffer)
170 (nnbabyl-possibly-change-newsgroup newsgroup server)
172 (set-buffer nnbabyl-mbox-buffer)
173 (goto-char (point-min))
174 (when (search-forward (nnbabyl-article-string article) nil t)
175 (let (start stop summary-line)
176 (unless (re-search-backward (concat "^" nnbabyl-mail-delimiter) nil t)
177 (goto-char (point-min))
179 (while (and (not (looking-at ".+:"))
180 (zerop (forward-line 1))))
182 (or (when (re-search-forward
183 (concat "^" nnbabyl-mail-delimiter) nil t)
186 (goto-char (point-max)))
188 (let ((nntp-server-buffer (or buffer nntp-server-buffer)))
189 (set-buffer nntp-server-buffer)
191 (insert-buffer-substring nnbabyl-mbox-buffer start stop)
192 (goto-char (point-min))
193 ;; If there is an EOOH header, then we have to remove some
194 ;; duplicated headers.
195 (setq summary-line (looking-at "Summary-line:"))
196 (when (search-forward "\n*** EOOH ***" nil t)
198 ;; The headers to be deleted are located before the
200 (delete-region (point-min) (progn (forward-line 1)
203 (delete-region (progn (beginning-of-line) (point))
204 (or (search-forward "\n\n" nil t)
206 (if (numberp article)
207 (cons nnbabyl-current-group article)
208 (nnbabyl-article-group-number)))))))
210 (deffoo nnbabyl-request-group (group &optional server dont-check)
211 (let ((active (cadr (assoc group nnbabyl-group-alist))))
215 (null (nnbabyl-possibly-change-newsgroup group server)))
216 (nnheader-report 'nnbabyl "No such group: %s" group))
218 (nnheader-report 'nnbabyl "Selected group %s" group)
219 (nnheader-insert ""))
221 (nnheader-report 'nnbabyl "Selected group %s" group)
222 (nnheader-insert "211 %d %d %d %s\n"
223 (1+ (- (cdr active) (car active)))
224 (car active) (cdr active) group))))))
226 (deffoo nnbabyl-request-scan (&optional group server)
227 (nnbabyl-possibly-change-newsgroup group server)
233 (set-buffer nnbabyl-mbox-buffer)
235 (file-name-directory nnbabyl-mbox-file)
239 (let ((in-buf (current-buffer)))
240 (goto-char (point-min))
241 (while (search-forward "\n\^_\n" nil t)
243 (set-buffer nnbabyl-mbox-buffer)
244 (goto-char (point-max))
245 (search-backward "\n\^_" nil t)
246 (goto-char (match-end 0))
247 (insert-buffer-substring in-buf)))
248 (nnmail-save-active nnbabyl-group-alist nnbabyl-active-file))))
250 (deffoo nnbabyl-close-group (group &optional server)
253 (deffoo nnbabyl-request-create-group (group &optional server args)
254 (nnmail-activate 'nnbabyl)
255 (unless (assoc group nnbabyl-group-alist)
256 (push (list group (cons 1 0))
258 (nnmail-save-active nnbabyl-group-alist nnbabyl-active-file))
261 (deffoo nnbabyl-request-list (&optional server)
263 (nnmail-find-file nnbabyl-active-file)
264 (setq nnbabyl-group-alist (nnmail-get-active))
267 (deffoo nnbabyl-request-newgroups (date &optional server)
268 (nnbabyl-request-list server))
270 (deffoo nnbabyl-request-list-newsgroups (&optional server)
271 (nnheader-report 'nnbabyl "nnbabyl: LIST NEWSGROUPS is not implemented."))
273 (deffoo nnbabyl-request-expire-articles
274 (articles newsgroup &optional server force)
275 (nnbabyl-possibly-change-newsgroup newsgroup server)
278 (nnmail-activate 'nnbabyl)
281 (set-buffer nnbabyl-mbox-buffer)
282 (gnus-set-text-properties (point-min) (point-max) nil)
283 (while (and articles is-old)
284 (goto-char (point-min))
285 (when (search-forward (nnbabyl-article-string (car articles)) nil t)
287 (nnmail-expired-article-p
290 (point) (progn (end-of-line) (point))) force))
292 (unless (eq nnmail-expiry-target 'delete)
294 (nnbabyl-request-article (car articles)
297 (let ((nnml-current-directory nil))
298 (nnmail-expiry-target-group
299 nnmail-expiry-target newsgroup)))
300 (nnbabyl-possibly-change-newsgroup newsgroup server))
301 (nnheader-message 5 "Deleting article %d in %s..."
302 (car articles) newsgroup)
303 (nnbabyl-delete-mail))
304 (push (car articles) rest)))
305 (setq articles (cdr articles)))
307 ;; Find the lowest active article in this group.
308 (let ((active (nth 1 (assoc newsgroup nnbabyl-group-alist))))
309 (goto-char (point-min))
310 (while (and (not (search-forward
311 (nnbabyl-article-string (car active)) nil t))
312 (<= (car active) (cdr active)))
313 (setcar active (1+ (car active)))
314 (goto-char (point-min))))
315 (nnmail-save-active nnbabyl-group-alist nnbabyl-active-file)
316 (nconc rest articles))))
318 (deffoo nnbabyl-request-move-article
319 (article group server accept-form &optional last)
320 (let ((buf (get-buffer-create " *nnbabyl move*"))
323 (nnbabyl-request-article article group server)
326 (insert-buffer-substring nntp-server-buffer)
327 (goto-char (point-min))
328 (while (re-search-forward
330 (save-excursion (search-forward "\n\n" nil t) (point)) t)
331 (delete-region (progn (beginning-of-line) (point))
332 (progn (forward-line 1) (point))))
333 (setq result (eval accept-form))
334 (kill-buffer (current-buffer))
337 (nnbabyl-possibly-change-newsgroup group server)
338 (set-buffer nnbabyl-mbox-buffer)
339 (goto-char (point-min))
340 (if (search-forward (nnbabyl-article-string article) nil t)
341 (nnbabyl-delete-mail))
342 (and last (save-buffer))))
345 (deffoo nnbabyl-request-accept-article (group &optional server last)
346 (nnbabyl-possibly-change-newsgroup group server)
347 (nnmail-check-syntax)
348 (let ((buf (current-buffer))
351 (nnmail-activate 'nnbabyl)
353 (goto-char (point-min))
354 (search-forward "\n\n" nil t)
357 (while (re-search-backward "^X-Gnus-Newsgroup: " beg t)
358 (delete-region (point) (progn (forward-line 1) (point)))))
359 (when nnmail-cache-accepted-message-ids
360 (nnmail-cache-insert (nnmail-fetch-field "message-id")))
363 (list (cons group (nnbabyl-active-number group)))
364 (nnmail-article-group 'nnbabyl-active-number)))
365 (if (and (null result)
366 (yes-or-no-p "Moved to `junk' group; delete article? "))
368 (setq result (car (nnbabyl-save-mail result))))
369 (set-buffer nnbabyl-mbox-buffer)
370 (goto-char (point-max))
371 (search-backward "\n\^_")
372 (goto-char (match-end 0))
373 (insert-buffer-substring buf)
375 (when nnmail-cache-accepted-message-ids
376 (nnmail-cache-insert (nnmail-fetch-field "message-id")))
378 (nnmail-save-active nnbabyl-group-alist nnbabyl-active-file))
381 (deffoo nnbabyl-request-replace-article (article group buffer)
382 (nnbabyl-possibly-change-newsgroup group)
384 (set-buffer nnbabyl-mbox-buffer)
385 (goto-char (point-min))
386 (if (not (search-forward (nnbabyl-article-string article) nil t))
388 (nnbabyl-delete-mail t t)
389 (insert-buffer-substring buffer)
393 (deffoo nnbabyl-request-delete-group (group &optional force server)
394 (nnbabyl-possibly-change-newsgroup group server)
395 ;; Delete all articles in GROUP.
397 () ; Don't delete the articles.
399 (set-buffer nnbabyl-mbox-buffer)
400 (goto-char (point-min))
401 ;; Delete all articles in this group.
402 (let ((ident (concat "\nX-Gnus-Newsgroup: " nnbabyl-current-group ":"))
404 (while (search-forward ident nil t)
406 (nnbabyl-delete-mail))
409 ;; Remove the group from all structures.
410 (setq nnbabyl-group-alist
411 (delq (assoc group nnbabyl-group-alist) nnbabyl-group-alist)
412 nnbabyl-current-group nil)
413 ;; Save the active file.
414 (nnmail-save-active nnbabyl-group-alist nnbabyl-active-file)
417 (deffoo nnbabyl-request-rename-group (group new-name &optional server)
418 (nnbabyl-possibly-change-newsgroup group server)
420 (set-buffer nnbabyl-mbox-buffer)
421 (goto-char (point-min))
422 (let ((ident (concat "\nX-Gnus-Newsgroup: " nnbabyl-current-group ":"))
423 (new-ident (concat "\nX-Gnus-Newsgroup: " new-name ":"))
425 (while (search-forward ident nil t)
426 (replace-match new-ident t t)
430 (let ((entry (assoc group nnbabyl-group-alist)))
431 (and entry (setcar entry new-name))
432 (setq nnbabyl-current-group nil)
433 ;; Save the new group alist.
434 (nnmail-save-active nnbabyl-group-alist nnbabyl-active-file)
438 ;;; Internal functions.
440 ;; If FORCE, delete article no matter how many X-Gnus-Newsgroup
441 ;; headers there are. If LEAVE-DELIM, don't delete the Unix mbox
443 (defun nnbabyl-delete-mail (&optional force leave-delim)
444 ;; Delete the current X-Gnus-Newsgroup line.
447 (progn (beginning-of-line) (point))
448 (progn (forward-line 1) (point))))
449 ;; Beginning of the article.
455 (unless (re-search-backward (concat "^" nnbabyl-mail-delimiter) nil t)
456 (goto-char (point-min))
458 (if leave-delim (progn (forward-line 1) (point))
459 (match-beginning 0)))
462 (or (and (re-search-forward (concat "^" nnbabyl-mail-delimiter)
466 (goto-char (point-min))
467 ;; Only delete the article if no other groups owns it as well.
468 (when (or force (not (re-search-forward "^X-Gnus-Newsgroup: " nil t)))
469 (delete-region (point-min) (point-max))))))
471 (defun nnbabyl-possibly-change-newsgroup (newsgroup &optional server)
473 (not (nnbabyl-server-opened server)))
474 (nnbabyl-open-server server))
475 (when (or (not nnbabyl-mbox-buffer)
476 (not (buffer-name nnbabyl-mbox-buffer)))
477 (save-excursion (nnbabyl-read-mbox)))
478 (unless nnbabyl-group-alist
479 (nnmail-activate 'nnbabyl))
481 (if (assoc newsgroup nnbabyl-group-alist)
482 (setq nnbabyl-current-group newsgroup)
483 (nnheader-report 'nnbabyl "No such group in file"))
486 (defun nnbabyl-article-string (article)
487 (if (numberp article)
488 (concat "\nX-Gnus-Newsgroup: " nnbabyl-current-group ":"
489 (int-to-string article) " ")
490 (concat "\nMessage-ID: " article)))
492 (defun nnbabyl-article-group-number ()
494 (goto-char (point-min))
495 (when (re-search-forward "^X-Gnus-Newsgroup: +\\([^:]+\\):\\([0-9]+\\) "
497 (cons (buffer-substring (match-beginning 1) (match-end 1))
499 (buffer-substring (match-beginning 2) (match-end 2)))))))
501 (defun nnbabyl-insert-lines ()
502 "Insert how many lines and chars there are in the body of the mail."
505 (goto-char (point-min))
506 (when (search-forward "\n\n" nil t)
507 ;; There may be an EOOH line here...
508 (when (looking-at "\\*\\*\\* EOOH \\*\\*\\*")
509 (search-forward "\n\n" nil t))
510 (setq chars (- (point-max) (point))
511 lines (max (- (count-lines (point) (point-max)) 1) 0))
512 ;; Move back to the end of the headers.
513 (goto-char (point-min))
514 (search-forward "\n\n" nil t)
517 (when (re-search-backward "^Lines: " nil t)
518 (delete-region (point) (progn (forward-line 1) (point)))))
519 (insert (format "Lines: %d\n" lines))
522 (defun nnbabyl-save-mail (group-art)
523 ;; Called narrowed to an article.
524 (nnbabyl-insert-lines)
525 (nnmail-insert-xref group-art)
526 (nnbabyl-insert-newsgroup-line group-art)
527 (run-hooks 'nnbabyl-prepare-save-mail-hook)
530 (defun nnbabyl-insert-newsgroup-line (group-art)
532 (goto-char (point-min))
533 (while (looking-at "From ")
534 (replace-match "Mail-from: From " t t)
536 ;; If there is a C-l at the beginning of the narrowed region, this
537 ;; isn't really a "save", but rather a "scan".
538 (goto-char (point-min))
539 (unless (looking-at "\^L")
541 (insert "\^L\n0, unseen,,\n*** EOOH ***\n")
542 (goto-char (point-max))
544 (when (search-forward "\n\n" nil t)
547 (insert (format "X-Gnus-Newsgroup: %s:%d %s\n"
548 (caar group-art) (cdar group-art)
549 (current-time-string)))
550 (setq group-art (cdr group-art))))
553 (defun nnbabyl-active-number (group)
554 ;; Find the next article number in GROUP.
555 (let ((active (cadr (assoc group nnbabyl-group-alist))))
557 (setcdr active (1+ (cdr active)))
558 ;; This group is new, so we create a new entry for it.
559 ;; This might be a bit naughty... creating groups on the drop of
560 ;; a hat, but I don't know...
561 (push (list group (setq active (cons 1 1)))
562 nnbabyl-group-alist))
565 (defun nnbabyl-create-mbox ()
566 (unless (file-exists-p nnbabyl-mbox-file)
567 ;; Create a new, empty RMAIL mbox file.
569 (set-buffer (setq nnbabyl-mbox-buffer
570 (create-file-buffer nnbabyl-mbox-file)))
571 (setq buffer-file-name nnbabyl-mbox-file)
572 (insert "BABYL OPTIONS:\n\n\^_")
574 (point-min) (point-max) nnbabyl-mbox-file t 'nomesg))))
576 (defun nnbabyl-read-mbox ()
577 (nnmail-activate 'nnbabyl)
578 (nnbabyl-create-mbox)
580 (unless (and nnbabyl-mbox-buffer
581 (buffer-name nnbabyl-mbox-buffer)
583 (set-buffer nnbabyl-mbox-buffer)
584 (= (buffer-size) (nnheader-file-size nnbabyl-mbox-file))))
585 ;; This buffer has changed since we read it last. Possibly.
587 (let ((delim (concat "^" nnbabyl-mail-delimiter))
588 (alist nnbabyl-group-alist)
590 (set-buffer (setq nnbabyl-mbox-buffer
591 (nnheader-find-file-noselect
592 nnbabyl-mbox-file nil t)))
593 ;; Save previous buffer mode.
594 (setq nnbabyl-previous-buffer-mode
595 (cons (cons (point-min) (point-max))
598 (buffer-disable-undo)
600 (setq buffer-read-only nil)
603 ;; Go through the group alist and compare against
606 (goto-char (point-max))
607 (when (and (re-search-backward
608 (format "^X-Gnus-Newsgroup: %s:\\([0-9]+\\) "
614 (match-beginning 1) (match-end 1))))
616 (setcdr (cadar alist) number))
617 (setq alist (cdr alist)))
619 ;; We go through the mbox and make sure that each and
620 ;; every mail belongs to some group or other.
621 (goto-char (point-min))
622 (if (looking-at "\^L")
624 (re-search-forward delim nil t)
625 (setq start (match-end 0)))
626 (while (re-search-forward delim nil t)
627 (setq end (match-end 0))
628 (unless (search-backward "\nX-Gnus-Newsgroup: " start t)
632 (narrow-to-region (goto-char start) end)
634 (nnmail-article-group 'nnbabyl-active-number))
635 (setq end (point-max)))))
636 (goto-char (setq start end)))
637 (when (buffer-modified-p (current-buffer))
639 (nnmail-save-active nnbabyl-group-alist nnbabyl-active-file)))))
641 (defun nnbabyl-remove-incoming-delims ()
642 (goto-char (point-min))
643 (while (search-forward "\^_" nil t)
644 (replace-match "?" t t)))
646 (defun nnbabyl-check-mbox ()
647 "Go through the nnbabyl mbox and make sure that no article numbers are reused."
649 (let ((idents (make-vector 1000 0))
652 (when (or (not nnbabyl-mbox-buffer)
653 (not (buffer-name nnbabyl-mbox-buffer)))
655 (set-buffer nnbabyl-mbox-buffer)
656 (goto-char (point-min))
657 (while (re-search-forward "^X-Gnus-Newsgroup: \\([^ ]+\\) " nil t)
658 (if (intern-soft (setq id (match-string 1)) idents)
660 (delete-region (progn (beginning-of-line) (point))
661 (progn (forward-line 1) (point)))
662 (nnheader-message 7 "Moving %s..." id)
664 (nnmail-article-group 'nnbabyl-active-number)))
666 (when (buffer-modified-p (current-buffer))
668 (nnmail-save-active nnbabyl-group-alist nnbabyl-active-file)
669 (nnheader-message 5 ""))))
673 ;;; nnbabyl.el ends here