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.
52 Go through the .nnmh-articles file and compare with the actual
53 articles in this folder. The articles that are \"new\" will be marked
58 (defconst nnmh-version "nnmh 1.0"
61 (defvoo nnmh-current-directory nil
62 "Current news group directory.")
64 (defvoo nnmh-status-string "")
65 (defvoo nnmh-group-alist nil)
66 ;; Don't even think about setting this variable. It does not exist.
67 ;; Forget about it. Uh-huh. Nope. Nobody here. It's only bound
68 ;; dynamically by certain functions in nndraft.
69 (defvar nnmh-allow-delete-final nil)
73 ;;; Interface functions.
75 (nnoo-define-basics nnmh)
77 (deffoo nnmh-retrieve-headers (articles &optional newsgroup server fetch-old)
79 (set-buffer nntp-server-buffer)
82 (number (length articles))
83 (large (and (numberp nnmail-large-newsgroup)
84 (> number nnmail-large-newsgroup)))
86 (pathname-coding-system 'binary)
88 (nnmh-possibly-change-directory newsgroup server)
89 ;; We don't support fetching by Message-ID.
90 (if (stringp (car articles))
93 (when (and (file-exists-p
94 (setq file (concat (file-name-as-directory
95 nnmh-current-directory)
97 (setq article (pop articles))))))
98 (not (file-directory-p file)))
99 (insert (format "221 %d Article retrieved.\n" article))
101 (nnheader-insert-head file)
103 (if (search-forward "\n\n" nil t)
105 (goto-char (point-max))
108 (delete-region (point) (point-max)))
109 (setq count (1+ count))
113 (nnheader-message 5 "nnmh: Receiving headers... %d%%"
114 (/ (* count 100) number))))
117 (nnheader-message 5 "nnmh: Receiving headers...done"))
119 (nnheader-fold-continuation-lines)
122 (deffoo nnmh-open-server (server &optional defs)
123 (nnoo-change-server 'nnmh server defs)
124 (when (not (file-exists-p nnmh-directory))
126 (make-directory nnmh-directory t)
129 ((not (file-exists-p nnmh-directory))
131 (nnheader-report 'nnmh "Couldn't create directory: %s" nnmh-directory))
132 ((not (file-directory-p (file-truename nnmh-directory)))
134 (nnheader-report 'nnmh "Not a directory: %s" nnmh-directory))
136 (nnheader-report 'nnmh "Opened server %s using directory %s"
137 server nnmh-directory)
140 (deffoo nnmh-request-article (id &optional newsgroup server buffer)
141 (nnmh-possibly-change-directory newsgroup server)
142 (let ((file (if (stringp id)
144 (concat nnmh-current-directory (int-to-string id))))
145 (pathname-coding-system 'binary)
146 (nntp-server-buffer (or buffer nntp-server-buffer)))
149 (not (file-directory-p file))
150 (save-excursion (nnmail-find-file file))
151 (string-to-int (file-name-nondirectory file)))))
153 (deffoo nnmh-request-group (group &optional server dont-check)
154 (nnheader-init-server-buffer)
155 (nnmh-possibly-change-directory group server)
156 (let ((pathname (nnmail-group-pathname group nnmh-directory))
157 (pathname-coding-system 'binary)
160 ((not (file-directory-p pathname))
162 'nnmh "Can't select group (no such directory): %s" group))
164 (setq nnmh-current-directory pathname)
165 (and nnmh-get-new-mail
167 (nnmh-update-gnus-unreads group))
170 (nnheader-report 'nnmh "Selected group %s" group)
173 ;; Re-scan the directory if it's on a foreign system.
174 (nnheader-re-read-dir pathname)
177 (mapcar (lambda (name) (string-to-int name))
178 (directory-files pathname nil "^[0-9]+$" t))
182 (setq nnmh-group-alist
183 (delq (assoc group nnmh-group-alist) nnmh-group-alist))
184 (push (list group (cons (car dir) (car (last dir))))
186 (nnheader-report 'nnmh "Selected group %s" group)
188 "211 %d %d %d %s\n" (length dir) (car dir)
189 (car (last dir)) group))
191 (nnheader-report 'nnmh "Empty group %s" group)
192 (nnheader-insert (format "211 0 1 0 %s\n" group))))))))))
194 (deffoo nnmh-request-scan (&optional group server)
195 (nnmail-get-new-mail 'nnmh nil nnmh-directory group))
197 (deffoo nnmh-request-list (&optional server dir)
199 (nnmh-possibly-change-directory nil server)
200 (let ((pathname-coding-system 'binary)
202 (file-truename (or dir (file-name-as-directory nnmh-directory)))))
203 (nnmh-request-list-1 nnmh-toplev))
204 (setq nnmh-group-alist (nnmail-get-active))
208 (defun nnmh-request-list-1 (dir)
209 (setq dir (expand-file-name dir))
210 ;; Recurse down all directories.
211 (let ((dirs (and (file-readable-p dir)
212 (> (nth 1 (file-attributes (file-chase-links dir))) 2)
213 (nnheader-directory-files dir t nil t)))
215 ;; Recurse down directories.
216 (while (setq rdir (pop dirs))
217 (when (and (file-directory-p rdir)
218 (file-readable-p rdir)
219 (not (equal (file-truename rdir)
220 (file-truename dir))))
221 (nnmh-request-list-1 rdir))))
222 ;; For each directory, generate an active file line.
223 (unless (string= (expand-file-name nnmh-toplev) dir)
225 (lambda (name) (string-to-int name))
226 (directory-files dir nil "^[0-9]+$" t))))
229 (set-buffer nntp-server-buffer)
230 (goto-char (point-max))
237 (file-truename (file-name-as-directory
238 (expand-file-name nnmh-toplev))))
240 (nnheader-replace-chars-in-string
241 (mm-decode-coding-string (substring dir (match-end 0))
242 nnmail-pathname-coding-system)
245 (apply 'min files)))))))
248 (deffoo nnmh-request-newgroups (date &optional server)
249 (nnmh-request-list server))
251 (deffoo nnmh-request-expire-articles (articles newsgroup
252 &optional server force)
253 (nnmh-possibly-change-directory newsgroup server)
255 article rest mod-time)
256 (nnheader-init-server-buffer)
258 (while (and articles is-old)
259 (setq article (concat nnmh-current-directory
260 (int-to-string (car articles))))
261 (when (setq mod-time (nth 5 (file-attributes article)))
262 (if (and (nnmh-deletable-article-p newsgroup (car articles))
264 (nnmail-expired-article-p newsgroup mod-time force)))
266 (nnheader-message 5 "Deleting article %s in %s..."
269 (funcall nnmail-delete-file-function article)
271 (nnheader-message 1 "Couldn't delete article %s in %s"
273 (push (car articles) rest))))
274 (push (car articles) rest)))
275 (setq articles (cdr articles)))
276 (nnheader-message 5 "")
277 (nconc rest articles)))
279 (deffoo nnmh-close-group (group &optional server)
282 (deffoo nnmh-request-move-article
283 (article group server accept-form &optional last)
284 (let ((buf (get-buffer-create " *nnmh move*"))
287 (nnmh-deletable-article-p group article)
288 (nnmh-request-article article group server)
292 (insert-buffer-substring nntp-server-buffer)
293 (setq result (eval accept-form))
294 (kill-buffer (current-buffer))
297 (nnmh-possibly-change-directory group server)
299 (funcall nnmail-delete-file-function
300 (concat nnmh-current-directory (int-to-string article)))
304 (deffoo nnmh-request-accept-article (group &optional server last noinsert)
305 (nnmh-possibly-change-directory group server)
306 (nnmail-check-syntax)
307 (when nnmail-cache-accepted-message-ids
308 (nnmail-cache-insert (nnmail-fetch-field "message-id")))
309 (nnheader-init-server-buffer)
313 (nnmh-active-number group)
315 (list (cons group (nnmh-active-number group)))
317 (let ((res (nnmail-article-group 'nnmh-active-number)))
319 (yes-or-no-p "Moved to `junk' group; delete article? "))
321 (car (nnmh-save-mail res noinsert)))))
322 (when (and last nnmail-cache-accepted-message-ids)
323 (nnmail-cache-close))))
325 (deffoo nnmh-request-replace-article (article group buffer)
326 (nnmh-possibly-change-directory group)
329 (nnmh-possibly-create-directory group)
332 (point-min) (point-max)
333 (concat nnmh-current-directory (int-to-string article))
334 nil (if (nnheader-be-verbose 5) nil 'nomesg))
337 (deffoo nnmh-request-create-group (group &optional server args)
338 (nnheader-init-server-buffer)
339 (unless (assoc group nnmh-group-alist)
341 (push (list group (setq active (cons 1 0)))
343 (nnmh-possibly-create-directory group)
344 (nnmh-possibly-change-directory group server)
345 (let ((articles (mapcar
347 (string-to-int file))
349 nnmh-current-directory nil "^[0-9]+$"))))
351 (setcar active (apply 'min articles))
352 (setcdr active (apply 'max articles))))))
355 (deffoo nnmh-request-delete-group (group &optional force server)
356 (nnmh-possibly-change-directory group server)
357 ;; Delete all articles in GROUP.
359 () ; Don't delete the articles.
360 (let ((articles (directory-files nnmh-current-directory t "^[0-9]+$")))
362 (when (file-writable-p (car articles))
363 (nnheader-message 5 "Deleting article %s in %s..."
364 (car articles) group)
365 (funcall nnmail-delete-file-function (car articles)))
366 (setq articles (cdr articles))))
367 ;; Try to delete the directory itself.
369 (delete-directory nnmh-current-directory)))
370 ;; Remove the group from all structures.
371 (setq nnmh-group-alist
372 (delq (assoc group nnmh-group-alist) nnmh-group-alist)
373 nnmh-current-directory nil)
376 (deffoo nnmh-request-rename-group (group new-name &optional server)
377 (nnmh-possibly-change-directory group server)
378 (let ((new-dir (nnmail-group-pathname new-name nnmh-directory))
379 (old-dir (nnmail-group-pathname group nnmh-directory)))
381 (make-directory new-dir t)
383 ;; We move the articles file by file instead of renaming
384 ;; the directory -- there may be subgroups in this group.
385 ;; One might be more clever, I guess.
386 (let ((files (nnheader-article-to-file-alist old-dir)))
389 (concat old-dir (cdar files))
390 (concat new-dir (cdar files)))
392 (when (<= (length (directory-files old-dir)) 2)
394 (delete-directory old-dir)))
395 ;; That went ok, so we change the internal structures.
396 (let ((entry (assoc group nnmh-group-alist)))
398 (setcar entry new-name))
399 (setq nnmh-current-directory nil)
402 (nnoo-define-skeleton nnmh)
405 ;;; Internal functions.
407 (defun nnmh-possibly-change-directory (newsgroup &optional server)
409 (not (nnmh-server-opened server)))
410 (nnmh-open-server server))
412 (let ((pathname (nnmail-group-pathname newsgroup nnmh-directory))
413 (pathname-coding-system 'binary))
414 (if (file-directory-p pathname)
415 (setq nnmh-current-directory pathname)
416 (error "No such newsgroup: %s" newsgroup)))))
418 (defun nnmh-possibly-create-directory (group)
420 (setq dir (nnmail-group-pathname group nnmh-directory))
421 (while (not (file-directory-p dir))
423 (setq dir (file-name-directory (directory-file-name dir))))
425 (when (make-directory (directory-file-name (car dirs)))
426 (error "Could not create directory %s" (car dirs)))
427 (nnheader-message 5 "Creating mail directory %s" (car dirs))
428 (setq dirs (cdr dirs)))))
430 (defun nnmh-save-mail (group-art &optional noinsert)
431 "Called narrowed to an article."
433 (nnmail-insert-lines)
434 (nnmail-insert-xref group-art))
435 (run-hooks 'nnmail-prepare-save-mail-hook)
436 (run-hooks 'nnmh-prepare-save-mail-hook)
437 (goto-char (point-min))
438 (while (looking-at "From ")
439 (replace-match "X-From-Line: ")
441 ;; We save the article in all the newsgroups it belongs in.
445 (nnmh-possibly-create-directory (caar ga))
446 (let ((file (concat (nnmail-group-pathname
447 (caar ga) nnmh-directory)
448 (int-to-string (cdar ga)))))
450 ;; It was already saved, so we just make a hard link.
451 (funcall nnmail-crosspost-link-function first file t)
453 (nnmail-write-region (point-min) (point-max) file nil nil)
458 (defun nnmh-active-number (group)
459 "Compute the next article number in GROUP."
460 (let ((active (cadr (assoc group nnmh-group-alist)))
461 (dir (nnmail-group-pathname group nnmh-directory))
462 (pathname-coding-system 'binary)
465 ;; The group wasn't known to nnmh, so we just create an active
467 (setq active (cons 1 0))
468 (push (list group active) nnmh-group-alist)
469 (unless (file-exists-p dir)
470 (gnus-make-directory dir))
471 ;; Find the highest number in the group.
476 (directory-files dir nil "^[0-9]+$"))
479 (setcdr active (car files)))))
480 (setcdr active (1+ (cdr active)))
482 ;; See whether the file exists...
484 (setq file (concat (nnmail-group-pathname group nnmh-directory)
485 (int-to-string (cdr active)))))
486 ;; ... or there is a buffer that will make that file exist
488 (get-file-buffer file))
489 ;; Skip past that file.
490 (setcdr active (1+ (cdr active))))
493 (defun nnmh-update-gnus-unreads (group)
494 ;; Go through the .nnmh-articles file and compare with the actual
495 ;; articles in this folder. The articles that are "new" will be
496 ;; marked as unread by Gnus.
497 (let* ((dir nnmh-current-directory)
498 (files (sort (mapcar (function (lambda (name) (string-to-int name)))
499 (directory-files nnmh-current-directory
502 (nnmh-file (concat dir ".nnmh-articles"))
504 ;; Load the .nnmh-articles file.
505 (when (file-exists-p nnmh-file)
507 (let (nnmh-newsgroup-articles)
508 (ignore-errors (load nnmh-file nil t t))
509 nnmh-newsgroup-articles)))
510 ;; Add all new articles to the `new' list.
513 (unless (assq (car art) articles)
514 (push (car art) new))
515 (setq art (cdr art))))
516 ;; Remove all deleted articles.
517 (let ((art articles))
519 (unless (memq (caar art) files)
520 (setq articles (delq (car art) articles)))
521 (setq art (cdr art))))
522 ;; Check whether the articles really are the ones that Gnus thinks
523 ;; they are by looking at the time-stamps.
524 (let ((arts articles)
526 (while (setq art (pop arts))
528 (nth 5 (file-attributes
529 (concat dir (int-to-string (car art)))))
531 (setq articles (delq art articles))
532 (push (car art) new))))
533 ;; Go through all the new articles and add them, and their
534 ;; time-stamps, to the list.
540 (nth 5 (file-attributes
541 (concat dir (int-to-string art))))))
543 ;; Make Gnus mark all new articles as unread.
545 (gnus-make-articles-unread
546 (gnus-group-prefixed-name group (list 'nnmh ""))
547 (setq new (sort new '<))))
548 ;; Sort the article list with highest numbers first.
549 (setq articles (sort articles (lambda (art1 art2)
550 (> (car art1) (car art2)))))
551 ;; Finally write this list back to the .nnmh-articles file.
552 (with-temp-file nnmh-file
553 (insert ";; Gnus article active file for " group "\n\n")
554 (insert "(setq nnmh-newsgroup-articles '")
555 (gnus-prin1 articles)
558 (defun nnmh-deletable-article-p (group article)
559 "Say whether ARTICLE in GROUP can be deleted."
560 (let ((path (concat nnmh-current-directory (int-to-string article))))
562 (and (file-writable-p path)
564 ;; We can never delete the last article in the group.
565 (not (eq (cdr (nth 1 (assoc group nnmh-group-alist)))
568 nnmh-allow-delete-final))))
572 ;;; nnmh.el ends here