1 ;;; nnbabyl.el --- rmail mbox access for Gnus
3 ;; Copyright (C) 1995, 1996, 1997, 1998, 1099, 2000
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 (nnheader-message 5 "Deleting article %d in %s..."
301 (car articles) newsgroup)
302 (nnbabyl-delete-mail))
303 (push (car articles) rest)))
304 (setq articles (cdr articles)))
306 ;; Find the lowest active article in this group.
307 (let ((active (nth 1 (assoc newsgroup nnbabyl-group-alist))))
308 (goto-char (point-min))
309 (while (and (not (search-forward
310 (nnbabyl-article-string (car active)) nil t))
311 (<= (car active) (cdr active)))
312 (setcar active (1+ (car active)))
313 (goto-char (point-min))))
314 (nnmail-save-active nnbabyl-group-alist nnbabyl-active-file)
315 (nconc rest articles))))
317 (deffoo nnbabyl-request-move-article
318 (article group server accept-form &optional last)
319 (let ((buf (get-buffer-create " *nnbabyl move*"))
322 (nnbabyl-request-article article group server)
325 (insert-buffer-substring nntp-server-buffer)
326 (goto-char (point-min))
327 (while (re-search-forward
329 (save-excursion (search-forward "\n\n" nil t) (point)) t)
330 (delete-region (progn (beginning-of-line) (point))
331 (progn (forward-line 1) (point))))
332 (setq result (eval accept-form))
333 (kill-buffer (current-buffer))
336 (nnbabyl-possibly-change-newsgroup group server)
337 (set-buffer nnbabyl-mbox-buffer)
338 (goto-char (point-min))
339 (if (search-forward (nnbabyl-article-string article) nil t)
340 (nnbabyl-delete-mail))
341 (and last (save-buffer))))
344 (deffoo nnbabyl-request-accept-article (group &optional server last)
345 (nnbabyl-possibly-change-newsgroup group server)
346 (nnmail-check-syntax)
347 (let ((buf (current-buffer))
350 (nnmail-activate 'nnbabyl)
352 (goto-char (point-min))
353 (search-forward "\n\n" nil t)
356 (while (re-search-backward "^X-Gnus-Newsgroup: " beg t)
357 (delete-region (point) (progn (forward-line 1) (point)))))
358 (when nnmail-cache-accepted-message-ids
359 (nnmail-cache-insert (nnmail-fetch-field "message-id")))
362 (list (cons group (nnbabyl-active-number group)))
363 (nnmail-article-group 'nnbabyl-active-number)))
364 (if (and (null result)
365 (yes-or-no-p "Moved to `junk' group; delete article? "))
367 (setq result (car (nnbabyl-save-mail result))))
368 (set-buffer nnbabyl-mbox-buffer)
369 (goto-char (point-max))
370 (search-backward "\n\^_")
371 (goto-char (match-end 0))
372 (insert-buffer-substring buf)
374 (when nnmail-cache-accepted-message-ids
375 (nnmail-cache-insert (nnmail-fetch-field "message-id")))
377 (nnmail-save-active nnbabyl-group-alist nnbabyl-active-file))
380 (deffoo nnbabyl-request-replace-article (article group buffer)
381 (nnbabyl-possibly-change-newsgroup group)
383 (set-buffer nnbabyl-mbox-buffer)
384 (goto-char (point-min))
385 (if (not (search-forward (nnbabyl-article-string article) nil t))
387 (nnbabyl-delete-mail t t)
388 (insert-buffer-substring buffer)
392 (deffoo nnbabyl-request-delete-group (group &optional force server)
393 (nnbabyl-possibly-change-newsgroup group server)
394 ;; Delete all articles in GROUP.
396 () ; Don't delete the articles.
398 (set-buffer nnbabyl-mbox-buffer)
399 (goto-char (point-min))
400 ;; Delete all articles in this group.
401 (let ((ident (concat "\nX-Gnus-Newsgroup: " nnbabyl-current-group ":"))
403 (while (search-forward ident nil t)
405 (nnbabyl-delete-mail))
408 ;; Remove the group from all structures.
409 (setq nnbabyl-group-alist
410 (delq (assoc group nnbabyl-group-alist) nnbabyl-group-alist)
411 nnbabyl-current-group nil)
412 ;; Save the active file.
413 (nnmail-save-active nnbabyl-group-alist nnbabyl-active-file)
416 (deffoo nnbabyl-request-rename-group (group new-name &optional server)
417 (nnbabyl-possibly-change-newsgroup group server)
419 (set-buffer nnbabyl-mbox-buffer)
420 (goto-char (point-min))
421 (let ((ident (concat "\nX-Gnus-Newsgroup: " nnbabyl-current-group ":"))
422 (new-ident (concat "\nX-Gnus-Newsgroup: " new-name ":"))
424 (while (search-forward ident nil t)
425 (replace-match new-ident t t)
429 (let ((entry (assoc group nnbabyl-group-alist)))
430 (and entry (setcar entry new-name))
431 (setq nnbabyl-current-group nil)
432 ;; Save the new group alist.
433 (nnmail-save-active nnbabyl-group-alist nnbabyl-active-file)
437 ;;; Internal functions.
439 ;; If FORCE, delete article no matter how many X-Gnus-Newsgroup
440 ;; headers there are. If LEAVE-DELIM, don't delete the Unix mbox
442 (defun nnbabyl-delete-mail (&optional force leave-delim)
443 ;; Delete the current X-Gnus-Newsgroup line.
446 (progn (beginning-of-line) (point))
447 (progn (forward-line 1) (point))))
448 ;; Beginning of the article.
454 (unless (re-search-backward (concat "^" nnbabyl-mail-delimiter) nil t)
455 (goto-char (point-min))
457 (if leave-delim (progn (forward-line 1) (point))
458 (match-beginning 0)))
461 (or (and (re-search-forward (concat "^" nnbabyl-mail-delimiter)
465 (goto-char (point-min))
466 ;; Only delete the article if no other groups owns it as well.
467 (when (or force (not (re-search-forward "^X-Gnus-Newsgroup: " nil t)))
468 (delete-region (point-min) (point-max))))))
470 (defun nnbabyl-possibly-change-newsgroup (newsgroup &optional server)
472 (not (nnbabyl-server-opened server)))
473 (nnbabyl-open-server server))
474 (when (or (not nnbabyl-mbox-buffer)
475 (not (buffer-name nnbabyl-mbox-buffer)))
476 (save-excursion (nnbabyl-read-mbox)))
477 (unless nnbabyl-group-alist
478 (nnmail-activate 'nnbabyl))
480 (if (assoc newsgroup nnbabyl-group-alist)
481 (setq nnbabyl-current-group newsgroup)
482 (nnheader-report 'nnbabyl "No such group in file"))
485 (defun nnbabyl-article-string (article)
486 (if (numberp article)
487 (concat "\nX-Gnus-Newsgroup: " nnbabyl-current-group ":"
488 (int-to-string article) " ")
489 (concat "\nMessage-ID: " article)))
491 (defun nnbabyl-article-group-number ()
493 (goto-char (point-min))
494 (when (re-search-forward "^X-Gnus-Newsgroup: +\\([^:]+\\):\\([0-9]+\\) "
496 (cons (buffer-substring (match-beginning 1) (match-end 1))
498 (buffer-substring (match-beginning 2) (match-end 2)))))))
500 (defun nnbabyl-insert-lines ()
501 "Insert how many lines and chars there are in the body of the mail."
504 (goto-char (point-min))
505 (when (search-forward "\n\n" nil t)
506 ;; There may be an EOOH line here...
507 (when (looking-at "\\*\\*\\* EOOH \\*\\*\\*")
508 (search-forward "\n\n" nil t))
509 (setq chars (- (point-max) (point))
510 lines (max (- (count-lines (point) (point-max)) 1) 0))
511 ;; Move back to the end of the headers.
512 (goto-char (point-min))
513 (search-forward "\n\n" nil t)
516 (when (re-search-backward "^Lines: " nil t)
517 (delete-region (point) (progn (forward-line 1) (point)))))
518 (insert (format "Lines: %d\n" lines))
521 (defun nnbabyl-save-mail (group-art)
522 ;; Called narrowed to an article.
523 (nnbabyl-insert-lines)
524 (nnmail-insert-xref group-art)
525 (nnbabyl-insert-newsgroup-line group-art)
526 (run-hooks 'nnbabyl-prepare-save-mail-hook)
529 (defun nnbabyl-insert-newsgroup-line (group-art)
531 (goto-char (point-min))
532 (while (looking-at "From ")
533 (replace-match "Mail-from: From " t t)
535 ;; If there is a C-l at the beginning of the narrowed region, this
536 ;; isn't really a "save", but rather a "scan".
537 (goto-char (point-min))
538 (unless (looking-at "\^L")
540 (insert "\^L\n0, unseen,,\n*** EOOH ***\n")
541 (goto-char (point-max))
543 (when (search-forward "\n\n" nil t)
546 (insert (format "X-Gnus-Newsgroup: %s:%d %s\n"
547 (caar group-art) (cdar group-art)
548 (current-time-string)))
549 (setq group-art (cdr group-art))))
552 (defun nnbabyl-active-number (group)
553 ;; Find the next article number in GROUP.
554 (let ((active (cadr (assoc group nnbabyl-group-alist))))
556 (setcdr active (1+ (cdr active)))
557 ;; This group is new, so we create a new entry for it.
558 ;; This might be a bit naughty... creating groups on the drop of
559 ;; a hat, but I don't know...
560 (push (list group (setq active (cons 1 1)))
561 nnbabyl-group-alist))
564 (defun nnbabyl-create-mbox ()
565 (unless (file-exists-p nnbabyl-mbox-file)
566 ;; Create a new, empty RMAIL mbox file.
568 (set-buffer (setq nnbabyl-mbox-buffer
569 (create-file-buffer nnbabyl-mbox-file)))
570 (setq buffer-file-name nnbabyl-mbox-file)
571 (insert "BABYL OPTIONS:\n\n\^_")
573 (point-min) (point-max) nnbabyl-mbox-file t 'nomesg))))
575 (defun nnbabyl-read-mbox ()
576 (nnmail-activate 'nnbabyl)
577 (nnbabyl-create-mbox)
579 (unless (and nnbabyl-mbox-buffer
580 (buffer-name nnbabyl-mbox-buffer)
582 (set-buffer nnbabyl-mbox-buffer)
583 (= (buffer-size) (nnheader-file-size nnbabyl-mbox-file))))
584 ;; This buffer has changed since we read it last. Possibly.
586 (let ((delim (concat "^" nnbabyl-mail-delimiter))
587 (alist nnbabyl-group-alist)
589 (set-buffer (setq nnbabyl-mbox-buffer
590 (nnheader-find-file-noselect
591 nnbabyl-mbox-file nil t)))
592 ;; Save previous buffer mode.
593 (setq nnbabyl-previous-buffer-mode
594 (cons (cons (point-min) (point-max))
597 (buffer-disable-undo)
599 (setq buffer-read-only nil)
602 ;; Go through the group alist and compare against
605 (goto-char (point-max))
606 (when (and (re-search-backward
607 (format "^X-Gnus-Newsgroup: %s:\\([0-9]+\\) "
613 (match-beginning 1) (match-end 1))))
615 (setcdr (cadar alist) number))
616 (setq alist (cdr alist)))
618 ;; We go through the mbox and make sure that each and
619 ;; every mail belongs to some group or other.
620 (goto-char (point-min))
621 (if (looking-at "\^L")
623 (re-search-forward delim nil t)
624 (setq start (match-end 0)))
625 (while (re-search-forward delim nil t)
626 (setq end (match-end 0))
627 (unless (search-backward "\nX-Gnus-Newsgroup: " start t)
631 (narrow-to-region (goto-char start) end)
633 (nnmail-article-group 'nnbabyl-active-number))
634 (setq end (point-max)))))
635 (goto-char (setq start end)))
636 (when (buffer-modified-p (current-buffer))
638 (nnmail-save-active nnbabyl-group-alist nnbabyl-active-file)))))
640 (defun nnbabyl-remove-incoming-delims ()
641 (goto-char (point-min))
642 (while (search-forward "\^_" nil t)
643 (replace-match "?" t t)))
645 (defun nnbabyl-check-mbox ()
646 "Go through the nnbabyl mbox and make sure that no article numbers are reused."
648 (let ((idents (make-vector 1000 0))
651 (when (or (not nnbabyl-mbox-buffer)
652 (not (buffer-name nnbabyl-mbox-buffer)))
654 (set-buffer nnbabyl-mbox-buffer)
655 (goto-char (point-min))
656 (while (re-search-forward "^X-Gnus-Newsgroup: \\([^ ]+\\) " nil t)
657 (if (intern-soft (setq id (match-string 1)) idents)
659 (delete-region (progn (beginning-of-line) (point))
660 (progn (forward-line 1) (point)))
661 (nnheader-message 7 "Moving %s..." id)
663 (nnmail-article-group 'nnbabyl-active-number)))
665 (when (buffer-modified-p (current-buffer))
667 (nnmail-save-active nnbabyl-group-alist nnbabyl-active-file)
668 (nnheader-message 5 ""))))
672 ;;; nnbabyl.el ends here