;;; nnmbox.el --- mail mbox access for Gnus
-;; Copyright (C) 1995 Free Software Foundation, Inc.
+;; Copyright (C) 1995,96 Free Software Foundation, Inc.
;; Author: Lars Magne Ingebrigtsen <larsi@ifi.uio.no>
;; Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
;; 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, 675 Mass Ave, Cambridge, MA 02139, USA.
+;; 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:
+;; For an overview of what the interface functions do, please see the
+;; Gnus sources.
+
;;; Code:
(require 'nnheader)
(require 'rmail)
(require 'nnmail)
+(eval-when-compile (require 'cl))
(defvar nnmbox-mbox-file (expand-file-name "~/mbox")
- "The name of the mail box file in the users home directory.")
+ "The name of the mail box file in the user's home directory.")
(defvar nnmbox-active-file (expand-file-name "~/.mbox-active")
"The name of the active file for the mail box.")
(defvar nnmbox-get-new-mail t
- "If non-nil, nnml will check the incoming mail file and split the mail.")
+ "If non-nil, nnmbox will check the incoming mail file and split the mail.")
+
+(defvar nnmbox-prepare-save-mail-hook nil
+ "Hook run narrowed to an article before saving.")
\f
-(defconst nnmbox-version "nnmbox 0.1"
+(defconst nnmbox-version "nnmbox 1.0"
"nnmbox version.")
(defvar nnmbox-current-group nil
"Current nnmbox news group directory.")
-(defconst nnmbox-mbox-buffer " *nnmbox mbox buffer*")
+(defconst nnmbox-mbox-buffer nil)
(defvar nnmbox-status-string "")
(defvar nnmbox-group-alist nil)
+(defvar nnmbox-active-timestamp nil)
+
+\f
+
+(defvar nnmbox-current-server nil)
+(defvar nnmbox-server-alist nil)
+(defvar nnmbox-server-variables
+ `((nnmbox-mbox-file ,nnmbox-mbox-file)
+ (nnmbox-active-file ,nnmbox-active-file)
+ (nnmbox-get-new-mail ,nnmbox-get-new-mail)
+ (nnmbox-current-group nil)
+ (nnmbox-status-string "")
+ (nnmbox-group-alist nil)))
+
+\f
;;; Interface functions
-(defun nnmbox-retrieve-headers (sequence &optional newsgroup server)
- "Retrieve the headers for the articles in SEQUENCE.
-Newsgroup must be selected before calling this function."
+(defun nnmbox-retrieve-headers (sequence &optional newsgroup server fetch-old)
(save-excursion
(set-buffer nntp-server-buffer)
(erase-buffer)
- (let ((file nil)
- (number (length sequence))
+ (let ((number (length sequence))
(count 0)
- beg article art-string start stop)
+ article art-string start stop)
(nnmbox-possibly-change-newsgroup newsgroup)
(while sequence
(setq article (car sequence))
(setq art-string (nnmbox-article-string article))
(set-buffer nnmbox-mbox-buffer)
(if (or (search-forward art-string nil t)
- (progn (goto-char 1)
+ (progn (goto-char (point-min))
(search-forward art-string nil t)))
(progn
(setq start
(setq stop (1- (point)))
(set-buffer nntp-server-buffer)
(insert (format "221 %d Article retrieved.\n" article))
- (setq beg (point))
(insert-buffer-substring nnmbox-mbox-buffer start stop)
(goto-char (point-max))
(insert ".\n")))
(and (numberp nnmail-large-newsgroup)
(> number nnmail-large-newsgroup)
(zerop (% count 20))
- gnus-verbose-backends
- (message "nnmbox: Receiving headers... %d%%"
- (/ (* count 100) number))))
+ (nnheader-message 5 "nnmbox: Receiving headers... %d%%"
+ (/ (* count 100) number))))
(and (numberp nnmail-large-newsgroup)
(> number nnmail-large-newsgroup)
- gnus-verbose-backends
- (message "nnmbox: Receiving headers... done"))
+ (nnheader-message 5 "nnmbox: Receiving headers...done"))
- ;; Fold continuation lines.
- (goto-char 1)
- (while (re-search-forward "\\(\r?\n[ \t]+\\)+" nil t)
- (replace-match " " t t))
+ (set-buffer nntp-server-buffer)
+ (nnheader-fold-continuation-lines)
'headers)))
-(defun nnmbox-open-server (host &optional service)
- "Open mbox backend."
- (setq nnmbox-status-string "")
- (setq nnmbox-group-alist nil)
- (nnheader-init-server-buffer))
+(defun nnmbox-open-server (server &optional defs)
+ (nnheader-change-server 'nnmbox server defs)
+ (cond
+ ((not (file-exists-p nnmbox-mbox-file))
+ (nnmbox-close-server)
+ (nnheader-report 'nnmbox "No such file: %s" nnmbox-mbox-file))
+ ((file-directory-p nnmbox-mbox-file)
+ (nnmbox-close-server)
+ (nnheader-report 'nnmbox "Not a regular file: %s" nnmbox-mbox-file))
+ (t
+ (nnheader-report 'nnmbox "Opened server %s using mbox %s" server
+ nnmbox-mbox-file)
+ t)))
(defun nnmbox-close-server (&optional server)
- "Close news server."
+ (when (and nnmbox-mbox-buffer
+ (buffer-name nnmbox-mbox-buffer))
+ (kill-buffer nnmbox-mbox-buffer))
+ (setq nnmbox-current-server nil)
t)
(defun nnmbox-server-opened (&optional server)
- "Return server process status, T or NIL.
-If the stream is opened, return T, otherwise return NIL."
- (and nntp-server-buffer
- (get-buffer nntp-server-buffer)))
+ (and (equal server nnmbox-current-server)
+ nnmbox-mbox-buffer
+ (buffer-name nnmbox-mbox-buffer)
+ nntp-server-buffer
+ (buffer-name nntp-server-buffer)))
(defun nnmbox-status-message (&optional server)
- "Return server status response as string."
nnmbox-status-string)
(defun nnmbox-request-article (article &optional newsgroup server buffer)
- "Select ARTICLE by number."
(nnmbox-possibly-change-newsgroup newsgroup)
- (if (stringp article)
- nil
- (save-excursion
- (set-buffer nnmbox-mbox-buffer)
- (goto-char 1)
- (if (search-forward (nnmbox-article-string article) nil t)
- (let (start stop)
- (re-search-backward (concat "^" rmail-unix-mail-delimiter) nil t)
- (setq start (point))
- (forward-line 1)
- (or (and (re-search-forward
- (concat "^" rmail-unix-mail-delimiter) nil t)
- (forward-line -1))
- (goto-char (point-max)))
- (setq stop (point))
- (let ((nntp-server-buffer (or buffer nntp-server-buffer)))
- (set-buffer nntp-server-buffer)
- (erase-buffer)
- (insert-buffer-substring nnmbox-mbox-buffer start stop)
- (goto-char (point-min))
- (while (looking-at "From ")
- (delete-char 5)
- (insert "X-From-Line: ")
- (forward-line 1))
- t))))))
-
-(defun nnmbox-request-group (group &optional server dont-check)
- "Select news GROUP."
(save-excursion
- (if (nnmbox-possibly-change-newsgroup group)
- (if dont-check
- t
- (nnmbox-get-new-mail)
- (save-excursion
+ (set-buffer nnmbox-mbox-buffer)
+ (goto-char (point-min))
+ (if (search-forward (nnmbox-article-string article) nil t)
+ (let (start stop)
+ (re-search-backward (concat "^" rmail-unix-mail-delimiter) nil t)
+ (setq start (point))
+ (forward-line 1)
+ (or (and (re-search-forward
+ (concat "^" rmail-unix-mail-delimiter) nil t)
+ (forward-line -1))
+ (goto-char (point-max)))
+ (setq stop (point))
+ (let ((nntp-server-buffer (or buffer nntp-server-buffer)))
(set-buffer nntp-server-buffer)
(erase-buffer)
- (let ((active (assoc group nnmbox-group-alist)))
- (insert (format "211 %d %d %d %s\n"
- (1+ (- (cdr (car (cdr active)))
- (car (car (cdr active)))))
- (car (car (cdr active)))
- (cdr (car (cdr active)))
- (car active))))
- t)))))
+ (insert-buffer-substring nnmbox-mbox-buffer start stop)
+ (goto-char (point-min))
+ (while (looking-at "From ")
+ (delete-char 5)
+ (insert "X-From-Line: ")
+ (forward-line 1))
+ (if (numberp article)
+ (cons nnmbox-current-group article)
+ (nnmbox-article-group-number)))))))
+
+(defun nnmbox-request-group (group &optional server dont-check)
+ (let ((active (cadr (assoc group nnmbox-group-alist))))
+ (cond
+ ((null active)
+ (nnheader-report 'nnmbox "No such group: %s" group))
+ ((null (nnmbox-possibly-change-newsgroup group))
+ (nnheader-report 'nnmbox "No such group: %s" group))
+ (dont-check
+ (nnheader-report 'nnmbox "Selected group %s" group)
+ (nnheader-insert ""))
+ (t
+ (nnheader-report 'nnmbox "Selected group %s" group)
+ (nnheader-insert "211 %d %d %d %s\n"
+ (1+ (- (cdr active) (car active)))
+ (car active) (cdr active) group)
+ t))))
+
+(defun nnmbox-request-scan (&optional group server)
+ (nnmbox-read-mbox)
+ (nnmail-get-new-mail
+ 'nnmbox
+ (lambda ()
+ (save-excursion
+ (set-buffer nnmbox-mbox-buffer)
+ (save-buffer)))
+ nnmbox-mbox-file group
+ (lambda ()
+ (save-excursion
+ (let ((in-buf (current-buffer)))
+ (set-buffer nnmbox-mbox-buffer)
+ (goto-char (point-max))
+ (insert-buffer-substring in-buf))))))
(defun nnmbox-close-group (group &optional server)
t)
(defun nnmbox-request-list (&optional server)
- "List active newsgoups."
- (if server (nnmbox-get-new-mail))
- (or (nnmail-find-file nnmbox-active-file)
- (progn
- (setq nnmbox-group-alist (nnmail-get-active))
- (nnmail-save-active nnmbox-group-alist nnmbox-active-file)
- (nnmail-find-file nnmbox-active-file))))
+ (save-excursion
+ (or (nnmail-find-file nnmbox-active-file)
+ (progn
+ (setq nnmbox-group-alist (nnmail-get-active))
+ (nnmail-save-active nnmbox-group-alist nnmbox-active-file)
+ (nnmail-find-file nnmbox-active-file)))))
(defun nnmbox-request-newgroups (date &optional server)
- "List groups created after DATE."
(nnmbox-request-list server))
(defun nnmbox-request-list-newsgroups (&optional server)
- "List newsgroups (defined in NNTP2)."
- (setq nnmbox-status-string "nnmbox: LIST NEWSGROUPS is not implemented.")
- nil)
-
-(defun nnmbox-request-post (&optional server)
- "Post a new news in current buffer."
- (mail-send-and-exit nil))
-
-(fset 'nnmbox-request-post-buffer 'nnmail-request-post-buffer)
-
-(defun nnmbox-request-expire-articles (articles newsgroup &optional server force)
- "Expire all articles in the ARTICLES list in group GROUP.
-The list of unexpired articles will be returned (ie. all articles that
-were too fresh to be expired).
-If FORCE is non-nil, the ARTICLES will be deleted without looking at
-the date."
+ (nnheader-report 'nnmbox "LIST NEWSGROUPS is not implemented."))
+
+(defun nnmbox-request-expire-articles
+ (articles newsgroup &optional server force)
(nnmbox-possibly-change-newsgroup newsgroup)
- (let* ((days (or (and nnmail-expiry-wait-function
- (funcall nnmail-expiry-wait-function newsgroup))
- nnmail-expiry-wait))
- article rest)
+ (let* ((is-old t)
+ rest)
+ (nnmail-activate 'nnmbox)
+
(save-excursion
(set-buffer nnmbox-mbox-buffer)
- (while articles
- (goto-char 1)
+ (while (and articles is-old)
+ (goto-char (point-min))
(if (search-forward (nnmbox-article-string (car articles)) nil t)
- (if (or force
- (> (nnmail-days-between
- (current-time-string)
- (buffer-substring
- (point) (progn (end-of-line) (point))))
- days))
+ (if (setq is-old
+ (nnmail-expired-article-p
+ newsgroup
+ (buffer-substring
+ (point) (progn (end-of-line) (point))) force))
(progn
- (and gnus-verbose-backends
- (message "Deleting: %s" (car articles)))
+ (nnheader-message 5 "Deleting article %d in %s..."
+ (car articles) newsgroup)
(nnmbox-delete-mail))
(setq rest (cons (car articles) rest))))
(setq articles (cdr articles)))
(save-buffer)
- rest)))
+ ;; Find the lowest active article in this group.
+ (let ((active (nth 1 (assoc newsgroup nnmbox-group-alist))))
+ (goto-char (point-min))
+ (while (and (not (search-forward
+ (nnmbox-article-string (car active)) nil t))
+ (<= (car active) (cdr active)))
+ (setcar active (1+ (car active)))
+ (goto-char (point-min))))
+ (nnmail-save-active nnmbox-group-alist nnmbox-active-file)
+ (nconc rest articles))))
(defun nnmbox-request-move-article
(article group server accept-form &optional last)
result)
(save-excursion
(set-buffer nnmbox-mbox-buffer)
- (goto-char 1)
+ (goto-char (point-min))
(if (search-forward (nnmbox-article-string article) nil t)
(nnmbox-delete-mail))
(and last (save-buffer))))
(defun nnmbox-request-accept-article (group &optional last)
(let ((buf (current-buffer))
- result beg)
- (debug (current-buffer))
+ result)
(goto-char (point-min))
(if (looking-at "X-From-Line: ")
(replace-match "From ")
(insert "From nobody " (current-time-string) "\n"))
(and
- (nnmbox-request-list)
- (setq nnmbox-group-alist (nnmail-get-active))
+ (nnmail-activate 'nnmbox)
(progn
(set-buffer buf)
(goto-char (point-min))
(nnmbox-possibly-change-newsgroup group)
(save-excursion
(set-buffer nnmbox-mbox-buffer)
- (goto-char 1)
+ (goto-char (point-min))
(if (not (search-forward (nnmbox-article-string article) nil t))
nil
(nnmbox-delete-mail t t)
(save-buffer)
t)))
+(defun nnmbox-request-delete-group (group &optional force server)
+ (nnmbox-possibly-change-newsgroup group)
+ ;; Delete all articles in GROUP.
+ (if (not force)
+ () ; Don't delete the articles.
+ (save-excursion
+ (set-buffer nnmbox-mbox-buffer)
+ (goto-char (point-min))
+ ;; Delete all articles in this group.
+ (let ((ident (concat "\nX-Gnus-Newsgroup: " nnmbox-current-group ":"))
+ found)
+ (while (search-forward ident nil t)
+ (setq found t)
+ (nnmbox-delete-mail))
+ (and found (save-buffer)))))
+ ;; Remove the group from all structures.
+ (setq nnmbox-group-alist
+ (delq (assoc group nnmbox-group-alist) nnmbox-group-alist)
+ nnmbox-current-group nil)
+ ;; Save the active file.
+ (nnmail-save-active nnmbox-group-alist nnmbox-active-file)
+ t)
+
+(defun nnmbox-request-rename-group (group new-name &optional server)
+ (nnmbox-possibly-change-newsgroup group)
+ (save-excursion
+ (set-buffer nnmbox-mbox-buffer)
+ (goto-char (point-min))
+ (let ((ident (concat "\nX-Gnus-Newsgroup: " nnmbox-current-group ":"))
+ (new-ident (concat "\nX-Gnus-Newsgroup: " new-name ":"))
+ found)
+ (while (search-forward ident nil t)
+ (replace-match new-ident t t)
+ (setq found t))
+ (and found (save-buffer))))
+ (let ((entry (assoc group nnmbox-group-alist)))
+ (and entry (setcar entry new-name))
+ (setq nnmbox-current-group nil)
+ ;; Save the new group alist.
+ (nnmail-save-active nnmbox-group-alist nnmbox-active-file)
+ t))
+
\f
;;; Internal functions.
+;; If FORCE, delete article no matter how many X-Gnus-Newsgroup
+;; headers there are. If LEAVE-DELIM, don't delete the Unix mbox
+;; delimiter line.
(defun nnmbox-delete-mail (&optional force leave-delim)
- "If FORCE, delete article no matter how many X-Gnus-Newsgroup
-headers there are. If LEAVE-DELIM, don't delete the Unix mbox
-delimeter line."
;; Delete the current X-Gnus-Newsgroup line.
(or force
(delete-region
(delete-region (point-min) (point-max))))))
(defun nnmbox-possibly-change-newsgroup (newsgroup)
- (if (not (get-buffer nnmbox-mbox-buffer))
+ (if (or (not nnmbox-mbox-buffer)
+ (not (buffer-name nnmbox-mbox-buffer)))
(save-excursion
(set-buffer (setq nnmbox-mbox-buffer
- (find-file-noselect nnmbox-mbox-file)))
+ (nnheader-find-file-noselect
+ nnmbox-mbox-file nil 'raw)))
(buffer-disable-undo (current-buffer))))
(if (not nnmbox-group-alist)
- (progn
- (nnmbox-request-list)
- (setq nnmbox-group-alist (nnmail-get-active))))
+ (nnmail-activate 'nnmbox))
(if newsgroup
(if (assoc newsgroup nnmbox-group-alist)
- (setq nnmbox-current-group newsgroup))))
+ (setq nnmbox-current-group newsgroup))
+ t))
(defun nnmbox-article-string (article)
- (concat "\nX-Gnus-Newsgroup: " nnmbox-current-group ":"
- (int-to-string article) " "))
+ (if (numberp article)
+ (concat "\nX-Gnus-Newsgroup: " nnmbox-current-group ":"
+ (int-to-string article) " ")
+ (concat "\nMessage-ID: " article)))
+
+(defun nnmbox-article-group-number ()
+ (save-excursion
+ (goto-char (point-min))
+ (and (re-search-forward "^X-Gnus-Newsgroup: +\\([^:]+\\):\\([0-9]+\\) "
+ nil t)
+ (cons (buffer-substring (match-beginning 1) (match-end 1))
+ (string-to-int
+ (buffer-substring (match-beginning 2) (match-end 2)))))))
(defun nnmbox-save-mail (&optional group)
"Called narrowed to an article."
(let* ((nnmail-split-methods
(if group (list (list group "")) nnmail-split-methods))
- (group-art (nreverse (nnmail-article-group 'nnmbox-active-number))))
+ (group-art (nreverse (nnmail-article-group 'nnmbox-active-number)))
+ (delim (concat "^" rmail-unix-mail-delimiter)))
+ (goto-char (point-min))
+ ;; This might come from somewhere else.
+ (unless (looking-at delim)
+ (insert "From nobody " (current-time-string) "\n")
+ (goto-char (point-min)))
+ ;; Quote all "From " lines in the article.
+ (forward-line 1)
+ (while (re-search-forward delim nil t)
+ (beginning-of-line)
+ (insert "> "))
(nnmail-insert-lines)
(nnmail-insert-xref group-art)
(nnmbox-insert-newsgroup-line group-art)
+ (run-hooks 'nnmbox-prepare-save-mail-hook)
group-art))
(defun nnmbox-insert-newsgroup-line (group-art)
t))
(defun nnmbox-active-number (group)
- "Find the next article number in GROUP."
+ ;; Find the next article number in GROUP.
(let ((active (car (cdr (assoc group nnmbox-group-alist)))))
- (setcdr active (1+ (cdr active)))
+ (if active
+ (setcdr active (1+ (cdr active)))
+ ;; This group is new, so we create a new entry for it.
+ ;; This might be a bit naughty... creating groups on the drop of
+ ;; a hat, but I don't know...
+ (setq nnmbox-group-alist (cons (list group (setq active (cons 1 1)))
+ nnmbox-group-alist)))
(cdr active)))
(defun nnmbox-read-mbox ()
- (nnmbox-request-list)
- (setq nnmbox-group-alist (nnmail-get-active))
+ (nnmail-activate 'nnmbox)
(if (not (file-exists-p nnmbox-mbox-file))
(write-region 1 1 nnmbox-mbox-file t 'nomesg))
(if (and nnmbox-mbox-buffer
- (get-buffer nnmbox-mbox-buffer)
(buffer-name nnmbox-mbox-buffer)
(save-excursion
(set-buffer nnmbox-mbox-buffer)
(let ((delim (concat "^" rmail-unix-mail-delimiter))
start end)
(set-buffer (setq nnmbox-mbox-buffer
- (find-file-noselect nnmbox-mbox-file)))
+ (nnheader-find-file-noselect
+ nnmbox-mbox-file nil 'raw)))
(buffer-disable-undo (current-buffer))
(goto-char (point-min))
(while (re-search-forward delim nil t)
(nnmbox-save-mail))))
(goto-char end))))))
-(defun nnmbox-get-new-mail ()
- (let (incoming)
- (nnmbox-read-mbox)
- (if (and nnmail-spool-file nnmbox-get-new-mail
- (file-exists-p nnmail-spool-file)
- (> (nth 7 (file-attributes nnmail-spool-file)) 0))
- (progn
- (and gnus-verbose-backends
- (message "nnmbox: Reading incoming mail..."))
- (setq incoming
- (nnmail-move-inbox nnmail-spool-file
- (concat nnmbox-mbox-file "-Incoming")))
- (save-excursion
- (let ((in-buf (nnmail-split-incoming
- incoming 'nnmbox-save-mail t)))
- (set-buffer nnmbox-mbox-buffer)
- (goto-char (point-max))
- (insert-buffer-substring in-buf)
- (kill-buffer in-buf)))
- (run-hooks 'nnmail-read-incoming-hook)
- (and gnus-verbose-backends
- (message "nnmbox: Reading incoming mail...done"))))
- (and (buffer-modified-p nnmbox-mbox-buffer)
- (save-excursion
- (nnmail-save-active nnmbox-group-alist nnmbox-active-file)
- (set-buffer nnmbox-mbox-buffer)
- (save-buffer)))
-; (if incoming
-; (delete-file incoming))
- ))
-
(provide 'nnmbox)
;;; nnmbox.el ends here