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 fetch-old)
79 (set-buffer nntp-server-buffer)
81 (let ((number (length sequence))
83 article art-string start stop)
84 (nnbabyl-possibly-change-newsgroup newsgroup)
86 (setq article (car sequence))
87 (setq art-string (nnbabyl-article-string article))
88 (set-buffer nnbabyl-mbox-buffer)
89 (if (or (search-forward art-string nil t)
90 (search-backward art-string nil t))
92 (re-search-backward (concat "^" nnbabyl-mail-delimiter) nil t)
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)
99 (insert "221 " (int-to-string article) " Article retrieved.\n")
100 (insert-buffer-substring nnbabyl-mbox-buffer start stop)
101 (goto-char (point-max))
103 (setq sequence (cdr sequence))
104 (setq count (1+ count))
105 (and (numberp nnmail-large-newsgroup)
106 (> number nnmail-large-newsgroup)
108 gnus-verbose-backends
109 (message "nnbabyl: Receiving headers... %d%%"
110 (/ (* count 100) number))))
112 (and (numberp nnmail-large-newsgroup)
113 (> number nnmail-large-newsgroup)
114 gnus-verbose-backends
115 (message "nnbabyl: Receiving headers...done"))
117 ;; Fold continuation lines.
118 (set-buffer nntp-server-buffer)
119 (goto-char (point-min))
120 (while (re-search-forward "\\(\r?\n[ \t]+\\)+" nil t)
121 (replace-match " " t t))
124 (defun nnbabyl-open-server (server &optional defs)
125 (nnheader-init-server-buffer)
126 (if (equal server nnbabyl-current-server)
128 (if nnbabyl-current-server
129 (setq nnbabyl-server-alist
130 (cons (list nnbabyl-current-server
131 (nnheader-save-variables nnbabyl-server-variables))
132 nnbabyl-server-alist)))
133 (let ((state (assoc server nnbabyl-server-alist)))
136 (nnheader-restore-variables (nth 1 state))
137 (setq nnbabyl-server-alist (delq state nnbabyl-server-alist)))
138 (nnheader-set-init-variables nnbabyl-server-variables defs)))
139 (setq nnbabyl-current-server server)))
141 (defun nnbabyl-close-server (&optional server)
142 (setq nnbabyl-current-server nil)
145 (defun nnbabyl-server-opened (&optional server)
146 (and (equal server nnbabyl-current-server)
148 (buffer-name nnbabyl-mbox-buffer)
150 (buffer-name nntp-server-buffer)))
152 (defun nnbabyl-status-message (&optional server)
153 nnbabyl-status-string)
155 (defun nnbabyl-request-article (article &optional newsgroup server buffer)
156 (nnbabyl-possibly-change-newsgroup newsgroup)
158 (set-buffer nnbabyl-mbox-buffer)
159 (goto-char (point-min))
160 (if (search-forward (nnbabyl-article-string article) nil t)
161 (let (start stop summary-line)
162 (re-search-backward (concat "^" nnbabyl-mail-delimiter) nil t)
163 (while (and (not (looking-at ".+:"))
164 (zerop (forward-line 1))))
166 (or (and (re-search-forward
167 (concat "^" nnbabyl-mail-delimiter) nil t)
169 (goto-char (point-max)))
171 (let ((nntp-server-buffer (or buffer nntp-server-buffer)))
172 (set-buffer nntp-server-buffer)
174 (insert-buffer-substring nnbabyl-mbox-buffer start stop)
175 (goto-char (point-min))
176 ;; If there is an EOOH header, then we have to remove some
177 ;; duplicated headers.
178 (setq summary-line (looking-at "Summary-line:"))
179 (when (search-forward "\n*** EOOH ***" nil t)
181 ;; The headers to be deleted are located before the
183 (delete-region (point-min) (progn (forward-line 1)
186 (delete-region (progn (beginning-of-line) (point))
187 (or (search-forward "\n\n" nil t)
189 (if (numberp article)
190 (cons nnbabyl-current-group article)
191 (nnbabyl-article-group-number)))))))
193 (defun nnbabyl-request-group (group &optional server dont-check)
195 (if (nnbabyl-possibly-change-newsgroup group)
199 (set-buffer nntp-server-buffer)
201 (let ((active (assoc group nnbabyl-group-alist)))
202 (insert (format "211 %d %d %d %s\n"
203 (1+ (- (cdr (car (cdr active)))
204 (car (car (cdr active)))))
205 (car (car (cdr active)))
206 (cdr (car (cdr active)))
210 (defun nnbabyl-request-scan (&optional group server)
216 (set-buffer nnbabyl-mbox-buffer)
218 nnbabyl-mbox-file group
221 (let ((in-buf (current-buffer)))
222 (goto-char (point-min))
223 (while (search-forward "\n\^_\n" nil t)
225 (set-buffer nnbabyl-mbox-buffer)
226 (goto-char (point-max))
227 (search-backward "\n\^_" nil t)
228 (goto-char (match-end 0))
229 (insert-buffer-substring in-buf))))))
231 (defun nnbabyl-close-group (group &optional server)
234 (defun nnbabyl-request-create-group (group &optional server)
235 (nnmail-activate 'nnbabyl)
236 (or (assoc group nnbabyl-group-alist)
238 (setq nnbabyl-group-alist (cons (list group (setq active (cons 1 0)))
239 nnbabyl-group-alist))
240 (nnmail-save-active nnbabyl-group-alist nnbabyl-active-file)))
243 (defun nnbabyl-request-list (&optional server)
245 (or (nnmail-find-file nnbabyl-active-file)
247 (setq nnbabyl-group-alist (nnmail-get-active))
248 (nnmail-save-active nnbabyl-group-alist nnbabyl-active-file)
249 (nnmail-find-file nnbabyl-active-file)))))
251 (defun nnbabyl-request-newgroups (date &optional server)
252 (nnbabyl-request-list server))
254 (defun nnbabyl-request-list-newsgroups (&optional server)
255 (setq nnbabyl-status-string "nnbabyl: LIST NEWSGROUPS is not implemented.")
258 (defun nnbabyl-request-post (&optional server)
259 (mail-send-and-exit nil))
261 (defun nnbabyl-request-expire-articles
262 (articles newsgroup &optional server force)
263 (nnbabyl-possibly-change-newsgroup newsgroup)
264 (let* ((days (or (and nnmail-expiry-wait-function
265 (funcall nnmail-expiry-wait-function newsgroup))
269 (nnmail-activate 'nnbabyl)
272 (set-buffer nnbabyl-mbox-buffer)
273 (set-text-properties (point-min) (point-max) nil)
274 (while (and articles is-old)
275 (goto-char (point-min))
276 (if (search-forward (nnbabyl-article-string (car articles)) nil t)
279 (> (nnmail-days-between
280 (current-time-string)
282 (point) (progn (end-of-line) (point))))
285 (and gnus-verbose-backends
286 (message "Deleting article %d in %s..."
287 (car articles) newsgroup))
288 (nnbabyl-delete-mail))
289 (setq rest (cons (car articles) rest))))
290 (setq articles (cdr articles)))
292 ;; Find the lowest active article in this group.
293 (let ((active (nth 1 (assoc newsgroup nnbabyl-group-alist))))
294 (goto-char (point-min))
295 (while (and (not (search-forward
296 (nnbabyl-article-string (car active)) nil t))
297 (<= (car active) (cdr active)))
298 (setcar active (1+ (car active)))
299 (goto-char (point-min))))
300 (nnmail-save-active nnbabyl-group-alist nnbabyl-active-file)
301 (nconc rest articles))))
303 (defun nnbabyl-request-move-article
304 (article group server accept-form &optional last)
305 (nnbabyl-possibly-change-newsgroup group)
306 (let ((buf (get-buffer-create " *nnbabyl move*"))
309 (nnbabyl-request-article article group server)
312 (insert-buffer-substring nntp-server-buffer)
313 (goto-char (point-min))
314 (if (re-search-forward
316 (save-excursion (search-forward "\n\n" nil t) (point)) t)
317 (delete-region (progn (beginning-of-line) (point))
318 (progn (forward-line 1) (point))))
319 (setq result (eval accept-form))
320 (kill-buffer (current-buffer))
323 (set-buffer nnbabyl-mbox-buffer)
324 (goto-char (point-min))
325 (if (search-forward (nnbabyl-article-string article) nil t)
326 (nnbabyl-delete-mail))
327 (and last (save-buffer))))
330 (defun nnbabyl-request-accept-article (group &optional last)
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 (let ((nnmail-split-methods
343 (if (stringp group) (list (list group ""))
344 nnmail-split-methods)))
345 (setq result (car (nnbabyl-save-mail))))
346 (set-buffer nnbabyl-mbox-buffer)
347 (goto-char (point-max))
348 (search-backward "\n\^_")
349 (goto-char (match-end 0))
350 (insert-buffer-substring buf)
354 nnbabyl-group-alist nnbabyl-active-file)))
357 (defun nnbabyl-request-replace-article (article group buffer)
358 (nnbabyl-possibly-change-newsgroup group)
360 (set-buffer nnbabyl-mbox-buffer)
361 (goto-char (point-min))
362 (if (not (search-forward (nnbabyl-article-string article) nil t))
364 (nnbabyl-delete-mail t t)
365 (insert-buffer-substring buffer)
369 (defun nnbabyl-request-delete-group (group &optional force server)
370 (nnbabyl-possibly-change-newsgroup group)
371 ;; Delete all articles in GROUP.
373 () ; Don't delete the articles.
375 (set-buffer nnbabyl-mbox-buffer)
376 (goto-char (point-min))
377 ;; Delete all articles in this group.
378 (let ((ident (concat "\nX-Gnus-Newsgroup: " nnbabyl-current-group ":"))
380 (while (search-forward ident nil t)
382 (nnbabyl-delete-mail))
383 (and found (save-buffer)))))
384 ;; Remove the group from all structures.
385 (setq nnbabyl-group-alist
386 (delq (assoc group nnbabyl-group-alist) nnbabyl-group-alist)
387 nnbabyl-current-group nil)
388 ;; Save the active file.
389 (nnmail-save-active nnbabyl-group-alist nnbabyl-active-file)
392 (defun nnbabyl-request-rename-group (group new-name &optional server)
393 (nnbabyl-possibly-change-newsgroup group)
395 (set-buffer nnbabyl-mbox-buffer)
396 (goto-char (point-min))
397 (let ((ident (concat "\nX-Gnus-Newsgroup: " nnbabyl-current-group ":"))
398 (new-ident (concat "\nX-Gnus-Newsgroup: " new-name ":"))
400 (while (search-forward ident nil t)
401 (replace-match new-ident t t)
403 (and found (save-buffer))))
404 (let ((entry (assoc group nnbabyl-group-alist)))
405 (and entry (setcar entry new-name))
406 (setq nnbabyl-current-group nil)
407 ;; Save the new group alist.
408 (nnmail-save-active nnbabyl-group-alist nnbabyl-active-file)
412 ;;; Internal functions.
414 ;; If FORCE, delete article no matter how many X-Gnus-Newsgroup
415 ;; headers there are. If LEAVE-DELIM, don't delete the Unix mbox
417 (defun nnbabyl-delete-mail (&optional force leave-delim)
418 ;; Delete the current X-Gnus-Newsgroup line.
421 (progn (beginning-of-line) (point))
422 (progn (forward-line 1) (point))))
423 ;; Beginning of the article.
429 (re-search-backward (concat "^" nnbabyl-mail-delimiter) nil t)
430 (if leave-delim (progn (forward-line 1) (point))
431 (match-beginning 0)))
434 (or (and (re-search-forward (concat "^" nnbabyl-mail-delimiter)
436 (if (and (not (bobp)) leave-delim)
437 (progn (forward-line -2) (point))
438 (match-beginning 0)))
440 (goto-char (point-min))
441 ;; Only delete the article if no other groups owns it as well.
442 (if (or force (not (re-search-forward "^X-Gnus-Newsgroup: " nil t)))
443 (delete-region (point-min) (point-max))))))
445 (defun nnbabyl-possibly-change-newsgroup (newsgroup)
446 (if (or (not nnbabyl-mbox-buffer)
447 (not (buffer-name nnbabyl-mbox-buffer)))
448 (save-excursion (nnbabyl-read-mbox)))
449 (or nnbabyl-group-alist
450 (nnmail-activate 'nnbabyl))
452 (if (assoc newsgroup nnbabyl-group-alist)
453 (setq nnbabyl-current-group newsgroup)
454 (setq nnbabyl-status-string "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 (and (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 (if (search-forward "\n\n" nil t)
479 ;; There may be an EOOH line here...
480 (if (looking-at "\\*\\*\\* EOOH \\*\\*\\*")
481 (search-forward "\n\n" nil t))
482 (setq chars (- (point-max) (point)))
483 (setq lines (- (count-lines (point) (point-max)) 1))
484 ;; Move back to the end of the headers.
485 (goto-char (point-min))
486 (search-forward "\n\n" nil t)
489 (if (re-search-backward "^Lines: " nil t)
490 (delete-region (point) (progn (forward-line 1) (point)))))
491 (insert (format "Lines: %d\n" lines))
494 (defun nnbabyl-save-mail ()
495 ;; Called narrowed to an article.
496 (let ((group-art (nreverse (nnmail-article-group 'nnbabyl-active-number))))
497 (nnbabyl-insert-lines)
498 (nnmail-insert-xref group-art)
499 (nnbabyl-insert-newsgroup-line group-art)
500 (run-hooks 'nnbabyl-prepare-save-mail-hook)
503 (defun nnbabyl-insert-newsgroup-line (group-art)
505 (goto-char (point-min))
506 (while (looking-at "From ")
507 (replace-match "Mail-from: From " t t)
509 ;; If there is a C-l at the beginning of the narrowed region, this
510 ;; isn't really a "save", but rather a "scan".
511 (goto-char (point-min))
512 (or (looking-at "\^L")
514 (insert "\^L\n0, unseen,,\n*** EOOH ***\n")
515 (goto-char (point-max))
517 (if (search-forward "\n\n" nil t)
521 (insert (format "X-Gnus-Newsgroup: %s:%d %s\n"
522 (car (car group-art)) (cdr (car group-art))
523 (current-time-string)))
524 (setq group-art (cdr group-art)))))
527 (defun nnbabyl-active-number (group)
528 ;; Find the next article number in GROUP.
529 (let ((active (car (cdr (assoc group nnbabyl-group-alist)))))
531 (setcdr active (1+ (cdr active)))
532 ;; This group is new, so we create a new entry for it.
533 ;; This might be a bit naughty... creating groups on the drop of
534 ;; a hat, but I don't know...
535 (setq nnbabyl-group-alist (cons (list group (setq active (cons 1 1)))
536 nnbabyl-group-alist)))
539 (defun nnbabyl-read-mbox ()
540 (nnmail-activate 'nnbabyl)
541 (or (file-exists-p nnbabyl-mbox-file)
543 (set-buffer (setq nnbabyl-mbox-buffer
544 (create-file-buffer nnbabyl-mbox-file)))
545 (setq buffer-file-name nnbabyl-mbox-file)
546 (insert "BABYL OPTIONS:\n\n\^_")
547 (write-region (point-min) (point-max) nnbabyl-mbox-file t 'nomesg)))
549 (if (and nnbabyl-mbox-buffer
550 (buffer-name nnbabyl-mbox-buffer)
552 (set-buffer nnbabyl-mbox-buffer)
553 (= (buffer-size) (nth 7 (file-attributes nnbabyl-mbox-file)))))
556 (let ((delim (concat "^" nnbabyl-mail-delimiter))
558 (set-buffer (setq nnbabyl-mbox-buffer
559 (nnheader-find-file-noselect
560 nnbabyl-mbox-file nil 'raw)))
561 (buffer-disable-undo (current-buffer))
563 (setq buffer-read-only nil)
566 (goto-char (point-min))
567 (re-search-forward delim nil t)
568 (setq start (match-end 0))
569 (while (re-search-forward delim nil t)
570 (setq end (match-end 0))
571 (or (search-backward "\nX-Gnus-Newsgroup: " start t)
577 (narrow-to-region start end)
579 (setq end (point-max))))))
580 (goto-char (setq start end)))
581 (and (buffer-modified-p (current-buffer)) (save-buffer))
582 (nnmail-save-active nnbabyl-group-alist nnbabyl-active-file)))))
584 (defun nnbabyl-remove-incoming-delims ()
585 (goto-char (point-min))
586 (while (search-forward "\^_" nil t)
587 (replace-match "?" t t)))
591 ;;; nnbabyl.el ends here