1 ;;; nnmh.el --- mhspool access for Gnus
2 ;; Copyright (C) 1995,96 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-and-compile (require 'cl))
41 (defvoo nnmh-directory "~/Mail/"
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)
66 ;;; Interface functions.
68 (nnoo-define-basics nnmh)
70 (deffoo nnmh-retrieve-headers (articles &optional newsgroup server fetch-old)
72 (set-buffer nntp-server-buffer)
75 (number (length articles))
76 (large (and (numberp nnmail-large-newsgroup)
77 (> number nnmail-large-newsgroup)))
80 (nnmh-possibly-change-directory newsgroup server)
81 ;; We don't support fetching by Message-ID.
82 (if (stringp (car articles))
85 (when (and (file-exists-p
86 (setq file (concat (file-name-as-directory
87 nnmh-current-directory)
89 (setq article (pop articles))))))
91 (not (file-directory-p file)))
92 (insert (format "221 %d Article retrieved.\n" article))
94 (nnheader-insert-head file)
96 (if (search-forward "\n\n" nil t)
98 (goto-char (point-max))
101 (delete-region (point) (point-max)))
102 (setq count (1+ count))
106 (message "nnmh: Receiving headers... %d%%"
107 (/ (* count 100) number))))
109 (and large (message "nnmh: Receiving headers...done"))
111 (nnheader-fold-continuation-lines)
114 (deffoo nnmh-open-server (server &optional defs)
115 (nnoo-change-server 'nnmh server defs)
116 (when (not (file-exists-p nnmh-directory))
118 (make-directory nnmh-directory t)
121 ((not (file-exists-p nnmh-directory))
123 (nnheader-report 'nnmh "Couldn't create directory: %s" nnmh-directory))
124 ((not (file-directory-p (file-truename nnmh-directory)))
126 (nnheader-report 'nnmh "Not a directory: %s" nnmh-directory))
128 (nnheader-report 'nnmh "Opened server %s using directory %s"
129 server nnmh-directory)
132 (deffoo nnmh-request-article (id &optional newsgroup server buffer)
133 (nnmh-possibly-change-directory newsgroup server)
134 (let ((file (if (stringp id)
136 (concat nnmh-current-directory (int-to-string id))))
137 (nntp-server-buffer (or buffer nntp-server-buffer)))
140 (not (file-directory-p file))
141 (save-excursion (nnmail-find-file file))
142 (string-to-int (file-name-nondirectory file)))))
144 (deffoo nnmh-request-group (group &optional server dont-check)
145 (let ((pathname (nnmail-group-pathname group nnmh-directory))
148 ((not (file-directory-p pathname))
150 'nnmh "Can't select group (no such directory): %s" group))
152 (setq nnmh-current-directory pathname)
153 (and nnmh-get-new-mail
155 (nnmh-update-gnus-unreads group))
158 (nnheader-report 'nnmh "Selected group %s" group)
163 (mapcar (lambda (name) (string-to-int name))
164 (directory-files pathname nil "^[0-9]+$" t))
168 (nnheader-report 'nnmh "Selected group %s" group)
170 "211 %d %d %d %s\n" (length dir) (car dir)
171 (progn (while (cdr dir) (setq dir (cdr dir))) (car dir))
174 (nnheader-report 'nnmh "Empty group %s" group)
175 (nnheader-insert (format "211 0 1 0 %s\n" group))))))))))
177 (deffoo nnmh-request-scan (&optional group server)
178 (nnmail-get-new-mail 'nnmh nil nnmh-directory group))
180 (deffoo nnmh-request-list (&optional server dir)
183 (or dir (file-truename (file-name-as-directory nnmh-directory)))))
184 (nnmh-request-list-1 nnmh-toplev))
185 (setq nnmh-group-alist (nnmail-get-active))
189 (defun nnmh-request-list-1 (dir)
190 (setq dir (expand-file-name dir))
191 ;; Recurse down all directories.
192 (let ((dirs (and (file-readable-p dir)
193 (> (nth 1 (file-attributes (file-chase-links dir))) 2)
194 (directory-files dir t nil t)))
196 ;; Recurse down directories.
197 (while (setq dir (pop dirs))
198 (when (and (not (string-match "/\\.\\.?$" dir))
199 (file-directory-p dir)
200 (file-readable-p dir))
201 (nnmh-request-list-1 dir))))
202 ;; For each directory, generate an active file line.
203 (unless (string= (expand-file-name nnmh-toplev) dir)
205 (lambda (name) (string-to-int name))
206 (directory-files dir nil "^[0-9]+$" t))))
209 (set-buffer nntp-server-buffer)
210 (goto-char (point-max))
216 (file-truename (file-name-as-directory
217 (expand-file-name nnmh-toplev))) dir)
218 (nnheader-replace-chars-in-string
219 (substring dir (match-end 0)) ?/ ?.))
220 (apply (function max) files)
221 (apply (function min) files)))))))
224 (deffoo nnmh-request-newgroups (date &optional server)
225 (nnmh-request-list server))
227 (deffoo nnmh-request-expire-articles (articles newsgroup &optional server force)
228 (nnmh-possibly-change-directory newsgroup server)
229 (let* ((active-articles
233 (string-to-int name)))
234 (directory-files nnmh-current-directory nil "^[0-9]+$" t)))
236 article rest mod-time)
237 (nnmail-activate 'nnmh)
239 (while (and articles is-old)
240 (setq article (concat nnmh-current-directory
241 (int-to-string (car articles))))
242 (if (setq mod-time (nth 5 (file-attributes article)))
243 (if (and (nnmh-deletable-article-p newsgroup (car articles))
245 (nnmail-expired-article-p newsgroup mod-time force)))
247 (nnheader-message 5 "Deleting article %s in %s..."
250 (funcall nnmail-delete-file-function article)
252 (setq rest (cons (car articles) rest)))))
253 (setq rest (cons (car articles) rest))))
254 (setq articles (cdr articles)))
256 (nconc rest articles)))
258 (deffoo nnmh-close-group (group &optional server)
261 (deffoo nnmh-request-move-article
262 (article group server accept-form &optional last)
263 (let ((buf (get-buffer-create " *nnmh move*"))
266 (nnmh-deletable-article-p group article)
267 (nnmh-request-article article group server)
270 (insert-buffer-substring nntp-server-buffer)
271 (setq result (eval accept-form))
272 (kill-buffer (current-buffer))
275 (funcall nnmail-delete-file-function
276 (concat nnmh-current-directory (int-to-string article)))
280 (deffoo nnmh-request-accept-article (group &optional server last noinsert)
281 (nnmh-possibly-change-directory group server)
284 (nnmail-activate 'nnmh)
285 ;; We trick the choosing function into believing that only one
286 ;; group is available.
287 (let ((nnmail-split-methods (list (list group ""))))
288 (car (nnmh-save-mail noinsert))))
290 (nnmail-activate 'nnmh)
291 (car (nnmh-save-mail noinsert)))))
293 (deffoo nnmh-request-replace-article (article group buffer)
294 (nnmh-possibly-change-directory group)
297 (nnmh-possibly-create-directory group)
300 (write-region (point-min) (point-max)
301 (concat nnmh-current-directory (int-to-string article))
302 nil (if (nnheader-be-verbose 5) nil 'nomesg))
306 (deffoo nnmh-request-create-group (group &optional server)
307 (nnmail-activate 'nnmh)
308 (or (assoc group nnmh-group-alist)
310 (setq nnmh-group-alist (cons (list group (setq active (cons 1 0)))
312 (nnmh-possibly-create-directory group)
313 (nnmh-possibly-change-directory group server)
314 (let ((articles (mapcar
316 (string-to-int file))
318 nnmh-current-directory nil "^[0-9]+$"))))
321 (setcar active (apply 'min articles))
322 (setcdr active (apply 'max articles)))))))
325 (deffoo nnmh-request-delete-group (group &optional force server)
326 (nnmh-possibly-change-directory group server)
327 ;; Delete all articles in GROUP.
329 () ; Don't delete the articles.
330 (let ((articles (directory-files nnmh-current-directory t "^[0-9]+$")))
332 (and (file-writable-p (car articles))
334 (nnheader-message 5 "Deleting article %s in %s..."
335 (car articles) group)
336 (funcall nnmail-delete-file-function (car articles))))
337 (setq articles (cdr articles))))
338 ;; Try to delete the directory itself.
340 (delete-directory nnmh-current-directory)
342 ;; Remove the group from all structures.
343 (setq nnmh-group-alist
344 (delq (assoc group nnmh-group-alist) nnmh-group-alist)
345 nnmh-current-directory nil)
348 (deffoo nnmh-request-rename-group (group new-name &optional server)
349 (nnmh-possibly-change-directory group server)
351 (and (file-writable-p nnmh-current-directory)
355 (directory-file-name nnmh-current-directory)
357 (nnmail-group-pathname new-name nnmh-directory)))
360 ;; That went ok, so we change the internal structures.
361 (let ((entry (assoc group nnmh-group-alist)))
362 (and entry (setcar entry new-name))
363 (setq nnmh-current-directory nil)
367 ;;; Internal functions.
369 (defun nnmh-possibly-change-directory (newsgroup &optional server)
371 (not (nnmh-server-opened server)))
372 (nnmh-open-server server))
374 (let ((pathname (nnmail-group-pathname newsgroup nnmh-directory)))
375 (if (file-directory-p pathname)
376 (setq nnmh-current-directory pathname)
377 (error "No such newsgroup: %s" newsgroup)))))
379 (defun nnmh-possibly-create-directory (group)
381 (setq dir (nnmail-group-pathname group nnmh-directory))
382 (while (not (file-directory-p dir))
383 (setq dirs (cons dir dirs))
384 (setq dir (file-name-directory (directory-file-name dir))))
386 (if (make-directory (directory-file-name (car dirs)))
387 (error "Could not create directory %s" (car dirs)))
388 (nnheader-message 5 "Creating mail directory %s" (car dirs))
389 (setq dirs (cdr dirs)))))
391 (defun nnmh-save-mail (&optional noinsert)
392 "Called narrowed to an article."
393 (let ((group-art (nreverse (nnmail-article-group 'nnmh-active-number))))
395 (nnmail-insert-lines)
396 (nnmail-insert-xref group-art))
397 (run-hooks 'nnmail-prepare-save-mail-hook)
398 (run-hooks 'nnmh-prepare-save-mail-hook)
399 (goto-char (point-min))
400 (while (looking-at "From ")
401 (replace-match "X-From-Line: ")
403 ;; We save the article in all the newsgroups it belongs in.
407 (nnmh-possibly-create-directory (caar ga))
408 (let ((file (concat (nnmail-group-pathname
409 (caar ga) nnmh-directory)
410 (int-to-string (cdar ga)))))
412 ;; It was already saved, so we just make a hard link.
413 (funcall nnmail-crosspost-link-function first file t)
415 (write-region (point-min) (point-max) file nil nil)
420 (defun nnmh-active-number (group)
421 "Compute the next article number in GROUP."
422 (let ((active (cadr (assoc group nnmh-group-alist))))
423 ;; The group wasn't known to nnmh, so we just create an active
427 (setq active (cons 1 0))
428 (setq nnmh-group-alist (cons (list group active) nnmh-group-alist))))
429 (setcdr active (1+ (cdr active)))
430 (while (file-exists-p
431 (concat (nnmail-group-pathname group nnmh-directory)
432 (int-to-string (cdr active))))
433 (setcdr active (1+ (cdr active))))
436 (defun nnmh-update-gnus-unreads (group)
437 ;; Go through the .nnmh-articles file and compare with the actual
438 ;; articles in this folder. The articles that are "new" will be
439 ;; marked as unread by Gnus.
440 (let* ((dir nnmh-current-directory)
441 (files (sort (mapcar (function (lambda (name) (string-to-int name)))
442 (directory-files nnmh-current-directory
443 nil "^[0-9]+$" t)) '<))
444 (nnmh-file (concat dir ".nnmh-articles"))
446 ;; Load the .nnmh-articles file.
447 (if (file-exists-p nnmh-file)
449 (let (nnmh-newsgroup-articles)
450 (condition-case nil (load nnmh-file nil t t) (error nil))
451 nnmh-newsgroup-articles)))
452 ;; Add all new articles to the `new' list.
455 (if (not (assq (car art) articles)) (setq new (cons (car art) new)))
456 (setq art (cdr art))))
457 ;; Remove all deleted articles.
458 (let ((art articles))
460 (if (not (memq (caar art) files))
461 (setq articles (delq (car art) articles)))
462 (setq art (cdr art))))
463 ;; Check whether the highest-numbered articles really are the ones
464 ;; that Gnus thinks they are by looking at the time-stamps.
465 (let ((art articles))
468 (nth 5 (file-attributes
469 (concat dir (int-to-string (caar art)))))
471 (setq articles (delq (car art) articles))
472 (setq new (cons (caar art) new))
473 (setq art (cdr art))))
474 ;; Go through all the new articles and add them, and their
475 ;; time-stamps to the list.
481 (nth 5 (file-attributes
482 (concat dir (int-to-string (car n))))))
485 ;; Make Gnus mark all new articles as unread.
486 (or (zerop (length new))
487 (gnus-make-articles-unread
488 (gnus-group-prefixed-name group (list 'nnmh ""))
489 (setq new (sort new '<))))
490 ;; Sort the article list with highest numbers first.
491 (setq articles (sort articles (lambda (art1 art2)
492 (> (car art1) (car art2)))))
493 ;; Finally write this list back to the .nnmh-articles file.
495 (set-buffer (get-buffer-create "*nnmh out*"))
496 (insert ";; Gnus article active file for " group "\n\n")
497 (insert "(setq nnmh-newsgroup-articles '")
498 (insert (prin1-to-string articles) ")\n")
499 (write-region (point-min) (point-max) nnmh-file nil 'nomesg)
500 (kill-buffer (current-buffer)))))
502 (defun nnmh-deletable-article-p (group article)
503 "Say whether ARTICLE in GROUP can be deleted."
504 (let ((path (concat nnmh-current-directory (int-to-string article))))
505 (and (file-writable-p path)
506 (or (not nnmail-keep-last-article)
507 (not (eq (cdr (nth 1 (assoc group nnmh-group-alist)))
512 ;;; nnmh.el ends here