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 ;; MORIOKA Tomohiko <morioka@jaist.ac.jp>
9 ;; Keywords: news, mail
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software; you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation; either version 2, or (at your option)
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs; see the file COPYING. If not, write to the
25 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
26 ;; Boston, MA 02111-1307, USA.
30 ;; Based on nnspool.el by Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>.
31 ;; For an overview of what the interface functions do, please see the
36 (eval-when-compile (require 'cl))
45 (defvoo nnmh-directory message-directory
46 "Mail spool directory.")
48 (defvoo nnmh-get-new-mail t
49 "If non-nil, nnmh will check the incoming mail file and split the mail.")
51 (defvoo nnmh-prepare-save-mail-hook nil
52 "Hook run narrowed to an article before saving.")
54 (defvoo nnmh-be-safe nil
55 "If non-nil, nnmh will check all articles to make sure whether they are new or not.
56 Go through the .nnmh-articles file and compare with the actual
57 articles in this folder. The articles that are \"new\" will be marked
62 (defconst nnmh-version "nnmh 1.0"
65 (defvoo nnmh-current-directory nil
66 "Current news group directory.")
68 (defvoo nnmh-status-string "")
69 (defvoo nnmh-group-alist nil)
70 ;; Don't even think about setting this variable. It does not exist.
71 ;; Forget about it. Uh-huh. Nope. Nobody here. It's only bound
72 ;; dynamically by certain functions in nndraft.
73 (defvar nnmh-allow-delete-final nil)
77 ;;; Interface functions.
79 (nnoo-define-basics nnmh)
81 (deffoo nnmh-retrieve-headers (articles &optional newsgroup server fetch-old)
83 (set-buffer nntp-server-buffer)
86 (number (length articles))
87 (large (and (numberp nnmail-large-newsgroup)
88 (> number nnmail-large-newsgroup)))
90 (file-name-coding-system nnmail-pathname-coding-system)
92 (nnmh-possibly-change-directory newsgroup server)
93 ;; We don't support fetching by Message-ID.
94 (if (stringp (car articles))
97 (when (and (file-exists-p
98 (setq file (concat (file-name-as-directory
99 nnmh-current-directory)
101 (setq article (pop articles))))))
102 (not (file-directory-p file)))
103 (insert (format "221 %d Article retrieved.\n" article))
105 (nnheader-insert-head file)
107 (if (search-forward "\n\n" nil t)
109 (goto-char (point-max))
112 (delete-region (point) (point-max)))
113 (setq count (1+ count))
117 (nnheader-message 5 "nnmh: Receiving headers... %d%%"
118 (/ (* count 100) number))))
121 (nnheader-message 5 "nnmh: Receiving headers...done"))
123 ;; (nnheader-fold-continuation-lines)
126 (deffoo nnmh-open-server (server &optional defs)
127 (nnoo-change-server 'nnmh server defs)
128 (when (not (file-exists-p nnmh-directory))
130 (make-directory nnmh-directory t)
133 ((not (file-exists-p nnmh-directory))
135 (nnheader-report 'nnmh "Couldn't create directory: %s" nnmh-directory))
136 ((not (file-directory-p (file-truename nnmh-directory)))
138 (nnheader-report 'nnmh "Not a directory: %s" nnmh-directory))
140 (nnheader-report 'nnmh "Opened server %s using directory %s"
141 server nnmh-directory)
144 (deffoo nnmh-request-article (id &optional newsgroup server buffer)
145 (nnmh-possibly-change-directory newsgroup server)
146 (let ((file (if (stringp id)
148 (concat nnmh-current-directory (int-to-string id))))
149 (file-name-coding-system nnmail-pathname-coding-system)
150 (nntp-server-buffer (or buffer nntp-server-buffer)))
153 (not (file-directory-p file))
154 (save-excursion (nnmail-find-file file))
155 (string-to-int (file-name-nondirectory file)))))
157 (deffoo nnmh-request-group (group &optional server dont-check)
158 (nnheader-init-server-buffer)
159 (nnmh-possibly-change-directory group server)
160 (let ((pathname (nnmail-group-pathname group nnmh-directory))
161 (file-name-coding-system nnmail-pathname-coding-system)
164 ((not (file-directory-p pathname))
166 'nnmh "Can't select group (no such directory): %s" group))
168 (setq nnmh-current-directory pathname)
169 (and nnmh-get-new-mail
171 (nnmh-update-gnus-unreads group))
174 (nnheader-report 'nnmh "Selected group %s" group)
177 ;; Re-scan the directory if it's on a foreign system.
178 (nnheader-re-read-dir pathname)
181 (mapcar 'string-to-int
182 (directory-files pathname nil "^[0-9]+$" t))
186 (setq nnmh-group-alist
187 (delq (assoc group nnmh-group-alist) nnmh-group-alist))
188 (push (list group (cons (car dir) (car (last dir))))
190 (nnheader-report 'nnmh "Selected group %s" group)
192 "211 %d %d %d %s\n" (length dir) (car dir)
193 (car (last dir)) group))
195 (nnheader-report 'nnmh "Empty group %s" group)
196 (nnheader-insert (format "211 0 1 0 %s\n" group))))))))))
198 (deffoo nnmh-request-scan (&optional group server)
199 (nnmail-get-new-mail 'nnmh nil nnmh-directory group))
201 (deffoo nnmh-request-list (&optional server dir)
203 (nnmh-possibly-change-directory nil server)
204 (let ((file-name-coding-system nnmail-pathname-coding-system)
206 (file-truename (or dir (file-name-as-directory nnmh-directory)))))
207 (nnmh-request-list-1 nnmh-toplev))
208 (setq nnmh-group-alist (nnmail-get-active))
212 (defun nnmh-request-list-1 (dir)
213 (setq dir (expand-file-name dir))
214 ;; Recurse down all directories.
215 (let ((dirs (and (file-readable-p dir)
216 (> (nth 1 (file-attributes (file-chase-links dir))) 2)
217 (nnheader-directory-files dir t nil t)))
219 ;; Recurse down directories.
220 (while (setq rdir (pop dirs))
221 (when (and (file-directory-p rdir)
222 (file-readable-p rdir)
223 (not (equal (file-truename rdir)
224 (file-truename dir))))
225 (nnmh-request-list-1 rdir))))
226 ;; For each directory, generate an active file line.
227 (unless (string= (expand-file-name nnmh-toplev) dir)
228 (let ((files (mapcar 'string-to-int
229 (directory-files dir nil "^[0-9]+$" t))))
232 (set-buffer nntp-server-buffer)
233 (goto-char (point-max))
240 (file-truename (file-name-as-directory
241 (expand-file-name nnmh-toplev))))
244 (encode-coding-string
245 (nnheader-replace-chars-in-string
246 (substring dir (match-end 0))
248 nnmail-pathname-coding-system)))
250 (apply 'min files)))))))
253 (deffoo nnmh-request-newgroups (date &optional server)
254 (nnmh-request-list server))
256 (deffoo nnmh-request-expire-articles (articles newsgroup
257 &optional server force)
258 (nnmh-possibly-change-directory newsgroup server)
260 article rest mod-time)
261 (nnheader-init-server-buffer)
263 (while (and articles is-old)
264 (setq article (concat nnmh-current-directory
265 (int-to-string (car articles))))
266 (when (setq mod-time (nth 5 (file-attributes article)))
267 (if (and (nnmh-deletable-article-p newsgroup (car articles))
269 (nnmail-expired-article-p newsgroup mod-time force)))
271 ;; Allow a special target group. -- jcn
272 (unless (eq nnmail-expiry-target 'delete)
274 (nnmh-request-article (car articles)
275 newsgroup server (current-buffer))
276 (nnmail-expiry-target-group
277 nnmail-expiry-target newsgroup)))
278 (nnheader-message 5 "Deleting article %s in %s..."
281 (funcall nnmail-delete-file-function article)
283 (nnheader-message 1 "Couldn't delete article %s in %s"
285 (push (car articles) rest))))
286 (push (car articles) rest)))
287 (setq articles (cdr articles)))
288 (nnheader-message 5 "")
289 (nconc rest articles)))
291 (deffoo nnmh-close-group (group &optional server)
294 (deffoo nnmh-request-move-article (article group server
295 accept-form &optional last)
296 (let ((buf (get-buffer-create " *nnmh move*"))
299 (nnmh-deletable-article-p group article)
300 (nnmh-request-article article group server)
304 (insert-buffer-substring nntp-server-buffer)
305 (setq result (eval accept-form))
306 (kill-buffer (current-buffer))
309 (nnmh-possibly-change-directory group server)
311 (funcall nnmail-delete-file-function
312 (concat nnmh-current-directory (int-to-string article)))
316 (deffoo nnmh-request-accept-article (group &optional server last noinsert)
317 (nnmh-possibly-change-directory group server)
318 (if (and (not (equal group "queue"))
319 (not (equal group "draft")))
320 (nnmail-check-syntax))
321 (when nnmail-cache-accepted-message-ids
322 (nnmail-cache-insert (nnmail-fetch-field "message-id")
324 (nnmail-fetch-field "subject")
325 (nnmail-fetch-field "from")))
326 (nnheader-init-server-buffer)
330 (nnmh-active-number group)
332 (list (cons group (nnmh-active-number group)))
334 (let ((res (nnmail-article-group 'nnmh-active-number)))
336 (yes-or-no-p "Moved to `junk' group; delete article? "))
338 (car (nnmh-save-mail res noinsert)))))
339 (when (and last nnmail-cache-accepted-message-ids)
340 (nnmail-cache-close))))
342 (deffoo nnmh-request-replace-article (article group buffer)
343 (nnmh-possibly-change-directory group)
346 (nnmh-possibly-create-directory group)
349 (point-min) (point-max)
350 (concat nnmh-current-directory (int-to-string article))
351 nil (if (nnheader-be-verbose 5) nil 'nomesg))
354 (deffoo nnmh-request-create-group (group &optional server args)
355 (nnheader-init-server-buffer)
356 (unless (assoc group nnmh-group-alist)
358 (push (list group (setq active (cons 1 0)))
360 (nnmh-possibly-create-directory group)
361 (nnmh-possibly-change-directory group server)
362 (let ((articles (mapcar 'string-to-int
364 nnmh-current-directory nil "^[0-9]+$"))))
366 (setcar active (apply 'min articles))
367 (setcdr active (apply 'max articles))))))
370 (deffoo nnmh-request-delete-group (group &optional force server)
371 (nnmh-possibly-change-directory group server)
372 ;; Delete all articles in GROUP.
374 () ; Don't delete the articles.
375 (let ((articles (directory-files nnmh-current-directory t "^[0-9]+$")))
377 (when (file-writable-p (car articles))
378 (nnheader-message 5 "Deleting article %s in %s..."
379 (car articles) group)
380 (funcall nnmail-delete-file-function (car articles)))
381 (setq articles (cdr articles))))
382 ;; Try to delete the directory itself.
384 (delete-directory nnmh-current-directory)))
385 ;; Remove the group from all structures.
386 (setq nnmh-group-alist
387 (delq (assoc group nnmh-group-alist) nnmh-group-alist)
388 nnmh-current-directory nil)
391 (deffoo nnmh-request-rename-group (group new-name &optional server)
392 (nnmh-possibly-change-directory group server)
393 (let ((new-dir (nnmail-group-pathname new-name nnmh-directory))
394 (old-dir (nnmail-group-pathname group nnmh-directory)))
396 (make-directory new-dir t)
398 ;; We move the articles file by file instead of renaming
399 ;; the directory -- there may be subgroups in this group.
400 ;; One might be more clever, I guess.
401 (let ((files (nnheader-article-to-file-alist old-dir)))
404 (concat old-dir (cdar files))
405 (concat new-dir (cdar files)))
407 (when (<= (length (directory-files old-dir)) 2)
409 (delete-directory old-dir)))
410 ;; That went ok, so we change the internal structures.
411 (let ((entry (assoc group nnmh-group-alist)))
413 (setcar entry new-name))
414 (setq nnmh-current-directory nil)
417 (nnoo-define-skeleton nnmh)
420 ;;; Internal functions.
422 (defun nnmh-possibly-change-directory (newsgroup &optional server)
424 (not (nnmh-server-opened server)))
425 (nnmh-open-server server))
427 (let ((pathname (nnmail-group-pathname newsgroup nnmh-directory))
428 (file-name-coding-system nnmail-pathname-coding-system))
429 (if (file-directory-p pathname)
430 (setq nnmh-current-directory pathname)
431 (nnheader-report 'nnmh "Not a directory: %s" nnmh-directory)))))
433 (defun nnmh-possibly-create-directory (group)
435 (setq dir (nnmail-group-pathname group nnmh-directory))
436 (while (not (file-directory-p dir))
438 (setq dir (file-name-directory (directory-file-name dir))))
440 (when (make-directory (directory-file-name (car dirs)))
441 (error "Could not create directory %s" (car dirs)))
442 (nnheader-message 5 "Creating mail directory %s" (car dirs))
443 (setq dirs (cdr dirs)))))
445 (defun nnmh-save-mail (group-art &optional noinsert)
446 "Called narrowed to an article."
448 (nnmail-insert-lines)
449 (nnmail-insert-xref group-art))
450 (run-hooks 'nnmail-prepare-save-mail-hook)
451 (run-hooks 'nnmh-prepare-save-mail-hook)
452 (goto-char (point-min))
453 (while (looking-at "From ")
454 (replace-match "X-From-Line: ")
456 ;; We save the article in all the newsgroups it belongs in.
460 (nnmh-possibly-create-directory (caar ga))
461 (let ((file (concat (nnmail-group-pathname
462 (caar ga) nnmh-directory)
463 (int-to-string (cdar ga)))))
465 ;; It was already saved, so we just make a hard link.
466 (funcall nnmail-crosspost-link-function first file t)
468 (nnmail-write-region (point-min) (point-max) file nil nil)
473 (defun nnmh-active-number (group)
474 "Compute the next article number in GROUP."
475 (let ((active (cadr (assoc group nnmh-group-alist)))
476 (dir (nnmail-group-pathname group nnmh-directory))
477 (file-name-coding-system nnmail-pathname-coding-system)
480 ;; The group wasn't known to nnmh, so we just create an active
482 (setq active (cons 1 0))
483 (push (list group active) nnmh-group-alist)
484 (unless (file-exists-p dir)
485 (gnus-make-directory dir))
486 ;; Find the highest number in the group.
488 (mapcar 'string-to-int
489 (directory-files dir nil "^[0-9]+$"))
492 (setcdr active (car files)))))
493 (setcdr active (1+ (cdr active)))
495 ;; See whether the file exists...
497 (setq file (concat (nnmail-group-pathname group nnmh-directory)
498 (int-to-string (cdr active)))))
499 ;; ... or there is a buffer that will make that file exist
501 (get-file-buffer file))
502 ;; Skip past that file.
503 (setcdr active (1+ (cdr active))))
506 (defun nnmh-update-gnus-unreads (group)
507 ;; Go through the .nnmh-articles file and compare with the actual
508 ;; articles in this folder. The articles that are "new" will be
509 ;; marked as unread by Gnus.
510 (let* ((dir nnmh-current-directory)
511 (files (sort (mapcar 'string-to-int
512 (directory-files nnmh-current-directory
515 (nnmh-file (concat dir ".nnmh-articles"))
517 ;; Load the .nnmh-articles file.
518 (when (file-exists-p nnmh-file)
520 (let (nnmh-newsgroup-articles)
521 (ignore-errors (load nnmh-file nil t t))
522 nnmh-newsgroup-articles)))
523 ;; Add all new articles to the `new' list.
526 (unless (assq (car art) articles)
527 (push (car art) new))
528 (setq art (cdr art))))
529 ;; Remove all deleted articles.
530 (let ((art articles))
532 (unless (memq (caar art) files)
533 (setq articles (delq (car art) articles)))
534 (setq art (cdr art))))
535 ;; Check whether the articles really are the ones that Gnus thinks
536 ;; they are by looking at the time-stamps.
537 (let ((arts articles)
539 (while (setq art (pop arts))
541 (nth 5 (file-attributes
542 (concat dir (int-to-string (car art)))))
544 (setq articles (delq art articles))
545 (push (car art) new))))
546 ;; Go through all the new articles and add them, and their
547 ;; time-stamps, to the list.
553 (nth 5 (file-attributes
554 (concat dir (int-to-string art))))))
556 ;; Make Gnus mark all new articles as unread.
558 (gnus-make-articles-unread
559 (gnus-group-prefixed-name group (list 'nnmh ""))
560 (setq new (sort new '<))))
561 ;; Sort the article list with highest numbers first.
562 (setq articles (sort articles (lambda (art1 art2)
563 (> (car art1) (car art2)))))
564 ;; Finally write this list back to the .nnmh-articles file.
565 (with-temp-file nnmh-file
566 (insert ";; Gnus article active file for " group "\n\n")
567 (insert "(setq nnmh-newsgroup-articles '")
568 (gnus-prin1 articles)
571 (defun nnmh-deletable-article-p (group article)
572 "Say whether ARTICLE in GROUP can be deleted."
573 (let ((path (concat nnmh-current-directory (int-to-string article))))
575 (and (file-writable-p path)
577 ;; We can never delete the last article in the group.
578 (not (eq (cdr (nth 1 (assoc group nnmh-group-alist)))
581 nnmh-allow-delete-final))))
585 ;;; nnmh.el ends here