1 ;;; nnmh.el --- mhspool access for Gnus
2 ;; Copyright (C) 1995,96,97,98,99 Free Software Foundation, Inc.
4 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
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 ;; Based on nnspool.el by Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>.
28 ;; For an overview of what the interface functions do, please see the
37 (eval-when-compile (require 'cl))
41 (defvoo nnmh-directory message-directory
42 "*Mail spool directory.")
44 (defvoo nnmh-get-new-mail t
45 "*If non-nil, nnmh will check the incoming mail file and split the mail.")
47 (defvoo nnmh-prepare-save-mail-hook nil
48 "*Hook run narrowed to an article before saving.")
50 (defvoo nnmh-be-safe nil
51 "*If non-nil, nnmh will check all articles to make sure whether they are new or not.")
55 (defconst nnmh-version "nnmh 1.0"
58 (defvoo nnmh-current-directory nil
59 "Current news group directory.")
61 (defvoo nnmh-status-string "")
62 (defvoo nnmh-group-alist nil)
63 (defvoo nnmh-allow-delete-final nil)
67 ;;; Interface functions.
69 (nnoo-define-basics nnmh)
71 (deffoo nnmh-retrieve-headers (articles &optional newsgroup server fetch-old)
73 (set-buffer nntp-server-buffer)
76 (number (length articles))
77 (large (and (numberp nnmail-large-newsgroup)
78 (> number nnmail-large-newsgroup)))
80 (pathname-coding-system 'binary)
82 (nnmh-possibly-change-directory newsgroup server)
83 ;; We don't support fetching by Message-ID.
84 (if (stringp (car articles))
87 (when (and (file-exists-p
88 (setq file (concat (file-name-as-directory
89 nnmh-current-directory)
91 (setq article (pop articles))))))
92 (not (file-directory-p file)))
93 (insert (format "221 %d Article retrieved.\n" article))
95 (nnheader-insert-head file)
97 (if (search-forward "\n\n" nil t)
99 (goto-char (point-max))
102 (delete-region (point) (point-max)))
103 (setq count (1+ count))
107 (nnheader-message 5 "nnmh: Receiving headers... %d%%"
108 (/ (* count 100) number))))
111 (nnheader-message 5 "nnmh: Receiving headers...done"))
113 (nnheader-fold-continuation-lines)
116 (deffoo nnmh-open-server (server &optional defs)
117 (nnoo-change-server 'nnmh server defs)
118 (when (not (file-exists-p nnmh-directory))
120 (make-directory nnmh-directory t)
123 ((not (file-exists-p nnmh-directory))
125 (nnheader-report 'nnmh "Couldn't create directory: %s" nnmh-directory))
126 ((not (file-directory-p (file-truename nnmh-directory)))
128 (nnheader-report 'nnmh "Not a directory: %s" nnmh-directory))
130 (nnheader-report 'nnmh "Opened server %s using directory %s"
131 server nnmh-directory)
134 (deffoo nnmh-request-article (id &optional newsgroup server buffer)
135 (nnmh-possibly-change-directory newsgroup server)
136 (let ((file (if (stringp id)
138 (concat nnmh-current-directory (int-to-string id))))
139 (pathname-coding-system 'binary)
140 (nntp-server-buffer (or buffer nntp-server-buffer)))
143 (not (file-directory-p file))
144 (save-excursion (nnmail-find-file file))
145 (string-to-int (file-name-nondirectory file)))))
147 (deffoo nnmh-request-group (group &optional server dont-check)
148 (nnheader-init-server-buffer)
149 (nnmh-possibly-change-directory group server)
150 (let ((pathname (nnmail-group-pathname group nnmh-directory))
151 (pathname-coding-system 'binary)
154 ((not (file-directory-p pathname))
156 'nnmh "Can't select group (no such directory): %s" group))
158 (setq nnmh-current-directory pathname)
159 (and nnmh-get-new-mail
161 (nnmh-update-gnus-unreads group))
164 (nnheader-report 'nnmh "Selected group %s" group)
167 ;; Re-scan the directory if it's on a foreign system.
168 (nnheader-re-read-dir pathname)
171 (mapcar (lambda (name) (string-to-int name))
172 (directory-files pathname nil "^[0-9]+$" t))
176 (setq nnmh-group-alist
177 (delq (assoc group nnmh-group-alist) nnmh-group-alist))
178 (push (list group (cons (car dir) (car (last dir))))
180 (nnheader-report 'nnmh "Selected group %s" group)
182 "211 %d %d %d %s\n" (length dir) (car dir)
183 (car (last dir)) group))
185 (nnheader-report 'nnmh "Empty group %s" group)
186 (nnheader-insert (format "211 0 1 0 %s\n" group))))))))))
188 (deffoo nnmh-request-scan (&optional group server)
189 (nnmail-get-new-mail 'nnmh nil nnmh-directory group))
191 (deffoo nnmh-request-list (&optional server dir)
193 (nnmh-possibly-change-directory nil server)
194 (let ((pathname-coding-system 'binary)
196 (file-truename (or dir (file-name-as-directory nnmh-directory)))))
197 (nnmh-request-list-1 nnmh-toplev))
198 (setq nnmh-group-alist (nnmail-get-active))
202 (defun nnmh-request-list-1 (dir)
203 (setq dir (expand-file-name dir))
204 ;; Recurse down all directories.
205 (let ((dirs (and (file-readable-p dir)
206 (> (nth 1 (file-attributes (file-chase-links dir))) 2)
207 (nnheader-directory-files dir t nil t)))
209 ;; Recurse down directories.
210 (while (setq rdir (pop dirs))
211 (when (and (file-directory-p rdir)
212 (file-readable-p rdir)
213 (not (equal (file-truename rdir)
214 (file-truename dir))))
215 (nnmh-request-list-1 rdir))))
216 ;; For each directory, generate an active file line.
217 (unless (string= (expand-file-name nnmh-toplev) dir)
219 (lambda (name) (string-to-int name))
220 (directory-files dir nil "^[0-9]+$" t))))
223 (set-buffer nntp-server-buffer)
224 (goto-char (point-max))
231 (file-truename (file-name-as-directory
232 (expand-file-name nnmh-toplev))))
234 (nnheader-replace-chars-in-string
235 (mm-decode-coding-string (substring dir (match-end 0))
236 nnmail-pathname-coding-system)
239 (apply 'min files)))))))
242 (deffoo nnmh-request-newgroups (date &optional server)
243 (nnmh-request-list server))
245 (deffoo nnmh-request-expire-articles (articles newsgroup
246 &optional server force)
247 (nnmh-possibly-change-directory newsgroup server)
249 article rest mod-time)
250 (nnheader-init-server-buffer)
252 (while (and articles is-old)
253 (setq article (concat nnmh-current-directory
254 (int-to-string (car articles))))
255 (when (setq mod-time (nth 5 (file-attributes article)))
256 (if (and (nnmh-deletable-article-p newsgroup (car articles))
258 (nnmail-expired-article-p newsgroup mod-time force)))
260 (nnheader-message 5 "Deleting article %s in %s..."
263 (funcall nnmail-delete-file-function article)
265 (nnheader-message 1 "Couldn't delete article %s in %s"
267 (push (car articles) rest))))
268 (push (car articles) rest)))
269 (setq articles (cdr articles)))
270 (nnheader-message 5 "")
271 (nconc rest articles)))
273 (deffoo nnmh-close-group (group &optional server)
276 (deffoo nnmh-request-move-article
277 (article group server accept-form &optional last)
278 (let ((buf (get-buffer-create " *nnmh move*"))
281 (nnmh-deletable-article-p group article)
282 (nnmh-request-article article group server)
286 (insert-buffer-substring nntp-server-buffer)
287 (setq result (eval accept-form))
288 (kill-buffer (current-buffer))
291 (nnmh-possibly-change-directory group server)
293 (funcall nnmail-delete-file-function
294 (concat nnmh-current-directory (int-to-string article)))
298 (deffoo nnmh-request-accept-article (group &optional server last noinsert)
299 (nnmh-possibly-change-directory group server)
300 (nnmail-check-syntax)
301 (when nnmail-cache-accepted-message-ids
302 (nnmail-cache-insert (nnmail-fetch-field "message-id")))
303 (nnheader-init-server-buffer)
307 (nnmh-active-number group)
309 (list (cons group (nnmh-active-number group)))
311 (let ((res (nnmail-article-group 'nnmh-active-number)))
313 (yes-or-no-p "Moved to `junk' group; delete article? "))
315 (car (nnmh-save-mail res noinsert)))))
316 (when (and last nnmail-cache-accepted-message-ids)
317 (nnmail-cache-close))))
319 (deffoo nnmh-request-replace-article (article group buffer)
320 (nnmh-possibly-change-directory group)
323 (nnmh-possibly-create-directory group)
326 (point-min) (point-max)
327 (concat nnmh-current-directory (int-to-string article))
328 nil (if (nnheader-be-verbose 5) nil 'nomesg))
331 (deffoo nnmh-request-create-group (group &optional server args)
332 (nnheader-init-server-buffer)
333 (unless (assoc group nnmh-group-alist)
335 (push (list group (setq active (cons 1 0)))
337 (nnmh-possibly-create-directory group)
338 (nnmh-possibly-change-directory group server)
339 (let ((articles (mapcar
341 (string-to-int file))
343 nnmh-current-directory nil "^[0-9]+$"))))
345 (setcar active (apply 'min articles))
346 (setcdr active (apply 'max articles))))))
349 (deffoo nnmh-request-delete-group (group &optional force server)
350 (nnmh-possibly-change-directory group server)
351 ;; Delete all articles in GROUP.
353 () ; Don't delete the articles.
354 (let ((articles (directory-files nnmh-current-directory t "^[0-9]+$")))
356 (when (file-writable-p (car articles))
357 (nnheader-message 5 "Deleting article %s in %s..."
358 (car articles) group)
359 (funcall nnmail-delete-file-function (car articles)))
360 (setq articles (cdr articles))))
361 ;; Try to delete the directory itself.
363 (delete-directory nnmh-current-directory)))
364 ;; Remove the group from all structures.
365 (setq nnmh-group-alist
366 (delq (assoc group nnmh-group-alist) nnmh-group-alist)
367 nnmh-current-directory nil)
370 (deffoo nnmh-request-rename-group (group new-name &optional server)
371 (nnmh-possibly-change-directory group server)
372 (let ((new-dir (nnmail-group-pathname new-name nnmh-directory))
373 (old-dir (nnmail-group-pathname group nnmh-directory)))
375 (make-directory new-dir t)
377 ;; We move the articles file by file instead of renaming
378 ;; the directory -- there may be subgroups in this group.
379 ;; One might be more clever, I guess.
380 (let ((files (nnheader-article-to-file-alist old-dir)))
383 (concat old-dir (cdar files))
384 (concat new-dir (cdar files)))
386 (when (<= (length (directory-files old-dir)) 2)
388 (delete-directory old-dir)))
389 ;; That went ok, so we change the internal structures.
390 (let ((entry (assoc group nnmh-group-alist)))
392 (setcar entry new-name))
393 (setq nnmh-current-directory nil)
396 (nnoo-define-skeleton nnmh)
399 ;;; Internal functions.
401 (defun nnmh-possibly-change-directory (newsgroup &optional server)
403 (not (nnmh-server-opened server)))
404 (nnmh-open-server server))
406 (let ((pathname (nnmail-group-pathname newsgroup nnmh-directory))
407 (pathname-coding-system 'binary))
408 (if (file-directory-p pathname)
409 (setq nnmh-current-directory pathname)
410 (error "No such newsgroup: %s" newsgroup)))))
412 (defun nnmh-possibly-create-directory (group)
414 (setq dir (nnmail-group-pathname group nnmh-directory))
415 (while (not (file-directory-p dir))
417 (setq dir (file-name-directory (directory-file-name dir))))
419 (when (make-directory (directory-file-name (car dirs)))
420 (error "Could not create directory %s" (car dirs)))
421 (nnheader-message 5 "Creating mail directory %s" (car dirs))
422 (setq dirs (cdr dirs)))))
424 (defun nnmh-save-mail (group-art &optional noinsert)
425 "Called narrowed to an article."
427 (nnmail-insert-lines)
428 (nnmail-insert-xref group-art))
429 (run-hooks 'nnmail-prepare-save-mail-hook)
430 (run-hooks 'nnmh-prepare-save-mail-hook)
431 (goto-char (point-min))
432 (while (looking-at "From ")
433 (replace-match "X-From-Line: ")
435 ;; We save the article in all the newsgroups it belongs in.
439 (nnmh-possibly-create-directory (caar ga))
440 (let ((file (concat (nnmail-group-pathname
441 (caar ga) nnmh-directory)
442 (int-to-string (cdar ga)))))
444 ;; It was already saved, so we just make a hard link.
445 (funcall nnmail-crosspost-link-function first file t)
447 (nnmail-write-region (point-min) (point-max) file nil nil)
452 (defun nnmh-active-number (group)
453 "Compute the next article number in GROUP."
454 (let ((active (cadr (assoc group nnmh-group-alist)))
455 (dir (nnmail-group-pathname group nnmh-directory))
456 (pathname-coding-system 'binary))
458 ;; The group wasn't known to nnmh, so we just create an active
460 (setq active (cons 1 0))
461 (push (list group active) nnmh-group-alist)
462 (unless (file-exists-p dir)
463 (gnus-make-directory dir))
464 ;; Find the highest number in the group.
469 (directory-files dir nil "^[0-9]+$"))
472 (setcdr active (car files)))))
473 (setcdr active (1+ (cdr active)))
474 (while (file-exists-p
475 (concat (nnmail-group-pathname group nnmh-directory)
476 (int-to-string (cdr active))))
477 (setcdr active (1+ (cdr active))))
480 (defun nnmh-update-gnus-unreads (group)
481 ;; Go through the .nnmh-articles file and compare with the actual
482 ;; articles in this folder. The articles that are "new" will be
483 ;; marked as unread by Gnus.
484 (let* ((dir nnmh-current-directory)
485 (files (sort (mapcar (function (lambda (name) (string-to-int name)))
486 (directory-files nnmh-current-directory
489 (nnmh-file (concat dir ".nnmh-articles"))
491 ;; Load the .nnmh-articles file.
492 (when (file-exists-p nnmh-file)
494 (let (nnmh-newsgroup-articles)
495 (ignore-errors (load nnmh-file nil t t))
496 nnmh-newsgroup-articles)))
497 ;; Add all new articles to the `new' list.
500 (unless (assq (car art) articles)
501 (push (car art) new))
502 (setq art (cdr art))))
503 ;; Remove all deleted articles.
504 (let ((art articles))
506 (unless (memq (caar art) files)
507 (setq articles (delq (car art) articles)))
508 (setq art (cdr art))))
509 ;; Check whether the articles really are the ones that Gnus thinks
510 ;; they are by looking at the time-stamps.
511 (let ((arts articles)
513 (while (setq art (pop arts))
515 (nth 5 (file-attributes
516 (concat dir (int-to-string (car art)))))
518 (setq articles (delq art articles))
519 (push (car art) new))))
520 ;; Go through all the new articles and add them, and their
521 ;; time-stamps, to the list.
527 (nth 5 (file-attributes
528 (concat dir (int-to-string art))))))
530 ;; Make Gnus mark all new articles as unread.
532 (gnus-make-articles-unread
533 (gnus-group-prefixed-name group (list 'nnmh ""))
534 (setq new (sort new '<))))
535 ;; Sort the article list with highest numbers first.
536 (setq articles (sort articles (lambda (art1 art2)
537 (> (car art1) (car art2)))))
538 ;; Finally write this list back to the .nnmh-articles file.
539 (with-temp-file nnmh-file
540 (insert ";; Gnus article active file for " group "\n\n")
541 (insert "(setq nnmh-newsgroup-articles '")
542 (gnus-prin1 articles)
545 (defun nnmh-deletable-article-p (group article)
546 "Say whether ARTICLE in GROUP can be deleted."
547 (let ((path (concat nnmh-current-directory (int-to-string article))))
549 (and (file-writable-p path)
551 ;; We can never delete the last article in the group.
552 (not (eq (cdr (nth 1 (assoc group nnmh-group-alist)))
555 nnmh-allow-delete-final))))
559 ;;; nnmh.el ends here