*** empty log message ***
[gnus] / lisp / nnspool.el
index 5fe6a30..50ad88a 100644 (file)
@@ -1,5 +1,5 @@
 ;;; nnspool.el --- spool access for GNU Emacs
-;; Copyright (C) 1988,89,90,93,94,95,96 Free Software Foundation, Inc.
+;; Copyright (C) 1988,89,90,93,94,95,96,97 Free Software Foundation, Inc.
 
 ;; Author: Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
 ;;     Lars Magne Ingebrigtsen <larsi@ifi.uio.no>
@@ -18,8 +18,9 @@
 ;; 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:
 
 (require 'nnheader)
 (require 'nntp)
 (require 'timezone)
+(require 'nnoo)
+(eval-when-compile (require 'cl))
 
-(defvar nnspool-inews-program news-inews-program
+(nnoo-declare nnspool)
+
+(defvoo nnspool-inews-program news-inews-program
   "Program to post news.
 This is most commonly `inews' or `injnews'.")
 
-(defvar nnspool-inews-switches '("-h")
+(defvoo nnspool-inews-switches '("-h" "-S")
   "Switches for nnspool-request-post to pass to `inews' for posting news.
 If you are using Cnews, you probably should set this variable to nil.")
 
-(defvar nnspool-spool-directory (file-name-as-directory news-path)
+(defvoo nnspool-spool-directory (file-name-as-directory news-path)
   "Local news spool directory.")
 
-(defvar nnspool-nov-directory (concat nnspool-spool-directory "over.view/")
+(defvoo nnspool-nov-directory (concat nnspool-spool-directory "over.view/")
   "Local news nov directory.")
 
-(defvar nnspool-lib-dir "/usr/lib/news/"
+(defvoo nnspool-lib-dir "/usr/lib/news/"
   "Where the local news library files are stored.")
 
-(defvar nnspool-active-file (concat nnspool-lib-dir "active")
+(defvoo nnspool-active-file (concat nnspool-lib-dir "active")
   "Local news active file.")
 
-(defvar nnspool-newsgroups-file (concat nnspool-lib-dir "newsgroups")
+(defvoo nnspool-newsgroups-file (concat nnspool-lib-dir "newsgroups")
   "Local news newsgroups file.")
 
-(defvar nnspool-distributions-file (concat nnspool-lib-dir "distributions")
+(defvoo nnspool-distributions-file (concat nnspool-lib-dir "distribs.pat")
   "Local news distributions file.")
 
-(defvar nnspool-history-file (concat nnspool-lib-dir "history")
+(defvoo nnspool-history-file (concat nnspool-lib-dir "history")
   "Local news history file.")
 
-(defvar nnspool-active-times-file (concat nnspool-lib-dir "active.times")
+(defvoo nnspool-active-times-file (concat nnspool-lib-dir "active.times")
   "Local news active date file.")
 
-(defvar nnspool-large-newsgroup 50
+(defvoo nnspool-large-newsgroup 50
   "The number of the articles which indicates a large newsgroup.
 If the number of the articles is greater than the value, verbose
 messages will be shown to indicate the current status.")
 
-(defvar nnspool-nov-is-evil nil
+(defvoo nnspool-nov-is-evil nil
   "Non-nil means that nnspool will never return NOV lines instead of headers.")
 
 (defconst nnspool-sift-nov-with-sed nil
@@ -74,7 +79,7 @@ messages will be shown to indicate the current status.")
 If nil, nnspool will load the entire file into a buffer and process it
 there.")
 
-(defvar nnspool-rejected-article-hook nil
+(defvoo nnspool-rejected-article-hook nil
   "*A hook that will be run when an article has been rejected by the server.")
 
 \f
@@ -82,39 +87,18 @@ there.")
 (defconst nnspool-version "nnspool 2.0"
   "Version numbers of this version of NNSPOOL.")
 
-(defvar nnspool-current-directory nil
+(defvoo nnspool-current-directory nil
   "Current news group directory.")
 
-(defvar nnspool-current-group nil)
-(defvar nnspool-status-string "")
-
-\f
-
-(defvar nnspool-current-server nil)
-(defvar nnspool-server-alist nil)
-(defvar nnspool-server-variables 
-  (list
-   (list 'nnspool-inews-program nnspool-inews-program)
-   (list 'nnspool-inews-switches nnspool-inews-switches)
-   (list 'nnspool-spool-directory nnspool-spool-directory)
-   (list 'nnspool-nov-directory nnspool-nov-directory)
-   (list 'nnspool-lib-dir nnspool-lib-dir)
-   (list 'nnspool-active-file nnspool-active-file)
-   (list 'nnspool-newsgroups-file nnspool-newsgroups-file)
-   (list 'nnspool-distributions-file nnspool-distributions-file)
-   (list 'nnspool-history-file nnspool-history-file)
-   (list 'nnspool-active-times-file nnspool-active-times-file)
-   (list 'nnspool-large-newsgroup nnspool-large-newsgroup)
-   (list 'nnspool-nov-is-evil nnspool-nov-is-evil)
-   (list 'nnspool-sift-nov-with-sed nnspool-sift-nov-with-sed)
-   '(nnspool-current-directory nil)
-   '(nnspool-current-group nil)
-   '(nnspool-status-string "")))
+(defvoo nnspool-current-group nil)
+(defvoo nnspool-status-string "")
 
 \f
 ;;; Interface functions.
 
-(defun nnspool-retrieve-headers (articles &optional group server fetch-old)
+(nnoo-define-basics nnspool)
+
+(deffoo nnspool-retrieve-headers (articles &optional group server fetch-old)
   "Retrieve the headers of ARTICLES."
   (save-excursion
     (set-buffer nntp-server-buffer)
@@ -122,6 +106,7 @@ there.")
     (when (nnspool-possibly-change-directory group)
       (let* ((number (length articles))
             (count 0)
+            (default-directory nnspool-current-directory)
             (do-message (and (numberp nnspool-large-newsgroup)
                              (> number nnspool-large-newsgroup)))
             file beg article ag)
@@ -130,8 +115,7 @@ there.")
            ;; We successfully retrieved the NOV headers.
            'nov
          ;; No NOV headers here, so we do it the hard way.
-         (while articles
-           (setq article (pop articles))
+         (while (setq article (pop articles))
            (if (stringp article)
                ;; This is a Message-ID.
                (setq ag (nnspool-find-id article)
@@ -139,14 +123,15 @@ there.")
                                    (car ag) (cdr ag)))
                      article (cdr ag))
              ;; This is an article in the current group.
-             (setq file (nnspool-article-pathname 
-                         nnspool-current-group article)))
+             (setq file (int-to-string article)))
            ;; Insert the head of the article.
            (when (and file
                       (file-exists-p file))
-             (insert (format "221 %d Article retrieved.\n" article))
+             (insert "221 ")
+             (princ article (current-buffer))
+             (insert " Article retrieved.\n")
              (setq beg (point))
-             (nnheader-insert-head file)
+             (inline (nnheader-insert-head file))
              (goto-char beg)
              (search-forward "\n\n" nil t)
              (forward-char -1)
@@ -158,44 +143,34 @@ there.")
                 (message "nnspool: Receiving headers... %d%%"
                          (/ (* count 100) number))))
          
-         (and do-message
-              (message "nnspool: Receiving headers...done"))
+         (when do-message
+           (message "nnspool: Receiving headers...done"))
          
          ;; Fold continuation lines.
          (nnheader-fold-continuation-lines)
          'headers)))))
 
-(defun nnspool-open-server (server &optional defs)
-  (nnheader-init-server-buffer)
-  (if (equal server nnspool-current-server)
-      t
-    (if nnspool-current-server
-       (setq nnspool-server-alist 
-             (cons (list nnspool-current-server
-                         (nnheader-save-variables nnspool-server-variables))
-                   nnspool-server-alist)))
-    (let ((state (assoc server nnspool-server-alist)))
-      (if state 
-         (progn
-           (nnheader-restore-variables (nth 1 state))
-           (setq nnspool-server-alist (delq state nnspool-server-alist)))
-       (nnheader-set-init-variables nnspool-server-variables defs)))
-    (setq nnspool-current-server server)))
-
-(defun nnspool-close-server (&optional server)
-  (setq nnspool-current-server nil)
-  t)
-
-(defun nnspool-server-opened (&optional server)
-  (and (equal server nnspool-current-server)
-       nntp-server-buffer
-       (buffer-name nntp-server-buffer)))
-
-(defun nnspool-status-message (&optional server)
-  "Return server status response as string."
-  nnspool-status-string)
-
-(defun nnspool-request-article (id &optional group server buffer)
+(deffoo nnspool-open-server (server &optional defs)
+  (nnoo-change-server 'nnspool server defs)
+  (cond 
+   ((not (file-exists-p nnspool-spool-directory))
+    (nnspool-close-server)
+    (nnheader-report 'nnspool "Spool directory doesn't exist: %s"
+                    nnspool-spool-directory))
+   ((not (file-directory-p
+         (directory-file-name
+          (file-truename nnspool-spool-directory))))
+    (nnspool-close-server)
+    (nnheader-report 'nnspool "Not a directory: %s" nnspool-spool-directory))
+   ((not (file-exists-p nnspool-active-file))
+    (nnheader-report 'nnspool "The active file doesn't exist: %s" 
+                    nnspool-active-file))
+   (t
+    (nnheader-report 'nnspool "Opened server %s using directory %s"
+                    server nnspool-spool-directory)
+    t)))
+
+(deffoo nnspool-request-article (id &optional group server buffer)
   "Select article by message ID (or number)."
   (nnspool-possibly-change-directory group)
   (let ((nntp-server-buffer (or buffer nntp-server-buffer))
@@ -214,18 +189,19 @@ there.")
             (cons nnspool-current-group id)
           ag))))
            
-(defun nnspool-request-body (id &optional group server)
+(deffoo nnspool-request-body (id &optional group server)
   "Select article body by message ID (or number)."
   (nnspool-possibly-change-directory group)
-  (if (nnspool-request-article id)
+  (let ((res (nnspool-request-article id)))
+    (when res
       (save-excursion
        (set-buffer nntp-server-buffer)
        (goto-char (point-min))
-       (if (search-forward "\n\n" nil t)
-           (delete-region (point-min) (point)))
-       t)))
+       (when (search-forward "\n\n" nil t)
+         (delete-region (point-min) (point)))
+       res))))
 
-(defun nnspool-request-head (id &optional group server)
+(deffoo nnspool-request-head (id &optional group server)
   "Select article head by message ID (or number)."
   (nnspool-possibly-change-directory group)
   (let ((res (nnspool-request-article id)))
@@ -234,10 +210,11 @@ there.")
        (set-buffer nntp-server-buffer)
        (goto-char (point-min))
        (when (search-forward "\n\n" nil t)
-         (delete-region (1- (point)) (point-max)))))
+         (delete-region (1- (point)) (point-max)))
+       (nnheader-fold-continuation-lines)))
     res))
 
-(defun nnspool-request-group (group &optional server dont-check)
+(deffoo nnspool-request-group (group &optional server dont-check)
   "Select news GROUP."
   (let ((pathname (nnspool-article-pathname group))
        dir)
@@ -250,49 +227,47 @@ there.")
          (progn
            (nnheader-report 'nnspool "Selected group %s" group)
            t)
-       ;; Yes, completely empty spool directories *are* possible
+       ;; Yes, completely empty spool directories *are* possible.
        ;; Fix by Sudish Joseph <joseph@cis.ohio-state.edu>
        (when (setq dir (directory-files pathname nil "^[0-9]+$" t))
          (setq dir 
                (sort (mapcar (lambda (name) (string-to-int name)) dir) '<)))
-       (save-excursion
-         (set-buffer nntp-server-buffer)
-         (erase-buffer)
-         (if dir
-             (progn
-               (insert
-                (format "211 %d %d %d %s\n" (length dir) (car dir)
-                        (progn (while (cdr dir) (setq dir (cdr dir)))
-                               (car dir))
-                        group))
-               t)
-           (insert (format "211 0 0 0 %s\n" group))
-           (nnheader-report 'nnspool "Empty group %s" group)
-           t))))))
-
-(defun nnspool-request-type (group &optional article)
+       (if dir
+           (nnheader-insert
+            "211 %d %d %d %s\n" (length dir) (car dir)
+            (progn (while (cdr dir) (setq dir (cdr dir))) (car dir))
+            group)
+         (nnheader-report 'nnspool "Empty group %s" group)
+         (nnheader-insert "211 0 0 0 %s\n" group))))))
+
+(deffoo nnspool-request-type (group &optional article)
   'news)
 
-(defun nnspool-close-group (group &optional server)
+(deffoo nnspool-close-group (group &optional server)
   t)
 
-(defun nnspool-request-list (&optional server)
+(deffoo nnspool-request-list (&optional server)
   "List active newsgroups."
   (save-excursion
-    (nnspool-find-file nnspool-active-file)))
+    (or (nnspool-find-file nnspool-active-file)
+       (nnheader-report 'nnspool (nnheader-file-error nnspool-active-file)))))
 
-(defun nnspool-request-list-newsgroups (&optional server)
+(deffoo nnspool-request-list-newsgroups (&optional server)
   "List newsgroups (defined in NNTP2)."
   (save-excursion
-    (nnspool-find-file nnspool-newsgroups-file)))
+    (or (nnspool-find-file nnspool-newsgroups-file)
+       (nnheader-report 'nnspool (nnheader-file-error 
+                                  nnspool-newsgroups-file)))))
 
-(defun nnspool-request-list-distributions (&optional server)
+(deffoo nnspool-request-list-distributions (&optional server)
   "List distributions (defined in NNTP2)."
   (save-excursion
-    (nnspool-find-file nnspool-distributions-file)))
+    (or (nnspool-find-file nnspool-distributions-file)
+       (nnheader-report 'nnspool (nnheader-file-error 
+                                  nnspool-distributions-file)))))
 
 ;; Suggested by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
-(defun nnspool-request-newgroups (date &optional server)
+(deffoo nnspool-request-newgroups (date &optional server)
   "List groups created after DATE."
   (if (nnspool-find-file nnspool-active-times-file)
       (save-excursion
@@ -307,7 +282,7 @@ there.")
          (while (and (looking-at "\\([^ ]+\\) +[0-9]+ ")
                      (progn
                        ;; We insert a .0 to make the list reader
-                       ;; interpret the number as a float. It is far
+                       ;; interpret the number as a float.  It is far
                        ;; too big to be stored in a lisp integer. 
                        (goto-char (1- (match-end 0)))
                        (insert ".0")
@@ -315,9 +290,9 @@ there.")
                             (goto-char (match-end 1))
                             (read (current-buffer)))
                           seconds))
-                     (setq groups (cons (buffer-substring
+                     (push (buffer-substring
                                          (match-beginning 1) (match-end 1))
-                                        groups))
+                                        groups)
                      (zerop (forward-line -1))))
          (erase-buffer)
          (while groups
@@ -326,7 +301,7 @@ there.")
        t)
     nil))
 
-(defun nnspool-request-post (&optional server)
+(deffoo nnspool-request-post (&optional server)
   "Post a new news in current buffer."
   (save-excursion
     (let* ((process-connection-type nil) ; t bugs out on Solaris
@@ -336,21 +311,23 @@ there.")
                (apply 'start-process "*nnspool inews*" inews-buffer
                       nnspool-inews-program nnspool-inews-switches)
              (error
-              (setq nnspool-status-string (format "inews error: %S" err))
-              nil))))
+              (nnheader-report 'nnspool "inews error: %S" err)))))
       (if (not proc)
          ;; The inews program failed.
          ()
-       (setq nnspool-status-string "")
+       (nnheader-report 'nnspool "")
        (set-process-sentinel proc 'nnspool-inews-sentinel)
        (process-send-region proc (point-min) (point-max))
        ;; We slap a condition-case around this, because the process may
        ;; have exited already...
-       (condition-case nil
-           (process-send-eof proc)
-         (error nil))
+       (ignore-errors
+         (process-send-eof proc))
        t))))
 
+
+\f
+;;; Internal functions.
+
 (defun nnspool-inews-sentinel (proc status)
   (save-excursion
     (set-buffer (process-buffer proc))
@@ -361,19 +338,18 @@ there.")
       ;; Make status message by folding lines.
       (while (re-search-forward "[ \t\n]+" nil t)
        (replace-match " " t t))
-      (setq nnspool-status-string (buffer-string))
+      (nnheader-report 'nnspool "%s" (buffer-string))
       (message "nnspool: %s" nnspool-status-string)
       (ding)
       (run-hooks 'nnspool-rejected-article-hook))))
 
-\f
-;;; Internal functions.
-
 (defun nnspool-retrieve-headers-with-nov (articles &optional fetch-old)
   (if (or gnus-nov-is-evil nnspool-nov-is-evil)
       nil
     (let ((nov (nnheader-group-pathname 
-               nnspool-current-group nnspool-nov-directory ".overview")))
+               nnspool-current-group nnspool-nov-directory ".overview"))
+         (arts articles)
+         last)
       (if (not (file-exists-p nov))
          ()
        (save-excursion
@@ -381,52 +357,49 @@ there.")
          (erase-buffer)
          (if nnspool-sift-nov-with-sed
              (nnspool-sift-nov-with-sed articles nov)
-           (insert-file-contents nov)
+           (nnheader-insert-file-contents nov)
            (if (and fetch-old
                     (not (numberp fetch-old)))
                t                       ; We want all the headers.
-             ;; First we find the first wanted line.
-             (nnspool-find-nov-line
-              (if fetch-old (max 1 (- (car articles) fetch-old))
-                (car articles)))
-             (delete-region (point-min) (point))
-             ;; Then we find the last wanted line. 
-             (if (nnspool-find-nov-line 
-                  (progn (while (cdr articles) (setq articles (cdr articles)))
-                         (car articles)))
-                 (forward-line 1))
-             (delete-region (point) (point-max))
-             ;; If the buffer is empty, this wasn't very successful.
-             (not (zerop (buffer-size))))))))))
-
-(defun nnspool-find-nov-line (article)
-  (let ((max (point-max))
-       (min (goto-char (point-min)))
-       (cur (current-buffer))
-       (prev (point-min))
-       num found)
-    (while (not found)
-      (goto-char (/ (+ max min) 2))
-      (beginning-of-line)
-      (if (or (= (point) prev)
-             (eobp))
-         (setq found t)
-       (setq prev (point))
-       (cond ((> (setq num (read cur)) article)
-              (setq max (point)))
-             ((< num article)
-              (setq min (point)))
-             (t
-              (setq found t)))))
-    (when (not (eq num article))
-      (setq found (point))
-      (forward-line 1)
-      (or (eobp)
-         (= (setq num (read cur)) article)
-         (goto-char found)))
-    (beginning-of-line)
-    (eq num article)))
-    
+             (ignore-errors
+               ;; Delete unwanted NOV lines.
+               (nnheader-nov-delete-outside-range
+                (if fetch-old (max 1 (- (car articles) fetch-old))
+                  (car articles))
+                (car (last articles)))
+               ;; If the buffer is empty, this wasn't very successful.
+               (unless (zerop (buffer-size))
+                 ;; We check what the last article number was.  
+                 ;; The NOV file may be out of sync with the articles
+                 ;; in the group.
+                 (forward-line -1)
+                 (setq last (read (current-buffer)))
+                 (if (= last (car articles))
+                     ;; Yup, it's all there.
+                     t
+                   ;; Perhaps not.  We try to find the missing articles.
+                   (while (and arts
+                               (<= last (car arts)))
+                     (pop arts))
+                   ;; The articles in `arts' are missing from the buffer.
+                   (while arts
+                     (nnspool-insert-nov-head (pop arts)))
+                   t))))))))))
+
+(defun nnspool-insert-nov-head (article)
+  "Read the head of ARTICLE, convert to NOV headers, and insert."
+  (save-excursion
+    (let ((cur (current-buffer))
+         buf)
+      (setq buf (nnheader-set-temp-buffer " *nnspool head*"))
+      (when (nnheader-insert-head
+            (nnspool-article-pathname nnspool-current-group article))
+       (nnheader-insert-article-line article)
+       (let ((headers (nnheader-parse-head)))
+         (set-buffer cur)
+         (goto-char (point-max))
+         (nnheader-insert-nov headers)))
+      (kill-buffer buf))))
 
 (defun nnspool-sift-nov-with-sed (articles file)
   (let ((first (car articles))
@@ -444,13 +417,12 @@ there.")
     (set-buffer (get-buffer-create " *nnspool work*"))
     (buffer-disable-undo (current-buffer))
     (erase-buffer)
-    (condition-case ()
-       (call-process "grep" nil t nil id nnspool-history-file)
-      (error nil))
+    (ignore-errors
+      (call-process "grep" nil t nil (regexp-quote id) nnspool-history-file))
     (goto-char (point-min))
     (prog1
-       (if (looking-at "<[^>]+>[ \t]+[-0-9~]+[ \t]+\\([^ /\t\n]+\\)/\\([0-9]+\\)[ \t\n]")
-           (cons (match-string 1) (string-to-int (match-string 2))))
+       (when (looking-at "<[^>]+>[ \t]+[-0-9~]+[ \t]+\\([^ /\t\n]+\\)/\\([0-9]+\\)[ \t\n]")
+         (cons (match-string 1) (string-to-int (match-string 2))))
       (kill-buffer (current-buffer)))))
 
 (defun nnspool-find-file (file)
@@ -458,20 +430,17 @@ there.")
   (set-buffer nntp-server-buffer)
   (erase-buffer)
   (condition-case ()
-      (progn (insert-file-contents file) t)
+      (progn (nnheader-insert-file-contents file) t)
     (file-error nil)))
 
 (defun nnspool-possibly-change-directory (group)
-  (if group
-      (let ((pathname (nnspool-article-pathname group)))
-       (if (file-directory-p pathname)
-           (progn
-             (setq nnspool-current-directory pathname)
-             (setq nnspool-current-group group))
-         (setq nnspool-status-string 
-               (format "No such newsgroup: %s" group))
-         nil))
-    t))
+  (if (not group)
+      t
+    (let ((pathname (nnspool-article-pathname group)))
+      (if (file-directory-p pathname)
+         (setq nnspool-current-directory pathname
+               nnspool-current-group group)
+       (nnheader-report 'nnspool "No such newsgroup: %s" group)))))
 
 (defun nnspool-article-pathname (group &optional article)
   "Find the path for GROUP."
@@ -484,10 +453,10 @@ there.")
                        (timezone-parse-time
                         (aref (timezone-parse-date date) 3))))
         (unix (encode-time (nth 2 ttime) (nth 1 ttime) (nth 0 ttime)
-                           (nth 2 tdate) (nth 1 tdate) (nth 0 tdate) 
+                           (nth 2 tdate) (nth 1 tdate) (nth 0 tdate)
                            (nth 4 tdate))))
     (+ (* (car unix) 65536.0)
-       (car (cdr unix)))))
+       (cadr unix))))
 
 (provide 'nnspool)