1 ;;; nnmh.el --- mhspool 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 ;; 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 (message "nnmh: Receiving headers... %d%%"
108 (/ (* count 100) number))))
111 (message "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 (nnmh-possibly-change-directory group server)
149 (let ((pathname (nnmail-group-pathname group nnmh-directory))
150 (pathname-coding-system 'binary)
153 ((not (file-directory-p pathname))
155 'nnmh "Can't select group (no such directory): %s" group))
157 (setq nnmh-current-directory pathname)
158 (and nnmh-get-new-mail
160 (nnmh-update-gnus-unreads group))
163 (nnheader-report 'nnmh "Selected group %s" group)
166 ;; Re-scan the directory if it's on a foreign system.
167 (nnheader-re-read-dir pathname)
170 (mapcar (lambda (name) (string-to-int name))
171 (directory-files pathname nil "^[0-9]+$" t))
175 (nnheader-report 'nnmh "Selected group %s" group)
177 "211 %d %d %d %s\n" (length dir) (car dir)
178 (progn (while (cdr dir) (setq dir (cdr dir))) (car dir))
181 (nnheader-report 'nnmh "Empty group %s" group)
182 (nnheader-insert (format "211 0 1 0 %s\n" group))))))))))
184 (deffoo nnmh-request-scan (&optional group server)
185 (nnmail-get-new-mail 'nnmh nil nnmh-directory group))
187 (deffoo nnmh-request-list (&optional server dir)
189 (nnmh-possibly-change-directory nil server)
190 (let ((pathname-coding-system 'binary)
192 (file-truename (or dir (file-name-as-directory nnmh-directory)))))
193 (nnmh-request-list-1 nnmh-toplev))
194 (setq nnmh-group-alist (nnmail-get-active))
198 (defun nnmh-request-list-1 (dir)
199 (setq dir (expand-file-name dir))
200 ;; Recurse down all directories.
201 (let ((dirs (and (file-readable-p dir)
202 (> (nth 1 (file-attributes (file-chase-links dir))) 2)
203 (nnheader-directory-files dir t nil t)))
205 ;; Recurse down directories.
206 (while (setq rdir (pop dirs))
207 (when (and (file-directory-p rdir)
208 (file-readable-p rdir)
209 (not (equal (file-truename rdir)
210 (file-truename dir))))
211 (nnmh-request-list-1 rdir))))
212 ;; For each directory, generate an active file line.
213 (unless (string= (expand-file-name nnmh-toplev) dir)
215 (lambda (name) (string-to-int name))
216 (directory-files dir nil "^[0-9]+$" t))))
219 (set-buffer nntp-server-buffer)
220 (goto-char (point-max))
227 (file-truename (file-name-as-directory
228 (expand-file-name nnmh-toplev))))
230 (nnheader-replace-chars-in-string
231 (gnus-decode-coding-string (substring dir (match-end 0))
232 nnmail-pathname-coding-system)
235 (apply 'min files)))))))
238 (deffoo nnmh-request-newgroups (date &optional server)
239 (nnmh-request-list server))
241 (deffoo nnmh-request-expire-articles (articles newsgroup
242 &optional server force)
243 (nnmh-possibly-change-directory newsgroup server)
244 (let* ((active-articles
248 (string-to-int name)))
249 (directory-files nnmh-current-directory nil "^[0-9]+$" t)))
251 article rest mod-time)
252 (nnmail-activate 'nnmh)
254 (while (and articles is-old)
255 (setq article (concat nnmh-current-directory
256 (int-to-string (car articles))))
257 (when (setq mod-time (nth 5 (file-attributes article)))
258 (if (and (nnmh-deletable-article-p newsgroup (car articles))
260 (nnmail-expired-article-p newsgroup mod-time force)))
262 (nnheader-message 5 "Deleting article %s in %s..."
265 (funcall nnmail-delete-file-function article)
267 (nnheader-message 1 "Couldn't delete article %s in %s"
269 (push (car articles) rest))))
270 (push (car articles) rest)))
271 (setq articles (cdr articles)))
273 (nconc rest articles)))
275 (deffoo nnmh-close-group (group &optional server)
278 (deffoo nnmh-request-move-article
279 (article group server accept-form &optional last)
280 (let ((buf (get-buffer-create " *nnmh move*"))
283 (nnmh-deletable-article-p group article)
284 (nnmh-request-article article group server)
288 (insert-buffer-substring nntp-server-buffer)
289 (setq result (eval accept-form))
290 (kill-buffer (current-buffer))
293 (nnmh-possibly-change-directory group server)
295 (funcall nnmail-delete-file-function
296 (concat nnmh-current-directory (int-to-string article)))
300 (deffoo nnmh-request-accept-article (group &optional server last noinsert)
301 (nnmh-possibly-change-directory group server)
302 (nnmail-check-syntax)
303 (when nnmail-cache-accepted-message-ids
304 (nnmail-cache-insert (nnmail-fetch-field "message-id")))
308 (nnmail-activate 'nnmh)
310 (nnmh-active-number group)
312 (list (cons group (nnmh-active-number group)))
315 (nnmail-activate 'nnmh)
316 (let ((res (nnmail-article-group 'nnmh-active-number)))
318 (yes-or-no-p "Moved to `junk' group; delete article? "))
320 (car (nnmh-save-mail res noinsert))))))
321 (when (and last nnmail-cache-accepted-message-ids)
322 (nnmail-cache-close))))
324 (deffoo nnmh-request-replace-article (article group buffer)
325 (nnmh-possibly-change-directory group)
328 (nnmh-possibly-create-directory group)
331 (point-min) (point-max)
332 (concat nnmh-current-directory (int-to-string article))
333 nil (if (nnheader-be-verbose 5) nil 'nomesg))
336 (deffoo nnmh-request-create-group (group &optional server args)
337 (nnmail-activate 'nnmh)
338 (unless (assoc group nnmh-group-alist)
340 (push (list group (setq active (cons 1 0)))
342 (nnmh-possibly-create-directory group)
343 (nnmh-possibly-change-directory group server)
344 (let ((articles (mapcar
346 (string-to-int file))
348 nnmh-current-directory nil "^[0-9]+$"))))
350 (setcar active (apply 'min articles))
351 (setcdr active (apply 'max articles))))))
354 (deffoo nnmh-request-delete-group (group &optional force server)
355 (nnmh-possibly-change-directory group server)
356 ;; Delete all articles in GROUP.
358 () ; Don't delete the articles.
359 (let ((articles (directory-files nnmh-current-directory t "^[0-9]+$")))
361 (when (file-writable-p (car articles))
362 (nnheader-message 5 "Deleting article %s in %s..."
363 (car articles) group)
364 (funcall nnmail-delete-file-function (car articles)))
365 (setq articles (cdr articles))))
366 ;; Try to delete the directory itself.
368 (delete-directory nnmh-current-directory)))
369 ;; Remove the group from all structures.
370 (setq nnmh-group-alist
371 (delq (assoc group nnmh-group-alist) nnmh-group-alist)
372 nnmh-current-directory nil)
375 (deffoo nnmh-request-rename-group (group new-name &optional server)
376 (nnmh-possibly-change-directory group server)
377 (let ((new-dir (nnmail-group-pathname new-name nnmh-directory))
378 (old-dir (nnmail-group-pathname group nnmh-directory)))
380 (make-directory new-dir t)
382 ;; We move the articles file by file instead of renaming
383 ;; the directory -- there may be subgroups in this group.
384 ;; One might be more clever, I guess.
385 (let ((files (nnheader-article-to-file-alist old-dir)))
388 (concat old-dir (cdar files))
389 (concat new-dir (cdar files)))
391 (when (<= (length (directory-files old-dir)) 2)
393 (delete-directory old-dir)))
394 ;; That went ok, so we change the internal structures.
395 (let ((entry (assoc group nnmh-group-alist)))
397 (setcar entry new-name))
398 (setq nnmh-current-directory nil)
401 (nnoo-define-skeleton nnmh)
404 ;;; Internal functions.
406 (defun nnmh-possibly-change-directory (newsgroup &optional server)
408 (not (nnmh-server-opened server)))
409 (nnmh-open-server server))
411 (let ((pathname (nnmail-group-pathname newsgroup nnmh-directory))
412 (pathname-coding-system 'binary))
413 (if (file-directory-p pathname)
414 (setq nnmh-current-directory pathname)
415 (error "No such newsgroup: %s" newsgroup)))))
417 (defun nnmh-possibly-create-directory (group)
419 (setq dir (nnmail-group-pathname group nnmh-directory))
420 (while (not (file-directory-p dir))
422 (setq dir (file-name-directory (directory-file-name dir))))
424 (when (make-directory (directory-file-name (car dirs)))
425 (error "Could not create directory %s" (car dirs)))
426 (nnheader-message 5 "Creating mail directory %s" (car dirs))
427 (setq dirs (cdr dirs)))))
429 (defun nnmh-save-mail (group-art &optional noinsert)
430 "Called narrowed to an article."
432 (nnmail-insert-lines)
433 (nnmail-insert-xref group-art))
434 (run-hooks 'nnmail-prepare-save-mail-hook)
435 (run-hooks 'nnmh-prepare-save-mail-hook)
436 (goto-char (point-min))
437 (while (looking-at "From ")
438 (replace-match "X-From-Line: ")
440 ;; We save the article in all the newsgroups it belongs in.
444 (nnmh-possibly-create-directory (caar ga))
445 (let ((file (concat (nnmail-group-pathname
446 (caar ga) nnmh-directory)
447 (int-to-string (cdar ga)))))
449 ;; It was already saved, so we just make a hard link.
450 (funcall nnmail-crosspost-link-function first file t)
452 (nnmail-write-region (point-min) (point-max) file nil nil)
457 (defun nnmh-active-number (group)
458 "Compute the next article number in GROUP."
459 (let ((active (cadr (assoc group nnmh-group-alist)))
460 (dir (nnmail-group-pathname group nnmh-directory))
461 (pathname-coding-system 'binary))
463 ;; The group wasn't known to nnmh, so we just create an active
465 (setq active (cons 1 0))
466 (push (list group active) nnmh-group-alist)
467 (unless (file-exists-p dir)
468 (make-directory dir))
469 ;; Find the highest number in the group.
474 (directory-files dir nil "^[0-9]+$"))
477 (setcdr active (car files)))))
478 (setcdr active (1+ (cdr active)))
479 (while (file-exists-p
480 (concat (nnmail-group-pathname group nnmh-directory)
481 (int-to-string (cdr active))))
482 (setcdr active (1+ (cdr active))))
485 (defun nnmh-update-gnus-unreads (group)
486 ;; Go through the .nnmh-articles file and compare with the actual
487 ;; articles in this folder. The articles that are "new" will be
488 ;; marked as unread by Gnus.
489 (let* ((dir nnmh-current-directory)
490 (files (sort (mapcar (function (lambda (name) (string-to-int name)))
491 (directory-files nnmh-current-directory
494 (nnmh-file (concat dir ".nnmh-articles"))
496 ;; Load the .nnmh-articles file.
497 (when (file-exists-p nnmh-file)
499 (let (nnmh-newsgroup-articles)
500 (ignore-errors (load nnmh-file nil t t))
501 nnmh-newsgroup-articles)))
502 ;; Add all new articles to the `new' list.
505 (unless (assq (car art) articles)
506 (push (car art) new))
507 (setq art (cdr art))))
508 ;; Remove all deleted articles.
509 (let ((art articles))
511 (unless (memq (caar art) files)
512 (setq articles (delq (car art) articles)))
513 (setq art (cdr art))))
514 ;; Check whether the articles really are the ones that Gnus thinks
515 ;; they are by looking at the time-stamps.
516 (let ((arts articles)
518 (while (setq art (pop arts))
520 (nth 5 (file-attributes
521 (concat dir (int-to-string (car art)))))
523 (setq articles (delq art articles))
524 (push (car art) new))))
525 ;; Go through all the new articles and add them, and their
526 ;; time-stamps, to the list.
532 (nth 5 (file-attributes
533 (concat dir (int-to-string art))))))
535 ;; Make Gnus mark all new articles as unread.
537 (gnus-make-articles-unread
538 (gnus-group-prefixed-name group (list 'nnmh ""))
539 (setq new (sort new '<))))
540 ;; Sort the article list with highest numbers first.
541 (setq articles (sort articles (lambda (art1 art2)
542 (> (car art1) (car art2)))))
543 ;; Finally write this list back to the .nnmh-articles file.
544 (nnheader-temp-write nnmh-file
545 (insert ";; Gnus article active file for " group "\n\n")
546 (insert "(setq nnmh-newsgroup-articles '")
547 (gnus-prin1 articles)
550 (defun nnmh-deletable-article-p (group article)
551 "Say whether ARTICLE in GROUP can be deleted."
552 (let ((path (concat nnmh-current-directory (int-to-string article))))
554 (and (file-writable-p path)
556 ;; We can never delete the last article in the group.
557 (not (eq (cdr (nth 1 (assoc group nnmh-group-alist)))
560 nnmh-allow-delete-final))))
564 ;;; nnmh.el ends here