1 ;;; nnmh.el --- mhspool access for Gnus
3 ;; Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2003
4 ;; 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 ;; 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; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
25 ;; Boston, MA 02111-1307, USA.
29 ;; Based on nnspool.el by Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>.
30 ;; For an overview of what the interface functions do, please see the
39 (eval-when-compile (require 'cl))
43 (defvoo nnmh-directory message-directory
44 "Mail spool directory.")
46 (defvoo nnmh-get-new-mail t
47 "If non-nil, nnmh will check the incoming mail file and split the mail.")
49 (defvoo nnmh-prepare-save-mail-hook nil
50 "Hook run narrowed to an article before saving.")
52 (defvoo nnmh-be-safe nil
53 "If non-nil, nnmh will check all articles to make sure whether they are new or not.
54 Go through the .nnmh-articles file and compare with the actual
55 articles in this folder. The articles that are \"new\" will be marked
60 (defconst nnmh-version "nnmh 1.0"
63 (defvoo nnmh-current-directory nil
64 "Current news group directory.")
66 (defvoo nnmh-status-string "")
67 (defvoo nnmh-group-alist nil)
68 ;; Don't even think about setting this variable. It does not exist.
69 ;; Forget about it. Uh-huh. Nope. Nobody here. It's only bound
70 ;; dynamically by certain functions in nndraft.
71 (defvar nnmh-allow-delete-final nil)
75 ;;; Interface functions.
77 (nnoo-define-basics nnmh)
79 (deffoo nnmh-retrieve-headers (articles &optional newsgroup server fetch-old)
81 (set-buffer nntp-server-buffer)
84 (number (length articles))
85 (large (and (numberp nnmail-large-newsgroup)
86 (> number nnmail-large-newsgroup)))
88 (file-name-coding-system nnmail-pathname-coding-system)
90 (nnmh-possibly-change-directory newsgroup server)
91 ;; We don't support fetching by Message-ID.
92 (if (stringp (car articles))
95 (when (and (file-exists-p
96 (setq file (concat (file-name-as-directory
97 nnmh-current-directory)
99 (setq article (pop articles))))))
100 (not (file-directory-p file)))
101 (insert (format "221 %d Article retrieved.\n" article))
103 (nnheader-insert-head file)
105 (if (search-forward "\n\n" nil t)
107 (goto-char (point-max))
110 (delete-region (point) (point-max)))
111 (setq count (1+ count))
115 (nnheader-message 5 "nnmh: Receiving headers... %d%%"
116 (/ (* count 100) number))))
119 (nnheader-message 5 "nnmh: Receiving headers...done"))
121 (nnheader-fold-continuation-lines)
124 (deffoo nnmh-open-server (server &optional defs)
125 (nnoo-change-server 'nnmh server defs)
126 (when (not (file-exists-p nnmh-directory))
128 (make-directory nnmh-directory t)
131 ((not (file-exists-p nnmh-directory))
133 (nnheader-report 'nnmh "Couldn't create directory: %s" nnmh-directory))
134 ((not (file-directory-p (file-truename nnmh-directory)))
136 (nnheader-report 'nnmh "Not a directory: %s" nnmh-directory))
138 (nnheader-report 'nnmh "Opened server %s using directory %s"
139 server nnmh-directory)
142 (deffoo nnmh-request-article (id &optional newsgroup server buffer)
143 (nnmh-possibly-change-directory newsgroup server)
144 (let ((file (if (stringp id)
146 (concat nnmh-current-directory (int-to-string id))))
147 (file-name-coding-system nnmail-pathname-coding-system)
148 (nntp-server-buffer (or buffer nntp-server-buffer)))
151 (not (file-directory-p file))
152 (save-excursion (nnmail-find-file file))
153 (string-to-int (file-name-nondirectory file)))))
155 (deffoo nnmh-request-group (group &optional server dont-check)
156 (nnheader-init-server-buffer)
157 (nnmh-possibly-change-directory group server)
158 (let ((pathname (nnmail-group-pathname group nnmh-directory))
159 (file-name-coding-system nnmail-pathname-coding-system)
162 ((not (file-directory-p pathname))
164 'nnmh "Can't select group (no such directory): %s" group))
166 (setq nnmh-current-directory pathname)
167 (and nnmh-get-new-mail
169 (nnmh-update-gnus-unreads group))
172 (nnheader-report 'nnmh "Selected group %s" group)
175 ;; Re-scan the directory if it's on a foreign system.
176 (nnheader-re-read-dir pathname)
179 (mapcar (lambda (name) (string-to-int name))
180 (directory-files pathname nil "^[0-9]+$" t))
184 (setq nnmh-group-alist
185 (delq (assoc group nnmh-group-alist) nnmh-group-alist))
186 (push (list group (cons (car dir) (car (last dir))))
188 (nnheader-report 'nnmh "Selected group %s" group)
190 "211 %d %d %d %s\n" (length dir) (car dir)
191 (car (last dir)) group))
193 (nnheader-report 'nnmh "Empty group %s" group)
194 (nnheader-insert (format "211 0 1 0 %s\n" group))))))))))
196 (deffoo nnmh-request-scan (&optional group server)
197 (nnmail-get-new-mail 'nnmh nil nnmh-directory group))
199 (deffoo nnmh-request-list (&optional server dir)
201 (nnmh-possibly-change-directory nil server)
202 (let ((file-name-coding-system nnmail-pathname-coding-system)
204 (file-truename (or dir (file-name-as-directory nnmh-directory)))))
205 (nnmh-request-list-1 nnmh-toplev))
206 (setq nnmh-group-alist (nnmail-get-active))
210 (defun nnmh-request-list-1 (dir)
211 (setq dir (expand-file-name dir))
212 ;; Recurse down all directories.
213 (let ((dirs (and (file-readable-p dir)
214 (> (nth 1 (file-attributes (file-chase-links dir))) 2)
215 (nnheader-directory-files dir t nil t)))
217 ;; Recurse down directories.
218 (while (setq rdir (pop dirs))
219 (when (and (file-directory-p rdir)
220 (file-readable-p rdir)
221 (not (equal (file-truename rdir)
222 (file-truename dir))))
223 (nnmh-request-list-1 rdir))))
224 ;; For each directory, generate an active file line.
225 (unless (string= (expand-file-name nnmh-toplev) dir)
227 (lambda (name) (string-to-int name))
228 (directory-files dir nil "^[0-9]+$" t))))
231 (set-buffer nntp-server-buffer)
232 (goto-char (point-max))
239 (file-truename (file-name-as-directory
240 (expand-file-name nnmh-toplev))))
242 (mm-string-as-multibyte
243 (mm-encode-coding-string
244 (nnheader-replace-chars-in-string
245 (substring dir (match-end 0))
247 nnmail-pathname-coding-system)))
249 (apply 'min files)))))))
252 (deffoo nnmh-request-newgroups (date &optional server)
253 (nnmh-request-list server))
255 (deffoo nnmh-request-expire-articles (articles newsgroup
256 &optional server force)
257 (nnmh-possibly-change-directory newsgroup server)
259 article rest mod-time)
260 (nnheader-init-server-buffer)
262 (while (and articles is-old)
263 (setq article (concat nnmh-current-directory
264 (int-to-string (car articles))))
265 (when (setq mod-time (nth 5 (file-attributes article)))
266 (if (and (nnmh-deletable-article-p newsgroup (car articles))
268 (nnmail-expired-article-p newsgroup mod-time force)))
270 ;; Allow a special target group. -- jcn
271 (unless (eq nnmail-expiry-target 'delete)
273 (nnmh-request-article (car articles)
274 newsgroup server (current-buffer))
275 (nnmail-expiry-target-group
276 nnmail-expiry-target newsgroup)))
277 (nnheader-message 5 "Deleting article %s in %s..."
280 (funcall nnmail-delete-file-function article)
282 (nnheader-message 1 "Couldn't delete article %s in %s"
284 (push (car articles) rest))))
285 (push (car articles) rest)))
286 (setq articles (cdr articles)))
287 (nnheader-message 5 "")
288 (nconc rest articles)))
290 (deffoo nnmh-close-group (group &optional server)
293 (deffoo nnmh-request-move-article (article group server
294 accept-form &optional last)
295 (let ((buf (get-buffer-create " *nnmh move*"))
298 (nnmh-deletable-article-p group article)
299 (nnmh-request-article article group server)
303 (insert-buffer-substring nntp-server-buffer)
304 (setq result (eval accept-form))
305 (kill-buffer (current-buffer))
308 (nnmh-possibly-change-directory group server)
310 (funcall nnmail-delete-file-function
311 (concat nnmh-current-directory (int-to-string article)))
315 (deffoo nnmh-request-accept-article (group &optional server last noinsert)
316 (nnmh-possibly-change-directory group server)
317 (nnmail-check-syntax)
318 (when nnmail-cache-accepted-message-ids
319 (nnmail-cache-insert (nnmail-fetch-field "message-id") group))
320 (nnheader-init-server-buffer)
324 (nnmh-active-number group)
326 (list (cons group (nnmh-active-number group)))
328 (let ((res (nnmail-article-group 'nnmh-active-number)))
330 (yes-or-no-p "Moved to `junk' group; delete article? "))
332 (car (nnmh-save-mail res noinsert)))))
333 (when (and last nnmail-cache-accepted-message-ids)
334 (nnmail-cache-close))))
336 (deffoo nnmh-request-replace-article (article group buffer)
337 (nnmh-possibly-change-directory group)
340 (nnmh-possibly-create-directory group)
343 (point-min) (point-max)
344 (concat nnmh-current-directory (int-to-string article))
345 nil (if (nnheader-be-verbose 5) nil 'nomesg))
348 (deffoo nnmh-request-create-group (group &optional server args)
349 (nnheader-init-server-buffer)
350 (unless (assoc group nnmh-group-alist)
352 (push (list group (setq active (cons 1 0)))
354 (nnmh-possibly-create-directory group)
355 (nnmh-possibly-change-directory group server)
356 (let ((articles (mapcar
358 (string-to-int file))
360 nnmh-current-directory nil "^[0-9]+$"))))
362 (setcar active (apply 'min articles))
363 (setcdr active (apply 'max articles))))))
366 (deffoo nnmh-request-delete-group (group &optional force server)
367 (nnmh-possibly-change-directory group server)
368 ;; Delete all articles in GROUP.
370 () ; Don't delete the articles.
371 (let ((articles (directory-files nnmh-current-directory t "^[0-9]+$")))
373 (when (file-writable-p (car articles))
374 (nnheader-message 5 "Deleting article %s in %s..."
375 (car articles) group)
376 (funcall nnmail-delete-file-function (car articles)))
377 (setq articles (cdr articles))))
378 ;; Try to delete the directory itself.
380 (delete-directory nnmh-current-directory)))
381 ;; Remove the group from all structures.
382 (setq nnmh-group-alist
383 (delq (assoc group nnmh-group-alist) nnmh-group-alist)
384 nnmh-current-directory nil)
387 (deffoo nnmh-request-rename-group (group new-name &optional server)
388 (nnmh-possibly-change-directory group server)
389 (let ((new-dir (nnmail-group-pathname new-name nnmh-directory))
390 (old-dir (nnmail-group-pathname group nnmh-directory)))
392 (make-directory new-dir t)
394 ;; We move the articles file by file instead of renaming
395 ;; the directory -- there may be subgroups in this group.
396 ;; One might be more clever, I guess.
397 (let ((files (nnheader-article-to-file-alist old-dir)))
400 (concat old-dir (cdar files))
401 (concat new-dir (cdar files)))
403 (when (<= (length (directory-files old-dir)) 2)
405 (delete-directory old-dir)))
406 ;; That went ok, so we change the internal structures.
407 (let ((entry (assoc group nnmh-group-alist)))
409 (setcar entry new-name))
410 (setq nnmh-current-directory nil)
413 (nnoo-define-skeleton nnmh)
416 ;;; Internal functions.
418 (defun nnmh-possibly-change-directory (newsgroup &optional server)
420 (not (nnmh-server-opened server)))
421 (nnmh-open-server server))
423 (let ((pathname (nnmail-group-pathname newsgroup nnmh-directory))
424 (file-name-coding-system nnmail-pathname-coding-system))
425 (if (file-directory-p pathname)
426 (setq nnmh-current-directory pathname)
427 (nnheader-report 'nnmh "Not a directory: %s" nnmh-directory)))))
429 (defun nnmh-possibly-create-directory (group)
431 (setq dir (nnmail-group-pathname group nnmh-directory))
432 (while (not (file-directory-p dir))
434 (setq dir (file-name-directory (directory-file-name dir))))
436 (when (make-directory (directory-file-name (car dirs)))
437 (error "Could not create directory %s" (car dirs)))
438 (nnheader-message 5 "Creating mail directory %s" (car dirs))
439 (setq dirs (cdr dirs)))))
441 (defun nnmh-save-mail (group-art &optional noinsert)
442 "Called narrowed to an article."
444 (nnmail-insert-lines)
445 (nnmail-insert-xref group-art))
446 (run-hooks 'nnmail-prepare-save-mail-hook)
447 (run-hooks 'nnmh-prepare-save-mail-hook)
448 (goto-char (point-min))
449 (while (looking-at "From ")
450 (replace-match "X-From-Line: ")
452 ;; We save the article in all the newsgroups it belongs in.
456 (nnmh-possibly-create-directory (caar ga))
457 (let ((file (concat (nnmail-group-pathname
458 (caar ga) nnmh-directory)
459 (int-to-string (cdar ga)))))
461 ;; It was already saved, so we just make a hard link.
462 (funcall nnmail-crosspost-link-function first file t)
464 (nnmail-write-region (point-min) (point-max) file nil nil)
469 (defun nnmh-active-number (group)
470 "Compute the next article number in GROUP."
471 (let ((active (cadr (assoc group nnmh-group-alist)))
472 (dir (nnmail-group-pathname group nnmh-directory))
473 (file-name-coding-system nnmail-pathname-coding-system)
476 ;; The group wasn't known to nnmh, so we just create an active
478 (setq active (cons 1 0))
479 (push (list group active) nnmh-group-alist)
480 (unless (file-exists-p dir)
481 (gnus-make-directory dir))
482 ;; Find the highest number in the group.
487 (directory-files dir nil "^[0-9]+$"))
490 (setcdr active (car files)))))
491 (setcdr active (1+ (cdr active)))
493 ;; See whether the file exists...
495 (setq file (concat (nnmail-group-pathname group nnmh-directory)
496 (int-to-string (cdr active)))))
497 ;; ... or there is a buffer that will make that file exist
499 (get-file-buffer file))
500 ;; Skip past that file.
501 (setcdr active (1+ (cdr active))))
504 (defun nnmh-update-gnus-unreads (group)
505 ;; Go through the .nnmh-articles file and compare with the actual
506 ;; articles in this folder. The articles that are "new" will be
507 ;; marked as unread by Gnus.
508 (let* ((dir nnmh-current-directory)
509 (files (sort (mapcar (function (lambda (name) (string-to-int name)))
510 (directory-files nnmh-current-directory
513 (nnmh-file (concat dir ".nnmh-articles"))
515 ;; Load the .nnmh-articles file.
516 (when (file-exists-p nnmh-file)
518 (let (nnmh-newsgroup-articles)
519 (ignore-errors (load nnmh-file nil t t))
520 nnmh-newsgroup-articles)))
521 ;; Add all new articles to the `new' list.
524 (unless (assq (car art) articles)
525 (push (car art) new))
526 (setq art (cdr art))))
527 ;; Remove all deleted articles.
528 (let ((art articles))
530 (unless (memq (caar art) files)
531 (setq articles (delq (car art) articles)))
532 (setq art (cdr art))))
533 ;; Check whether the articles really are the ones that Gnus thinks
534 ;; they are by looking at the time-stamps.
535 (let ((arts articles)
537 (while (setq art (pop arts))
539 (nth 5 (file-attributes
540 (concat dir (int-to-string (car art)))))
542 (setq articles (delq art articles))
543 (push (car art) new))))
544 ;; Go through all the new articles and add them, and their
545 ;; time-stamps, to the list.
551 (nth 5 (file-attributes
552 (concat dir (int-to-string art))))))
554 ;; Make Gnus mark all new articles as unread.
556 (gnus-make-articles-unread
557 (gnus-group-prefixed-name group (list 'nnmh ""))
558 (setq new (sort new '<))))
559 ;; Sort the article list with highest numbers first.
560 (setq articles (sort articles (lambda (art1 art2)
561 (> (car art1) (car art2)))))
562 ;; Finally write this list back to the .nnmh-articles file.
563 (with-temp-file nnmh-file
564 (insert ";; Gnus article active file for " group "\n\n")
565 (insert "(setq nnmh-newsgroup-articles '")
566 (gnus-prin1 articles)
569 (defun nnmh-deletable-article-p (group article)
570 "Say whether ARTICLE in GROUP can be deleted."
571 (let ((path (concat nnmh-current-directory (int-to-string article))))
573 (and (file-writable-p path)
575 ;; We can never delete the last article in the group.
576 (not (eq (cdr (nth 1 (assoc group nnmh-group-alist)))
579 nnmh-allow-delete-final))))
583 ;;; nnmh.el ends here