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
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)
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))))))
90 (not (file-directory-p file)))
91 (insert (format "221 %d Article retrieved.\n" article))
93 (nnheader-insert-head file)
95 (if (search-forward "\n\n" nil t)
97 (goto-char (point-max))
100 (delete-region (point) (point-max)))
101 (setq count (1+ count))
105 (message "nnmh: Receiving headers... %d%%"
106 (/ (* count 100) number))))
109 (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)
161 ;; Re-scan the directory if it's on a foreign system.
162 (nnheader-re-read-dir pathname)
165 (mapcar (lambda (name) (string-to-int name))
166 (directory-files pathname nil "^[0-9]+$" t))
170 (nnheader-report 'nnmh "Selected group %s" group)
172 "211 %d %d %d %s\n" (length dir) (car dir)
173 (progn (while (cdr dir) (setq dir (cdr dir))) (car dir))
176 (nnheader-report 'nnmh "Empty group %s" group)
177 (nnheader-insert (format "211 0 1 0 %s\n" group))))))))))
179 (deffoo nnmh-request-scan (&optional group server)
180 (nnmail-get-new-mail 'nnmh nil nnmh-directory group))
182 (deffoo nnmh-request-list (&optional server dir)
185 (or dir (file-truename (file-name-as-directory nnmh-directory)))))
186 (nnmh-request-list-1 nnmh-toplev))
187 (setq nnmh-group-alist (nnmail-get-active))
191 (defun nnmh-request-list-1 (dir)
192 (setq dir (expand-file-name dir))
193 ;; Recurse down all directories.
194 (let ((dirs (and (file-readable-p dir)
195 (> (nth 1 (file-attributes (file-chase-links dir))) 2)
196 (directory-files dir t nil t)))
198 ;; Recurse down directories.
199 (while (setq dir (pop dirs))
200 (when (and (not (member (file-name-nondirectory dir) '("." "..")))
201 (file-directory-p dir)
202 (file-readable-p dir))
203 (nnmh-request-list-1 dir))))
204 ;; For each directory, generate an active file line.
205 (unless (string= (expand-file-name nnmh-toplev) dir)
207 (lambda (name) (string-to-int name))
208 (directory-files dir nil "^[0-9]+$" t))))
211 (set-buffer nntp-server-buffer)
212 (goto-char (point-max))
219 (file-truename (file-name-as-directory
220 (expand-file-name nnmh-toplev))))
222 (nnheader-replace-chars-in-string
223 (substring dir (match-end 0)) ?/ ?.))
225 (apply 'min files)))))))
228 (deffoo nnmh-request-newgroups (date &optional server)
229 (nnmh-request-list server))
231 (deffoo nnmh-request-expire-articles (articles newsgroup
232 &optional server force)
233 (nnmh-possibly-change-directory newsgroup server)
234 (let* ((active-articles
238 (string-to-int name)))
239 (directory-files nnmh-current-directory nil "^[0-9]+$" t)))
241 article rest mod-time)
242 (nnmail-activate 'nnmh)
244 (while (and articles is-old)
245 (setq article (concat nnmh-current-directory
246 (int-to-string (car articles))))
247 (when (setq mod-time (nth 5 (file-attributes article)))
248 (if (and (nnmh-deletable-article-p newsgroup (car articles))
250 (nnmail-expired-article-p newsgroup mod-time force)))
252 (nnheader-message 5 "Deleting article %s in %s..."
255 (funcall nnmail-delete-file-function article)
257 (nnheader-message 1 "Couldn't delete article %s in %s"
259 (push (car articles) rest))))
260 (push (car articles) rest)))
261 (setq articles (cdr articles)))
263 (nconc rest articles)))
265 (deffoo nnmh-close-group (group &optional server)
268 (deffoo nnmh-request-move-article
269 (article group server accept-form &optional last)
270 (let ((buf (get-buffer-create " *nnmh move*"))
273 (nnmh-deletable-article-p group article)
274 (nnmh-request-article article group server)
278 (insert-buffer-substring nntp-server-buffer)
279 (setq result (eval accept-form))
280 (kill-buffer (current-buffer))
283 (nnmh-possibly-change-directory group server)
285 (funcall nnmail-delete-file-function
286 (concat nnmh-current-directory (int-to-string article)))
290 (deffoo nnmh-request-accept-article (group &optional server last noinsert)
291 (nnmh-possibly-change-directory group server)
292 (nnmail-check-syntax)
293 (nnmail-cache-insert (nnmail-fetch-field "message-id"))
297 (nnmail-activate 'nnmh)
299 (list (cons group (nnmh-active-number group)))
302 (nnmail-activate 'nnmh)
303 (car (nnmh-save-mail (nnmail-article-group 'nnmh-active-number)
306 (nnmail-cache-close))))
308 (deffoo nnmh-request-replace-article (article group buffer)
309 (nnmh-possibly-change-directory group)
312 (nnmh-possibly-create-directory group)
315 (point-min) (point-max)
316 (concat nnmh-current-directory (int-to-string article))
317 nil (if (nnheader-be-verbose 5) nil 'nomesg))
320 (deffoo nnmh-request-create-group (group &optional server args)
321 (nnmail-activate 'nnmh)
322 (unless (assoc group nnmh-group-alist)
324 (push (list group (setq active (cons 1 0)))
326 (nnmh-possibly-create-directory group)
327 (nnmh-possibly-change-directory group server)
328 (let ((articles (mapcar
330 (string-to-int file))
332 nnmh-current-directory nil "^[0-9]+$"))))
334 (setcar active (apply 'min articles))
335 (setcdr active (apply 'max articles))))))
338 (deffoo nnmh-request-delete-group (group &optional force server)
339 (nnmh-possibly-change-directory group server)
340 ;; Delete all articles in GROUP.
342 () ; Don't delete the articles.
343 (let ((articles (directory-files nnmh-current-directory t "^[0-9]+$")))
345 (when (file-writable-p (car articles))
346 (nnheader-message 5 "Deleting article %s in %s..."
347 (car articles) group)
348 (funcall nnmail-delete-file-function (car articles)))
349 (setq articles (cdr articles))))
350 ;; Try to delete the directory itself.
352 (delete-directory nnmh-current-directory)))
353 ;; Remove the group from all structures.
354 (setq nnmh-group-alist
355 (delq (assoc group nnmh-group-alist) nnmh-group-alist)
356 nnmh-current-directory nil)
359 (deffoo nnmh-request-rename-group (group new-name &optional server)
360 (nnmh-possibly-change-directory group server)
361 (let ((new-dir (nnmail-group-pathname new-name nnmh-directory))
362 (old-dir (nnmail-group-pathname group nnmh-directory)))
364 (make-directory new-dir t)
366 ;; We move the articles file by file instead of renaming
367 ;; the directory -- there may be subgroups in this group.
368 ;; One might be more clever, I guess.
369 (let ((files (nnheader-article-to-file-alist old-dir)))
372 (concat old-dir (cdar files))
373 (concat new-dir (cdar files)))
375 (when (<= (length (directory-files old-dir)) 2)
377 (delete-directory old-dir)))
378 ;; That went ok, so we change the internal structures.
379 (let ((entry (assoc group nnmh-group-alist)))
381 (setcar entry new-name))
382 (setq nnmh-current-directory nil)
385 (nnoo-define-skeleton nnmh)
388 ;;; Internal functions.
390 (defun nnmh-possibly-change-directory (newsgroup &optional server)
392 (not (nnmh-server-opened server)))
393 (nnmh-open-server server))
395 (let ((pathname (nnmail-group-pathname newsgroup nnmh-directory)))
396 (if (file-directory-p pathname)
397 (setq nnmh-current-directory pathname)
398 (error "No such newsgroup: %s" newsgroup)))))
400 (defun nnmh-possibly-create-directory (group)
402 (setq dir (nnmail-group-pathname group nnmh-directory))
403 (while (not (file-directory-p dir))
405 (setq dir (file-name-directory (directory-file-name dir))))
407 (when (make-directory (directory-file-name (car dirs)))
408 (error "Could not create directory %s" (car dirs)))
409 (nnheader-message 5 "Creating mail directory %s" (car dirs))
410 (setq dirs (cdr dirs)))))
412 (defun nnmh-save-mail (group-art &optional noinsert)
413 "Called narrowed to an article."
415 (nnmail-insert-lines)
416 (nnmail-insert-xref group-art))
417 (run-hooks 'nnmail-prepare-save-mail-hook)
418 (run-hooks 'nnmh-prepare-save-mail-hook)
419 (goto-char (point-min))
420 (while (looking-at "From ")
421 (replace-match "X-From-Line: ")
423 ;; We save the article in all the newsgroups it belongs in.
427 (nnmh-possibly-create-directory (caar ga))
428 (let ((file (concat (nnmail-group-pathname
429 (caar ga) nnmh-directory)
430 (int-to-string (cdar ga)))))
432 ;; It was already saved, so we just make a hard link.
433 (funcall nnmail-crosspost-link-function first file t)
435 (nnmail-write-region (point-min) (point-max) file nil nil)
440 (defun nnmh-active-number (group)
441 "Compute the next article number in GROUP."
442 (let ((active (cadr (assoc group nnmh-group-alist))))
444 ;; The group wasn't known to nnmh, so we just create an active
446 (setq active (cons 1 0))
447 (push (list group active) nnmh-group-alist)
448 ;; Find the highest number in the group.
454 (nnmail-group-pathname group nnmh-directory)
458 (setcdr active (car files)))))
459 (setcdr active (1+ (cdr active)))
460 (while (file-exists-p
461 (concat (nnmail-group-pathname group nnmh-directory)
462 (int-to-string (cdr active))))
463 (setcdr active (1+ (cdr active))))
466 (defun nnmh-update-gnus-unreads (group)
467 ;; Go through the .nnmh-articles file and compare with the actual
468 ;; articles in this folder. The articles that are "new" will be
469 ;; marked as unread by Gnus.
470 (let* ((dir nnmh-current-directory)
471 (files (sort (mapcar (function (lambda (name) (string-to-int name)))
472 (directory-files nnmh-current-directory
475 (nnmh-file (concat dir ".nnmh-articles"))
477 ;; Load the .nnmh-articles file.
478 (when (file-exists-p nnmh-file)
480 (let (nnmh-newsgroup-articles)
481 (ignore-errors (load nnmh-file nil t t))
482 nnmh-newsgroup-articles)))
483 ;; Add all new articles to the `new' list.
486 (unless (assq (car art) articles)
487 (push (car art) new))
488 (setq art (cdr art))))
489 ;; Remove all deleted articles.
490 (let ((art articles))
492 (unless (memq (caar art) files)
493 (setq articles (delq (car art) articles)))
494 (setq art (cdr art))))
495 ;; Check whether the articles really are the ones that Gnus thinks
496 ;; they are by looking at the time-stamps.
497 (let ((arts articles)
499 (while (setq art (pop arts))
501 (nth 5 (file-attributes
502 (concat dir (int-to-string (car art)))))
504 (setq articles (delq art articles))
505 (push (car art) new))))
506 ;; Go through all the new articles and add them, and their
507 ;; time-stamps, to the list.
513 (nth 5 (file-attributes
514 (concat dir (int-to-string art))))))
516 ;; Make Gnus mark all new articles as unread.
518 (gnus-make-articles-unread
519 (gnus-group-prefixed-name group (list 'nnmh ""))
520 (setq new (sort new '<))))
521 ;; Sort the article list with highest numbers first.
522 (setq articles (sort articles (lambda (art1 art2)
523 (> (car art1) (car art2)))))
524 ;; Finally write this list back to the .nnmh-articles file.
525 (nnheader-temp-write nnmh-file
526 (insert ";; Gnus article active file for " group "\n\n")
527 (insert "(setq nnmh-newsgroup-articles '")
528 (gnus-prin1 articles)
531 (defun nnmh-deletable-article-p (group article)
532 "Say whether ARTICLE in GROUP can be deleted."
533 (let ((path (concat nnmh-current-directory (int-to-string article))))
535 (and (file-writable-p path)
536 ;; We can never delete the last article in the group.
537 (not (eq (cdr (nth 1 (assoc group nnmh-group-alist)))
542 ;;; nnmh.el ends here