;;; nnml.el --- mail spool access for Gnus ;; Copyright (C) 1995,96 Free Software Foundation, Inc. ;; Author: Lars Magne Ingebrigtsen ;; Masanobu UMEDA ;; Keywords: news, mail ;; This file is part of GNU Emacs. ;; GNU Emacs is free software; you can redistribute it and/or modify ;; it under the terms of the GNU General Public License as published by ;; the Free Software Foundation; either version 2, or (at your option) ;; any later version. ;; GNU Emacs is distributed in the hope that it will be useful, ;; but WITHOUT ANY WARRANTY; without even the implied warranty of ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the ;; GNU General Public License for more details. ;; You should have received a copy of the GNU General Public License ;; along with GNU Emacs; see the file COPYING. If not, write to the ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, ;; Boston, MA 02111-1307, USA. ;;; Commentary: ;; Based on nnspool.el by Masanobu UMEDA . ;; For an overview of what the interface functions do, please see the ;; Gnus sources. ;;; Code: (require 'nnheader) (require 'nnmail) (require 'nnoo) (require 'cl) (nnoo-declare nnml) (defvoo nnml-directory message-directory "Mail spool directory.") (defvoo nnml-active-file (concat (file-name-as-directory nnml-directory) "active") "Mail active file.") (defvoo nnml-newsgroups-file (concat (file-name-as-directory nnml-directory) "newsgroups") "Mail newsgroups description file.") (defvoo nnml-get-new-mail t "If non-nil, nnml will check the incoming mail file and split the mail.") (defvoo nnml-nov-is-evil nil "If non-nil, Gnus will never generate and use nov databases for mail groups. Using nov databases will speed up header fetching considerably. This variable shouldn't be flipped much. If you have, for some reason, set this to t, and want to set it to nil again, you should always run the `nnml-generate-nov-databases' command. The function will go through all nnml directories and generate nov databases for them all. This may very well take some time.") (defvoo nnml-prepare-save-mail-hook nil "Hook run narrowed to an article before saving.") (defvoo nnml-inhibit-expiry nil "If non-nil, inhibit expiry.") (defconst nnml-version "nnml 1.0" "nnml version.") (defvoo nnml-nov-file-name ".overview") (defvoo nnml-current-directory nil) (defvoo nnml-current-group nil) (defvoo nnml-status-string "") (defvoo nnml-nov-buffer-alist nil) (defvoo nnml-group-alist nil) (defvoo nnml-active-timestamp nil) (defvoo nnml-article-file-alist nil) (defvoo nnml-generate-active-function 'nnml-generate-active-info) ;;; Interface functions. (nnoo-define-basics nnml) (deffoo nnml-retrieve-headers (sequence &optional newsgroup server fetch-old) (save-excursion (set-buffer nntp-server-buffer) (erase-buffer) (let ((file nil) (number (length sequence)) (count 0) beg article) (if (stringp (car sequence)) 'headers (nnml-possibly-change-directory newsgroup server) (unless nnml-article-file-alist (setq nnml-article-file-alist (nnheader-article-to-file-alist nnml-current-directory))) (if (nnml-retrieve-headers-with-nov sequence fetch-old) 'nov (while sequence (setq article (car sequence)) (setq file (concat nnml-current-directory (or (cdr (assq article nnml-article-file-alist)) ""))) (if (and (file-exists-p file) (not (file-directory-p file))) (progn (insert (format "221 %d Article retrieved.\n" article)) (setq beg (point)) (nnheader-insert-head file) (goto-char beg) (if (search-forward "\n\n" nil t) (forward-char -1) (goto-char (point-max)) (insert "\n\n")) (insert ".\n") (delete-region (point) (point-max)))) (setq sequence (cdr sequence)) (setq count (1+ count)) (and (numberp nnmail-large-newsgroup) (> number nnmail-large-newsgroup) (zerop (% count 20)) (nnheader-message 6 "nnml: Receiving headers... %d%%" (/ (* count 100) number)))) (and (numberp nnmail-large-newsgroup) (> number nnmail-large-newsgroup) (nnheader-message 6 "nnml: Receiving headers...done")) (nnheader-fold-continuation-lines) 'headers))))) (deffoo nnml-open-server (server &optional defs) (nnoo-change-server 'nnml server defs) (when (not (file-exists-p nnml-directory)) (condition-case () (make-directory nnml-directory t) (error t))) (cond ((not (file-exists-p nnml-directory)) (nnml-close-server) (nnheader-report 'nnml "Couldn't create directory: %s" nnml-directory)) ((not (file-directory-p (file-truename nnml-directory))) (nnml-close-server) (nnheader-report 'nnml "Not a directory: %s" nnml-directory)) (t (nnheader-report 'nnml "Opened server %s using directory %s" server nnml-directory) t))) (deffoo nnml-request-article (id &optional newsgroup server buffer) (nnml-possibly-change-directory newsgroup server) (let* ((nntp-server-buffer (or buffer nntp-server-buffer)) file path gpath group-num) (if (stringp id) (when (and (setq group-num (nnml-find-group-number id)) (setq file (cdr (assq (cdr group-num) (nnheader-article-to-file-alist (setq gpath (nnmail-group-pathname (car group-num) nnml-directory))))))) (setq path (concat gpath (int-to-string (cdr group-num))))) (unless nnml-article-file-alist (setq nnml-article-file-alist (nnheader-article-to-file-alist nnml-current-directory))) (when (setq file (cdr (assq id nnml-article-file-alist))) (setq path (concat nnml-current-directory file)))) (cond ((not path) (nnheader-report 'nnml "No such article: %s" id)) ((not (file-exists-p path)) (nnheader-report 'nnml "No such file: %s" path)) ((file-directory-p path) (nnheader-report 'nnml "File is a directory: %s" path)) ((not (save-excursion (nnmail-find-file path))) (nnheader-report 'nnml "Couldn't read file: %s" path)) (t (nnheader-report 'nnml "Article %s retrieved" id) ;; We return the article number. (cons newsgroup (string-to-int (file-name-nondirectory path))))))) (deffoo nnml-request-group (group &optional server dont-check) (cond ((not (nnml-possibly-change-directory group server)) (nnheader-report 'nnml "Invalid group (no such directory)")) ((not (file-directory-p nnml-current-directory)) (nnheader-report 'nnml "%s is not a directory" nnml-current-directory)) (dont-check (nnheader-report 'nnml "Group %s selected" group) t) (t (nnmail-activate 'nnml) (let ((active (nth 1 (assoc group nnml-group-alist)))) (if (not active) (nnheader-report 'nnml "No such group: %s" group) (nnheader-report 'nnml "Selected group %s" group) (nnheader-insert "211 %d %d %d %s\n" (max (1+ (- (cdr active) (car active))) 0) (car active) (cdr active) group)))))) (deffoo nnml-request-scan (&optional group server) (setq nnml-article-file-alist nil) (nnmail-get-new-mail 'nnml 'nnml-save-nov nnml-directory group)) (deffoo nnml-close-group (group &optional server) (setq nnml-article-file-alist nil) t) (deffoo nnml-request-create-group (group &optional server) (nnmail-activate 'nnml) (or (assoc group nnml-group-alist) (let (active) (setq nnml-group-alist (cons (list group (setq active (cons 1 0))) nnml-group-alist)) (nnml-possibly-create-directory group) (nnml-possibly-change-directory group server) (let ((articles (nnheader-directory-articles nnml-current-directory ))) (and articles (progn (setcar active (apply 'min articles)) (setcdr active (apply 'max articles))))) (nnmail-save-active nnml-group-alist nnml-active-file))) t) (deffoo nnml-request-list (&optional server) (save-excursion (nnmail-find-file nnml-active-file) (setq nnml-group-alist (nnmail-get-active)))) (deffoo nnml-request-newgroups (date &optional server) (nnml-request-list server)) (deffoo nnml-request-list-newsgroups (&optional server) (save-excursion (nnmail-find-file nnml-newsgroups-file))) (deffoo nnml-request-expire-articles (articles newsgroup &optional server force) (nnml-possibly-change-directory newsgroup server) (let* ((active-articles (nnheader-directory-articles nnml-current-directory)) (is-old t) article rest mod-time number) (nnmail-activate 'nnml) (unless nnml-article-file-alist (setq nnml-article-file-alist (nnheader-article-to-file-alist nnml-current-directory))) (while (and articles is-old) (setq article (concat nnml-current-directory (int-to-string (setq number (pop articles))))) (when (setq mod-time (nth 5 (file-attributes article))) (if (and (nnml-deletable-article-p newsgroup number) (setq is-old (nnmail-expired-article-p newsgroup mod-time force nnml-inhibit-expiry))) (progn (nnheader-message 5 "Deleting article %s in %s..." article newsgroup) (condition-case () (funcall nnmail-delete-file-function article) (file-error (push number rest))) (setq active-articles (delq number active-articles)) (nnml-nov-delete-article newsgroup number)) (push number rest)))) (let ((active (nth 1 (assoc newsgroup nnml-group-alist)))) (when active (setcar active (or (and active-articles (apply 'min active-articles)) (1+ (cdr active))))) (nnmail-save-active nnml-group-alist nnml-active-file)) (nnml-save-nov) (message "") (nconc rest articles))) (deffoo nnml-request-move-article (article group server accept-form &optional last) (let ((buf (get-buffer-create " *nnml move*")) result) (nnml-possibly-change-directory group server) (unless nnml-article-file-alist (setq nnml-article-file-alist (nnheader-article-to-file-alist nnml-current-directory))) (and (nnml-deletable-article-p group article) (nnml-request-article article group server) (save-excursion (set-buffer buf) (insert-buffer-substring nntp-server-buffer) (setq result (eval accept-form)) (kill-buffer (current-buffer)) result) (progn (nnml-possibly-change-directory group server) (condition-case () (funcall nnmail-delete-file-function (concat nnml-current-directory (int-to-string article))) (file-error nil)) (nnml-nov-delete-article group article) (and last (nnml-save-nov)))) result)) (deffoo nnml-request-accept-article (group &optional server last) (nnml-possibly-change-directory group server) (nnmail-check-syntax) (let (result) (if (stringp group) (and (nnmail-activate 'nnml) ;; We trick the choosing function into believing that only one ;; group is available. (let ((nnmail-split-methods (list (list group "")))) (setq result (car (nnml-save-mail)))) (progn (nnmail-save-active nnml-group-alist nnml-active-file) (and last (nnml-save-nov)))) (and (nnmail-activate 'nnml) (setq result (car (nnml-save-mail))) (progn (nnmail-save-active nnml-group-alist nnml-active-file) (and last (nnml-save-nov))))) result)) (deffoo nnml-request-replace-article (article group buffer) (nnml-possibly-change-directory group) (save-excursion (set-buffer buffer) (nnml-possibly-create-directory group) (let ((chars (nnmail-insert-lines)) (art (concat (int-to-string article) "\t")) headers) (when (condition-case () (progn (write-region (point-min) (point-max) (concat nnml-current-directory (int-to-string article)) nil (if (nnheader-be-verbose 5) nil 'nomesg)) t) (error nil)) (setq headers (nnml-parse-head chars article)) ;; Replace the NOV line in the NOV file. (save-excursion (set-buffer (nnml-open-nov group)) (goto-char (point-min)) (if (or (looking-at art) (search-forward (concat "\n" art) nil t)) ;; Delete the old NOV line. (delete-region (progn (beginning-of-line) (point)) (progn (forward-line 1) (point))) ;; The line isn't here, so we have to find out where ;; we should insert it. (This situation should never ;; occur, but one likes to make sure...) (while (and (looking-at "[0-9]+\t") (< (string-to-int (buffer-substring (match-beginning 0) (match-end 0))) article) (zerop (forward-line 1))))) (beginning-of-line) (nnheader-insert-nov headers) (nnml-save-nov) t))))) (deffoo nnml-request-delete-group (group &optional force server) (nnml-possibly-change-directory group server) (when force ;; Delete all articles in GROUP. (let ((articles (directory-files nnml-current-directory t (concat nnheader-numerical-short-files "\\|" (regexp-quote nnml-nov-file-name) "$"))) article) (while articles (setq article (pop articles)) (when (file-writable-p article) (nnheader-message 5 "Deleting article %s in %s..." article group) (funcall nnmail-delete-file-function article)))) ;; Try to delete the directory itself. (condition-case () (delete-directory nnml-current-directory) (error nil))) ;; Remove the group from all structures. (setq nnml-group-alist (delq (assoc group nnml-group-alist) nnml-group-alist) nnml-current-group nil nnml-current-directory nil) ;; Save the active file. (nnmail-save-active nnml-group-alist nnml-active-file) t) (deffoo nnml-request-rename-group (group new-name &optional server) (nnml-possibly-change-directory group server) ;; Rename directory. (and (file-writable-p nnml-current-directory) (condition-case () (let ((parent (file-name-directory (directory-file-name (nnmail-group-pathname new-name nnml-directory))))) (unless (file-exists-p parent) (make-directory parent t)) (rename-file (directory-file-name nnml-current-directory) (directory-file-name (nnmail-group-pathname new-name nnml-directory))) t) (error nil)) ;; That went ok, so we change the internal structures. (let ((entry (assoc group nnml-group-alist))) (and entry (setcar entry new-name)) (setq nnml-current-directory nil nnml-current-group nil) ;; Save the new group alist. (nnmail-save-active nnml-group-alist nnml-active-file) t))) ;;; Internal functions. (defun nnml-deletable-article-p (group article) "Say whether ARTICLE in GROUP can be deleted." (let (file path) (when (setq file (cdr (assq article nnml-article-file-alist))) (setq path (concat nnml-current-directory file)) (and (file-writable-p path) (or (not nnmail-keep-last-article) (not (eq (cdr (nth 1 (assoc group nnml-group-alist))) article))))))) ;; Find an article number in the current group given the Message-ID. (defun nnml-find-group-number (id) (save-excursion (set-buffer (get-buffer-create " *nnml id*")) (buffer-disable-undo (current-buffer)) (let ((alist nnml-group-alist) number) ;; We want to look through all .overview files, but we want to ;; start with the one in the current directory. It seems most ;; likely that the article we are looking for is in that group. (if (setq number (nnml-find-id nnml-current-group id)) (cons nnml-current-group number) ;; It wasn't there, so we look through the other groups as well. (while (and (not number) alist) (or (string= (caar alist) nnml-current-group) (setq number (nnml-find-id (caar alist) id))) (or number (setq alist (cdr alist)))) (and number (cons (caar alist) number)))))) (defun nnml-find-id (group id) (erase-buffer) (let ((nov (concat (nnmail-group-pathname group nnml-directory) nnml-nov-file-name)) number found) (when (file-exists-p nov) (insert-file-contents nov) (while (and (not found) (search-forward id nil t)) ; We find the ID. ;; And the id is in the fourth field. (if (search-backward "\t" (save-excursion (beginning-of-line) (point)) t 4) (progn (beginning-of-line) (setq found t) ;; We return the article number. (setq number (condition-case () (read (current-buffer)) (error nil)))))) number))) (defun nnml-retrieve-headers-with-nov (articles &optional fetch-old) (if (or gnus-nov-is-evil nnml-nov-is-evil) nil (let ((first (car articles)) (last (progn (while (cdr articles) (setq articles (cdr articles))) (car articles))) (nov (concat nnml-current-directory nnml-nov-file-name))) (when (file-exists-p nov) (save-excursion (set-buffer nntp-server-buffer) (erase-buffer) (insert-file-contents nov) (if (and fetch-old (not (numberp fetch-old))) t ; Don't remove anything. (if fetch-old (setq first (max 1 (- first fetch-old)))) (goto-char (point-min)) (while (and (not (eobp)) (> first (read (current-buffer)))) (forward-line 1)) (beginning-of-line) (if (not (eobp)) (delete-region 1 (point))) (while (and (not (eobp)) (>= last (read (current-buffer)))) (forward-line 1)) (beginning-of-line) (if (not (eobp)) (delete-region (point) (point-max))) t)))))) (defun nnml-possibly-change-directory (group &optional server) (when (and server (not (nnml-server-opened server))) (nnml-open-server server)) (when group (let ((pathname (nnmail-group-pathname group nnml-directory))) (when (not (equal pathname nnml-current-directory)) (setq nnml-current-directory pathname nnml-current-group group nnml-article-file-alist nil)))) t) (defun nnml-possibly-create-directory (group) (let (dir dirs) (setq dir (nnmail-group-pathname group nnml-directory)) (while (not (file-directory-p dir)) (setq dirs (cons dir dirs)) (setq dir (file-name-directory (directory-file-name dir)))) (while dirs (make-directory (directory-file-name (car dirs))) (nnheader-message 5 "Creating mail directory %s" (car dirs)) (setq dirs (cdr dirs))))) (defun nnml-save-mail () "Called narrowed to an article." (let ((group-art (nreverse (nnmail-article-group 'nnml-active-number))) chars headers) (setq chars (nnmail-insert-lines)) (nnmail-insert-xref group-art) (run-hooks 'nnmail-prepare-save-mail-hook) (run-hooks 'nnml-prepare-save-mail-hook) (goto-char (point-min)) (while (looking-at "From ") (replace-match "X-From-Line: ") (forward-line 1)) ;; We save the article in all the newsgroups it belongs in. (let ((ga group-art) first) (while ga (nnml-possibly-create-directory (caar ga)) (let ((file (concat (nnmail-group-pathname (caar ga) nnml-directory) (int-to-string (cdar ga))))) (if first ;; It was already saved, so we just make a hard link. (funcall nnmail-crosspost-link-function first file t) ;; Save the article. (write-region (point-min) (point-max) file nil (if (nnheader-be-verbose 5) nil 'nomesg)) (setq first file))) (setq ga (cdr ga)))) ;; Generate a nov line for this article. We generate the nov ;; line after saving, because nov generation destroys the ;; header. (setq headers (nnml-parse-head chars)) ;; Output the nov line to all nov databases that should have it. (let ((ga group-art)) (while ga (nnml-add-nov (caar ga) (cdar ga) headers) (setq ga (cdr ga)))) group-art)) (defun nnml-active-number (group) "Compute the next article number in GROUP." (let ((active (cadr (assoc group nnml-group-alist)))) ;; The group wasn't known to nnml, so we just create an active ;; entry for it. (unless active ;; Perhaps the active file was corrupt? See whether ;; there are any articles in this group. (nnml-possibly-create-directory group) (nnml-possibly-change-directory group) (unless nnml-article-file-alist (setq nnml-article-file-alist (sort (nnheader-article-to-file-alist nnml-current-directory) (lambda (a1 a2) (< (car a1) (car a2)))))) (setq active (if nnml-article-file-alist (cons (caar nnml-article-file-alist) (caar (last nnml-article-file-alist))) (cons 1 0))) (setq nnml-group-alist (cons (list group active) nnml-group-alist))) (setcdr active (1+ (cdr active))) (while (file-exists-p (concat (nnmail-group-pathname group nnml-directory) (int-to-string (cdr active)))) (setcdr active (1+ (cdr active)))) (cdr active))) (defun nnml-add-nov (group article headers) "Add a nov line for the GROUP base." (save-excursion (set-buffer (nnml-open-nov group)) (goto-char (point-max)) (mail-header-set-number headers article) (nnheader-insert-nov headers))) (defsubst nnml-header-value () (buffer-substring (match-end 0) (progn (end-of-line) (point)))) (defun nnml-parse-head (chars &optional number) "Parse the head of the current buffer." (save-excursion (save-restriction (goto-char (point-min)) (narrow-to-region (point) (1- (or (search-forward "\n\n" nil t) (point-max)))) ;; Fold continuation lines. (goto-char (point-min)) (while (re-search-forward "\\(\r?\n[ \t]+\\)+" nil t) (replace-match " " t t)) ;; Remove any tabs; they are too confusing. (subst-char-in-region (point-min) (point-max) ?\t ? ) (let ((headers (nnheader-parse-head t))) (mail-header-set-chars headers chars) (mail-header-set-number headers number) headers)))) (defun nnml-open-nov (group) (or (cdr (assoc group nnml-nov-buffer-alist)) (let ((buffer (find-file-noselect (concat (nnmail-group-pathname group nnml-directory) nnml-nov-file-name)))) (save-excursion (set-buffer buffer) (buffer-disable-undo (current-buffer))) (setq nnml-nov-buffer-alist (cons (cons group buffer) nnml-nov-buffer-alist)) buffer))) (defun nnml-save-nov () (save-excursion (while nnml-nov-buffer-alist (when (buffer-name (cdar nnml-nov-buffer-alist)) (set-buffer (cdar nnml-nov-buffer-alist)) (and (buffer-modified-p) (write-region 1 (point-max) (buffer-file-name) nil 'nomesg)) (set-buffer-modified-p nil) (kill-buffer (current-buffer))) (setq nnml-nov-buffer-alist (cdr nnml-nov-buffer-alist))))) ;;;###autoload (defun nnml-generate-nov-databases () "Generate nov databases in all nnml directories." (interactive) ;; Read the active file to make sure we don't re-use articles ;; numbers in empty groups. (nnmail-activate 'nnml) (nnml-open-server (or (nnoo-current-server 'nnml) "")) (setq nnml-directory (expand-file-name nnml-directory)) ;; Recurse down the directories. (nnml-generate-nov-databases-1 nnml-directory) ;; Save the active file. (nnmail-save-active nnml-group-alist nnml-active-file)) (defun nnml-generate-nov-databases-1 (dir) (setq dir (file-name-as-directory dir)) ;; We descend recursively (let ((dirs (directory-files dir t nil t)) dir) (while dirs (setq dir (pop dirs)) (when (and (not (member (file-name-nondirectory dir) '("." ".."))) (file-directory-p dir)) (nnml-generate-nov-databases-1 dir)))) ;; Do this directory. (let ((files (sort (mapcar (lambda (name) (string-to-int name)) (directory-files dir nil "^[0-9]+$" t)) '<))) (when files (funcall nnml-generate-active-function dir) ;; Generate the nov file. (nnml-generate-nov-file dir files)))) (defvar files) (defun nnml-generate-active-info (dir) ;; Update the active info for this group. (let ((group (nnheader-file-to-group (directory-file-name dir) nnml-directory))) (setq nnml-group-alist (delq (assoc group nnml-group-alist) nnml-group-alist)) (push (list group (cons (car files) (let ((f files)) (while (cdr f) (setq f (cdr f))) (car f)))) nnml-group-alist))) (defun nnml-generate-nov-file (dir files) (let* ((dir (file-name-as-directory dir)) (nov (concat dir nnml-nov-file-name)) (nov-buffer (get-buffer-create " *nov*")) nov-line chars file headers) (save-excursion ;; Init the nov buffer. (set-buffer nov-buffer) (buffer-disable-undo (current-buffer)) (erase-buffer) (set-buffer nntp-server-buffer) ;; Delete the old NOV file. (when (file-exists-p nov) (funcall nnmail-delete-file-function nov)) (while files (unless (file-directory-p (setq file (concat dir (int-to-string (car files))))) (erase-buffer) (insert-file-contents file) (narrow-to-region (goto-char (point-min)) (progn (search-forward "\n\n" nil t) (setq chars (- (point-max) (point))) (max 1 (1- (point))))) (when (and (not (= 0 chars)) ; none of them empty files... (not (= (point-min) (point-max)))) (goto-char (point-min)) (setq headers (nnml-parse-head chars (car files))) (save-excursion (set-buffer nov-buffer) (goto-char (point-max)) (nnheader-insert-nov headers))) (widen)) (setq files (cdr files))) (save-excursion (set-buffer nov-buffer) (write-region 1 (point-max) (expand-file-name nov) nil 'nomesg) (kill-buffer (current-buffer)))))) (defun nnml-nov-delete-article (group article) (save-excursion (set-buffer (nnml-open-nov group)) (goto-char (point-min)) (if (re-search-forward (concat "^" (int-to-string article) "\t") nil t) (delete-region (match-beginning 0) (progn (forward-line 1) (point)))) t)) (provide 'nnml) ;;; nnml.el ends here