1 ;;; nnmbox.el --- mail mbox access for Gnus
3 ;; Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003,
4 ;; 2004, 2005, 2006 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 2, or (at your option)
17 ;; You should have received a copy of the GNU General Public License
18 ;; along with GNU Emacs; see the file COPYING. If not, write to the
19 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20 ;; Boston, MA 02110-1301, USA.
24 ;; For an overview of what the interface functions do, please see the
34 (eval-when-compile (require 'cl))
38 (defvoo nnmbox-mbox-file (expand-file-name "~/mbox")
39 "The name of the mail box file in the user's home directory.")
41 (defvoo nnmbox-active-file (expand-file-name "~/.mbox-active")
42 "The name of the active file for the mail box.")
44 (defvoo nnmbox-get-new-mail t
45 "If non-nil, nnmbox will check the incoming mail file and split the mail.")
47 (defvoo nnmbox-prepare-save-mail-hook nil
48 "Hook run narrowed to an article before saving.")
52 (defconst nnmbox-version "nnmbox 1.0"
55 (defvoo nnmbox-current-group nil
56 "Current nnmbox news group directory.")
58 (defvar nnmbox-mbox-buffer nil)
60 (defvoo nnmbox-status-string "")
62 (defvoo nnmbox-group-alist nil)
63 (defvoo nnmbox-active-timestamp nil)
65 (defvoo nnmbox-file-coding-system mm-binary-coding-system)
66 (defvoo nnmbox-file-coding-system-for-write nil)
67 (defvoo nnmbox-active-file-coding-system mm-binary-coding-system)
68 (defvoo nnmbox-active-file-coding-system-for-write nil)
70 (defvar nnmbox-group-building-active-articles nil)
71 (defvar nnmbox-group-active-articles nil)
74 ;;; Interface functions
76 (nnoo-define-basics nnmbox)
78 (deffoo nnmbox-retrieve-headers (sequence &optional newsgroup server fetch-old)
80 (set-buffer nntp-server-buffer)
82 (let ((number (length sequence))
85 (nnmbox-possibly-change-newsgroup newsgroup server)
87 (setq article (car sequence))
88 (set-buffer nnmbox-mbox-buffer)
89 (when (nnmbox-find-article article)
93 (concat "^" message-unix-mail-delimiter) nil t)
95 (search-forward "\n\n" nil t)
96 (setq stop (1- (point)))
97 (set-buffer nntp-server-buffer)
98 (insert (format "221 %d Article retrieved.\n" article))
99 (insert-buffer-substring nnmbox-mbox-buffer start stop)
100 (goto-char (point-max))
102 (setq sequence (cdr sequence))
103 (setq count (1+ count))
104 (and (numberp nnmail-large-newsgroup)
105 (> number nnmail-large-newsgroup)
107 (nnheader-message 5 "nnmbox: Receiving headers... %d%%"
108 (/ (* count 100) number))))
110 (and (numberp nnmail-large-newsgroup)
111 (> number nnmail-large-newsgroup)
112 (nnheader-message 5 "nnmbox: Receiving headers...done"))
114 (set-buffer nntp-server-buffer)
115 (nnheader-fold-continuation-lines)
118 (deffoo nnmbox-open-server (server &optional defs)
119 (nnoo-change-server 'nnmbox server defs)
122 ((not (file-exists-p nnmbox-mbox-file))
123 (nnmbox-close-server)
124 (nnheader-report 'nnmbox "No such file: %s" nnmbox-mbox-file))
125 ((file-directory-p nnmbox-mbox-file)
126 (nnmbox-close-server)
127 (nnheader-report 'nnmbox "Not a regular file: %s" nnmbox-mbox-file))
129 (nnheader-report 'nnmbox "Opened server %s using mbox %s" server
133 (deffoo nnmbox-close-server (&optional server)
134 (when (and nnmbox-mbox-buffer
135 (buffer-name nnmbox-mbox-buffer))
136 (kill-buffer nnmbox-mbox-buffer))
137 (nnoo-close-server 'nnmbox server)
140 (deffoo nnmbox-server-opened (&optional server)
141 (and (nnoo-current-server-p 'nnmbox server)
143 (buffer-name nnmbox-mbox-buffer)
145 (buffer-name nntp-server-buffer)))
147 (deffoo nnmbox-request-article (article &optional newsgroup server buffer)
148 (nnmbox-possibly-change-newsgroup newsgroup server)
150 (set-buffer nnmbox-mbox-buffer)
151 (when (nnmbox-find-article article)
153 (re-search-backward (concat "^" message-unix-mail-delimiter) nil t)
156 (or (and (re-search-forward
157 (concat "^" message-unix-mail-delimiter) nil t)
159 (goto-char (point-max)))
161 (let ((nntp-server-buffer (or buffer nntp-server-buffer)))
162 (set-buffer nntp-server-buffer)
164 (insert-buffer-substring nnmbox-mbox-buffer start stop)
165 (goto-char (point-min))
166 (while (looking-at "From ")
168 (insert "X-From-Line: ")
170 (if (numberp article)
171 (cons nnmbox-current-group article)
172 (nnmbox-article-group-number nil)))))))
174 (deffoo nnmbox-request-group (group &optional server dont-check)
175 (nnmbox-possibly-change-newsgroup nil server)
176 (let ((active (cadr (assoc group nnmbox-group-alist))))
179 (null (nnmbox-possibly-change-newsgroup group server)))
180 (nnheader-report 'nnmbox "No such group: %s" group))
182 (nnheader-report 'nnmbox "Selected group %s" group)
183 (nnheader-insert ""))
185 (nnheader-report 'nnmbox "Selected group %s" group)
186 (nnheader-insert "211 %d %d %d %s\n"
187 (1+ (- (cdr active) (car active)))
188 (car active) (cdr active) group)))))
190 (defun nnmbox-save-buffer ()
191 (let ((coding-system-for-write
192 (or nnmbox-file-coding-system-for-write
193 nnmbox-file-coding-system)))
196 (defun nnmbox-save-active (group-alist active-file)
197 (let ((nnmail-active-file-coding-system
198 (or nnmbox-active-file-coding-system-for-write
199 nnmbox-active-file-coding-system)))
200 (nnmail-save-active group-alist active-file)))
202 (deffoo nnmbox-request-scan (&optional group server)
203 (nnmbox-possibly-change-newsgroup group server)
209 (set-buffer nnmbox-mbox-buffer)
210 (nnmbox-save-buffer)))
211 (file-name-directory nnmbox-mbox-file)
215 (let ((in-buf (current-buffer)))
216 (set-buffer nnmbox-mbox-buffer)
217 (goto-char (point-max))
218 (insert-buffer-substring in-buf)))
219 (nnmbox-save-active nnmbox-group-alist nnmbox-active-file))))
221 (deffoo nnmbox-close-group (group &optional server)
224 (deffoo nnmbox-request-create-group (group &optional server args)
225 (nnmail-activate 'nnmbox)
226 (unless (assoc group nnmbox-group-alist)
227 (push (list group (cons 1 0))
229 (nnmbox-save-active nnmbox-group-alist nnmbox-active-file))
232 (deffoo nnmbox-request-list (&optional server)
234 (let ((nnmail-file-coding-system
235 nnmbox-active-file-coding-system))
236 (nnmail-find-file nnmbox-active-file))
237 (setq nnmbox-group-alist (nnmail-get-active))
240 (deffoo nnmbox-request-newgroups (date &optional server)
241 (nnmbox-request-list server))
243 (deffoo nnmbox-request-list-newsgroups (&optional server)
244 (nnheader-report 'nnmbox "LIST NEWSGROUPS is not implemented."))
246 (deffoo nnmbox-request-expire-articles
247 (articles newsgroup &optional server force)
248 (nnmbox-possibly-change-newsgroup newsgroup server)
251 (nnmail-activate 'nnmbox)
254 (set-buffer nnmbox-mbox-buffer)
255 (while (and articles is-old)
256 (when (nnmbox-find-article (car articles))
258 (nnmail-expired-article-p
261 (point) (progn (end-of-line) (point))) force))
263 (unless (eq nnmail-expiry-target 'delete)
265 (nnmbox-request-article (car articles)
268 (let ((nnml-current-directory nil))
269 (nnmail-expiry-target-group
270 nnmail-expiry-target newsgroup)))
271 (nnmbox-possibly-change-newsgroup newsgroup server))
272 (nnheader-message 5 "Deleting article %d in %s..."
273 (car articles) newsgroup)
274 (nnmbox-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 nnmbox-group-alist))))
280 (while (and (not (nnmbox-find-article (car active)))
281 (<= (car active) (cdr active)))
282 (setcar active (1+ (car active)))))
283 (nnmbox-save-active nnmbox-group-alist nnmbox-active-file)
284 (nconc rest articles))))
286 (deffoo nnmbox-request-move-article
287 (article group server accept-form &optional last move-is-internal)
288 (let ((buf (get-buffer-create " *nnmbox move*"))
291 (nnmbox-request-article article group server)
295 (insert-buffer-substring nntp-server-buffer)
296 (goto-char (point-min))
297 (while (re-search-forward
299 (save-excursion (search-forward "\n\n" nil t) (point)) t)
301 (setq result (eval accept-form))
305 (nnmbox-possibly-change-newsgroup group server)
306 (set-buffer nnmbox-mbox-buffer)
307 (when (nnmbox-find-article article)
308 (nnmbox-delete-mail))
309 (and last (nnmbox-save-buffer))))
312 (deffoo nnmbox-request-accept-article (group &optional server last)
313 (nnmbox-possibly-change-newsgroup group server)
314 (nnmail-check-syntax)
315 (let ((buf (current-buffer))
317 (goto-char (point-min))
318 ;; The From line may have been quoted by movemail.
319 (when (looking-at (concat ">" message-unix-mail-delimiter))
321 (if (looking-at "X-From-Line: ")
322 (replace-match "From ")
323 (insert "From nobody " (current-time-string) "\n"))
325 (nnmail-activate 'nnmbox)
328 (goto-char (point-min))
329 (search-forward "\n\n" nil t)
331 (while (re-search-backward "^X-Gnus-Newsgroup: " nil t)
332 (delete-region (point) (progn (forward-line 1) (point))))
333 (when nnmail-cache-accepted-message-ids
334 (nnmail-cache-insert (nnmail-fetch-field "message-id")
336 (nnmail-fetch-field "subject")
337 (nnmail-fetch-field "from")))
338 (setq result (if (stringp group)
339 (list (cons group (nnmbox-active-number group)))
340 (nnmail-article-group 'nnmbox-active-number)))
341 (if (and (null result)
342 (yes-or-no-p "Moved to `junk' group; delete article? "))
344 (setq result (car (nnmbox-save-mail result)))))
346 (set-buffer nnmbox-mbox-buffer)
347 (goto-char (point-max))
348 (insert-buffer-substring buf)
350 (when nnmail-cache-accepted-message-ids
351 (nnmail-cache-close))
352 (nnmbox-save-active nnmbox-group-alist nnmbox-active-file)
353 (nnmbox-save-buffer))))
356 (deffoo nnmbox-request-replace-article (article group buffer)
357 (nnmbox-possibly-change-newsgroup group)
359 (set-buffer nnmbox-mbox-buffer)
360 (if (not (nnmbox-find-article article))
362 (nnmbox-delete-mail t t)
363 (insert-buffer-substring buffer)
367 (deffoo nnmbox-request-delete-group (group &optional force server)
368 (nnmbox-possibly-change-newsgroup group server)
369 ;; Delete all articles in GROUP.
371 () ; Don't delete the articles.
373 (set-buffer nnmbox-mbox-buffer)
374 (goto-char (point-min))
375 ;; Delete all articles in this group.
376 (let ((ident (concat "\nX-Gnus-Newsgroup: " nnmbox-current-group ":"))
378 (while (search-forward ident nil t)
380 (nnmbox-delete-mail))
382 (nnmbox-save-buffer)))))
383 ;; Remove the group from all structures.
384 (setq nnmbox-group-alist
385 (delq (assoc group nnmbox-group-alist) nnmbox-group-alist)
386 nnmbox-current-group nil)
387 ;; Save the active file.
388 (nnmbox-save-active nnmbox-group-alist nnmbox-active-file)
391 (deffoo nnmbox-request-rename-group (group new-name &optional server)
392 (nnmbox-possibly-change-newsgroup group server)
394 (set-buffer nnmbox-mbox-buffer)
395 (goto-char (point-min))
396 (let ((ident (concat "\nX-Gnus-Newsgroup: " nnmbox-current-group ":"))
397 (new-ident (concat "\nX-Gnus-Newsgroup: " new-name ":"))
399 (while (search-forward ident nil t)
400 (replace-match new-ident t t)
403 (nnmbox-save-buffer))))
404 (let ((entry (assoc group nnmbox-group-active-articles)))
406 (setcar entry new-name)))
407 (let ((entry (assoc group nnmbox-group-alist)))
409 (setcar entry new-name))
410 (setq nnmbox-current-group nil)
411 ;; Save the new group alist.
412 (nnmbox-save-active nnmbox-group-alist nnmbox-active-file)
416 ;;; Internal functions.
418 ;; If FORCE, delete article no matter how many X-Gnus-Newsgroup
419 ;; headers there are. If LEAVE-DELIM, don't delete the Unix mbox
421 (defun nnmbox-delete-mail (&optional force leave-delim)
422 ;; Delete the current X-Gnus-Newsgroup line.
423 ;; First delete record of active article, unless the article is being
424 ;; replaced, indicated by FORCE being non-nil.
426 (nnmbox-record-deleted-article (nnmbox-article-group-number t)))
429 ;; Beginning of the article.
434 (re-search-backward (concat "^" message-unix-mail-delimiter) nil t)
435 (if leave-delim (progn (forward-line 1) (point))
436 (match-beginning 0)))
439 (or (and (re-search-forward (concat "^" message-unix-mail-delimiter)
441 (if (and (not (bobp)) leave-delim)
442 (progn (forward-line -2) (point))
443 (match-beginning 0)))
445 (goto-char (point-min))
446 ;; Only delete the article if no other group owns it as well.
447 (when (or force (not (re-search-forward "^X-Gnus-Newsgroup: " nil t)))
448 (delete-region (point-min) (point-max))))))
450 (defun nnmbox-possibly-change-newsgroup (newsgroup &optional server)
452 (not (nnmbox-server-opened server)))
453 (nnmbox-open-server server))
454 (when (or (not nnmbox-mbox-buffer)
455 (not (buffer-name nnmbox-mbox-buffer)))
457 (when (not nnmbox-group-alist)
458 (nnmail-activate 'nnmbox))
460 (when (assoc newsgroup nnmbox-group-alist)
461 (setq nnmbox-current-group newsgroup))
464 (defun nnmbox-article-string (article)
465 (if (numberp article)
466 (concat "\nX-Gnus-Newsgroup: " nnmbox-current-group ":"
467 (int-to-string article) " ")
468 (concat "\nMessage-ID: " article)))
470 (defun nnmbox-article-group-number (this-line)
474 (goto-char (point-min)))
475 (when (re-search-forward "^X-Gnus-Newsgroup: +\\([^:]+\\):\\([0-9]+\\) "
477 (cons (buffer-substring (match-beginning 1) (match-end 1))
479 (buffer-substring (match-beginning 2) (match-end 2)))))))
481 (defun nnmbox-in-header-p (pos)