1 ;;; nnmh.el --- mhspool access for Gnus
3 ;; Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003,
4 ;; 2004, 2005, 2006, 2007, 2008, 2009, 2010 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 3 of the License, or
15 ;; (at your option) any later version.
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. If not, see <http://www.gnu.org/licenses/>.
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-when-compile (require 'cl))
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.
52 Go through the .nnmh-articles file and compare with the actual
53 articles in this folder. The articles that are \"new\" will be marked
58 (defconst nnmh-version "nnmh 1.0"
61 (defvoo nnmh-current-directory nil
62 "Current news group directory.")
64 (defvoo nnmh-status-string "")
65 (defvoo nnmh-group-alist nil)
66 ;; Don't even think about setting this variable. It does not exist.
67 ;; Forget about it. Uh-huh. Nope. Nobody here. It's only bound
68 ;; dynamically by certain functions in nndraft.
69 (defvar nnmh-allow-delete-final nil)
73 ;;; Interface functions.
75 (nnoo-define-basics nnmh)
77 (deffoo nnmh-retrieve-headers (articles &optional newsgroup server fetch-old)
78 (with-current-buffer nntp-server-buffer
81 (number (length articles))
82 (large (and (numberp nnmail-large-newsgroup)
83 (> number nnmail-large-newsgroup)))
85 (file-name-coding-system nnmail-pathname-coding-system)
87 (nnmh-possibly-change-directory newsgroup server)
88 ;; We don't support fetching by Message-ID.
89 (if (stringp (car articles))
92 (when (and (file-exists-p
93 (setq file (concat (file-name-as-directory
94 nnmh-current-directory)
96 (setq article (pop articles))))))
97 (not (file-directory-p file)))
98 (insert (format "221 %d Article retrieved.\n" article))
100 (nnheader-insert-head file)
102 (if (search-forward "\n\n" nil t)
104 (goto-char (point-max))
107 (delete-region (point) (point-max)))
108 (setq count (1+ count))
112 (nnheader-message 5 "nnmh: Receiving headers... %d%%"
113 (/ (* count 100) number))))
116 (nnheader-message 5 "nnmh: Receiving headers...done"))
118 (nnheader-fold-continuation-lines)
121 (deffoo nnmh-open-server (server &optional defs)
122 (nnoo-change-server 'nnmh server defs)
123 (when (not (file-exists-p nnmh-directory))
125 (make-directory nnmh-directory t)
128 ((not (file-exists-p nnmh-directory))
130 (nnheader-report 'nnmh "Couldn't create directory: %s" nnmh-directory))
131 ((not (file-directory-p (file-truename nnmh-directory)))
133 (nnheader-report 'nnmh "Not a directory: %s" nnmh-directory))
135 (nnheader-report 'nnmh "Opened server %s using directory %s"
136 server nnmh-directory)
139 (deffoo nnmh-request-article (id &optional newsgroup server buffer)
140 (nnmh-possibly-change-directory newsgroup server)
141 (let ((file (if (stringp id)
143 (concat nnmh-current-directory (int-to-string id))))
144 (file-name-coding-system nnmail-pathname-coding-system)
145 (nntp-server-buffer (or buffer nntp-server-buffer)))
148 (not (file-directory-p file))
149 (save-excursion (nnmail-find-file file))
150 (string-to-number (file-name-nondirectory file)))))
152 (deffoo nnmh-request-group (group &optional server dont-check)
153 (nnheader-init-server-buffer)
154 (nnmh-possibly-change-directory group server)
155 (let ((pathname (nnmail-group-pathname group nnmh-directory))
156 (file-name-coding-system nnmail-pathname-coding-system)
159 ((not (file-directory-p pathname))
161 'nnmh "Can't select group (no such directory): %s" group))
163 (setq nnmh-current-directory pathname)
164 (and nnmh-get-new-mail
166 (nnmh-update-gnus-unreads group))
169 (nnheader-report 'nnmh "Selected group %s" group)
172 ;; Re-scan the directory if it's on a foreign system.
173 (nnheader-re-read-dir pathname)
176 (mapcar 'string-to-number
177 (directory-files pathname nil "^[0-9]+$" t))
181 (setq nnmh-group-alist
182 (delq (assoc group nnmh-group-alist) nnmh-group-alist))
183 (push (list group (cons (car dir) (car (last dir))))
185 (nnheader-report 'nnmh "Selected group %s" group)
187 "211 %d %d %d %s\n" (length dir) (car dir)
188 (car (last dir)) group))
190 (nnheader-report 'nnmh "Empty group %s" group)
191 (nnheader-insert (format "211 0 1 0 %s\n" group))))))))))
193 (deffoo nnmh-request-scan (&optional group server)
194 (nnmail-get-new-mail 'nnmh nil nnmh-directory group))
196 (deffoo nnmh-request-list (&optional server dir)
198 (nnmh-possibly-change-directory nil server)
199 (let ((file-name-coding-system nnmail-pathname-coding-system)
201 (file-truename (or dir (file-name-as-directory nnmh-directory)))))
202 (nnmh-request-list-1 nnmh-toplev))
203 (setq nnmh-group-alist (nnmail-get-active))
207 (defun nnmh-request-list-1 (dir)
208 (setq dir (expand-file-name dir))
209 ;; Recurse down all directories.
210 (let ((files (nnheader-directory-files dir t nil t))
212 min rdir attributes num)
213 ;; Recurse down directories.
215 (setq attributes (file-attributes rdir))
216 (when (null (nth 0 attributes))
217 (setq file (file-name-nondirectory rdir))
218 (when (string-match "^[0-9]+$" file)
219 (setq num (string-to-number file))
220 (setq max (max max num))
224 (when (and (eq (nth 0 attributes) t) ; Is a directory
225 (> (nth 1 attributes) 2) ; Has sub-directories
226 (file-readable-p rdir)
227 (not (equal (file-truename rdir)
228 (file-truename dir))))
229 (nnmh-request-list-1 rdir)))
230 ;; For each directory, generate an active file line.
231 (unless (string= (expand-file-name nnmh-toplev) dir)
233 (with-current-buffer nntp-server-buffer
234 (goto-char (point-max))
241 (file-truename (file-name-as-directory
242 (expand-file-name nnmh-toplev))))
244 (mm-string-to-multibyte ;Why? Isn't it multibyte already?
245 (mm-encode-coding-string
246 (nnheader-replace-chars-in-string
247 (substring dir (match-end 0))
249 nnmail-pathname-coding-system)))
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 (nnmail-expiry-target
261 (or (gnus-group-find-parameter newsgroup 'expiry-target t)
262 nnmail-expiry-target))
263 article rest mod-time)
264 (nnheader-init-server-buffer)
266 (while (and articles is-old)
267 (setq article (concat nnmh-current-directory
268 (int-to-string (car articles))))
269 (when (setq mod-time (nth 5 (file-attributes article)))
270 (if (and (nnmh-deletable-article-p newsgroup (car articles))
272 (nnmail-expired-article-p newsgroup mod-time force)))
274 ;; Allow a special target group. -- jcn
275 (unless (eq nnmail-expiry-target 'delete)
277 (nnmh-request-article (car articles)
278 newsgroup server (current-buffer))
279 (nnmail-expiry-target-group
280 nnmail-expiry-target newsgroup)))
281 (nnheader-message 5 "Deleting article %s in %s..."
284 (funcall nnmail-delete-file-function article)
286 (nnheader-message 1 "Couldn't delete article %s in %s"
288 (push (car articles) rest))))
289 (push (car articles) rest)))
290 (setq articles (cdr articles)))
291 (nnheader-message 5 "")
292 (nconc rest articles)))
294 (deffoo nnmh-close-group (group &optional server)
297 (deffoo nnmh-request-move-article (article group server accept-form
298 &optional last move-is-internal)
299 (let ((buf (get-buffer-create " *nnmh move*"))
302 (nnmh-deletable-article-p group article)
303 (nnmh-request-article article group server)
304 (with-current-buffer buf
306 (insert-buffer-substring nntp-server-buffer)
307 (setq result (eval accept-form))
308 (kill-buffer (current-buffer))
311 (nnmh-possibly-change-directory group server)
313 (funcall nnmail-delete-file-function
314 (concat nnmh-current-directory (int-to-string article)))
318 (deffoo nnmh-request-accept-article (group &optional server last noinsert)
319 (nnmh-possibly-change-directory group server)
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)
344 (with-current-buffer buffer
345 (nnmh-possibly-create-directory group)
348 (point-min) (point-max)
349 (concat nnmh-current-directory (int-to-string article))
350 nil (if (nnheader-be-verbose 5) nil 'nomesg))
353 (deffoo nnmh-request-create-group (group &optional server args)
354 (nnheader-init-server-buffer)
355 (unless (assoc group nnmh-group-alist)
357 (push (list group (setq active (cons 1 0)))
359 (nnmh-possibly-create-directory group)
360 (nnmh-possibly-change-directory group server)
361 (let ((articles (mapcar 'string-to-number
363 nnmh-current-directory nil "^[0-9]+$"))))
365 (setcar active (apply 'min articles))
366 (setcdr active (apply 'max articles))))))
369 (deffoo nnmh-request-delete-group (group &optional force server)
370 (nnmh-possibly-change-directory group server)
371 ;; Delete all articles in GROUP.
373 () ; Don't delete the articles.
374 (let ((articles (directory-files nnmh-current-directory t "^[0-9]+$")))
376 (when (file-writable-p (car articles))
377 (nnheader-message 5 "Deleting article %s in %s..."
378 (car articles) group)
379 (funcall nnmail-delete-file-function (car articles)))
380 (setq articles (cdr articles))))
381 ;; Try to delete the directory itself.
383 (delete-directory nnmh-current-directory)))
384 ;; Remove the group from all structures.
385 (setq nnmh-group-alist
386 (delq (assoc group nnmh-group-alist) nnmh-group-alist)
387 nnmh-current-directory nil)
390 (deffoo nnmh-request-rename-group (group new-name &optional server)
391 (nnmh-possibly-change-directory group server)
392 (let ((new-dir (nnmail-group-pathname new-name nnmh-directory))
393 (old-dir (nnmail-group-pathname group nnmh-directory)))
395 (make-directory new-dir t)
397 ;; We move the articles file by file instead of renaming
398 ;; the directory -- there may be subgroups in this group.
399 ;; One might be more clever, I guess.
400 (let ((files (nnheader-article-to-file-alist old-dir)))
403 (concat old-dir (cdar files))
404 (concat new-dir (cdar files)))
406 (when (<= (length (directory-files old-dir)) 2)
408 (delete-directory old-dir)))
409 ;; That went ok, so we change the internal structures.
410 (let ((entry (assoc group nnmh-group-alist)))
412 (setcar entry new-name))
413 (setq nnmh-current-directory nil)
416 (nnoo-define-skeleton nnmh)
419 ;;; Internal functions.
421 (defun nnmh-possibly-change-directory (newsgroup &optional server)
423 (not (nnmh-server-opened server)))
424 (nnmh-open-server server))
426 (let ((pathname (nnmail-group-pathname newsgroup nnmh-directory))
427 (file-name-coding-system nnmail-pathname-coding-system))
428 (if (file-directory-p pathname)
429 (setq nnmh-current-directory pathname)
430 (nnheader-report 'nnmh "Not a directory: %s" nnmh-directory)))))
432 (defun nnmh-possibly-create-directory (group)
434 (setq dir (nnmail-group-pathname group nnmh-directory))
435 (while (not (file-directory-p dir))
437 (setq dir (file-name-directory (directory-file-name dir))))
439 (when (make-directory (directory-file-name (car dirs)))
440 (error "Could not create directory %s" (car dirs)))
441 (nnheader-message 5 "Creating mail directory %s" (car dirs))
442 (setq dirs (cdr dirs)))))
444 (defun nnmh-save-mail (group-art &optional noinsert)
445 "Called narrowed to an article."
447 (nnmail-insert-lines)
448 (nnmail-insert-xref group-art))
449 (run-hooks 'nnmail-prepare-save-mail-hook)
450 (run-hooks 'nnmh-prepare-save-mail-hook)
451 (goto-char (point-min))
452 (while (looking-at "From ")
453 (replace-match "X-From-Line: ")
455 ;; We save the article in all the newsgroups it belongs in.
459 (nnmh-possibly-create-directory (caar ga))
460 (let ((file (concat (nnmail-group-pathname
461 (caar ga) nnmh-directory)
462 (int-to-string (cdar ga)))))
464 ;; It was already saved, so we just make a hard link.
465 (funcall nnmail-crosspost-link-function first file t)
467 (nnmail-write-region (point-min) (point-max) file nil nil)
472 (defun nnmh-active-number (group)
473 "Compute the next article number in GROUP."
474 (let ((active (cadr (assoc group nnmh-group-alist)))
475 (dir (nnmail-group-pathname group nnmh-directory))
476 (file-name-coding-system nnmail-pathname-coding-system)
479 ;; The group wasn't known to nnmh, so we just create an active
481 (setq active (cons 1 0))
482 (push (list group active) nnmh-group-alist)
483 (unless (file-exists-p dir)
484 (gnus-make-directory dir))
485 ;; Find the highest number in the group.
487 (mapcar 'string-to-number
488 (directory-files dir nil "^[0-9]+$"))
491 (setcdr active (car files)))))
492 (setcdr active (1+ (cdr active)))
494 ;; See whether the file exists...
496 (setq file (concat (nnmail-group-pathname group nnmh-directory)
497 (int-to-string (cdr active)))))
498 ;; ... or there is a buffer that will make that file exist
500 (get-file-buffer file))
501 ;; Skip past that file.
502 (setcdr active (1+ (cdr active))))
505 (defun nnmh-update-gnus-unreads (group)
506 ;; Go through the .nnmh-articles file and compare with the actual
507 ;; articles in this folder. The articles that are "new" will be
508 ;; marked as unread by Gnus.
509 (let* ((dir nnmh-current-directory)
510 (files (sort (mapcar 'string-to-number
511 (directory-files nnmh-current-directory
514 (nnmh-file (concat dir ".nnmh-articles"))
516 ;; Load the .nnmh-articles file.
517 (when (file-exists-p nnmh-file)
519 (let (nnmh-newsgroup-articles)
520 (ignore-errors (load nnmh-file nil t t))
521 nnmh-newsgroup-articles)))
522 ;; Add all new articles to the `new' list.
525 (unless (assq (car art) articles)
526 (push (car art) new))
527 (setq art (cdr art))))
528 ;; Remove all deleted articles.
529 (let ((art articles))
531 (unless (memq (caar art) files)
532 (setq articles (delq (car art) articles)))
533 (setq art (cdr art))))
534 ;; Check whether the articles really are the ones that Gnus thinks
535 ;; they are by looking at the time-stamps.
536 (let ((arts articles)
538 (while (setq art (pop arts))
540 (nth 5 (file-attributes
541 (concat dir (int-to-string (car art)))))
543 (setq articles (delq art articles))
544 (push (car art) new))))
545 ;; Go through all the new articles and add them, and their
546 ;; time-stamps, to the list.
552 (nth 5 (file-attributes
553 (concat dir (int-to-string art))))))
555 ;; Make Gnus mark all new articles as unread.
557 (gnus-make-articles-unread
558 (gnus-group-prefixed-name group (list 'nnmh ""))
559 (setq new (sort new '<))))
560 ;; Sort the article list with highest numbers first.
561 (setq articles (sort articles (lambda (art1 art2)
562 (> (car art1) (car art2)))))
563 ;; Finally write this list back to the .nnmh-articles file.
564 (with-temp-file nnmh-file
565 (insert ";; Gnus article active file for " group "\n\n")
566 (insert "(setq nnmh-newsgroup-articles '")
567 (gnus-prin1 articles)
570 (defun nnmh-deletable-article-p (group article)
571 "Say whether ARTICLE in GROUP can be deleted."
572 (let ((path (concat nnmh-current-directory (int-to-string article))))
574 (and (file-writable-p path)
576 ;; We can never delete the last article in the group.
577 (not (eq (cdr (nth 1 (assoc group nnmh-group-alist)))
580 nnmh-allow-delete-final))))
584 ;;; nnmh.el ends here