1 ;;; nnmh.el --- mhspool access for Gnus
2 ;; Copyright (C) 1995 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
22 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
26 ;; Based on nnspool.el by Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>.
27 ;; For an overview of what the interface functions do, please see the
37 (defvar nnmh-directory "~/Mail/"
38 "*Mail spool directory.")
40 (defvar nnmh-get-new-mail t
41 "*If non-nil, nnmh will check the incoming mail file and split the mail.")
43 (defvar nnmh-prepare-save-mail-hook nil
44 "*Hook run narrowed to an article before saving.")
46 (defvar nnmh-be-safe nil
47 "*If non-nil, nnmh will check all articles to make sure whether they are new or not.")
51 (defconst nnmh-version "nnmh 1.0"
54 (defvar nnmh-current-directory nil
55 "Current news group directory.")
57 (defvar nnmh-status-string "")
58 (defvar nnmh-group-alist nil)
62 (defvar nnmh-current-server nil)
63 (defvar nnmh-server-alist nil)
64 (defvar nnmh-server-variables
66 (list 'nnmh-directory nnmh-directory)
67 (list 'nnmh-get-new-mail nnmh-get-new-mail)
68 '(nnmh-current-directory nil)
69 '(nnmh-status-string "")
74 ;;; Interface functions.
76 (defun nnmh-retrieve-headers (sequence &optional newsgroup server fetch-old)
78 (set-buffer nntp-server-buffer)
81 (number (length sequence))
82 (large (and (numberp nnmail-large-newsgroup)
83 (> number nnmail-large-newsgroup)))
86 (nnmh-possibly-change-directory newsgroup)
87 (if (stringp (car sequence))
90 (setq article (car sequence))
92 (concat nnmh-current-directory (int-to-string article)))
93 (if (and (file-exists-p file)
94 (not (file-directory-p file)))
96 (insert (format "221 %d Article retrieved.\n" article))
98 (nnheader-insert-head file)
100 (if (search-forward "\n\n" nil t)
102 (goto-char (point-max))
105 (delete-region (point) (point-max))))
106 (setq sequence (cdr sequence))
107 (setq count (1+ count))
111 (message "nnmh: Receiving headers... %d%%"
112 (/ (* count 100) number))))
114 (and large (message "nnmh: Receiving headers...done"))
116 ;; Fold continuation lines.
117 (goto-char (point-min))
118 (while (re-search-forward "\\(\r?\n[ \t]+\\)+" nil t)
119 (replace-match " " t t))
122 (defun nnmh-open-server (server &optional defs)
123 (nnheader-init-server-buffer)
124 (if (equal server nnmh-current-server)
126 (if nnmh-current-server
127 (setq nnmh-server-alist
128 (cons (list nnmh-current-server
129 (nnheader-save-variables nnmh-server-variables))
131 (let ((state (assoc server nnmh-server-alist)))
134 (nnheader-restore-variables (nth 1 state))
135 (setq nnmh-server-alist (delq state nnmh-server-alist)))
136 (nnheader-set-init-variables nnmh-server-variables defs)))
137 (setq nnmh-current-server server)))
139 (defun nnmh-close-server (&optional server)
142 (defun nnmh-server-opened (&optional server)
143 (and (equal server nnmh-current-server)
145 (buffer-name nntp-server-buffer)))
147 (defun nnmh-status-message (&optional server)
150 (defun nnmh-request-article (id &optional newsgroup server buffer)
151 (nnmh-possibly-change-directory newsgroup)
152 (let ((file (if (stringp id)
154 (concat nnmh-current-directory (int-to-string id))))
155 (nntp-server-buffer (or buffer nntp-server-buffer)))
158 (not (file-directory-p file))
159 (save-excursion (nnmail-find-file file))
160 (string-to-int (file-name-nondirectory file)))))
162 (defun nnmh-request-group (group &optional server dont-check)
163 (let ((pathname (nnmh-article-pathname group nnmh-directory))
165 (if (file-directory-p pathname)
167 (setq nnmh-current-directory pathname)
168 (and nnmh-get-new-mail
170 (nnmh-update-gnus-unreads group))
178 (string-to-int name)))
179 (directory-files pathname nil "^[0-9]+$" t))
182 (set-buffer nntp-server-buffer)
185 (insert (format "211 %d %d %d %s\n" (length dir)
187 (progn (while (cdr dir)
188 (setq dir (cdr dir)))
191 (insert (format "211 0 1 0 %s\n" group))))))
193 (setq nnmh-status-string "No such group")
196 (defun nnmh-request-scan (&optional group server)
197 (nnmail-get-new-mail 'nnmh nil nnmh-directory group))
199 (defun nnmh-request-list (&optional server dir)
202 (set-buffer nntp-server-buffer)
204 (setq dir (file-truename (file-name-as-directory nnmh-directory)))))
205 (setq dir (expand-file-name dir))
206 ;; Recurse down all directories.
207 (let ((dirs (and (file-readable-p dir)
208 (> (nth 1 (file-attributes (file-chase-links dir))) 2)
209 (directory-files dir t nil t))))
211 (if (and (not (string-match "/\\.\\.?$" (car dirs)))
212 (file-directory-p (car dirs))
213 (file-readable-p (car dirs)))
214 (nnmh-request-list nil (car dirs)))
215 (setq dirs (cdr dirs))))
216 ;; For each directory, generate an active file line.
217 (if (not (string= (expand-file-name nnmh-directory) dir))
219 (lambda (name) (string-to-int name))
220 (directory-files dir nil "^[0-9]+$" t))))
224 (set-buffer nntp-server-buffer)
225 (goto-char (point-max))
231 (file-truename (file-name-as-directory
232 (expand-file-name nnmh-directory))) dir)
233 (nnmail-replace-chars-in-string
234 (substring dir (match-end 0)) ?/ ?.))
235 (apply (function max) files)
236 (apply (function min) files)))))))
237 (setq nnmh-group-alist (nnmail-get-active))
240 (defun nnmh-request-newgroups (date &optional server)
241 (nnmh-request-list server))
243 (defun nnmh-request-post (&optional server)
244 (mail-send-and-exit nil))
246 (defun nnmh-request-expire-articles (articles newsgroup &optional server force)
247 (nnmh-possibly-change-directory newsgroup)
248 (let* ((days (or (and nnmail-expiry-wait-function
249 (funcall nnmail-expiry-wait-function newsgroup))
255 (string-to-int name)))
256 (directory-files nnmh-current-directory nil "^[0-9]+$" t)))
257 (max-article (and active-articles (apply 'max active-articles)))
259 article rest mod-time)
260 (nnmail-activate 'nnmh)
262 (while (and articles is-old)
263 (setq article (concat nnmh-current-directory
264 (int-to-string (car articles))))
265 (if (setq mod-time (nth 5 (file-attributes article)))
266 (if (and (or (not nnmail-keep-last-article)
268 (not (= (car articles) max-article)))
269 (not (equal mod-time '(0 0)))
272 (> (nnmail-days-between
273 (current-time-string)
274 (current-time-string mod-time))
277 (and gnus-verbose-backends
278 (message "Deleting article %s in %s..."
281 (funcall nnmail-delete-file-function article)
283 (setq rest (cons (car articles) rest)))))
284 (setq rest (cons (car articles) rest))))
285 (setq articles (cdr articles)))
287 (nconc rest articles)))
289 (defun nnmh-close-group (group &optional server)
292 (defun nnmh-request-move-article
293 (article group server accept-form &optional last)
294 (let ((buf (get-buffer-create " *nnmh move*"))
297 (nnmh-request-article article group server)
300 (insert-buffer-substring nntp-server-buffer)
301 (setq result (eval accept-form))
302 (kill-buffer (current-buffer))
305 (funcall nnmail-delete-file-function
306 (concat nnmh-current-directory (int-to-string article)))
310 (defun nnmh-request-accept-article (group &optional last)
313 (nnmail-activate 'nnmh)
314 ;; We trick the choosing function into believing that only one
315 ;; group is availiable.
316 (let ((nnmail-split-methods (list (list group ""))))
317 (car (nnmh-save-mail))))
319 (nnmail-activate 'nnmh)
320 (car (nnmh-save-mail)))))
322 (defun nnmh-request-replace-article (article group buffer)
323 (nnmh-possibly-change-directory group)
326 (nnmh-possibly-create-directory group)
329 (write-region (point-min) (point-max)
330 (concat nnmh-current-directory (int-to-string article))
331 nil (if gnus-verbose-backends nil 'nomesg))
335 (defun nnmh-request-create-group (group &optional server)
336 (nnmail-activate 'nnmh)
337 (or (assoc group nnmh-group-alist)
339 (setq nnmh-group-alist (cons (list group (setq active (cons 1 0)))
341 (nnmh-possibly-create-directory group)
342 (nnmh-possibly-change-directory group)
343 (let ((articles (mapcar
345 (string-to-int file))
347 nnmh-current-directory nil "^[0-9]+$"))))
350 (setcar active (apply 'min articles))
351 (setcdr active (apply 'max articles)))))))
354 (defun nnmh-request-delete-group (group &optional force server)
355 (nnmh-possibly-change-directory group)
356 ;; Delete all articles in GROUP.
358 () ; Don't delete the articles.
359 (let ((articles (directory-files nnmh-current-directory t "^[0-9]+$")))
361 (and (file-writable-p (car articles))
363 (and gnus-verbose-backends
364 (message (message "Deleting article %s in %s..."
365 (car articles) group)))
366 (funcall nnmail-delete-file-function (car articles))))
367 (setq articles (cdr articles))))
368 ;; Try to delete the directory itself.
370 (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 (defun nnmh-request-rename-group (group new-name &optional server)
379 (nnmh-possibly-change-directory group)
381 (and (file-writable-p nnmh-current-directory)
385 (directory-file-name nnmh-current-directory)
387 (nnmail-article-pathname new-name nnmh-directory)))
390 ;; That went ok, so we change the internal structures.
391 (let ((entry (assoc group nnmh-group-alist)))
392 (and entry (setcar entry new-name))
393 (setq nnmh-current-directory nil)
397 ;;; Internal functions.
399 (defun nnmh-possibly-change-directory (newsgroup)
401 (let ((pathname (nnmh-article-pathname newsgroup nnmh-directory)))
402 (if (file-directory-p pathname)
403 (setq nnmh-current-directory pathname)
404 (error "No such newsgroup: %s" newsgroup)))))
406 (defun nnmh-possibly-create-directory (group)
408 (setq dir (nnmh-article-pathname group nnmh-directory))
409 (while (not (file-directory-p dir))
410 (setq dirs (cons dir dirs))
411 (setq dir (file-name-directory (directory-file-name dir))))
413 (if (make-directory (directory-file-name (car dirs)))
414 (error "Could not create directory %s" (car dirs)))
415 (and gnus-verbose-backends
416 (message "Creating mail directory %s" (car dirs)))
417 (setq dirs (cdr dirs)))))
419 (defun nnmh-save-mail ()
420 "Called narrowed to an article."
421 (let ((group-art (nreverse (nnmail-article-group 'nnmh-active-number))))
422 (nnmail-insert-lines)
423 (nnmail-insert-xref group-art)
424 (run-hooks 'nnmh-prepare-save-mail-hook)
425 (goto-char (point-min))
426 (while (looking-at "From ")
427 (replace-match "X-From-Line: ")
429 ;; We save the article in all the newsgroups it belongs in.
433 (nnmh-possibly-create-directory (car (car ga)))
434 (let ((file (concat (nnmh-article-pathname
435 (car (car ga)) nnmh-directory)
436 (int-to-string (cdr (car ga))))))
438 ;; It was already saved, so we just make a hard link.
439 (add-name-to-file first file t)
441 (write-region (point-min) (point-max) file nil nil)
446 (defun nnmh-active-number (group)
447 "Compute the next article number in GROUP."
448 (let ((active (car (cdr (assoc group nnmh-group-alist)))))
449 ;; The group wasn't known to nnmh, so we just create an active
453 (setq active (cons 1 0))
454 (setq nnmh-group-alist (cons (list group active) nnmh-group-alist))))
455 (setcdr active (1+ (cdr active)))
456 (while (file-exists-p
457 (concat (nnmh-article-pathname group nnmh-directory)
458 (int-to-string (cdr active))))
459 (setcdr active (1+ (cdr active))))
462 (defun nnmh-article-pathname (group mail-dir)
463 "Make pathname for GROUP."
464 (let ((mail-dir (file-name-as-directory (expand-file-name mail-dir))))
465 (if (file-directory-p (concat mail-dir group))
466 (concat mail-dir group "/")
467 (concat mail-dir (nnmail-replace-chars-in-string group ?. ?/) "/"))))
469 (defun nnmh-update-gnus-unreads (group)
470 ;; Go through the .nnmh-articles file and compare with the actual
471 ;; articles in this folder. The articles that are "new" will be
472 ;; marked as unread by Gnus.
473 (let* ((dir nnmh-current-directory)
474 (files (sort (mapcar (function (lambda (name) (string-to-int name)))
475 (directory-files nnmh-current-directory
476 nil "^[0-9]+$" t)) '<))
477 (nnmh-file (concat dir ".nnmh-articles"))
479 ;; Load the .nnmh-articles file.
480 (if (file-exists-p nnmh-file)
482 (let (nnmh-newsgroup-articles)
483 (condition-case nil (load nnmh-file nil t t) (error nil))
484 nnmh-newsgroup-articles)))
485 ;; Add all new articles to the `new' list.
488 (if (not (assq (car art) articles)) (setq new (cons (car art) new)))
489 (setq art (cdr art))))
490 ;; Remove all deleted articles.
491 (let ((art articles))
493 (if (not (memq (car (car art)) files))
494 (setq articles (delq (car art) articles)))
495 (setq art (cdr art))))
496 ;; Check whether the highest-numbered articles really are the ones
497 ;; that Gnus thinks they are by looking at the time-stamps.
498 (let ((art articles))
501 (nth 5 (file-attributes
502 (concat dir (int-to-string (car (car art))))))
504 (setq articles (delq (car art) articles))
505 (setq new (cons (car (car art)) new))
506 (setq art (cdr art))))
507 ;; Go through all the new articles and add them, and their
508 ;; time-stamps to the list.
514 (nth 5 (file-attributes
515 (concat dir (int-to-string (car n))))))
518 ;; Make Gnus mark all new articles as unread.
519 (or (zerop (length new))
520 (gnus-make-articles-unread
521 (gnus-group-prefixed-name group (list 'nnmh ""))
522 (setq new (sort new '<))))
523 ;; Sort the article list with highest numbers first.
524 (setq articles (sort articles (lambda (art1 art2)
525 (> (car art1) (car art2)))))
526 ;; Finally write this list back to the .nnmh-articles file.
528 (set-buffer (get-buffer-create "*nnmh out*"))
529 (insert ";; Gnus article active file for " group "\n\n")
530 (insert "(setq nnmh-newsgroup-articles '")
531 (insert (prin1-to-string articles) ")\n")
532 (write-region (point-min) (point-max) nnmh-file nil 'nomesg)
533 (kill-buffer (current-buffer)))))
537 ;;; nnmh.el ends here