2001-08-19 Simon Josefsson <jas@extundo.com>
[gnus] / lisp / nnbabyl.el
index 2df3070..2d41d4c 100644 (file)
@@ -1,7 +1,9 @@
 ;;; nnbabyl.el --- rmail mbox access for Gnus
-;; Copyright (C) 1995 Free Software Foundation, Inc.
 
-;; Author: Lars Magne Ingebrigtsen <larsi@ifi.uio.no>
+;; Copyright (C) 1995, 1996, 1997, 1998, 1099, 2000
+;;     Free Software Foundation, Inc.
+
+;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
 ;;     Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
 ;; Keywords: news, mail
 
 ;; 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.  
+;; Gnus sources.
 
 ;;; Code:
 
 (require 'nnheader)
-(require 'rmail)
+(condition-case nil
+    (require 'rmail)
+  (t (nnheader-message
+      5 "Ignore rmail errors from this file, you don't have rmail")))
 (require 'nnmail)
+(require 'nnoo)
+(eval-when-compile (require 'cl))
+
+(nnoo-declare nnbabyl)
+
+(defvoo nnbabyl-mbox-file (expand-file-name "~/RMAIL")
+  "The name of the rmail box file in the users home directory.
+
+This variable is a virtual server slot.  See the Gnus manual for details.")
+
+(defvoo nnbabyl-active-file (expand-file-name "~/.rmail-active")
+  "The name of the active file for the rmail box.
+
+This variable is a virtual server slot.  See the Gnus manual for details.")
+
+(defvoo nnbabyl-get-new-mail t
+  "If non-nil, nnbabyl will check the incoming mail file and split the mail.
 
-(defvar nnbabyl-mbox-file (expand-file-name "~/RMAIL")
-  "The name of the rmail box file in the users home directory.")
+This variable is a virtual server slot.  See the Gnus manual for details.")
 
-(defvar nnbabyl-active-file (expand-file-name "~/.rmail-active")
-  "The name of the active file for the rmail box.")
 
-(defvar nnbabyl-get-new-mail t
-  "If non-nil, nnbabyl will check the incoming mail file and split the mail.")
+(defvoo nnbabyl-prepare-save-mail-hook nil
+  "Hook run narrowed to an article before saving.
 
-(defvar nnbabyl-prepare-save-mail-hook nil
-  "Hook run narrowed to an article before saving.")
+This variable is a virtual server slot.  See the Gnus manual for details.")
 
 \f
 
 (defconst nnbabyl-version "nnbabyl 1.0"
   "nnbabyl version.")
 
-(defvar nnbabyl-mbox-buffer nil)
-(defvar nnbabyl-current-group nil)
-(defvar nnbabyl-status-string "")
-(defvar nnbabyl-group-alist nil)
-(defvar nnbabyl-active-timestamp nil)
+(defvoo nnbabyl-mbox-buffer nil)
+(defvoo nnbabyl-current-group nil)
+(defvoo nnbabyl-status-string "")
+(defvoo nnbabyl-group-alist nil)
+(defvoo nnbabyl-active-timestamp nil)
 
-(defvar nnbabyl-previous-buffer-mode nil)
+(defvoo nnbabyl-previous-buffer-mode nil)
 
-\f
-
-(defvar nnbabyl-current-server nil)
-(defvar nnbabyl-server-alist nil)
-(defvar nnbabyl-server-variables 
-  (list
-   (list 'nnbabyl-mbox-file nnbabyl-mbox-file)
-   (list 'nnbabyl-active-file nnbabyl-active-file)
-   (list 'nnbabyl-get-new-mail nnbabyl-get-new-mail)
-   '(nnbabyl-current-group nil)
-   '(nnbabyl-status-string "")
-   '(nnbabyl-previous-buffer-mode nil)
-   '(nnbabyl-group-alist nil)))
+(eval-and-compile
+  (autoload 'gnus-set-text-properties "gnus-ems"))
 
 \f
 
 ;;; Interface functions
 
-(defun nnbabyl-retrieve-headers (sequence &optional newsgroup server fetch-old)
+(nnoo-define-basics nnbabyl)
+
+(deffoo nnbabyl-retrieve-headers (articles &optional group server fetch-old)
   (save-excursion
     (set-buffer nntp-server-buffer)
     (erase-buffer)
-    (let ((number (length sequence))
+    (let ((number (length articles))
          (count 0)
+         (delim (concat "^" nnbabyl-mail-delimiter))
          article art-string start stop)
-      (nnbabyl-possibly-change-newsgroup newsgroup)
-      (while sequence
-       (setq article (car sequence))
+      (nnbabyl-possibly-change-newsgroup group server)
+      (while (setq article (pop articles))
        (setq art-string (nnbabyl-article-string article))
        (set-buffer nnbabyl-mbox-buffer)
-       (if (or (search-forward art-string nil t)
-               (search-backward art-string nil t))
-           (progn
-             (re-search-backward (concat "^" nnbabyl-mail-delimiter) nil t)
-             (while (and (not (looking-at ".+:"))
-                         (zerop (forward-line 1))))
-             (setq start (point))
-             (search-forward "\n\n" nil t)
-             (setq stop (1- (point)))
-             (set-buffer nntp-server-buffer)
-             (insert "221 " (int-to-string article) " Article retrieved.\n")
-             (insert-buffer-substring nnbabyl-mbox-buffer start stop)
-             (goto-char (point-max))
-             (insert ".\n")))
-       (setq sequence (cdr sequence))
-       (setq count (1+ count))
+       (end-of-line)
+       (when (or (search-forward art-string nil t)
+                 (search-backward art-string nil t))
+         (unless (re-search-backward delim nil t)
+           (goto-char (point-min)))
+         (while (and (not (looking-at ".+:"))
+                     (zerop (forward-line 1))))
+         (setq start (point))
+         (search-forward "\n\n" nil t)
+         (setq stop (1- (point)))
+         (set-buffer nntp-server-buffer)
+         (insert "221 ")
+         (princ article (current-buffer))
+         (insert " Article retrieved.\n")
+         (insert-buffer-substring nnbabyl-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 "nnbabyl: Receiving headers... %d%%"
-                     (/ (* count 100) number))))
+            (zerop (% (incf count) 20))
+            (nnheader-message 5 "nnbabyl: Receiving headers... %d%%"
+                              (/ (* count 100) number))))
 
       (and (numberp nnmail-large-newsgroup)
           (> number nnmail-large-newsgroup)
-          gnus-verbose-backends
-          (message "nnbabyl: Receiving headers...done"))
+          (nnheader-message 5 "nnbabyl: Receiving headers...done"))
 
-      ;; Fold continuation lines.
       (set-buffer nntp-server-buffer)
-      (goto-char (point-min))
-      (while (re-search-forward "\\(\r?\n[ \t]+\\)+" nil t)
-       (replace-match " " t t))
+      (nnheader-fold-continuation-lines)
       'headers)))
 
-(defun nnbabyl-open-server (server &optional defs)
-  (nnheader-init-server-buffer)
-  (if (equal server nnbabyl-current-server)
-      t
-    (if nnbabyl-current-server
-       (setq nnbabyl-server-alist 
-             (cons (list nnbabyl-current-server
-                         (nnheader-save-variables nnbabyl-server-variables))
-                   nnbabyl-server-alist)))
-    (let ((state (assoc server nnbabyl-server-alist)))
-      (if state 
-         (progn
-           (nnheader-restore-variables (nth 1 state))
-           (setq nnbabyl-server-alist (delq state nnbabyl-server-alist)))
-       (nnheader-set-init-variables nnbabyl-server-variables defs)))
-    (setq nnbabyl-current-server server)))
-
-(defun nnbabyl-close-server (&optional server)
+(deffoo nnbabyl-open-server (server &optional defs)
+  (nnoo-change-server 'nnbabyl server defs)
+  (nnbabyl-create-mbox)
+  (cond
+   ((not (file-exists-p nnbabyl-mbox-file))
+    (nnbabyl-close-server)
+    (nnheader-report 'nnbabyl "No such file: %s" nnbabyl-mbox-file))
+   ((file-directory-p nnbabyl-mbox-file)
+    (nnbabyl-close-server)
+    (nnheader-report 'nnbabyl "Not a regular file: %s" nnbabyl-mbox-file))
+   (t
+    (nnheader-report 'nnbabyl "Opened server %s using mbox %s" server
+                    nnbabyl-mbox-file)
+    t)))
+
+(deffoo nnbabyl-close-server (&optional server)
   ;; Restore buffer mode.
   (when (and (nnbabyl-server-opened)
             nnbabyl-previous-buffer-mode)
     (save-excursion
       (set-buffer nnbabyl-mbox-buffer)
       (narrow-to-region
-       (car (car nnbabyl-previous-buffer-mode))
-       (cdr (car nnbabyl-previous-buffer-mode)))
+       (caar nnbabyl-previous-buffer-mode)
+       (cdar nnbabyl-previous-buffer-mode))
       (funcall (cdr nnbabyl-previous-buffer-mode))))
-  (setq nnbabyl-current-server nil
-       nnbabyl-mbox-buffer nil)
+  (nnoo-close-server 'nnbabyl server)
+  (setq nnbabyl-mbox-buffer nil)
   t)
 
-(defun nnbabyl-server-opened (&optional server)
-  (and (equal server nnbabyl-current-server)
+(deffoo nnbabyl-server-opened (&optional server)
+  (and (nnoo-current-server-p 'nnbabyl server)
        nnbabyl-mbox-buffer
        (buffer-name nnbabyl-mbox-buffer)
        nntp-server-buffer
        (buffer-name nntp-server-buffer)))
 
-(defun nnbabyl-status-message (&optional server)
-  nnbabyl-status-string)
-
-(defun nnbabyl-request-article (article &optional newsgroup server buffer)
-  (nnbabyl-possibly-change-newsgroup newsgroup)
+(deffoo nnbabyl-request-article (article &optional newsgroup server buffer)
+  (nnbabyl-possibly-change-newsgroup newsgroup server)
   (save-excursion
     (set-buffer nnbabyl-mbox-buffer)
     (goto-char (point-min))
-    (if (search-forward (nnbabyl-article-string article) nil t)
-       (let (start stop summary-line)
-         (re-search-backward (concat "^" nnbabyl-mail-delimiter) nil t)
-         (while (and (not (looking-at ".+:"))
-                     (zerop (forward-line 1))))
-         (setq start (point))
-         (or (and (re-search-forward 
-                   (concat "^" nnbabyl-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 nnbabyl-mbox-buffer start stop)
-           (goto-char (point-min))
-           ;; If there is an EOOH header, then we have to remove some
-           ;; duplicated headers. 
-           (setq summary-line (looking-at "Summary-line:"))
-           (when (search-forward "\n*** EOOH ***" nil t)
-             (if summary-line
-                 ;; The headers to be deleted are located before the
-                 ;; EOOH line...
-                 (delete-region (point-min) (progn (forward-line 1)
-                 (point)))
-               ;; ...or after.
-               (delete-region (progn (beginning-of-line) (point))
-                              (or (search-forward "\n\n" nil t)
-                                  (point)))))
-           (if (numberp article) 
-               (cons nnbabyl-current-group article)
-             (nnbabyl-article-group-number)))))))
-
-(defun nnbabyl-request-group (group &optional server dont-check)
-  (save-excursion
-    (if (nnbabyl-possibly-change-newsgroup group)
-       (if dont-check
-           t
-         (save-excursion
-           (set-buffer nntp-server-buffer)
-           (erase-buffer)
-           (let ((active (assoc group nnbabyl-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)))))
-
-(defun nnbabyl-request-scan (&optional group server)
+    (when (search-forward (nnbabyl-article-string article) nil t)
+      (let (start stop summary-line)
+       (unless (re-search-backward (concat "^" nnbabyl-mail-delimiter) nil t)
+         (goto-char (point-min))
+         (end-of-line))
+       (while (and (not (looking-at ".+:"))
+                   (zerop (forward-line 1))))
+       (setq start (point))
+       (or (when (re-search-forward
+                  (concat "^" nnbabyl-mail-delimiter) nil t)
+             (beginning-of-line)
+             t)
+           (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 nnbabyl-mbox-buffer start stop)
+         (goto-char (point-min))
+         ;; If there is an EOOH header, then we have to remove some
+         ;; duplicated headers.
+         (setq summary-line (looking-at "Summary-line:"))
+         (when (search-forward "\n*** EOOH ***" nil t)
+           (if summary-line
+               ;; The headers to be deleted are located before the
+               ;; EOOH line...
+               (delete-region (point-min) (progn (forward-line 1)
+                                                 (point)))
+             ;; ...or after.
+             (delete-region (progn (beginning-of-line) (point))
+                            (or (search-forward "\n\n" nil t)
+                                (point)))))
+         (if (numberp article)
+             (cons nnbabyl-current-group article)
+           (nnbabyl-article-group-number)))))))
+
+(deffoo nnbabyl-request-group (group &optional server dont-check)
+  (let ((active (cadr (assoc group nnbabyl-group-alist))))
+    (save-excursion
+      (cond
+       ((or (null active)
+           (null (nnbabyl-possibly-change-newsgroup group server)))
+       (nnheader-report 'nnbabyl "No such group: %s" group))
+       (dont-check
+       (nnheader-report 'nnbabyl "Selected group %s" group)
+       (nnheader-insert ""))
+       (t
+       (nnheader-report 'nnbabyl "Selected group %s" group)
+       (nnheader-insert "211 %d %d %d %s\n"
+                        (1+ (- (cdr active) (car active)))
+                        (car active) (cdr active) group))))))
+
+(deffoo nnbabyl-request-scan (&optional group server)
+  (nnbabyl-possibly-change-newsgroup group server)
   (nnbabyl-read-mbox)
-  (nnmail-get-new-mail 
-   'nnbabyl 
+  (nnmail-get-new-mail
+   'nnbabyl
    (lambda ()
      (save-excursion
        (set-buffer nnbabyl-mbox-buffer)
        (save-buffer)))
-   nnbabyl-mbox-file group
+   (file-name-directory nnbabyl-mbox-file)
+   group
    (lambda ()
      (save-excursion
        (let ((in-buf (current-buffer)))
         (goto-char (point-max))
         (search-backward "\n\^_" nil t)
         (goto-char (match-end 0))
-        (insert-buffer-substring in-buf))))))
+        (insert-buffer-substring in-buf)))
+     (nnmail-save-active nnbabyl-group-alist nnbabyl-active-file))))
 
-(defun nnbabyl-close-group (group &optional server)
+(deffoo nnbabyl-close-group (group &optional server)
   t)
 
-(defun nnbabyl-request-create-group (group &optional server) 
+(deffoo nnbabyl-request-create-group (group &optional server args)
   (nnmail-activate 'nnbabyl)
-  (or (assoc group nnbabyl-group-alist)
-      (let (active)
-       (setq nnbabyl-group-alist (cons (list group (setq active (cons 1 0)))
-                                       nnbabyl-group-alist))
-       (nnmail-save-active nnbabyl-group-alist nnbabyl-active-file)))
+  (unless (assoc group nnbabyl-group-alist)
+    (push (list group (cons 1 0))
+         nnbabyl-group-alist)
+    (nnmail-save-active nnbabyl-group-alist nnbabyl-active-file))
   t)
 
-(defun nnbabyl-request-list (&optional server)
+(deffoo nnbabyl-request-list (&optional server)
   (save-excursion
-    (or (nnmail-find-file nnbabyl-active-file)
-       (progn
-         (setq nnbabyl-group-alist (nnmail-get-active))
-         (nnmail-save-active nnbabyl-group-alist nnbabyl-active-file)
-         (nnmail-find-file nnbabyl-active-file)))))
+    (nnmail-find-file nnbabyl-active-file)
+    (setq nnbabyl-group-alist (nnmail-get-active))
+    t))
 
-(defun nnbabyl-request-newgroups (date &optional server)
+(deffoo nnbabyl-request-newgroups (date &optional server)
   (nnbabyl-request-list server))
 
-(defun nnbabyl-request-list-newsgroups (&optional server)
-  (setq nnbabyl-status-string "nnbabyl: LIST NEWSGROUPS is not implemented.")
-  nil)
+(deffoo nnbabyl-request-list-newsgroups (&optional server)
+  (nnheader-report 'nnbabyl "nnbabyl: LIST NEWSGROUPS is not implemented."))
 
-(defun nnbabyl-request-post (&optional server)
-  (mail-send-and-exit nil))
-
-(defun nnbabyl-request-expire-articles
-  (articles newsgroup &optional server force)
-  (nnbabyl-possibly-change-newsgroup newsgroup)
-  (let* ((days (or (and nnmail-expiry-wait-function
-                       (funcall nnmail-expiry-wait-function newsgroup))
-                  nnmail-expiry-wait))
-        (is-old t)
+(deffoo nnbabyl-request-expire-articles
+    (articles newsgroup &optional server force)
+  (nnbabyl-possibly-change-newsgroup newsgroup server)
+  (let* ((is-old t)
         rest)
     (nnmail-activate 'nnbabyl)
 
-    (save-excursion 
+    (save-excursion
       (set-buffer nnbabyl-mbox-buffer)
-      (set-text-properties (point-min) (point-max) nil)
+      (gnus-set-text-properties (point-min) (point-max) nil)
       (while (and articles is-old)
        (goto-char (point-min))
-       (if (search-forward (nnbabyl-article-string (car articles)) nil t)
-           (if (or force
-                   (setq is-old
-                         (> (nnmail-days-between 
-                             (current-time-string)
-                             (buffer-substring 
-                              (point) (progn (end-of-line) (point))))
-                            days)))
-               (progn
-                 (and gnus-verbose-backends
-                      (message "Deleting article %d in %s..." 
-                               (car articles) newsgroup))
-                 (nnbabyl-delete-mail))
-             (setq rest (cons (car articles) rest))))
+       (when (search-forward (nnbabyl-article-string (car articles)) nil t)
+         (if (setq is-old
+                   (nnmail-expired-article-p
+                    newsgroup
+                    (buffer-substring
+                     (point) (progn (end-of-line) (point))) force))
+             (progn
+               (unless (eq nnmail-expiry-target 'delete)
+                 (with-temp-buffer
+                   (nnbabyl-request-article (car articles)
+                                            newsgroup server
+                                            (current-buffer))
+                   (let ((nnml-current-directory nil))
+                     (nnmail-expiry-target-group
+                      nnmail-expiry-target newsgroup))))
+               (nnheader-message 5 "Deleting article %d in %s..."
+                                 (car articles) newsgroup)
+               (nnbabyl-delete-mail))
+           (push (car articles) rest)))
        (setq articles (cdr articles)))
       (save-buffer)
       ;; Find the lowest active article in this group.
       (nnmail-save-active nnbabyl-group-alist nnbabyl-active-file)
       (nconc rest articles))))
 
-(defun nnbabyl-request-move-article 
-  (article group server accept-form &optional last)
-  (nnbabyl-possibly-change-newsgroup group)
+(deffoo nnbabyl-request-move-article
+    (article group server accept-form &optional last)
   (let ((buf (get-buffer-create " *nnbabyl move*"))
        result)
-    (and 
+    (and
      (nnbabyl-request-article article group server)
      (save-excursion
        (set-buffer buf)
        (insert-buffer-substring nntp-server-buffer)
        (goto-char (point-min))
-       (if (re-search-forward 
-           "^X-Gnus-Newsgroup:" 
-           (save-excursion (search-forward "\n\n" nil t) (point)) t)
-          (delete-region (progn (beginning-of-line) (point))
-                         (progn (forward-line 1) (point))))
+       (while (re-search-forward
+              "^X-Gnus-Newsgroup:"
+