1 ;;; nnbabyl.el --- rmail mbox access for Gnus
2 ;; Copyright (C) 1995 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
22 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
26 ;; For an overview of what the interface functions do, please see the
35 (defvar nnbabyl-mbox-file (expand-file-name "~/RMAIL")
36 "The name of the rmail box file in the users home directory.")
38 (defvar nnbabyl-active-file (expand-file-name "~/.rmail-active")
39 "The name of the active file for the rmail box.")
41 (defvar nnbabyl-get-new-mail t
42 "If non-nil, nnbabyl will check the incoming mail file and split the mail.")
44 (defvar nnbabyl-prepare-save-mail-hook nil
45 "Hook run narrowed to an article before saving.")
49 (defvar nnbabyl-mail-delimiter "\^_")
51 (defconst nnbabyl-version "nnbabyl 1.0"
54 (defvar nnbabyl-mbox-buffer nil)
55 (defvar nnbabyl-current-group nil)
56 (defvar nnbabyl-status-string "")
57 (defvar nnbabyl-group-alist nil)
58 (defvar nnbabyl-active-timestamp nil)
62 (defvar nnbabyl-current-server nil)
63 (defvar nnbabyl-server-alist nil)
64 (defvar nnbabyl-server-variables
66 (list 'nnbabyl-mbox-file nnbabyl-mbox-file)
67 (list 'nnbabyl-active-file nnbabyl-active-file)
68 (list 'nnbabyl-get-new-mail nnbabyl-get-new-mail)
69 '(nnbabyl-current-group nil)
70 '(nnbabyl-status-string "")
71 '(nnbabyl-group-alist nil)))
75 ;;; Interface functions
77 (defun nnbabyl-retrieve-headers (sequence &optional newsgroup server)
79 (set-buffer nntp-server-buffer)
81 (let ((number (length sequence))
83 article art-string start stop)
84 (nnbabyl-possibly-change-newsgroup newsgroup)
85 (if (stringp (car sequence))
88 (setq article (car sequence))
89 (setq art-string (nnbabyl-article-string article))
90 (set-buffer nnbabyl-mbox-buffer)
91 (if (or (search-forward art-string nil t)
92 (search-backward art-string nil t))
94 (re-search-backward (concat "^" nnbabyl-mail-delimiter) nil t)
95 (while (and (not (looking-at ".+:"))
96 (zerop (forward-line 1))))
98 (search-forward "\n\n" nil t)
99 (setq stop (1- (point)))
100 (set-buffer nntp-server-buffer)
101 (insert "221 " (int-to-string article) " Article retrieved.\n")
102 (insert-buffer-substring nnbabyl-mbox-buffer start stop)
103 (goto-char (point-max))
105 (setq sequence (cdr sequence))
106 (setq count (1+ count))
107 (and (numberp nnmail-large-newsgroup)
108 (> number nnmail-large-newsgroup)
110 gnus-verbose-backends
111 (message "nnbabyl: Receiving headers... %d%%"
112 (/ (* count 100) number))))
114 (and (numberp nnmail-large-newsgroup)
115 (> number nnmail-large-newsgroup)
116 gnus-verbose-backends
117 (message "nnbabyl: Receiving headers...done"))
119 ;; Fold continuation lines.
120 (set-buffer nntp-server-buffer)
121 (goto-char (point-min))
122 (while (re-search-forward "\\(\r?\n[ \t]+\\)+" nil t)
123 (replace-match " " t t))
126 (defun nnbabyl-open-server (server &optional defs)
127 (nnheader-init-server-buffer)
128 (if (equal server nnbabyl-current-server)
130 (if nnbabyl-current-server
131 (setq nnbabyl-server-alist
132 (cons (list nnbabyl-current-server
133 (nnheader-save-variables nnbabyl-server-variables))
134 nnbabyl-server-alist)))
135 (let ((state (assoc server nnbabyl-server-alist)))
138 (nnheader-restore-variables (nth 1 state))
139 (setq nnbabyl-server-alist (delq state nnbabyl-server-alist)))
140 (nnheader-set-init-variables nnbabyl-server-variables defs)))
141 (setq nnbabyl-current-server server)))
143 (defun nnbabyl-close-server (&optional server)
146 (defun nnbabyl-server-opened (&optional server)
147 (and (equal server nnbabyl-current-server)
149 (buffer-name nnbabyl-mbox-buffer)
151 (buffer-name nntp-server-buffer)))
153 (defun nnbabyl-status-message (&optional server)
154 nnbabyl-status-string)
156 (defun nnbabyl-request-article (article &optional newsgroup server buffer)
157 (nnbabyl-possibly-change-newsgroup newsgroup)
158 (if (stringp article)
161 (set-buffer nnbabyl-mbox-buffer)
162 (goto-char (point-min))
163 (if (search-forward (nnbabyl-article-string article) nil t)
165 (re-search-backward (concat "^" nnbabyl-mail-delimiter) nil t)
166 (while (and (not (looking-at ".+:"))
167 (zerop (forward-line 1))))
169 (or (and (re-search-forward
170 (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 (search-forward "\n*** EOOH ***" nil t)
181 (delete-region (progn (beginning-of-line) (point))
182 (or (search-forward "\n\n" nil t)
186 (defun nnbabyl-request-group (group &optional server dont-check)
188 (if (nnbabyl-possibly-change-newsgroup group)
191 (nnbabyl-get-new-mail group)
193 (set-buffer nntp-server-buffer)
195 (let ((active (assoc group nnbabyl-group-alist)))
196 (insert (format "211 %d %d %d %s\n"
197 (1+ (- (cdr (car (cdr active)))
198 (car (car (cdr active)))))
199 (car (car (cdr active)))
200 (cdr (car (cdr active)))
204 (defun nnbabyl-close-group (group &optional server)
207 (defun nnbabyl-request-create-group (group &optional server)
208 (nnmail-activate 'nnbabyl)
209 (or (assoc group nnbabyl-group-alist)
211 (setq nnbabyl-group-alist (cons (list group (setq active (cons 1 0)))
212 nnbabyl-group-alist))
213 (nnmail-save-active nnbabyl-group-alist nnbabyl-active-file)))
216 (defun nnbabyl-request-list (&optional server)
217 (if server (nnbabyl-get-new-mail))
219 (or (nnmail-find-file nnbabyl-active-file)
221 (setq nnbabyl-group-alist (nnmail-get-active))
222 (nnmail-save-active nnbabyl-group-alist nnbabyl-active-file)
223 (nnmail-find-file nnbabyl-active-file)))))
225 (defun nnbabyl-request-newgroups (date &optional server)
226 (nnbabyl-request-list server))
228 (defun nnbabyl-request-list-newsgroups (&optional server)
229 (setq nnbabyl-status-string "nnbabyl: LIST NEWSGROUPS is not implemented.")
232 (defun nnbabyl-request-post (&optional server)
233 (mail-send-and-exit nil))
235 (defalias 'nnbabyl-request-post-buffer 'nnmail-request-post-buffer)
237 (defun nnbabyl-request-expire-articles
238 (articles newsgroup &optional server force)
239 (nnbabyl-possibly-change-newsgroup newsgroup)
240 (let* ((days (or (and nnmail-expiry-wait-function
241 (funcall nnmail-expiry-wait-function newsgroup))
245 (nnmail-activate 'nnbabyl)
248 (set-buffer nnbabyl-mbox-buffer)
249 (while (and articles is-old)
250 (goto-char (point-min))
251 (if (search-forward (nnbabyl-article-string (car articles)) nil t)
254 (> (nnmail-days-between
255 (current-time-string)
257 (point) (progn (end-of-line) (point))))
260 (and gnus-verbose-backends
261 (message "Deleting article %s..." (car articles)))
262 (nnbabyl-delete-mail))
263 (setq rest (cons (car articles) rest))))
264 (setq articles (cdr articles)))
266 ;; Find the lowest active article in this group.
267 (let ((active (nth 1 (assoc newsgroup nnbabyl-group-alist))))
268 (goto-char (point-min))
269 (while (and (not (search-forward
270 (nnbabyl-article-string (car active)) nil t))
271 (<= (car active) (cdr active)))
272 (setcar active (1+ (car active)))
273 (goto-char (point-min))))
274 (nnmail-save-active nnbabyl-group-alist nnbabyl-active-file)
275 (nconc rest articles))))
277 (defun nnbabyl-request-move-article
278 (article group server accept-form &optional last)
279 (nnbabyl-possibly-change-newsgroup group)
280 (let ((buf (get-buffer-create " *nnbabyl move*"))
283 (nnbabyl-request-article article group server)
286 (insert-buffer-substring nntp-server-buffer)
287 (goto-char (point-min))
288 (if (re-search-forward
290 (save-excursion (search-forward "\n\n" nil t) (point)) t)
291 (delete-region (progn (beginning-of-line) (point))
292 (progn (forward-line 1) (point))))
293 (setq result (eval accept-form))
294 (kill-buffer (current-buffer))
297 (set-buffer nnbabyl-mbox-buffer)
298 (goto-char (point-min))
299 (if (search-forward (nnbabyl-article-string article) nil t)
300 (nnbabyl-delete-mail))
301 (and last (save-buffer))))
304 (defun nnbabyl-request-accept-article (group &optional last)
305 (let ((buf (current-buffer))
308 (nnmail-activate 'nnbabyl)
310 (goto-char (point-min))
311 (search-forward "\n\n" nil t)
314 (while (re-search-backward "^X-Gnus-Newsgroup: " beg t)
315 (delete-region (point) (progn (forward-line 1) (point)))))
316 (let ((nnmail-split-methods
317 (if (stringp group) (list (list group ""))
318 nnmail-split-methods)))
319 (setq result (car (nnbabyl-save-mail))))
320 (set-buffer nnbabyl-mbox-buffer)
321 (goto-char (point-max))
322 (search-backward "\n\^_")
323 (goto-char (match-end 0))
328 nnbabyl-group-alist nnbabyl-active-file)))
331 (defun nnbabyl-request-replace-article (article group buffer)
332 (nnbabyl-possibly-change-newsgroup group)
334 (set-buffer nnbabyl-mbox-buffer)
335 (goto-char (point-min))
336 (if (not (search-forward (nnbabyl-article-string article) nil t))
338 (nnbabyl-delete-mail t t)
339 (insert-buffer-substring buffer)
344 ;;; Low-Level Interface
346 ;; If FORCE, delete article no matter how many X-Gnus-Newsgroup
347 ;; headers there are. If LEAVE-DELIM, don't delete the Unix mbox
349 (defun nnbabyl-delete-mail (&optional force leave-delim)
350 ;; Delete the current X-Gnus-Newsgroup line.
353 (progn (beginning-of-line) (point))
354 (progn (forward-line 1) (point))))
355 ;; Beginning of the article.
361 (re-search-backward (concat "^" nnbabyl-mail-delimiter) nil t)
362 (if leave-delim (progn (forward-line 1) (point))
363 (match-beginning 0)))
366 (or (and (re-search-forward (concat "^" nnbabyl-mail-delimiter)
368 (if (and (not (bobp)) leave-delim)
369 (progn (forward-line -2) (point))
370 (match-beginning 0)))
372 (goto-char (point-min))
373 ;; Only delete the article if no other groups owns it as well.
374 (if (or force (not (re-search-forward "^X-Gnus-Newsgroup: " nil t)))
375 (delete-region (point-min) (point-max))))))
377 (defun nnbabyl-possibly-change-newsgroup (newsgroup)
378 (if (or (not nnbabyl-mbox-buffer)
379 (not (buffer-name nnbabyl-mbox-buffer)))
380 (save-excursion (nnbabyl-read-mbox)))
381 (or nnbabyl-group-alist
382 (nnmail-activate 'nnbabyl))
384 (if (assoc newsgroup nnbabyl-group-alist)
385 (setq nnbabyl-current-group newsgroup)
386 (setq nnbabyl-status-string "No such group in file")
389 (defun nnbabyl-article-string (article)
390 (concat "\nX-Gnus-Newsgroup: " nnbabyl-current-group ":"
391 (int-to-string article) " "))
393 (defun nnbabyl-insert-lines ()
394 "Insert how many lines and chars there are in the body of the mail."
397 (goto-char (point-min))
398 (if (search-forward "\n\n" nil t)
400 ;; There may be an EOOH line here...
401 (if (looking-at "\\*\\*\\* EOOH \\*\\*\\*")
402 (search-forward "\n\n" nil t))
403 (setq chars (- (point-max) (point)))
404 (setq lines (- (count-lines (point) (point-max)) 1))
405 ;; Move back to the end of the headers.
406 (goto-char (point-min))
407 (search-forward "\n\n" nil t)
410 (if (re-search-backward "^Lines: " nil t)
411 (delete-region (point) (progn (forward-line 1) (point)))))
412 (insert (format "Lines: %d\n" lines))
415 (defun nnbabyl-save-mail ()
416 ;; Called narrowed to an article.
417 (let ((group-art (nreverse (nnmail-article-group 'nnbabyl-active-number))))
418 (nnbabyl-insert-lines)
419 (nnmail-insert-xref group-art)
420 (nnbabyl-insert-newsgroup-line group-art)
421 (run-hooks 'nnbabyl-prepare-save-mail-hook)
424 (defun nnbabyl-insert-newsgroup-line (group-art)
426 (goto-char (point-min))
427 (while (looking-at "From ")
428 (replace-match "Mail-from: From " t t)
430 ;; If there is a C-l at the beginning of the narrowed region, this
431 ;; isn't really a "save", but rather a "scan".
432 (goto-char (point-min))
433 (or (looking-at "\^L")
435 (insert "\^L\n0, unseen,,\n*** EOOH ***\n")
436 (goto-char (point-max))
438 (if (search-forward "\n\n" nil t)
442 (insert (format "X-Gnus-Newsgroup: %s:%d %s\n"
443 (car (car group-art)) (cdr (car group-art))
444 (current-time-string)))
445 (setq group-art (cdr group-art)))))
448 (defun nnbabyl-active-number (group)
449 ;; Find the next article number in GROUP.
450 (let ((active (car (cdr (assoc group nnbabyl-group-alist)))))
452 (setcdr active (1+ (cdr active)))
453 ;; This group is new, so we create a new entry for it.
454 ;; This might be a bit naughty... creating groups on the drop of
455 ;; a hat, but I don't know...
456 (setq nnbabyl-group-alist (cons (list group (setq active (cons 1 1)))
457 nnbabyl-group-alist)))
460 (defun nnbabyl-read-mbox ()
461 (nnmail-activate 'nnbabyl)
462 (or (file-exists-p nnbabyl-mbox-file)
464 (set-buffer (setq nnbabyl-mbox-buffer
465 (create-file-buffer nnbabyl-mbox-file)))
466 (setq buffer-file-name nnbabyl-mbox-file)
467 (insert "BABYL OPTIONS:\n\n\^_")
468 (write-region (point-min) (point-max) nnbabyl-mbox-file t 'nomesg)))
470 (if (and nnbabyl-mbox-buffer
471 (buffer-name nnbabyl-mbox-buffer)
473 (set-buffer nnbabyl-mbox-buffer)
474 (= (buffer-size) (nth 7 (file-attributes nnbabyl-mbox-file)))))
477 (let ((delim (concat "^" nnbabyl-mail-delimiter))
479 (set-buffer (setq nnbabyl-mbox-buffer
480 (nnheader-find-file-noselect
481 nnbabyl-mbox-file nil 'raw)))
482 (buffer-disable-undo (current-buffer))
484 (goto-char (point-min))
485 (re-search-forward delim nil t)
486 (setq start (match-end 0))
487 (while (re-search-forward delim nil t)
488 (setq end (match-end 0))
489 (or (search-backward "\nX-Gnus-Newsgroup: " start t)
495 (narrow-to-region start end)
497 (setq end (point-max))))))
498 (goto-char (setq start end)))
499 (and (buffer-modified-p (current-buffer)) (save-buffer))
500 (nnmail-save-active nnbabyl-group-alist nnbabyl-active-file)))))
502 (defun nnbabyl-remove-incoming-delims ()
503 (goto-char (point-min))
504 (while (search-forward "\^_" nil t)
505 (replace-match "?" t t)))
507 (defun nnbabyl-get-new-mail (&optional group)
508 "Read new incoming mail."
509 (let* ((spools (nnmail-get-spool-files group))
513 (if (or (not nnbabyl-get-new-mail) (not nnmail-spool-file))
515 ;; We go through all the existing spool files and split the
519 (file-exists-p (car spools))
520 (> (nth 7 (file-attributes (car spools))) 0)
522 (and gnus-verbose-backends
523 (message "nnbabyl: Reading incoming mail..."))
526 (car spools) (concat nnbabyl-mbox-file "-Incoming")))
527 (setq incomings (cons incoming incomings))
529 (setq group (nnmail-get-split-group (car spools) group-in))
530 (let* ((nnmail-prepare-incoming-hook
531 (cons 'nnbabyl-remove-incoming-delims
532 nnmail-prepare-incoming-hook))
534 (setq in-buf (nnmail-split-incoming
535 incoming 'nnbabyl-save-mail t group))
537 (goto-char (point-min))
538 (while (search-forward "\n\^_\n" nil t)
540 (set-buffer nnbabyl-mbox-buffer)
541 (goto-char (point-max))
542 (search-backward "\n\^_" nil t)
543 (goto-char (match-end 0))
544 (insert-buffer-substring in-buf)
545 (kill-buffer in-buf)))))
546 (setq spools (cdr spools)))
547 ;; If we did indeed read any incoming spools, we save all info.
548 (and (buffer-modified-p nnbabyl-mbox-buffer)
550 (nnmail-save-active nnbabyl-group-alist nnbabyl-active-file)
551 (set-buffer nnbabyl-mbox-buffer)
553 (if incomings (run-hooks 'nnmail-read-incoming-hook))
555 (setq incoming (car incomings))
556 (and nnmail-delete-incoming
557 (file-exists-p incoming)
558 (file-writable-p incoming)
559 (delete-file incoming))
560 (setq incomings (cdr incomings))))))
564 ;;; nnbabyl.el ends here