1 ;;; nnmh.el --- mhspool access for Gnus
3 ;; Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000
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 (nnheader-replace-chars-in-string
243 (mm-decode-coding-string (substring dir
(match-end 0))
244 nnmail-pathname-coding-system
)
247 (apply 'min files
)))))))
250 (deffoo nnmh-request-newgroups
(date &optional server
)
251 (nnmh-request-list server
))
253 (deffoo nnmh-request-expire-articles
(articles newsgroup
254 &optional server force
)
255 (nnmh-possibly-change-directory newsgroup server
)
257 article rest mod-time
)
258 (nnheader-init-server-buffer)
260 (while (and articles is-old
)
261 (setq article
(concat nnmh-current-directory
262 (int-to-string (car articles
))))
263 (when (setq mod-time
(nth 5 (file-attributes article
)))
264 (if (and (nnmh-deletable-article-p newsgroup
(car articles
))
266 (nnmail-expired-article-p newsgroup mod-time force
)))
268 (nnheader-message 5 "Deleting article %s in %s..."
271 (funcall nnmail-delete-file-function article
)
273 (nnheader-message 1 "Couldn't delete article %s in %s"
275 (push (car articles
) rest
))))
276 (push (car articles
) rest
)))
277 (setq articles
(cdr articles
)))
278 (nnheader-message 5 "")
279 (nconc rest articles
)))
281 (deffoo nnmh-close-group
(group &optional server
)
284 (deffoo nnmh-request-move-article
285 (article group server accept-form
&optional last
)
286 (let ((buf (get-buffer-create " *nnmh move*"))
289 (nnmh-deletable-article-p group article
)
290 (nnmh-request-article article group server
)
294 (insert-buffer-substring nntp-server-buffer
)
295 (setq result
(eval accept-form
))
296 (kill-buffer (current-buffer))
299 (nnmh-possibly-change-directory group server
)
301 (funcall nnmail-delete-file-function
302 (concat nnmh-current-directory
(int-to-string article
)))
306 (deffoo nnmh-request-accept-article
(group &optional server last noinsert
)
307 (nnmh-possibly-change-directory group server
)
308 (nnmail-check-syntax)
309 (when nnmail-cache-accepted-message-ids
310 (nnmail-cache-insert (nnmail-fetch-field "message-id")))
311 (nnheader-init-server-buffer)
315 (nnmh-active-number group
)
317 (list (cons group
(nnmh-active-number group
)))
319 (let ((res (nnmail-article-group 'nnmh-active-number
)))
321 (yes-or-no-p "Moved to `junk' group; delete article? "))
323 (car (nnmh-save-mail res noinsert
)))))
324 (when (and last nnmail-cache-accepted-message-ids
)
325 (nnmail-cache-close))))
327 (deffoo nnmh-request-replace-article
(article group buffer
)
328 (nnmh-possibly-change-directory group
)
331 (nnmh-possibly-create-directory group
)
334 (point-min) (point-max)
335 (concat nnmh-current-directory
(int-to-string article
))
336 nil
(if (nnheader-be-verbose 5) nil
'nomesg
))
339 (deffoo nnmh-request-create-group
(group &optional server args
)
340 (nnheader-init-server-buffer)
341 (unless (assoc group nnmh-group-alist
)
343 (push (list group
(setq active
(cons 1 0)))
345 (nnmh-possibly-create-directory group
)
346 (nnmh-possibly-change-directory group server
)
347 (let ((articles (mapcar
349 (string-to-int file
))
351 nnmh-current-directory nil
"^[0-9]+$"))))
353 (setcar active
(apply 'min articles
))
354 (setcdr active
(apply 'max articles
))))))
357 (deffoo nnmh-request-delete-group
(group &optional force server
)
358 (nnmh-possibly-change-directory group server
)
359 ;; Delete all articles in GROUP.
361 () ; Don't delete the articles.
362 (let ((articles (directory-files nnmh-current-directory t
"^[0-9]+$")))
364 (when (file-writable-p (car articles
))
365 (nnheader-message 5 "Deleting article %s in %s..."
366 (car articles
) group
)
367 (funcall nnmail-delete-file-function
(car articles
)))
368 (setq articles
(cdr articles
))))
369 ;; Try to delete the directory itself.
371 (delete-directory nnmh-current-directory
)))
372 ;; Remove the group from all structures.
373 (setq nnmh-group-alist
374 (delq (assoc group nnmh-group-alist
) nnmh-group-alist
)
375 nnmh-current-directory nil
)
378 (deffoo nnmh-request-rename-group
(group new-name
&optional server
)
379 (nnmh-possibly-change-directory group server
)
380 (let ((new-dir (nnmail-group-pathname new-name nnmh-directory
))
381 (old-dir (nnmail-group-pathname group nnmh-directory
)))
383 (make-directory new-dir t
)
385 ;; We move the articles file by file instead of renaming
386 ;; the directory -- there may be subgroups in this group.
387 ;; One might be more clever, I guess.
388 (let ((files (nnheader-article-to-file-alist old-dir
)))
391 (concat old-dir
(cdar files
))
392 (concat new-dir
(cdar files
)))
394 (when (<= (length (directory-files old-dir
)) 2)
396 (delete-directory old-dir
)))
397 ;; That went ok, so we change the internal structures.
398 (let ((entry (assoc group nnmh-group-alist
)))
400 (setcar entry new-name
))
401 (setq nnmh-current-directory nil
)
404 (nnoo-define-skeleton nnmh
)
407 ;;; Internal functions.
409 (defun nnmh-possibly-change-directory (newsgroup &optional server
)
411 (not (nnmh-server-opened server
)))
412 (nnmh-open-server server
))
414 (let ((pathname (nnmail-group-pathname newsgroup nnmh-directory
))
415 (file-name-coding-system nnmail-pathname-coding-system
))
416 (if (file-directory-p pathname
)
417 (setq nnmh-current-directory pathname
)
418 (error "No such newsgroup: %s" newsgroup
)))))
420 (defun nnmh-possibly-create-directory (group)
422 (setq dir
(nnmail-group-pathname group nnmh-directory
))
423 (while (not (file-directory-p dir
))
425 (setq dir
(file-name-directory (directory-file-name dir
))))
427 (when (make-directory (directory-file-name (car dirs
)))
428 (error "Could not create directory %s" (car dirs
)))
429 (nnheader-message 5 "Creating mail directory %s" (car dirs
))
430 (setq dirs
(cdr dirs
)))))
432 (defun nnmh-save-mail (group-art &optional noinsert
)
433 "Called narrowed to an article."
435 (nnmail-insert-lines)
436 (nnmail-insert-xref group-art
))
437 (run-hooks 'nnmail-prepare-save-mail-hook
)
438 (run-hooks 'nnmh-prepare-save-mail-hook
)
439 (goto-char (point-min))
440 (while (looking-at "From ")
441 (replace-match "X-From-Line: ")
443 ;; We save the article in all the newsgroups it belongs in.
447 (nnmh-possibly-create-directory (caar ga
))
448 (let ((file (concat (nnmail-group-pathname
449 (caar ga
) nnmh-directory
)
450 (int-to-string (cdar ga
)))))
452 ;; It was already saved, so we just make a hard link.
453 (funcall nnmail-crosspost-link-function first file t
)
455 (nnmail-write-region (point-min) (point-max) file nil nil
)
460 (defun nnmh-active-number (group)
461 "Compute the next article number in GROUP."
462 (let ((active (cadr (assoc group nnmh-group-alist
)))
463 (dir (nnmail-group-pathname group nnmh-directory
))
464 (file-name-coding-system nnmail-pathname-coding-system
)
467 ;; The group wasn't known to nnmh, so we just create an active
469 (setq active
(cons 1 0))
470 (push (list group active
) nnmh-group-alist
)
471 (unless (file-exists-p dir
)
472 (gnus-make-directory dir
))
473 ;; Find the highest number in the group.
478 (directory-files dir nil
"^[0-9]+$"))
481 (setcdr active
(car files
)))))
482 (setcdr active
(1+ (cdr active
)))
484 ;; See whether the file exists...
486 (setq file
(concat (nnmail-group-pathname group nnmh-directory
)
487 (int-to-string (cdr active
)))))
488 ;; ... or there is a buffer that will make that file exist
490 (get-file-buffer file
))
491 ;; Skip past that file.
492 (setcdr active
(1+ (cdr active
))))
495 (defun nnmh-update-gnus-unreads (group)
496 ;; Go through the .nnmh-articles file and compare with the actual
497 ;; articles in this folder. The articles that are "new" will be
498 ;; marked as unread by Gnus.
499 (let* ((dir nnmh-current-directory
)
500 (files (sort (mapcar (function (lambda (name) (string-to-int name
)))
501 (directory-files nnmh-current-directory
504 (nnmh-file (concat dir
".nnmh-articles"))
506 ;; Load the .nnmh-articles file.
507 (when (file-exists-p nnmh-file
)
509 (let (nnmh-newsgroup-articles)
510 (ignore-errors (load nnmh-file nil t t
))
511 nnmh-newsgroup-articles
)))
512 ;; Add all new articles to the `new' list.
515 (unless (assq (car art
) articles
)
516 (push (car art
) new
))
517 (setq art
(cdr art
))))
518 ;; Remove all deleted articles.
519 (let ((art articles
))
521 (unless (memq (caar art
) files
)
522 (setq articles
(delq (car art
) articles
)))
523 (setq art
(cdr art
))))
524 ;; Check whether the articles really are the ones that Gnus thinks
525 ;; they are by looking at the time-stamps.
526 (let ((arts articles
)
528 (while (setq art
(pop arts
))
530 (nth 5 (file-attributes
531 (concat dir
(int-to-string (car art
)))))
533 (setq articles
(delq art articles
))
534 (push (car art
) new
))))
535 ;; Go through all the new articles and add them, and their
536 ;; time-stamps, to the list.
542 (nth 5 (file-attributes
543 (concat dir
(int-to-string art
))))))
545 ;; Make Gnus mark all new articles as unread.
547 (gnus-make-articles-unread
548 (gnus-group-prefixed-name group
(list 'nnmh
""))
549 (setq new
(sort new
'<))))
550 ;; Sort the article list with highest numbers first.
551 (setq articles
(sort articles
(lambda (art1 art2
)
552 (> (car art1
) (car art2
)))))
553 ;; Finally write this list back to the .nnmh-articles file.
554 (with-temp-file nnmh-file
555 (insert ";; Gnus article active file for " group
"\n\n")
556 (insert "(setq nnmh-newsgroup-articles '")
557 (gnus-prin1 articles
)
560 (defun nnmh-deletable-article-p (group article
)
561 "Say whether ARTICLE in GROUP can be deleted."
562 (let ((path (concat nnmh-current-directory
(int-to-string article
))))
564 (and (file-writable-p path
)
566 ;; We can never delete the last article in the group.
567 (not (eq (cdr (nth 1 (assoc group nnmh-group-alist
)))
570 nnmh-allow-delete-final
))))
574 ;;; nnmh.el ends here