1 ;;; nnbabyl.el --- rmail mbox access for Gnus
2 ;; Copyright (C) 1995,96 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 (re-search-backward delim nil t)
92 (while (and (not (looking-at ".+:"))
93 (zerop (forward-line 1))))
95 (search-forward "\n\n" nil t)
96 (setq stop (1- (point)))
97 (set-buffer nntp-server-buffer)
99 (princ article (current-buffer))
100 (insert " Article retrieved.\n")
101 (insert-buffer-substring nnbabyl-mbox-buffer start stop)
102 (goto-char (point-max))
104 (and (numberp nnmail-large-newsgroup)
105 (> number nnmail-large-newsgroup)
106 (zerop (% (incf count) 20))
107 (nnheader-message 5 "nnbabyl: Receiving headers... %d%%"
108 (/ (* count 100) number))))
110 (and (numberp nnmail-large-newsgroup)
111 (> number nnmail-large-newsgroup)
112 (nnheader-message 5 "nnbabyl: Receiving headers...done"))
114 (set-buffer nntp-server-buffer)
115 (nnheader-fold-continuation-lines)
118 (deffoo nnbabyl-open-server (server &optional defs)
119 (nnoo-change-server 'nnbabyl server defs)
121 ((not (file-exists-p nnbabyl-mbox-file))
122 (nnbabyl-close-server)
123 (nnheader-report 'nnbabyl "No such file: %s" nnbabyl-mbox-file))
124 ((file-directory-p nnbabyl-mbox-file)
125 (nnbabyl-close-server)
126 (nnheader-report 'nnbabyl "Not a regular file: %s" nnbabyl-mbox-file))
128 (nnheader-report 'nnbabyl "Opened server %s using mbox %s" server
132 (deffoo nnbabyl-close-server (&optional server)
133 ;; Restore buffer mode.
134 (when (and (nnbabyl-server-opened)
135 nnbabyl-previous-buffer-mode)
137 (set-buffer nnbabyl-mbox-buffer)
139 (caar nnbabyl-previous-buffer-mode)
140 (cdar nnbabyl-previous-buffer-mode))
141 (funcall (cdr nnbabyl-previous-buffer-mode))))
142 (nnoo-close-server 'nnbabyl server)
143 (setq nnbabyl-mbox-buffer nil)
146 (deffoo nnbabyl-server-opened (&optional server)
147 (and (nnoo-current-server-p 'nnbabyl server)
149 (buffer-name nnbabyl-mbox-buffer)
151 (buffer-name nntp-server-buffer)))
153 (deffoo nnbabyl-request-article (article &optional newsgroup server buffer)
154 (nnbabyl-possibly-change-newsgroup newsgroup server)
156 (set-buffer nnbabyl-mbox-buffer)
157 (goto-char (point-min))
158 (when (search-forward (nnbabyl-article-string article) nil t)
159 (let (start stop summary-line)
160 (re-search-backward (concat "^" nnbabyl-mail-delimiter) nil t)
161 (while (and (not (looking-at ".+:"))
162 (zerop (forward-line 1))))
164 (or (when (re-search-forward
165 (concat "^" nnbabyl-mail-delimiter) nil t)
168 (goto-char (point-max)))
170 (let ((nntp-server-buffer (or buffer nntp-server-buffer)))
171 (set-buffer nntp-server-buffer)
173 (insert-buffer-substring nnbabyl-mbox-buffer start stop)
174 (goto-char (point-min))
175 ;; If there is an EOOH header, then we have to remove some
176 ;; duplicated headers.
177 (setq summary-line (looking-at "Summary-line:"))
178 (when (search-forward "\n*** EOOH ***" nil t)
180 ;; The headers to be deleted are located before the
182 (delete-region (point-min) (progn (forward-line 1)
185 (delete-region (progn (beginning-of-line) (point))
186 (or (search-forward "\n\n" nil t)
188 (if (numberp article)
189 (cons nnbabyl-current-group article)
190 (nnbabyl-article-group-number)))))))
192 (deffoo nnbabyl-request-group (group &optional server dont-check)
193 (let ((active (cadr (assoc group nnbabyl-group-alist))))
197 (null (nnbabyl-possibly-change-newsgroup group server)))
198 (nnheader-report 'nnbabyl "No such group: %s" group))
200 (nnheader-report 'nnbabyl "Selected group %s" group)
201 (nnheader-insert ""))
203 (nnheader-report 'nnbabyl "Selected group %s" group)
204 (nnheader-insert "211 %d %d %d %s\n"
205 (1+ (- (cdr active) (car active)))
206 (car active) (cdr active) group))))))
208 (deffoo nnbabyl-request-scan (&optional group server)
209 (nnbabyl-possibly-change-newsgroup group server)
215 (set-buffer nnbabyl-mbox-buffer)
217 nnbabyl-mbox-file group
220 (let ((in-buf (current-buffer)))
221 (goto-char (point-min))
222 (while (search-forward "\n\^_\n" nil t)
224 (set-buffer nnbabyl-mbox-buffer)
225 (goto-char (point-max))
226 (search-backward "\n\^_" nil t)
227 (goto-char (match-end 0))
228 (insert-buffer-substring in-buf)))
229 (nnmail-save-active nnbabyl-group-alist nnbabyl-active-file))))
231 (deffoo nnbabyl-close-group (group &optional server)
234 (deffoo nnbabyl-request-create-group (group &optional server args)
235 (nnmail-activate 'nnbabyl)
236 (unless (assoc group nnbabyl-group-alist)
237 (push (list group (cons 1 0))
239 (nnmail-save-active nnbabyl-group-alist nnbabyl-active-file))
242 (deffoo nnbabyl-request-list (&optional server)
244 (nnmail-find-file nnbabyl-active-file)
245 (setq nnbabyl-group-alist (nnmail-get-active))))
247 (deffoo nnbabyl-request-newgroups (date &optional server)
248 (nnbabyl-request-list server))
250 (deffoo nnbabyl-request-list-newsgroups (&optional server)
251 (nnheader-report 'nnbabyl "nnbabyl: LIST NEWSGROUPS is not implemented."))
253 (deffoo nnbabyl-request-expire-articles
254 (articles newsgroup &optional server force)
255 (nnbabyl-possibly-change-newsgroup newsgroup server)
258 (nnmail-activate 'nnbabyl)
261 (set-buffer nnbabyl-mbox-buffer)
262 (gnus-set-text-properties (point-min) (point-max) nil)
263 (while (and articles is-old)
264 (goto-char (point-min))
265 (when (search-forward (nnbabyl-article-string (car articles)) nil t)
267 (nnmail-expired-article-p
270 (point) (progn (end-of-line) (point))) force))
272 (nnheader-message 5 "Deleting article %d in %s..."
273 (car articles) newsgroup)
274 (nnbabyl-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 nnbabyl-group-alist))))
280 (goto-char (point-min))
281 (while (and (not (search-forward
282 (nnbabyl-article-string (car active)) nil t))
283 (<= (car active) (cdr active)))
284 (setcar active (1+ (car active)))
285 (goto-char (point-min))))
286 (nnmail-save-active nnbabyl-group-alist nnbabyl-active-file)
287 (nconc rest articles))))
289 (deffoo nnbabyl-request-move-article
290 (article group server accept-form &optional last)
291 (let ((buf (get-buffer-create " *nnbabyl move*"))
294 (nnbabyl-request-article article group server)
297 (insert-buffer-substring nntp-server-buffer)
298 (goto-char (point-min))
299 (while (re-search-forward
301 (save-excursion (search-forward "\n\n" nil t) (point)) t)
302 (delete-region (progn (beginning-of-line) (point))
303 (progn (forward-line 1) (point))))
304 (setq result (eval accept-form))
305 (kill-buffer (current-buffer))
308 (nnbabyl-possibly-change-newsgroup group server)
309 (set-buffer nnbabyl-mbox-buffer)
310 (goto-char (point-min))
311 (if (search-forward (nnbabyl-article-string article) nil t)
312 (nnbabyl-delete-mail))
313 (and last (save-buffer))))
316 (deffoo nnbabyl-request-accept-article (group &optional server last)
317 (nnbabyl-possibly-change-newsgroup group server)
318 (nnmail-check-syntax)
319 (let ((buf (current-buffer))
322 (nnmail-activate 'nnbabyl)
324 (goto-char (point-min))
325 (search-forward "\n\n" nil t)
328 (while (re-search-backward "^X-Gnus-Newsgroup: " beg t)
329 (delete-region (point) (progn (forward-line 1) (point)))))
330 (setq result (car (nnbabyl-save-mail
332 (list (cons group (nnbabyl-active-number group)))
333 (nnmail-article-group 'nnbabyl-active-number)))))
334 (set-buffer nnbabyl-mbox-buffer)
335 (goto-char (point-max))
336 (search-backward "\n\^_")
337 (goto-char (match-end 0))
338 (insert-buffer-substring buf)
341 (nnmail-save-active nnbabyl-group-alist nnbabyl-active-file))
344 (deffoo nnbabyl-request-replace-article (article group buffer)
345 (nnbabyl-possibly-change-newsgroup group)
347 (set-buffer nnbabyl-mbox-buffer)
348 (goto-char (point-min))
349 (if (not (search-forward (nnbabyl-article-string article) nil t))
351 (nnbabyl-delete-mail t t)
352 (insert-buffer-substring buffer)
356 (deffoo nnbabyl-request-delete-group (group &optional force server)
357 (nnbabyl-possibly-change-newsgroup group server)
358 ;; Delete all articles in GROUP.
360 () ; Don't delete the articles.
362 (set-buffer nnbabyl-mbox-buffer)
363 (goto-char (point-min))
364 ;; Delete all articles in this group.
365 (let ((ident (concat "\nX-Gnus-Newsgroup: " nnbabyl-current-group ":"))
367 (while (search-forward ident nil t)
369 (nnbabyl-delete-mail))
372 ;; Remove the group from all structures.
373 (setq nnbabyl-group-alist
374 (delq (assoc group nnbabyl-group-alist) nnbabyl-group-alist)
375 nnbabyl-current-group nil)
376 ;; Save the active file.
377 (nnmail-save-active nnbabyl-group-alist nnbabyl-active-file)
380 (deffoo nnbabyl-request-rename-group (group new-name &optional server)
381 (nnbabyl-possibly-change-newsgroup group server)
383 (set-buffer nnbabyl-mbox-buffer)
384 (goto-char (point-min))
385 (let ((ident (concat "\nX-Gnus-Newsgroup: " nnbabyl-current-group ":"))
386 (new-ident (concat "\nX-Gnus-Newsgroup: " new-name ":"))
388 (while (search-forward ident nil t)
389 (replace-match new-ident t t)
393 (let ((entry (assoc group nnbabyl-group-alist)))
394 (and entry (setcar entry new-name))
395 (setq nnbabyl-current-group nil)
396 ;; Save the new group alist.
397 (nnmail-save-active nnbabyl-group-alist nnbabyl-active-file)
401 ;;; Internal functions.
403 ;; If FORCE, delete article no matter how many X-Gnus-Newsgroup
404 ;; headers there are. If LEAVE-DELIM, don't delete the Unix mbox
406 (defun nnbabyl-delete-mail (&optional force leave-delim)
407 ;; Delete the current X-Gnus-Newsgroup line.
410 (progn (beginning-of-line) (point))
411 (progn (forward-line 1) (point))))
412 ;; Beginning of the article.
418 (re-search-backward (concat "^" nnbabyl-mail-delimiter) nil t)
419 (if leave-delim (progn (forward-line 1) (point))
420 (match-beginning 0)))
423 (or (and (re-search-forward (concat "^" nnbabyl-mail-delimiter)
427 (goto-char (point-min))
428 ;; Only delete the article if no other groups owns it as well.
429 (when (or force (not (re-search-forward "^X-Gnus-Newsgroup: " nil t)))
430 (delete-region (point-min) (point-max))))))
432 (defun nnbabyl-possibly-change-newsgroup (newsgroup &optional server)
434 (not (nnbabyl-server-opened server)))
435 (nnbabyl-open-server server))
436 (when (or (not nnbabyl-mbox-buffer)
437 (not (buffer-name nnbabyl-mbox-buffer)))
438 (save-excursion (nnbabyl-read-mbox)))
439 (unless nnbabyl-group-alist
440 (nnmail-activate 'nnbabyl))
442 (if (assoc newsgroup nnbabyl-group-alist)
443 (setq nnbabyl-current-group newsgroup)
444 (nnheader-report 'nnbabyl "No such group in file"))
447 (defun nnbabyl-article-string (article)
448 (if (numberp article)
449 (concat "\nX-Gnus-Newsgroup: " nnbabyl-current-group ":"
450 (int-to-string article) " ")
451 (concat "\nMessage-ID: " article)))
453 (defun nnbabyl-article-group-number ()
455 (goto-char (point-min))
456 (when (re-search-forward "^X-Gnus-Newsgroup: +\\([^:]+\\):\\([0-9]+\\) "
458 (cons (buffer-substring (match-beginning 1) (match-end 1))
460 (buffer-substring (match-beginning 2) (match-end 2)))))))
462 (defun nnbabyl-insert-lines ()
463 "Insert how many lines and chars there are in the body of the mail."
466 (goto-char (point-min))
467 (when (search-forward "\n\n" nil t)
468 ;; There may be an EOOH line here...
469 (when (looking-at "\\*\\*\\* EOOH \\*\\*\\*")
470 (search-forward "\n\n" nil t))
471 (setq chars (- (point-max) (point))
472 lines (max (- (count-lines (point) (point-max)) 1) 0))
473 ;; Move back to the end of the headers.
474 (goto-char (point-min))
475 (search-forward "\n\n" nil t)
478 (when (re-search-backward "^Lines: " nil t)
479 (delete-region (point) (progn (forward-line 1) (point)))))
480 (insert (format "Lines: %d\n" lines))
483 (defun nnbabyl-save-mail (group-art)
484 ;; Called narrowed to an article.
485 (nnbabyl-insert-lines)
486 (nnmail-insert-xref group-art)
487 (nnbabyl-insert-newsgroup-line group-art)
488 (run-hooks 'nnbabyl-prepare-save-mail-hook)
491 (defun nnbabyl-insert-newsgroup-line (group-art)
493 (goto-char (point-min))
494 (while (looking-at "From ")
495 (replace-match "Mail-from: From " t t)
497 ;; If there is a C-l at the beginning of the narrowed region, this
498 ;; isn't really a "save", but rather a "scan".
499 (goto-char (point-min))
500 (unless (looking-at "\^L")
502 (insert "\^L\n0, unseen,,\n*** EOOH ***\n")
503 (goto-char (point-max))
505 (when (search-forward "\n\n" nil t)
508 (insert (format "X-Gnus-Newsgroup: %s:%d %s\n"
509 (caar group-art) (cdar group-art)
510 (current-time-string)))
511 (setq group-art (cdr group-art))))
514 (defun nnbabyl-active-number (group)
515 ;; Find the next article number in GROUP.
516 (let ((active (cadr (assoc group nnbabyl-group-alist))))
518 (setcdr active (1+ (cdr active)))
519 ;; This group is new, so we create a new entry for it.
520 ;; This might be a bit naughty... creating groups on the drop of
521 ;; a hat, but I don't know...
522 (push (list group (setq active (cons 1 1)))
523 nnbabyl-group-alist))
526 (defun nnbabyl-read-mbox ()
527 (nnmail-activate 'nnbabyl)
528 (unless (file-exists-p nnbabyl-mbox-file)
529 ;; Create a new, empty RMAIL mbox file.
531 (set-buffer (setq nnbabyl-mbox-buffer
532 (create-file-buffer nnbabyl-mbox-file)))
533 (setq buffer-file-name nnbabyl-mbox-file)
534 (insert "BABYL OPTIONS:\n\n\^_")
536 (point-min) (point-max) nnbabyl-mbox-file t 'nomesg)))
538 (if (and nnbabyl-mbox-buffer
539 (buffer-name nnbabyl-mbox-buffer)
541 (set-buffer nnbabyl-mbox-buffer)
542 (= (buffer-size) (nnheader-file-size nnbabyl-mbox-file))))
543 () ; This buffer hasn't changed since we read it last. Possibly.
545 (let ((delim (concat "^" nnbabyl-mail-delimiter))
546 (alist nnbabyl-group-alist)
548 (set-buffer (setq nnbabyl-mbox-buffer
549 (nnheader-find-file-noselect
550 nnbabyl-mbox-file nil 'raw)))
551 ;; Save previous buffer mode.
552 (setq nnbabyl-previous-buffer-mode
553 (cons (cons (point-min) (point-max))
556 (buffer-disable-undo (current-buffer))
558 (setq buffer-read-only nil)
561 ;; Go through the group alist and compare against
564 (goto-char (point-max))
565 (when (and (re-search-backward
566 (format "^X-Gnus-Newsgroup: %s:\\([0-9]+\\) "
572 (match-beginning 1) (match-end 1))))
574 (setcdr (cadar alist) (1+ number)))
575 (setq alist (cdr alist)))
577 ;; We go through the mbox and make sure that each and
578 ;; every mail belongs to some group or other.
579 (goto-char (point-min))
580 (re-search-forward delim nil t)
581 (setq start (match-end 0))
582 (while (re-search-forward delim nil t)
583 (setq end (match-end 0))
584 (unless (search-backward "\nX-Gnus-Newsgroup: " start t)
588 (narrow-to-region (goto-char start) end)
590 (nnmail-article-group 'nnbabyl-active-number))
591 (setq end (point-max)))))
592 (goto-char (setq start end)))
593 (when (buffer-modified-p (current-buffer))
595 (nnmail-save-active nnbabyl-group-alist nnbabyl-active-file)))))
597 (defun nnbabyl-remove-incoming-delims ()
598 (goto-char (point-min))
599 (while (search-forward "\^_" nil t)
600 (replace-match "?" t t)))
602 (defun nnbabyl-check-mbox ()
603 "Go through the nnbabyl mbox and make sure that no article numbers are reused."
605 (let ((idents (make-vector 1000 0))
608 (when (or (not nnbabyl-mbox-buffer)
609 (not (buffer-name nnbabyl-mbox-buffer)))
611 (set-buffer nnbabyl-mbox-buffer)
612 (goto-char (point-min))
613 (while (re-search-forward "^X-Gnus-Newsgroup: \\([^ ]+\\) " nil t)
614 (if (intern-soft (setq id (match-string 1)) idents)
616 (delete-region (progn (beginning-of-line) (point))
617 (progn (forward-line 1) (point)))
618 (nnheader-message 7 "Moving %s..." id)
620 (nnmail-article-group 'nnbabyl-active-number)))
622 (when (buffer-modified-p (current-buffer))
624 (nnmail-save-active nnbabyl-group-alist nnbabyl-active-file)
629 ;;; nnbabyl.el ends here