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
34 (eval-when-compile (require 'cl))
40 5 "Ignore rmail errors from this file, you don't have rmail")))
44 (nnoo-declare nnbabyl)
46 (defvoo nnbabyl-mbox-file (expand-file-name "~/RMAIL")
47 "The name of the rmail box file in the users home directory.")
49 (defvoo nnbabyl-active-file (expand-file-name "~/.rmail-active")
50 "The name of the active file for the rmail box.")
52 (defvoo nnbabyl-get-new-mail t
53 "If non-nil, nnbabyl will check the incoming mail file and split the mail.")
55 (defvoo nnbabyl-prepare-save-mail-hook nil
56 "Hook run narrowed to an article before saving.")
60 (defvar nnbabyl-mail-delimiter "\^_")
62 (defconst nnbabyl-version "nnbabyl 1.0"
65 (defvoo nnbabyl-mbox-buffer nil)
66 (defvoo nnbabyl-current-group nil)
67 (defvoo nnbabyl-status-string "")
68 (defvoo nnbabyl-group-alist nil)
69 (defvoo nnbabyl-active-timestamp nil)
71 (defvoo nnbabyl-previous-buffer-mode nil)
74 (autoload 'gnus-set-text-properties "gnus-ems"))
78 ;;; Interface functions
80 (nnoo-define-basics nnbabyl)
82 (deffoo nnbabyl-retrieve-headers (articles &optional group server fetch-old)
84 (set-buffer nntp-server-buffer)
86 (let ((number (length articles))
88 (delim (concat "^" nnbabyl-mail-delimiter))
89 article art-string start stop)
90 (nnbabyl-possibly-change-newsgroup group server)
91 (while (setq article (pop articles))
92 (setq art-string (nnbabyl-article-string article))
93 (set-buffer nnbabyl-mbox-buffer)
95 (when (or (search-forward art-string nil t)
96 (search-backward art-string nil t))
97 (unless (re-search-backward delim nil t)
98 (goto-char (point-min)))
99 (while (and (not (looking-at ".+:"))
100 (zerop (forward-line 1))))
102 (search-forward "\n\n" nil t)
103 (setq stop (1- (point)))
104 (set-buffer nntp-server-buffer)
106 (princ article (current-buffer))
107 (insert " Article retrieved.\n")
108 (insert-buffer-substring nnbabyl-mbox-buffer start stop)
109 (goto-char (point-max))
111 (and (numberp nnmail-large-newsgroup)
112 (> number nnmail-large-newsgroup)
113 (zerop (% (incf count) 20))
114 (nnheader-message 5 "nnbabyl: Receiving headers... %d%%"
115 (/ (* count 100) number))))
117 (and (numberp nnmail-large-newsgroup)
118 (> number nnmail-large-newsgroup)
119 (nnheader-message 5 "nnbabyl: Receiving headers...done"))
121 (set-buffer nntp-server-buffer)
122 (nnheader-fold-continuation-lines)
125 (deffoo nnbabyl-open-server (server &optional defs)
126 (nnoo-change-server 'nnbabyl server defs)
127 (nnbabyl-create-mbox)
129 ((not (file-exists-p nnbabyl-mbox-file))
130 (nnbabyl-close-server)
131 (nnheader-report 'nnbabyl "No such file: %s" nnbabyl-mbox-file))
132 ((file-directory-p nnbabyl-mbox-file)
133 (nnbabyl-close-server)
134 (nnheader-report 'nnbabyl "Not a regular file: %s" nnbabyl-mbox-file))
136 (nnheader-report 'nnbabyl "Opened server %s using mbox %s" server
140 (deffoo nnbabyl-close-server (&optional server)
141 ;; Restore buffer mode.
142 (when (and (nnbabyl-server-opened)
143 nnbabyl-previous-buffer-mode)
145 (set-buffer nnbabyl-mbox-buffer)
147 (caar nnbabyl-previous-buffer-mode)
148 (cdar nnbabyl-previous-buffer-mode))
149 (funcall (cdr nnbabyl-previous-buffer-mode))))
150 (nnoo-close-server 'nnbabyl server)
151 (setq nnbabyl-mbox-buffer nil)
154 (deffoo nnbabyl-server-opened (&optional server)
155 (and (nnoo-current-server-p 'nnbabyl server)
157 (buffer-name nnbabyl-mbox-buffer)
159 (buffer-name nntp-server-buffer)))
161 (deffoo nnbabyl-request-article (article &optional newsgroup server buffer)
162 (nnbabyl-possibly-change-newsgroup newsgroup server)
164 (set-buffer nnbabyl-mbox-buffer)
165 (goto-char (point-min))
166 (when (search-forward (nnbabyl-article-string article) nil t)
167 (let (start stop summary-line)
168 (unless (re-search-backward (concat "^" nnbabyl-mail-delimiter) nil t)
169 (goto-char (point-min))
171 (while (and (not (looking-at ".+:"))
172 (zerop (forward-line 1))))
174 (or (when (re-search-forward
175 (concat "^" nnbabyl-mail-delimiter) nil t)
178 (goto-char (point-max)))
180 (let ((nntp-server-buffer (or buffer nntp-server-buffer)))
181 (set-buffer nntp-server-buffer)
183 (insert-buffer-substring nnbabyl-mbox-buffer start stop)
184 (goto-char (point-min))
185 ;; If there is an EOOH header, then we have to remove some
186 ;; duplicated headers.
187 (setq summary-line (looking-at "Summary-line:"))
188 (when (search-forward "\n*** EOOH ***" nil t)
190 ;; The headers to be deleted are located before the
192 (delete-region (point-min) (progn (forward-line 1)
195 (delete-region (progn (beginning-of-line) (point))
196 (or (search-forward "\n\n" nil t)
198 (if (numberp article)
199 (cons nnbabyl-current-group article)
200 (nnbabyl-article-group-number)))))))
202 (deffoo nnbabyl-request-group (group &optional server dont-check)
203 (let ((active (cadr (assoc group nnbabyl-group-alist))))
207 (null (nnbabyl-possibly-change-newsgroup group server)))
208 (nnheader-report 'nnbabyl "No such group: %s" group))
210 (nnheader-report 'nnbabyl "Selected group %s" group)
211 (nnheader-insert ""))
213 (nnheader-report 'nnbabyl "Selected group %s" group)
214 (nnheader-insert "211 %d %d %d %s\n"
215 (1+ (- (cdr active) (car active)))
216 (car active) (cdr active) group))))))
218 (deffoo nnbabyl-request-scan (&optional group server)
219 (nnbabyl-possibly-change-newsgroup group server)
225 (set-buffer nnbabyl-mbox-buffer)
227 (file-name-directory nnbabyl-mbox-file)
231 (let ((in-buf (current-buffer)))
232 (goto-char (point-min))
233 (while (search-forward "\n\^_\n" nil t)
235 (set-buffer nnbabyl-mbox-buffer)
236 (goto-char (point-max))
237 (search-backward "\n\^_" nil t)
238 (goto-char (match-end 0))
239 (insert-buffer-substring in-buf)))
240 (nnmail-save-active nnbabyl-group-alist nnbabyl-active-file))))
242 (deffoo nnbabyl-close-group (group &optional server)
245 (deffoo nnbabyl-request-create-group (group &optional server args)
246 (nnmail-activate 'nnbabyl)
247 (unless (assoc group nnbabyl-group-alist)
248 (push (list group (cons 1 0))
250 (nnmail-save-active nnbabyl-group-alist nnbabyl-active-file))
253 (deffoo nnbabyl-request-list (&optional server)
255 (nnmail-find-file nnbabyl-active-file)
256 (setq nnbabyl-group-alist (nnmail-get-active))
259 (deffoo nnbabyl-request-newgroups (date &optional server)
260 (nnbabyl-request-list server))
262 (deffoo nnbabyl-request-list-newsgroups (&optional server)
263 (nnheader-report 'nnbabyl "nnbabyl: LIST NEWSGROUPS is not implemented."))
265 (deffoo nnbabyl-request-expire-articles
266 (articles newsgroup &optional server force)
267 (nnbabyl-possibly-change-newsgroup newsgroup server)
270 (nnmail-activate 'nnbabyl)
273 (set-buffer nnbabyl-mbox-buffer)
274 (gnus-set-text-properties (point-min) (point-max) nil)
275 (while (and articles is-old)
276 (goto-char (point-min))
277 (when (search-forward (nnbabyl-article-string (car articles)) nil t)
279 (nnmail-expired-article-p
282 (point) (progn (end-of-line) (point))) force))
284 (nnheader-message 5 "Deleting article %d in %s..."
285 (car articles) newsgroup)
286 (nnbabyl-delete-mail))
287 (push (car articles) rest)))
288 (setq articles (cdr articles)))
290 ;; Find the lowest active article in this group.
291 (let ((active (nth 1 (assoc newsgroup nnbabyl-group-alist))))
292 (goto-char (point-min))
293 (while (and (not (search-forward
294 (nnbabyl-article-string (car active)) nil t))
295 (<= (car active) (cdr active)))
296 (setcar active (1+ (car active)))
297 (goto-char (point-min))))
298 (nnmail-save-active nnbabyl-group-alist nnbabyl-active-file)
299 (nconc rest articles))))
301 (deffoo nnbabyl-request-move-article
302 (article group server accept-form &optional last)
303 (let ((buf (get-buffer-create " *nnbabyl move*"))
306 (nnbabyl-request-article article group server)
309 (insert-buffer-substring nntp-server-buffer)
310 (goto-char (point-min))
311 (while (re-search-forward
313 (save-excursion (search-forward "\n\n" nil t) (point)) t)
314 (delete-region (progn (beginning-of-line) (point))
315 (progn (forward-line 1) (point))))
316 (setq result (eval accept-form))
317 (kill-buffer (current-buffer))
320 (nnbabyl-possibly-change-newsgroup group server)
321 (set-buffer nnbabyl-mbox-buffer)
322 (goto-char (point-min))
323 (if (search-forward (nnbabyl-article-string article) nil t)
324 (nnbabyl-delete-mail))
325 (and last (save-buffer))))
328 (deffoo nnbabyl-request-accept-article (group &optional server last)
329 (nnbabyl-possibly-change-newsgroup group server)
330 (nnmail-check-syntax)
331 (let ((buf (current-buffer))
334 (nnmail-activate 'nnbabyl)
336 (goto-char (point-min))
337 (search-forward "\n\n" nil t)
340 (while (re-search-backward "^X-Gnus-Newsgroup: " beg t)
341 (delete-region (point) (progn (forward-line 1) (point)))))
342 (when nnmail-cache-accepted-message-ids
343 (nnmail-cache-insert (nnmail-fetch-field "message-id")))
346 (list (cons group (nnbabyl-active-number group)))
347 (nnmail-article-group 'nnbabyl-active-number)))
348 (if (and (null result)
349 (yes-or-no-p "Moved to `junk' group; delete article? "))
351 (setq result (car (nnbabyl-save-mail result))))
352 (set-buffer nnbabyl-mbox-buffer)
353 (goto-char (point-max))
354 (search-backward "\n\^_")
355 (goto-char (match-end 0))
356 (insert-buffer-substring buf)
358 (when nnmail-cache-accepted-message-ids
359 (nnmail-cache-insert (nnmail-fetch-field "message-id")))
361 (nnmail-save-active nnbabyl-group-alist nnbabyl-active-file))
364 (deffoo nnbabyl-request-replace-article (article group buffer)
365 (nnbabyl-possibly-change-newsgroup group)
367 (set-buffer nnbabyl-mbox-buffer)
368 (goto-char (point-min))
369 (if (not (search-forward (nnbabyl-article-string article) nil t))
371 (nnbabyl-delete-mail t t)
372 (insert-buffer-substring buffer)
376 (deffoo nnbabyl-request-delete-group (group &optional force server)
377 (nnbabyl-possibly-change-newsgroup group server)
378 ;; Delete all articles in GROUP.
380 () ; Don't delete the articles.
382 (set-buffer nnbabyl-mbox-buffer)
383 (goto-char (point-min))
384 ;; Delete all articles in this group.
385 (let ((ident (concat "\nX-Gnus-Newsgroup: " nnbabyl-current-group ":"))
387 (while (search-forward ident nil t)
389 (nnbabyl-delete-mail))
392 ;; Remove the group from all structures.
393 (setq nnbabyl-group-alist
394 (delq (assoc group nnbabyl-group-alist) nnbabyl-group-alist)
395 nnbabyl-current-group nil)
396 ;; Save the active file.
397 (nnmail-save-active nnbabyl-group-alist nnbabyl-active-file)
400 (deffoo nnbabyl-request-rename-group (group new-name &optional server)
401 (nnbabyl-possibly-change-newsgroup group server)
403 (set-buffer nnbabyl-mbox-buffer)
404 (goto-char (point-min))
405 (let ((ident (concat "\nX-Gnus-Newsgroup: " nnbabyl-current-group ":"))
406 (new-ident (concat "\nX-Gnus-Newsgroup: " new-name ":"))
408 (while (search-forward ident nil t)
409 (replace-match new-ident t t)
413 (let ((entry (assoc group nnbabyl-group-alist)))
414 (and entry (setcar entry new-name))
415 (setq nnbabyl-current-group nil)
416 ;; Save the new group alist.
417 (nnmail-save-active nnbabyl-group-alist nnbabyl-active-file)
421 ;;; Internal functions.
423 ;; If FORCE, delete article no matter how many X-Gnus-Newsgroup
424 ;; headers there are. If LEAVE-DELIM, don't delete the Unix mbox
426 (defun nnbabyl-delete-mail (&optional force leave-delim)
427 ;; Delete the current X-Gnus-Newsgroup line.
430 (progn (beginning-of-line) (point))
431 (progn (forward-line 1) (point))))
432 ;; Beginning of the article.
438 (unless (re-search-backward (concat "^" nnbabyl-mail-delimiter) nil t)
439 (goto-char (point-min))
441 (if leave-delim (progn (forward-line 1) (point))
442 (match-beginning 0)))
445 (or (and (re-search-forward (concat "^" nnbabyl-mail-delimiter)
449 (goto-char (point-min))
450 ;; Only delete the article if no other groups owns it as well.
451 (when (or force (not (re-search-forward "^X-Gnus-Newsgroup: " nil t)))
452 (delete-region (point-min) (point-max))))))
454 (defun nnbabyl-possibly-change-newsgroup (newsgroup &optional server)
456 (not (nnbabyl-server-opened server)))
457 (nnbabyl-open-server server))
458 (when (or (not nnbabyl-mbox-buffer)
459 (not (buffer-name nnbabyl-mbox-buffer)))
460 (save-excursion (nnbabyl-read-mbox)))
461 (unless nnbabyl-group-alist
462 (nnmail-activate 'nnbabyl))
464 (if (assoc newsgroup nnbabyl-group-alist)
465 (setq nnbabyl-current-group newsgroup)
466 (nnheader-report 'nnbabyl "No such group in file"))
469 (defun nnbabyl-article-string (article)
470 (if (numberp article)
471 (concat "\nX-Gnus-Newsgroup: " nnbabyl-current-group ":"
472 (int-to-string article) " ")
473 (concat "\nMessage-ID: " article)))
475 (defun nnbabyl-article-group-number ()
477 (goto-char (point-min))
478 (when (re-search-forward "^X-Gnus-Newsgroup: +\\([^:]+\\):\\([0-9]+\\) "
480 (cons (buffer-substring (match-beginning 1) (match-end 1))
482 (buffer-substring (match-beginning 2) (match-end 2)))))))
484 (defun nnbabyl-insert-lines ()
485 "Insert how many lines and chars there are in the body of the mail."
488 (goto-char (point-min))
489 (when (search-forward "\n\n" nil t)
490 ;; There may be an EOOH line here...
491 (when (looking-at "\\*\\*\\* EOOH \\*\\*\\*")
492 (search-forward "\n\n" nil t))
493 (setq chars (- (point-max) (point))
494 lines (max (- (count-lines (point) (point-max)) 1) 0))
495 ;; Move back to the end of the headers.
496 (goto-char (point-min))
497 (search-forward "\n\n" nil t)
500 (when (re-search-backward "^Lines: " nil t)
501 (delete-region (point) (progn (forward-line 1) (point)))))
502 (insert (format "Lines: %d\n" lines))
505 (defun nnbabyl-save-mail (group-art)
506 ;; Called narrowed to an article.
507 (nnbabyl-insert-lines)
508 (nnmail-insert-xref group-art)
509 (nnbabyl-insert-newsgroup-line group-art)
510 (run-hooks 'nnbabyl-prepare-save-mail-hook)
513 (defun nnbabyl-insert-newsgroup-line (group-art)
515 (goto-char (point-min))
516 (while (looking-at "From ")
517 (replace-match "Mail-from: From " t t)
519 ;; If there is a C-l at the beginning of the narrowed region, this
520 ;; isn't really a "save", but rather a "scan".
521 (goto-char (point-min))
522 (unless (looking-at "\^L")
524 (insert "\^L\n0, unseen,,\n*** EOOH ***\n")
525 (goto-char (point-max))
527 (when (search-forward "\n\n" nil t)
530 (insert (format "X-Gnus-Newsgroup: %s:%d %s\n"
531 (caar group-art) (cdar group-art)
532 (current-time-string)))
533 (setq group-art (cdr group-art))))
536 (defun nnbabyl-active-number (group)
537 ;; Find the next article number in GROUP.
538 (let ((active (cadr (assoc group nnbabyl-group-alist))))
540 (setcdr active (1+ (cdr active)))
541 ;; This group is new, so we create a new entry for it.
542 ;; This might be a bit naughty... creating groups on the drop of
543 ;; a hat, but I don't know...
544 (push (list group (setq active (cons 1 1)))
545 nnbabyl-group-alist))
548 (defun nnbabyl-create-mbox ()
549 (unless (file-exists-p nnbabyl-mbox-file)
550 ;; Create a new, empty RMAIL mbox file.
552 (set-buffer (setq nnbabyl-mbox-buffer
553 (create-file-buffer nnbabyl-mbox-file)))
554 (setq buffer-file-name nnbabyl-mbox-file)
555 (insert "BABYL OPTIONS:\n\n\^_")
557 (point-min) (point-max) nnbabyl-mbox-file t 'nomesg))))
559 (defun nnbabyl-read-mbox ()
560 (nnmail-activate 'nnbabyl)
561 (nnbabyl-create-mbox)
563 (unless (and nnbabyl-mbox-buffer
564 (buffer-name nnbabyl-mbox-buffer)
566 (set-buffer nnbabyl-mbox-buffer)
567 (= (buffer-size) (nnheader-file-size nnbabyl-mbox-file))))
568 ;; This buffer has changed since we read it last. Possibly.
570 (let ((delim (concat "^" nnbabyl-mail-delimiter))
571 (alist nnbabyl-group-alist)
573 (set-buffer (setq nnbabyl-mbox-buffer
574 (nnheader-find-file-noselect
575 nnbabyl-mbox-file nil t)))
576 ;; Save previous buffer mode.
577 (setq nnbabyl-previous-buffer-mode
578 (cons (cons (point-min) (point-max))
581 (buffer-disable-undo)
583 (setq buffer-read-only nil)
586 ;; Go through the group alist and compare against
589 (goto-char (point-max))
590 (when (and (re-search-backward
591 (format "^X-Gnus-Newsgroup: %s:\\([0-9]+\\) "
597 (match-beginning 1) (match-end 1))))
599 (setcdr (cadar alist) number))
600 (setq alist (cdr alist)))
602 ;; We go through the mbox and make sure that each and
603 ;; every mail belongs to some group or other.
604 (goto-char (point-min))
605 (if (looking-at "\^L")
607 (re-search-forward delim nil t)
608 (setq start (match-end 0)))
609 (while (re-search-forward delim nil t)
610 (setq end (match-end 0))
611 (unless (search-backward "\nX-Gnus-Newsgroup: " start t)
615 (narrow-to-region (goto-char start) end)
617 (nnmail-article-group 'nnbabyl-active-number))
618 (setq end (point-max)))))
619 (goto-char (setq start end)))
620 (when (buffer-modified-p (current-buffer))
622 (nnmail-save-active nnbabyl-group-alist nnbabyl-active-file)))))
624 (defun nnbabyl-remove-incoming-delims ()
625 (goto-char (point-min))
626 (while (search-forward "\^_" nil t)
627 (replace-match "?" t t)))
629 (defun nnbabyl-check-mbox ()
630 "Go through the nnbabyl mbox and make sure that no article numbers are reused."
632 (let ((idents (make-vector 1000 0))
635 (when (or (not nnbabyl-mbox-buffer)
636 (not (buffer-name nnbabyl-mbox-buffer)))
638 (set-buffer nnbabyl-mbox-buffer)
639 (goto-char (point-min))
640 (while (re-search-forward "^X-Gnus-Newsgroup: \\([^ ]+\\) " nil t)
641 (if (intern-soft (setq id (match-string 1)) idents)
643 (delete-region (progn (beginning-of-line) (point))
644 (progn (forward-line 1) (point)))
645 (nnheader-message 7 "Moving %s..." id)
647 (nnmail-article-group 'nnbabyl-active-number)))
649 (when (buffer-modified-p (current-buffer))
651 (nnmail-save-active nnbabyl-group-alist nnbabyl-active-file)
652 (nnheader-message 5 ""))))
656 ;;; nnbabyl.el ends here