1 ;;; nnmbox.el --- mail 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))
40 (defvoo nnmbox-mbox-file (expand-file-name "~/mbox")
41 "The name of the mail box file in the user's home directory.")
43 (defvoo nnmbox-active-file (expand-file-name "~/.mbox-active")
44 "The name of the active file for the mail box.")
46 (defvoo nnmbox-get-new-mail t
47 "If non-nil, nnmbox will check the incoming mail file and split the mail.")
49 (defvoo nnmbox-prepare-save-mail-hook nil
50 "Hook run narrowed to an article before saving.")
54 (defconst nnmbox-version "nnmbox 1.0"
57 (defvoo nnmbox-current-group nil
58 "Current nnmbox news group directory.")
60 (defconst nnmbox-mbox-buffer nil)
62 (defvoo nnmbox-status-string "")
64 (defvoo nnmbox-group-alist nil)
65 (defvoo nnmbox-active-timestamp nil)
69 ;;; Interface functions
71 (nnoo-define-basics nnmbox)
73 (deffoo nnmbox-retrieve-headers (sequence &optional newsgroup server fetch-old)
75 (set-buffer nntp-server-buffer)
77 (let ((number (length sequence))
79 article art-string start stop)
80 (nnmbox-possibly-change-newsgroup newsgroup server)
82 (setq article (car sequence))
83 (setq art-string (nnmbox-article-string article))
84 (set-buffer nnmbox-mbox-buffer)
85 (when (or (search-forward art-string nil t)
86 (progn (goto-char (point-min))
87 (search-forward art-string nil t)))
91 (concat "^" message-unix-mail-delimiter) nil t)
93 (search-forward "\n\n" nil t)
94 (setq stop (1- (point)))
95 (set-buffer nntp-server-buffer)
96 (insert (format "221 %d Article retrieved.\n" article))
97 (insert-buffer-substring nnmbox-mbox-buffer start stop)
98 (goto-char (point-max))
100 (setq sequence (cdr sequence))
101 (setq count (1+ count))
102 (and (numberp nnmail-large-newsgroup)
103 (> number nnmail-large-newsgroup)
105 (nnheader-message 5 "nnmbox: Receiving headers... %d%%"
106 (/ (* count 100) number))))
108 (and (numberp nnmail-large-newsgroup)
109 (> number nnmail-large-newsgroup)
110 (nnheader-message 5 "nnmbox: Receiving headers...done"))
112 (set-buffer nntp-server-buffer)
113 (nnheader-fold-continuation-lines)
116 (deffoo nnmbox-open-server (server &optional defs)
117 (nnoo-change-server 'nnmbox server defs)
120 ((not (file-exists-p nnmbox-mbox-file))
121 (nnmbox-close-server)
122 (nnheader-report 'nnmbox "No such file: %s" nnmbox-mbox-file))
123 ((file-directory-p nnmbox-mbox-file)
124 (nnmbox-close-server)
125 (nnheader-report 'nnmbox "Not a regular file: %s" nnmbox-mbox-file))
127 (nnheader-report 'nnmbox "Opened server %s using mbox %s" server
131 (deffoo nnmbox-close-server (&optional server)
132 (when (and nnmbox-mbox-buffer
133 (buffer-name nnmbox-mbox-buffer))
134 (kill-buffer nnmbox-mbox-buffer))
135 (nnoo-close-server 'nnmbox server)
138 (deffoo nnmbox-server-opened (&optional server)
139 (and (nnoo-current-server-p 'nnmbox server)
141 (buffer-name nnmbox-mbox-buffer)
143 (buffer-name nntp-server-buffer)))
145 (deffoo nnmbox-request-article (article &optional newsgroup server buffer)
146 (nnmbox-possibly-change-newsgroup newsgroup server)
148 (set-buffer nnmbox-mbox-buffer)
149 (goto-char (point-min))
150 (when (search-forward (nnmbox-article-string article) nil t)
152 (re-search-backward (concat "^" message-unix-mail-delimiter) nil t)
155 (or (and (re-search-forward
156 (concat "^" message-unix-mail-delimiter) nil t)
158 (goto-char (point-max)))
160 (let ((nntp-server-buffer (or buffer nntp-server-buffer)))
161 (set-buffer nntp-server-buffer)
163 (insert-buffer-substring nnmbox-mbox-buffer start stop)
164 (goto-char (point-min))
165 (while (looking-at "From ")
167 (insert "X-From-Line: ")
169 (if (numberp article)
170 (cons nnmbox-current-group article)
171 (nnmbox-article-group-number)))))))
173 (deffoo nnmbox-request-group (group &optional server dont-check)
174 (let ((active (cadr (assoc group nnmbox-group-alist))))
177 (null (nnmbox-possibly-change-newsgroup group server)))
178 (nnheader-report 'nnmbox "No such group: %s" group))
180 (nnheader-report 'nnmbox "Selected group %s" group)
181 (nnheader-insert ""))
183 (nnheader-report 'nnmbox "Selected group %s" group)
184 (nnheader-insert "211 %d %d %d %s\n"
185 (1+ (- (cdr active) (car active)))
186 (car active) (cdr active) group)))))
188 (deffoo nnmbox-request-scan (&optional group server)
189 (nnmbox-possibly-change-newsgroup group server)
195 (set-buffer nnmbox-mbox-buffer)
197 (file-name-directory nnmbox-mbox-file)
201 (let ((in-buf (current-buffer)))
202 (set-buffer nnmbox-mbox-buffer)
203 (goto-char (point-max))
204 (insert-buffer-substring in-buf)))
205 (nnmail-save-active nnmbox-group-alist nnmbox-active-file))))
207 (deffoo nnmbox-close-group (group &optional server)
210 (deffoo nnmbox-request-list (&optional server)
212 (nnmail-find-file nnmbox-active-file)
213 (setq nnmbox-group-alist (nnmail-get-active))
216 (deffoo nnmbox-request-newgroups (date &optional server)
217 (nnmbox-request-list server))
219 (deffoo nnmbox-request-list-newsgroups (&optional server)
220 (nnheader-report 'nnmbox "LIST NEWSGROUPS is not implemented."))
222 (deffoo nnmbox-request-expire-articles
223 (articles newsgroup &optional server force)
224 (nnmbox-possibly-change-newsgroup newsgroup server)
227 (nnmail-activate 'nnmbox)
230 (set-buffer nnmbox-mbox-buffer)
231 (while (and articles is-old)
232 (goto-char (point-min))
233 (when (search-forward (nnmbox-article-string (car articles)) nil t)
235 (nnmail-expired-article-p
238 (point) (progn (end-of-line) (point))) force))
240 (nnheader-message 5 "Deleting article %d in %s..."
241 (car articles) newsgroup)
242 (nnmbox-delete-mail))
243 (push (car articles) rest)))
244 (setq articles (cdr articles)))
246 ;; Find the lowest active article in this group.
247 (let ((active (nth 1 (assoc newsgroup nnmbox-group-alist))))
248 (goto-char (point-min))
249 (while (and (not (search-forward
250 (nnmbox-article-string (car active)) nil t))
251 (<= (car active) (cdr active)))
252 (setcar active (1+ (car active)))
253 (goto-char (point-min))))
254 (nnmail-save-active nnmbox-group-alist nnmbox-active-file)
255 (nconc rest articles))))
257 (deffoo nnmbox-request-move-article
258 (article group server accept-form &optional last)
259 (let ((buf (get-buffer-create " *nnmbox move*"))
262 (nnmbox-request-article article group server)
265 (buffer-disable-undo (current-buffer))
267 (insert-buffer-substring nntp-server-buffer)
268 (goto-char (point-min))
269 (while (re-search-forward
271 (save-excursion (search-forward "\n\n" nil t) (point)) t)
272 (delete-region (progn (beginning-of-line) (point))
273 (progn (forward-line 1) (point))))
274 (setq result (eval accept-form))
278 (nnmbox-possibly-change-newsgroup group server)
279 (set-buffer nnmbox-mbox-buffer)
280 (goto-char (point-min))
281 (when (search-forward (nnmbox-article-string article) nil t)
282 (nnmbox-delete-mail))
283 (and last (save-buffer))))
286 (deffoo nnmbox-request-accept-article (group &optional server last)
287 (nnmbox-possibly-change-newsgroup group server)
288 (nnmail-check-syntax)
289 (let ((buf (current-buffer))
291 (goto-char (point-min))
292 ;; The From line may have been quoted by movemail.
293 (when (looking-at (concat ">" message-unix-mail-delimiter))
295 (if (looking-at "X-From-Line: ")
296 (replace-match "From ")
297 (insert "From nobody " (current-time-string) "\n"))
299 (nnmail-activate 'nnmbox)
302 (goto-char (point-min))
303 (search-forward "\n\n" nil t)
305 (while (re-search-backward "^X-Gnus-Newsgroup: " nil t)
306 (delete-region (point) (progn (forward-line 1) (point))))
307 (when nnmail-cache-message-id-when-accepting
308 (nnmail-cache-insert (nnmail-fetch-field "message-id")))
309 (setq result (nnmbox-save-mail
311 (list (cons group (nnmbox-active-number group)))
312 (nnmail-article-group 'nnmbox-active-number)))))
314 (set-buffer nnmbox-mbox-buffer)
315 (goto-char (point-max))
316 (insert-buffer-substring buf)
319 (nnmail-save-active nnmbox-group-alist nnmbox-active-file)
323 (deffoo nnmbox-request-replace-article (article group buffer)
324 (nnmbox-possibly-change-newsgroup group)
326 (set-buffer nnmbox-mbox-buffer)
327 (goto-char (point-min))
328 (if (not (search-forward (nnmbox-article-string article) nil t))
330 (nnmbox-delete-mail t t)
331 (insert-buffer-substring buffer)
335 (deffoo nnmbox-request-delete-group (group &optional force server)
336 (nnmbox-possibly-change-newsgroup group server)
337 ;; Delete all articles in GROUP.
339 () ; Don't delete the articles.
341 (set-buffer nnmbox-mbox-buffer)
342 (goto-char (point-min))
343 ;; Delete all articles in this group.
344 (let ((ident (concat "\nX-Gnus-Newsgroup: " nnmbox-current-group ":"))
346 (while (search-forward ident nil t)
348 (nnmbox-delete-mail))
351 ;; Remove the group from all structures.
352 (setq nnmbox-group-alist
353 (delq (assoc group nnmbox-group-alist) nnmbox-group-alist)
354 nnmbox-current-group nil)
355 ;; Save the active file.
356 (nnmail-save-active nnmbox-group-alist nnmbox-active-file)
359 (deffoo nnmbox-request-rename-group (group new-name &optional server)
360 (nnmbox-possibly-change-newsgroup group server)
362 (set-buffer nnmbox-mbox-buffer)
363 (goto-char (point-min))
364 (let ((ident (concat "\nX-Gnus-Newsgroup: " nnmbox-current-group ":"))
365 (new-ident (concat "\nX-Gnus-Newsgroup: " new-name ":"))
367 (while (search-forward ident nil t)
368 (replace-match new-ident t t)
372 (let ((entry (assoc group nnmbox-group-alist)))
374 (setcar entry new-name))
375 (setq nnmbox-current-group nil)
376 ;; Save the new group alist.
377 (nnmail-save-active nnmbox-group-alist nnmbox-active-file)
381 ;;; Internal functions.
383 ;; If FORCE, delete article no matter how many X-Gnus-Newsgroup
384 ;; headers there are. If LEAVE-DELIM, don't delete the Unix mbox
386 (defun nnmbox-delete-mail (&optional force leave-delim)
387 ;; Delete the current X-Gnus-Newsgroup line.
390 (progn (beginning-of-line) (point))
391 (progn (forward-line 1) (point))))
392 ;; Beginning of the article.
397 (re-search-backward (concat "^" message-unix-mail-delimiter) nil t)
398 (if leave-delim (progn (forward-line 1) (point))
399 (match-beginning 0)))
402 (or (and (re-search-forward (concat "^" message-unix-mail-delimiter)
404 (if (and (not (bobp)) leave-delim)
405 (progn (forward-line -2) (point))
406 (match-beginning 0)))
408 (goto-char (point-min))
409 ;; Only delete the article if no other groups owns it as well.
410 (when (or force (not (re-search-forward "^X-Gnus-Newsgroup: " nil t)))
411 (delete-region (point-min) (point-max))))))
413 (defun nnmbox-possibly-change-newsgroup (newsgroup &optional server)
415 (not (nnmbox-server-opened server)))
416 (nnmbox-open-server server))
417 (when (or (not nnmbox-mbox-buffer)
418 (not (buffer-name nnmbox-mbox-buffer)))
420 (set-buffer (setq nnmbox-mbox-buffer
421 (nnheader-find-file-noselect
422 nnmbox-mbox-file nil 'raw)))
423 (buffer-disable-undo (current-buffer))))
424 (when (not nnmbox-group-alist)
425 (nnmail-activate 'nnmbox))
427 (when (assoc newsgroup nnmbox-group-alist)
428 (setq nnmbox-current-group newsgroup))
431 (defun nnmbox-article-string (article)
432 (if (numberp article)
433 (concat "\nX-Gnus-Newsgroup: " nnmbox-current-group ":"
434 (int-to-string article) " ")
435 (concat "\nMessage-ID: " article)))
437 (defun nnmbox-article-group-number ()
439 (goto-char (point-min))
440 (when (re-search-forward "^X-Gnus-Newsgroup: +\\([^:]+\\):\\([0-9]+\\) "
442 (cons (buffer-substring (match-beginning 1) (match-end 1))
444 (buffer-substring (match-beginning 2) (match-end 2)))))))
446 (defun nnmbox-save-mail (group-art)
447 "Called narrowed to an article."
448 (let ((delim (concat "^" message-unix-mail-delimiter)))
449 (goto-char (point-min))
450 ;; This might come from somewhere else.
451 (unless (looking-at delim)
452 (insert "From nobody " (current-time-string) "\n")
453 (goto-char (point-min)))
454 ;; Quote all "From " lines in the article.
456 (while (re-search-forward delim nil t)
459 (nnmail-insert-lines)
460 (nnmail-insert-xref group-art)
461 (nnmbox-insert-newsgroup-line group-art)
462 (run-hooks 'nnmail-prepare-save-mail-hook)
463 (run-hooks 'nnmbox-prepare-save-mail-hook)
466 (defun nnmbox-insert-newsgroup-line (group-art)
468 (goto-char (point-min))
469 (when (search-forward "\n\n" nil t)
472 (insert (format "X-Gnus-Newsgroup: %s:%d %s\n"
473 (caar group-art) (cdar group-art)
474 (current-time-string)))
475 (setq group-art (cdr group-art))))
478 (defun nnmbox-active-number (group)
479 ;; Find the next article number in GROUP.
480 (let ((active (cadr (assoc group nnmbox-group-alist))))
482 (setcdr active (1+ (cdr active)))
483 ;; This group is new, so we create a new entry for it.
484 ;; This might be a bit naughty... creating groups on the drop of
485 ;; a hat, but I don't know...
486 (push (list group (setq active (cons 1 1)))
490 (defun nnmbox-create-mbox ()
491 (when (not (file-exists-p nnmbox-mbox-file))
492 (nnmail-write-region 1 1 nnmbox-mbox-file t 'nomesg)))
494 (defun nnmbox-read-mbox ()
495 (nnmail-activate 'nnmbox)
497 (if (and nnmbox-mbox-buffer
498 (buffer-name nnmbox-mbox-buffer)
500 (set-buffer nnmbox-mbox-buffer)
501 (= (buffer-size) (nnheader-file-size nnmbox-mbox-file))))
504 (let ((delim (concat "^" message-unix-mail-delimiter))
505 (alist nnmbox-group-alist)
507 (set-buffer (setq nnmbox-mbox-buffer
508 (nnheader-find-file-noselect
509 nnmbox-mbox-file nil 'raw)))
510 (buffer-disable-undo (current-buffer))
512 ;; Go through the group alist and compare against
515 (goto-char (point-max))
516 (when (and (re-search-backward
517 (format "^X-Gnus-Newsgroup: %s:\\([0-9]+\\) "
522 (match-beginning 1) (match-end 1))))
524 (setcdr (cadar alist) (1+ number)))
525 (setq alist (cdr alist)))
527 (goto-char (point-min))
528 (while (re-search-forward delim nil t)
529 (setq start (match-beginning 0))
530 (when (not (search-forward "\nX-Gnus-Newsgroup: "
535 (re-search-forward delim nil t)
541 (narrow-to-region start end)
543 (nnmail-article-group 'nnmbox-active-number)))))
548 ;;; nnmbox.el ends here