1 ;;; nnbabyl.el --- rmail mbox access for Gnus
3 ;; Copyright (C) 1995, 1996, 1997, 1998, 1099, 2000, 2001, 2002, 2003,
4 ;; 2004, 2005, 2006, 2007, 2008 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 3 of the License, or
15 ;; (at your option) any later version.
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. If not, see <http://www.gnu.org/licenses/>.
27 ;; For an overview of what the interface functions do, please see the
36 5 "Ignore rmail errors from this file, you don't have rmail")))
39 (eval-when-compile (require 'cl))
41 (nnoo-declare nnbabyl)
43 (defvoo nnbabyl-mbox-file (expand-file-name "~/RMAIL")
44 "The name of the rmail box file in the users home directory.")
46 (defvoo nnbabyl-active-file (expand-file-name "~/.rmail-active")
47 "The name of the active file for the rmail box.")
49 (defvoo nnbabyl-get-new-mail t
50 "If non-nil, nnbabyl will check the incoming mail file and split the mail.")
53 (defvoo nnbabyl-prepare-save-mail-hook nil
54 "Hook run narrowed to an article before saving.")
58 (defvar nnbabyl-mail-delimiter "\^_")
60 (defconst nnbabyl-version "nnbabyl 1.0"
63 (defvoo nnbabyl-mbox-buffer nil)
64 (defvoo nnbabyl-current-group nil)
65 (defvoo nnbabyl-status-string "")
66 (defvoo nnbabyl-group-alist nil)
67 (defvoo nnbabyl-active-timestamp nil)
69 (defvoo nnbabyl-previous-buffer-mode nil)
73 ;;; Interface functions
75 (nnoo-define-basics nnbabyl)
77 (deffoo nnbabyl-retrieve-headers (articles &optional group server fetch-old)
79 (set-buffer nntp-server-buffer)
81 (let ((number (length articles))
83 (delim (concat "^" nnbabyl-mail-delimiter))
84 article art-string start stop)
85 (nnbabyl-possibly-change-newsgroup group server)
86 (while (setq article (pop articles))
87 (setq art-string (nnbabyl-article-string article))
88 (set-buffer nnbabyl-mbox-buffer)
90 (when (or (search-forward art-string nil t)
91 (search-backward art-string nil t))
92 (unless (re-search-backward delim nil t)
93 (goto-char (point-min)))
94 (while (and (not (looking-at ".+:"))
95 (zerop (forward-line 1))))
97 (search-forward "\n\n" nil t)
98 (setq stop (1- (point)))
99 (set-buffer nntp-server-buffer)
101 (princ article (current-buffer))
102 (insert " Article retrieved.\n")
103 (insert-buffer-substring nnbabyl-mbox-buffer start stop)
104 (goto-char (point-max))
106 (and (numberp nnmail-large-newsgroup)
107 (> number nnmail-large-newsgroup)
108 (zerop (% (incf count) 20))
109 (nnheader-message 5 "nnbabyl: Receiving headers... %d%%"
110 (/ (* count 100) number))))
112 (and (numberp nnmail-large-newsgroup)
113 (> number nnmail-large-newsgroup)
114 (nnheader-message 5 "nnbabyl: Receiving headers...done"))
116 (set-buffer nntp-server-buffer)
117 (nnheader-fold-continuation-lines)
120 (deffoo nnbabyl-open-server (server &optional defs)
121 (nnoo-change-server 'nnbabyl server defs)
122 (nnbabyl-create-mbox)
124 ((not (file-exists-p nnbabyl-mbox-file))
125 (nnbabyl-close-server)
126 (nnheader-report 'nnbabyl "No such file: %s" nnbabyl-mbox-file))
127 ((file-directory-p nnbabyl-mbox-file)
128 (nnbabyl-close-server)
129 (nnheader-report 'nnbabyl "Not a regular file: %s" nnbabyl-mbox-file))
131 (nnheader-report 'nnbabyl "Opened server %s using mbox %s" server
135 (deffoo nnbabyl-close-server (&optional server)
136 ;; Restore buffer mode.
137 (when (and (nnbabyl-server-opened)
138 nnbabyl-previous-buffer-mode)
140 (set-buffer nnbabyl-mbox-buffer)
142 (caar nnbabyl-previous-buffer-mode)
143 (cdar nnbabyl-previous-buffer-mode))
144 (funcall (cdr nnbabyl-previous-buffer-mode))))
145 (nnoo-close-server 'nnbabyl server)
146 (setq nnbabyl-mbox-buffer nil)
149 (deffoo nnbabyl-server-opened (&optional server)
150 (and (nnoo-current-server-p 'nnbabyl server)
152 (buffer-name nnbabyl-mbox-buffer)
154 (buffer-name nntp-server-buffer)))
156 (deffoo nnbabyl-request-article (article &optional newsgroup server buffer)
157 (nnbabyl-possibly-change-newsgroup newsgroup server)
159 (set-buffer nnbabyl-mbox-buffer)
160 (goto-char (point-min))
161 (when (search-forward (nnbabyl-article-string article) nil t)
162 (let (start stop summary-line)
163 (unless (re-search-backward (concat "^" nnbabyl-mail-delimiter) nil t)
164 (goto-char (point-min))
166 (while (and (not (looking-at ".+:"))
167 (zerop (forward-line 1))))
169 (or (when (re-search-forward
170 (concat "^" nnbabyl-mail-delimiter) nil t)
173 (goto-char (point-max)))
175 (let ((nntp-server-buffer (or buffer nntp-server-buffer)))
176 (set-buffer nntp-server-buffer)
178 (insert-buffer-substring nnbabyl-mbox-buffer start stop)
179 (goto-char (point-min))
180 ;; If there is an EOOH header, then we have to remove some
181 ;; duplicated headers.
182 (setq summary-line (looking-at "Summary-line:"))
183 (when (search-forward "\n*** EOOH ***" nil t)
185 ;; The headers to be deleted are located before the
187 (delete-region (point-min) (progn (forward-line 1)
190 (delete-region (progn (beginning-of-line) (point))
191 (or (search-forward "\n\n" nil t)
193 (if (numberp article)
194 (cons nnbabyl-current-group article)
195 (nnbabyl-article-group-number)))))))
197 (deffoo nnbabyl-request-group (group &optional server dont-check)
198 (let ((active (cadr (assoc group nnbabyl-group-alist))))
202 (null (nnbabyl-possibly-change-newsgroup group server)))
203 (nnheader-report 'nnbabyl "No such group: %s" group))
205 (nnheader-report 'nnbabyl "Selected group %s" group)
206 (nnheader-insert ""))
208 (nnheader-report 'nnbabyl "Selected group %s" group)
209 (nnheader-insert "211 %d %d %d %s\n"
210 (1+ (- (cdr active) (car active)))
211 (car active) (cdr active) group))))))
213 (deffoo nnbabyl-request-scan (&optional group server)
214 (nnbabyl-possibly-change-newsgroup group server)
220 (set-buffer nnbabyl-mbox-buffer)
222 (file-name-directory nnbabyl-mbox-file)
226 (let ((in-buf (current-buffer)))
227 (goto-char (point-min))
228 (while (search-forward "\n\^_\n" nil t)
230 (set-buffer nnbabyl-mbox-buffer)
231 (goto-char (point-max))
232 (search-backward "\n\^_" nil t)
233 (goto-char (match-end 0))
234 (insert-buffer-substring in-buf)))
235 (nnmail-save-active nnbabyl-group-alist nnbabyl-active-file))))
237 (deffoo nnbabyl-close-group (group &optional server)
240 (deffoo nnbabyl-request-create-group (group &optional server args)
241 (nnmail-activate 'nnbabyl)
242 (unless (assoc group nnbabyl-group-alist)
243 (push (list group (cons 1 0))
245 (nnmail-save-active nnbabyl-group-alist nnbabyl-active-file))
248 (deffoo nnbabyl-request-list (&optional server)
250 (nnmail-find-file nnbabyl-active-file)
251 (setq nnbabyl-group-alist (nnmail-get-active))
254 (deffoo nnbabyl-request-newgroups (date &optional server)
255 (nnbabyl-request-list server))
257 (deffoo nnbabyl-request-list-newsgroups (&optional server)
258 (nnheader-report 'nnbabyl "nnbabyl: LIST NEWSGROUPS is not implemented."))
260 (deffoo nnbabyl-request-expire-articles
261 (articles newsgroup &optional server force)
262 (nnbabyl-possibly-change-newsgroup newsgroup server)
265 (nnmail-activate 'nnbabyl)
268 (set-buffer nnbabyl-mbox-buffer)
269 (set-text-properties (point-min) (point-max) nil)
270 (while (and articles is-old)
271 (goto-char (point-min))
272 (when (search-forward (nnbabyl-article-string (car articles)) nil t)
274 (nnmail-expired-article-p
277 (point) (progn (end-of-line) (point))) force))
279 (unless (eq nnmail-expiry-target 'delete)
281 (nnbabyl-request-article (car articles)
284 (let ((nnml-current-directory nil))
285 (nnmail-expiry-target-group
286 nnmail-expiry-target newsgroup)))
287 (nnbabyl-possibly-change-newsgroup newsgroup server))
288 (nnheader-message 5 "Deleting article %d in %s..."
289 (car articles) newsgroup)
290 (nnbabyl-delete-mail))
291 (push (car articles) rest)))
292 (setq articles (cdr articles)))
294 ;; Find the lowest active article in this group.
295 (let ((active (nth 1 (assoc newsgroup nnbabyl-group-alist))))
296 (goto-char (point-min))
297 (while (and (not (search-forward
298 (nnbabyl-article-string (car active)) nil t))
299 (<= (car active) (cdr active)))
300 (setcar active (1+ (car active)))
301 (goto-char (point-min))))
302 (nnmail-save-active nnbabyl-group-alist nnbabyl-active-file)
303 (nconc rest articles))))
305 (deffoo nnbabyl-request-move-article
306 (article group server accept-form &optional last move-is-internal)
307 (let ((buf (get-buffer-create " *nnbabyl move*"))
310 (nnbabyl-request-article article group server)
313 (insert-buffer-substring nntp-server-buffer)
314 (goto-char (point-min))
315 (while (re-search-forward
317 (save-excursion (search-forward "\n\n" nil t) (point)) t)
318 (delete-region (progn (beginning-of-line) (point))
319 (progn (forward-line 1) (point))))
320 (setq result (eval accept-form))
321 (kill-buffer (current-buffer))
324 (nnbabyl-possibly-change-newsgroup group server)
325 (set-buffer nnbabyl-mbox-buffer)
326 (goto-char (point-min))
327 (if (search-forward (nnbabyl-article-string article) nil t)
328 (nnbabyl-delete-mail))
329 (and last (save-buffer))))
332 (deffoo nnbabyl-request-accept-article (group &optional server last)
333 (nnbabyl-possibly-change-newsgroup group server)
334 (nnmail-check-syntax)
335 (let ((buf (current-buffer))
338 (nnmail-activate 'nnbabyl)
340 (goto-char (point-min))
341 (search-forward "\n\n" nil t)
344 (while (re-search-backward "^X-Gnus-Newsgroup: " beg t)
345 (delete-region (point) (progn (forward-line 1) (point)))))
346 (when nnmail-cache-accepted-message-ids
347 (nnmail-cache-insert (nnmail-fetch-field "message-id")
349 (nnmail-fetch-field "subject")
350 (nnmail-fetch-field "from")))
353 (list (cons group (nnbabyl-active-number group)))
354 (nnmail-article-group 'nnbabyl-active-number)))
355 (if (and (null result)
356 (yes-or-no-p "Moved to `junk' group; delete article? "))
358 (setq result (car (nnbabyl-save-mail result))))
359 (set-buffer nnbabyl-mbox-buffer)
360 (goto-char (point-max))
361 (search-backward "\n\^_")
362 (goto-char (match-end 0))
363 (insert-buffer-substring buf)
365 (when nnmail-cache-accepted-message-ids
366 (nnmail-cache-insert (nnmail-fetch-field "message-id")
368 (nnmail-fetch-field "subject")
369 (nnmail-fetch-field "from")))
371 (nnmail-save-active nnbabyl-group-alist nnbabyl-active-file))
374 (deffoo nnbabyl-request-replace-article (article group buffer)
375 (nnbabyl-possibly-change-newsgroup group)
377 (set-buffer nnbabyl-mbox-buffer)
378 (goto-char (point-min))
379 (if (not (search-forward (nnbabyl-article-string article) nil t))
381 (nnbabyl-delete-mail t t)
382 (insert-buffer-substring buffer)
386 (deffoo nnbabyl-request-delete-group (group &optional force server)
387 (nnbabyl-possibly-change-newsgroup group server)
388 ;; Delete all articles in GROUP.
390 () ; Don't delete the articles.
392 (set-buffer nnbabyl-mbox-buffer)
393 (goto-char (point-min))
394 ;; Delete all articles in this group.
395 (let ((ident (concat "\nX-Gnus-Newsgroup: " nnbabyl-current-group ":"))
397 (while (search-forward ident nil t)
399 (nnbabyl-delete-mail))
402 ;; Remove the group from all structures.
403 (setq nnbabyl-group-alist
404 (delq (assoc group nnbabyl-group-alist) nnbabyl-group-alist)
405 nnbabyl-current-group nil)
406 ;; Save the active file.
407 (nnmail-save-active nnbabyl-group-alist nnbabyl-active-file)
410 (deffoo nnbabyl-request-rename-group (group new-name &optional server)
411 (nnbabyl-possibly-change-newsgroup group server)
413 (set-buffer nnbabyl-mbox-buffer)
414 (goto-char (point-min))
415 (let ((ident (concat "\nX-Gnus-Newsgroup: " nnbabyl-current-group ":"))
416 (new-ident (concat "\nX-Gnus-Newsgroup: " new-name ":"))
418 (while (search-forward ident nil t)
419 (replace-match new-ident t t)
423 (let ((entry (assoc group nnbabyl-group-alist)))
424 (and entry (setcar entry new-name))
425 (setq nnbabyl-current-group nil)
426 ;; Save the new group alist.
427 (nnmail-save-active nnbabyl-group-alist nnbabyl-active-file)
431 ;;; Internal functions.
433 ;; If FORCE, delete article no matter how many X-Gnus-Newsgroup
434 ;; headers there are. If LEAVE-DELIM, don't delete the Unix mbox
436 (defun nnbabyl-delete-mail (&optional force leave-delim)
437 ;; Delete the current X-Gnus-Newsgroup line.
440 (progn (beginning-of-line) (point))
441 (progn (forward-line 1) (point))))
442 ;; Beginning of the article.
448 (unless (re-search-backward (concat "^" nnbabyl-mail-delimiter) nil t)
449 (goto-char (point-min))
451 (if leave-delim (progn (forward-line 1) (point))
452 (match-beginning 0)))
455 (or (and (re-search-forward (concat "^" nnbabyl-mail-delimiter)
459 (goto-char (point-min))
460 ;; Only delete the article if no other groups owns it as well.
461 (when (or force (not (re-search-forward "^X-Gnus-Newsgroup: " nil t)))
462 (delete-region (point-min) (point-max))))))
464 (defun nnbabyl-possibly-change-newsgroup (newsgroup &optional server)
466 (not (nnbabyl-server-opened server)))
467 (nnbabyl-open-server server))
468 (when (or (not nnbabyl-mbox-buffer)
469 (not (buffer-name nnbabyl-mbox-buffer)))