1 ;;; nnbabyl.el --- rmail mbox access for Gnus
2 ;; Copyright (C) 1995,96,97 Free Software Foundation, Inc.
4 ;; Author: Lars Magne Ingebrigtsen <larsi@ifi.uio.no>
5 ;; Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
6 ;; Keywords: news, mail
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING. If not, write to the
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 ;; Boston, MA 02111-1307, USA.
27 ;; For an overview of what the interface functions do, please see the
36 (eval-when-compile (require 'cl))
38 (nnoo-declare nnbabyl)
40 (defvoo nnbabyl-mbox-file (expand-file-name "~/RMAIL")
41 "The name of the rmail box file in the users home directory.")
43 (defvoo nnbabyl-active-file (expand-file-name "~/.rmail-active")
44 "The name of the active file for the rmail box.")
46 (defvoo nnbabyl-get-new-mail t
47 "If non-nil, nnbabyl will check the incoming mail file and split the mail.")
49 (defvoo nnbabyl-prepare-save-mail-hook nil
50 "Hook run narrowed to an article before saving.")
54 (defvar nnbabyl-mail-delimiter "\^_")
56 (defconst nnbabyl-version "nnbabyl 1.0"
59 (defvoo nnbabyl-mbox-buffer nil)
60 (defvoo nnbabyl-current-group nil)
61 (defvoo nnbabyl-status-string "")
62 (defvoo nnbabyl-group-alist nil)
63 (defvoo nnbabyl-active-timestamp nil)
65 (defvoo nnbabyl-previous-buffer-mode nil)
68 (autoload 'gnus-set-text-properties "gnus-ems"))
72 ;;; Interface functions
74 (nnoo-define-basics nnbabyl)
76 (deffoo nnbabyl-retrieve-headers (articles &optional group server fetch-old)
78 (set-buffer nntp-server-buffer)
80 (let ((number (length articles))
82 (delim (concat "^" nnbabyl-mail-delimiter))
83 article art-string start stop)
84 (nnbabyl-possibly-change-newsgroup group server)
85 (while (setq article (pop articles))
86 (setq art-string (nnbabyl-article-string article))
87 (set-buffer nnbabyl-mbox-buffer)
89 (when (or (search-forward art-string nil t)
90 (search-backward art-string nil t))
91 (unless (re-search-backward delim nil t)
92 (goto-char (point-min)))
93 (while (and (not (looking-at ".+:"))
94 (zerop (forward-line 1))))
96 (search-forward "\n\n" nil t)
97 (setq stop (1- (point)))
98 (set-buffer nntp-server-buffer)
100 (princ article (current-buffer))
101 (insert " Article retrieved.\n")
102 (insert-buffer-substring nnbabyl-mbox-buffer start stop)
103 (goto-char (point-max))
105 (and (numberp nnmail-large-newsgroup)
106 (> number nnmail-large-newsgroup)
107 (zerop (% (incf count) 20))
108 (nnheader-message 5 "nnbabyl: Receiving headers... %d%%"
109 (/ (* count 100) number))))
111 (and (numberp nnmail-large-newsgroup)
112 (> number nnmail-large-newsgroup)
113 (nnheader-message 5 "nnbabyl: Receiving headers...done"))
115 (set-buffer nntp-server-buffer)
116 (nnheader-fold-continuation-lines)
119 (deffoo nnbabyl-open-server (server &optional defs)
120 (nnoo-change-server 'nnbabyl server defs)
121 (nnbabyl-create-mbox)
123 ((not (file-exists-p nnbabyl-mbox-file))
124 (nnbabyl-close-server)
125 (nnheader-report 'nnbabyl "No such file: %s" nnbabyl-mbox-file))
126 ((file-directory-p nnbabyl-mbox-file)
127 (nnbabyl-close-server)
128 (nnheader-report 'nnbabyl "Not a regular file: %s" nnbabyl-mbox-file))
130 (nnheader-report 'nnbabyl "Opened server %s using mbox %s" server
134 (deffoo nnbabyl-close-server (&optional server)
135 ;; Restore buffer mode.
136 (when (and (nnbabyl-server-opened)
137 nnbabyl-previous-buffer-mode)
139 (set-buffer nnbabyl-mbox-buffer)
141 (caar nnbabyl-previous-buffer-mode)
142 (cdar nnbabyl-previous-buffer-mode))
143 (funcall (cdr nnbabyl-previous-buffer-mode))))
144 (nnoo-close-server 'nnbabyl server)
145 (setq nnbabyl-mbox-buffer nil)
148 (deffoo nnbabyl-server-opened (&optional server)
149 (and (nnoo-current-server-p 'nnbabyl server)
151 (buffer-name nnbabyl-mbox-buffer)
153 (buffer-name nntp-server-buffer)))
155 (deffoo nnbabyl-request-article (article &optional newsgroup server buffer)
156 (nnbabyl-possibly-change-newsgroup newsgroup server)
158 (set-buffer nnbabyl-mbox-buffer)
159 (goto-char (point-min))
160 (when (search-forward (nnbabyl-article-string article) nil t)
161 (let (start stop summary-line)
162 (unless (re-search-backward (concat "^" nnbabyl-mail-delimiter) nil t)
163 (goto-char (point-min))
165 (while (and (not (looking-at ".+:"))
166 (zerop (forward-line 1))))
168 (or (when (re-search-forward
169 (concat "^" nnbabyl-mail-delimiter) nil t)
172 (goto-char (point-max)))
174 (let ((nntp-server-buffer (or buffer nntp-server-buffer)))
175 (set-buffer nntp-server-buffer)
177 (insert-buffer-substring nnbabyl-mbox-buffer start stop)
178 (goto-char (point-min))
179 ;; If there is an EOOH header, then we have to remove some
180 ;; duplicated headers.
181 (setq summary-line (looking-at "Summary-line:"))
182 (when (search-forward "\n*** EOOH ***" nil t)
184 ;; The headers to be deleted are located before the
186 (delete-region (point-min) (progn (forward-line 1)
189 (delete-region (progn (beginning-of-line) (point))
190 (or (search-forward "\n\n" nil t)
192 (if (numberp article)
193 (cons nnbabyl-current-group article)
194 (nnbabyl-article-group-number)))))))
196 (deffoo nnbabyl-request-group (group &optional server dont-check)
197 (let ((active (cadr (assoc group nnbabyl-group-alist))))
201 (null (nnbabyl-possibly-change-newsgroup group server)))
202 (nnheader-report 'nnbabyl "No such group: %s" group))
204 (nnheader-report 'nnbabyl "Selected group %s" group)
205 (nnheader-insert ""))
207 (nnheader-report 'nnbabyl "Selected group %s" group)
208 (nnheader-insert "211 %d %d %d %s\n"
209 (1+ (- (cdr active) (car active)))
210 (car active) (cdr active) group))))))
212 (deffoo nnbabyl-request-scan (&optional group server)
213 (nnbabyl-possibly-change-newsgroup group server)
219 (set-buffer nnbabyl-mbox-buffer)
221 (file-name-directory nnbabyl-mbox-file)
225 (let ((in-buf (current-buffer)))
226 (goto-char (point-min))
227 (while (search-forward "\n\^_\n" nil t)
229 (set-buffer nnbabyl-mbox-buffer)
230 (goto-char (point-max))
231 (search-backward "\n\^_" nil t)
232 (goto-char (match-end 0))
233 (insert-buffer-substring in-buf)))
234 (nnmail-save-active nnbabyl-group-alist nnbabyl-active-file))))
236 (deffoo nnbabyl-close-group (group &optional server)
239 (deffoo nnbabyl-request-create-group (group &optional server args)
240 (nnmail-activate 'nnbabyl)
241 (unless (assoc group nnbabyl-group-alist)
242 (push (list group (cons 1 0))
244 (nnmail-save-active nnbabyl-group-alist nnbabyl-active-file))
247 (deffoo nnbabyl-request-list (&optional server)
249 (nnmail-find-file nnbabyl-active-file)
250 (setq nnbabyl-group-alist (nnmail-get-active))
253 (deffoo nnbabyl-request-newgroups (date &optional server)
254 (nnbabyl-request-list server))
256 (deffoo nnbabyl-request-list-newsgroups (&optional server)
257 (nnheader-report 'nnbabyl "nnbabyl: LIST NEWSGROUPS is not implemented."))
259 (deffoo nnbabyl-request-expire-articles
260 (articles newsgroup &optional server force)
261 (nnbabyl-possibly-change-newsgroup newsgroup server)
264 (nnmail-activate 'nnbabyl)
267 (set-buffer nnbabyl-mbox-buffer)
268 (gnus-set-text-properties (point-min) (point-max) nil)
269 (while (and articles is-old)
270 (goto-char (point-min))
271 (when (search-forward (nnbabyl-article-string (car articles)) nil t)
273 (nnmail-expired-article-p
276 (point) (progn (end-of-line) (point))) force))
278 (nnheader-message 5 "Deleting article %d in %s..."
279 (car articles) newsgroup)
280 (nnbabyl-delete-mail))
281 (push (car articles) rest)))
282 (setq articles (cdr articles)))
284 ;; Find the lowest active article in this group.
285 (let ((active (nth 1 (assoc newsgroup nnbabyl-group-alist))))
286 (goto-char (point-min))
287 (while (and (not (search-forward
288 (nnbabyl-article-string (car active)) nil t))
289 (<= (car active) (cdr active)))
290 (setcar active (1+ (car active)))
291 (goto-char (point-min))))
292 (nnmail-save-active nnbabyl-group-alist nnbabyl-active-file)
293 (nconc rest articles))))
295 (deffoo nnbabyl-request-move-article
296 (article group server accept-form &optional last)
297 (let ((buf (get-buffer-create " *nnbabyl move*"))
300 (nnbabyl-request-article article group server)
303 (insert-buffer-substring nntp-server-buffer)
304 (goto-char (point-min))
305 (while (re-search-forward
307 (save-excursion (search-forward "\n\n" nil t) (point)) t)
308 (delete-region (progn (beginning-of-line) (point))
309 (progn (forward-line 1) (point))))
310 (setq result (eval accept-form))
311 (kill-buffer (current-buffer))
314 (nnbabyl-possibly-change-newsgroup group server)
315 (set-buffer nnbabyl-mbox-buffer)
316 (goto-char (point-min))
317 (if (search-forward (nnbabyl-article-string article) nil t)
318 (nnbabyl-delete-mail))
319 (and last (save-buffer))))
322 (deffoo nnbabyl-request-accept-article (group &optional server last)
323 (nnbabyl-possibly-change-newsgroup group server)
324 (nnmail-check-syntax)
325 (let ((buf (current-buffer))
328 (nnmail-activate 'nnbabyl)
330 (goto-char (point-min))
331 (search-forward "\n\n" nil t)
334 (while (re-search-backward "^X-Gnus-Newsgroup: " beg t)
335 (delete-region (point) (progn (forward-line 1) (point)))))
336 (nnmail-cache-insert (nnmail-fetch-field "message-id"))
337 (setq result (car (nnbabyl-save-mail
339 (list (cons group (nnbabyl-active-number group)))
340 (nnmail-article-group 'nnbabyl-active-number)))))
341 (set-buffer nnbabyl-mbox-buffer)
342 (goto-char (point-max))
343 (search-backward "\n\^_")
344 (goto-char (match-end 0))
345 (insert-buffer-substring buf)
347 (nnmail-cache-insert (nnmail-fetch-field "message-id"))
349 (nnmail-save-active nnbabyl-group-alist nnbabyl-active-file))
352 (deffoo nnbabyl-request-replace-article (article group buffer)
353 (nnbabyl-possibly-change-newsgroup group)
355 (set-buffer nnbabyl-mbox-buffer)
356 (goto-char (point-min))
357 (if (not (search-forward (nnbabyl-article-string article) nil t))
359 (nnbabyl-delete-mail t t)
360 (insert-buffer-substring buffer)
364 (deffoo nnbabyl-request-delete-group (group &optional force server)
365 (nnbabyl-possibly-change-newsgroup group server)
366 ;; Delete all articles in GROUP.
368 () ; Don't delete the articles.
370 (set-buffer nnbabyl-mbox-buffer)
371 (goto-char (point-min))
372 ;; Delete all articles in this group.
373 (let ((ident (concat "\nX-Gnus-Newsgroup: " nnbabyl-current-group ":"))
375 (while (search-forward ident nil t)
377 (nnbabyl-delete-mail))
380 ;; Remove the group from all structures.
381 (setq nnbabyl-group-alist
382 (delq (assoc group nnbabyl-group-alist) nnbabyl-group-alist)
383 nnbabyl-current-group nil)
384 ;; Save the active file.
385 (nnmail-save-active nnbabyl-group-alist nnbabyl-active-file)
388 (deffoo nnbabyl-request-rename-group (group new-name &optional server)
389 (nnbabyl-possibly-change-newsgroup group server)
391 (set-buffer nnbabyl-mbox-buffer)
392 (goto-char (point-min))
393 (let ((ident (concat "\nX-Gnus-Newsgroup: " nnbabyl-current-group ":"))
394 (new-ident (concat "\nX-Gnus-Newsgroup: " new-name ":"))
396 (while (search-forward ident nil t)
397 (replace-match new-ident t t)
401 (let ((entry (assoc group nnbabyl-group-alist)))
402 (and entry (setcar entry new-name))
403 (setq nnbabyl-current-group nil)
404 ;; Save the new group alist.
405 (nnmail-save-active nnbabyl-group-alist nnbabyl-active-file)
409 ;;; Internal functions.
411 ;; If FORCE, delete article no matter how many X-Gnus-Newsgroup
412 ;; headers there are. If LEAVE-DELIM, don't delete the Unix mbox
414 (defun nnbabyl-delete-mail (&optional force leave-delim)
415 ;; Delete the current X-Gnus-Newsgroup line.
418 (progn (beginning-of-line) (point))
419 (progn (forward-line 1) (point))))
420 ;; Beginning of the article.
426 (unless (re-search-backward (concat "^" nnbabyl-mail-delimiter) nil t)
427 (goto-char (point-min))
429 (if leave-delim (progn (forward-line 1) (point))
430 (match-beginning 0)))
433 (or (and (re-search-forward (concat "^" nnbabyl-mail-delimiter)
437 (goto-char (point-min))
438 ;; Only delete the article if no other groups owns it as well.
439 (when (or force (not (re-search-forward "^X-Gnus-Newsgroup: " nil t)))
440 (delete-region (point-min) (point-max))))))
442 (defun nnbabyl-possibly-change-newsgroup (newsgroup &optional server)
444 (not (nnbabyl-server-opened server)))
445 (nnbabyl-open-server server))
446 (when (or (not nnbabyl-mbox-buffer)
447 (not (buffer-name nnbabyl-mbox-buffer)))
448 (save-excursion (nnbabyl-read-mbox)))
449 (unless nnbabyl-group-alist
450 (nnmail-activate 'nnbabyl))
452 (if (assoc newsgroup nnbabyl-group-alist)
453 (setq nnbabyl-current-group newsgroup)
454 (nnheader-report 'nnbabyl "No such group in file"))
457 (defun nnbabyl-article-string (article)
458 (if (numberp article)
459 (concat "\nX-Gnus-Newsgroup: " nnbabyl-current-group ":"
460 (int-to-string article) " ")
461 (concat "\nMessage-ID: " article)))
463 (defun nnbabyl-article-group-number ()
465 (goto-char (point-min))
466 (when (re-search-forward "^X-Gnus-Newsgroup: +\\([^:]+\\):\\([0-9]+\\) "
468 (cons (buffer-substring (match-beginning 1) (match-end 1))
470 (buffer-substring (match-beginning 2) (match-end 2)))))))
472 (defun nnbabyl-insert-lines ()
473 "Insert how many lines and chars there are in the body of the mail."
476 (goto-char (point-min))
477 (when (search-forward "\n\n" nil t)
478 ;; There may be an EOOH line here...
479 (when (looking-at "\\*\\*\\* EOOH \\*\\*\\*")
480 (search-forward "\n\n" nil t))
481 (setq chars (- (point-max) (point))
482 lines (max (- (count-lines (point) (point-max)) 1) 0))
483 ;; Move back to the end of the headers.
484 (goto-char (point-min))
485 (search-forward "\n\n" nil t)
488 (when (re-search-backward "^Lines: " nil t)
489 (delete-region (point) (progn (forward-line 1) (point)))))
490 (insert (format "Lines: %d\n" lines))
493 (defun nnbabyl-save-mail (group-art)
494 ;; Called narrowed to an article.
495 (nnbabyl-insert-lines)
496 (nnmail-insert-xref group-art)
497 (nnbabyl-insert-newsgroup-line group-art)
498 (run-hooks 'nnbabyl-prepare-save-mail-hook)
501 (defun nnbabyl-insert-newsgroup-line (group-art)
503 (goto-char (point-min))
504 (while (looking-at "From ")
505 (replace-match "Mail-from: From " t t)
507 ;; If there is a C-l at the beginning of the narrowed region, this
508 ;; isn't really a "save", but rather a "scan".
509 (goto-char (point-min))
510 (unless (looking-at "\^L")
512 (insert "\^L\n0, unseen,,\n*** EOOH ***\n")
513 (goto-char (point-max))
515 (when (search-forward "\n\n" nil t)
518 (insert (format "X-Gnus-Newsgroup: %s:%d %s\n"
519 (caar group-art) (cdar group-art)
520 (current-time-string)))
521 (setq group-art (cdr group-art))))
524 (defun nnbabyl-active-number (group)
525 ;; Find the next article number in GROUP.
526 (let ((active (cadr (assoc group nnbabyl-group-alist))))
528 (setcdr active (1+ (cdr active)))
529 ;; This group is new, so we create a new entry for it.
530 ;; This might be a bit naughty... creating groups on the drop of
531 ;; a hat, but I don't know...
532 (push (list group (setq active (cons 1 1)))
533 nnbabyl-group-alist))
536 (defun nnbabyl-create-mbox ()
537 (unless (file-exists-p nnbabyl-mbox-file)
538 ;; Create a new, empty RMAIL mbox file.
540 (set-buffer (setq nnbabyl-mbox-buffer
541 (create-file-buffer nnbabyl-mbox-file)))
542 (setq buffer-file-name nnbabyl-mbox-file)
543 (insert "BABYL OPTIONS:\n\n\^_")
545 (point-min) (point-max) nnbabyl-mbox-file t 'nomesg))))
547 (defun nnbabyl-read-mbox ()
548 (nnmail-activate 'nnbabyl)
549 (nnbabyl-create-mbox)
551 (unless (and nnbabyl-mbox-buffer
552 (buffer-name nnbabyl-mbox-buffer)
554 (set-buffer nnbabyl-mbox-buffer)
555 (= (buffer-size) (nnheader-file-size nnbabyl-mbox-file))))
556 ;; This buffer has changed since we read it last. Possibly.
558 (let ((delim (concat "^" nnbabyl-mail-delimiter))
559 (alist nnbabyl-group-alist)
561 (set-buffer (setq nnbabyl-mbox-buffer
562 (nnheader-find-file-noselect
563 nnbabyl-mbox-file nil 'raw)))
564 ;; Save previous buffer mode.
565 (setq nnbabyl-previous-buffer-mode
566 (cons (cons (point-min) (point-max))
569 (buffer-disable-undo (current-buffer))
571 (setq buffer-read-only nil)
574 ;; Go through the group alist and compare against
577 (goto-char (point-max))
578 (when (and (re-search-backward
579 (format "^X-Gnus-Newsgroup: %s:\\([0-9]+\\) "
585 (match-beginning 1) (match-end 1))))
587 (setcdr (cadar alist) number))
588 (setq alist (cdr alist)))
590 ;; We go through the mbox and make sure that each and
591 ;; every mail belongs to some group or other.
592 (goto-char (point-min))
593 (if (looking-at "\^L")
595 (re-search-forward delim nil t)
596 (setq start (match-end 0)))
597 (while (re-search-forward delim nil t)
598 (setq end (match-end 0))
599 (unless (search-backward "\nX-Gnus-Newsgroup: " start t)
603 (narrow-to-region (goto-char start) end)
605 (nnmail-article-group 'nnbabyl-active-number))
606 (setq end (point-max)))))
607 (goto-char (setq start end)))
608 (when (buffer-modified-p (current-buffer))
610 (nnmail-save-active nnbabyl-group-alist nnbabyl-active-file)))))
612 (defun nnbabyl-remove-incoming-delims ()
613 (goto-char (point-min))
614 (while (search-forward "\^_" nil t)
615 (replace-match "?" t t)))
617 (defun nnbabyl-check-mbox ()
618 "Go through the nnbabyl mbox and make sure that no article numbers are reused."
620 (let ((idents (make-vector 1000 0))
623 (when (or (not nnbabyl-mbox-buffer)
624 (not (buffer-name nnbabyl-mbox-buffer)))
626 (set-buffer nnbabyl-mbox-buffer)
627 (goto-char (point-min))
628 (while (re-search-forward "^X-Gnus-Newsgroup: \\([^ ]+\\) " nil t)
629 (if (intern-soft (setq id (match-string 1)) idents)
631 (delete-region (progn (beginning-of-line) (point))
632 (progn (forward-line 1) (point)))
633 (nnheader-message 7 "Moving %s..." id)
635 (nnmail-article-group 'nnbabyl-active-number)))
637 (when (buffer-modified-p (current-buffer))
639 (nnmail-save-active nnbabyl-group-alist nnbabyl-active-file)
644 ;;; nnbabyl.el ends here