Revision: miles@gnu.org--gnu-2005/gnus--devo--0--patch-182
[gnus] / lisp / nnspool.el
index 75ef4eb..d03d04b 100644 (file)
@@ -1,8 +1,10 @@
 ;;; nnspool.el --- spool access for GNU Emacs
-;; Copyright (C) 1988,89,90,93,94,95 Free Software Foundation, Inc.
+
+;; Copyright (C) 1988, 1989, 1990, 1993, 1994, 1995, 1996, 1997, 1998,
+;;   2000, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
 
 ;; Author: Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
-;;     Lars Magne Ingebrigtsen <larsi@ifi.uio.no>
+;;     Lars Magne Ingebrigtsen <larsi@gnus.org>
 ;; Keywords: news
 
 ;; This file is part of GNU Emacs.
@@ -18,8 +20,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., 51 Franklin Street, Fifth Floor,
+;; Boston, MA 02110-1301, USA.
 
 ;;; Commentary:
 
 
 (require 'nnheader)
 (require 'nntp)
-(require 'timezone)
+(require 'nnoo)
+(eval-when-compile (require 'cl))
+
+(nnoo-declare nnspool)
 
-(defvar nnspool-inews-program news-inews-program
+(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 news-path
+(defvoo nnspool-spool-directory
+    (file-name-as-directory (if (boundp 'news-directory)
+                               (symbol-value 'news-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
+    (if (file-exists-p "/usr/lib/news/active")
+       "/usr/lib/news/"
+      "/var/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
-  "The number of the articles which indicates a large newsgroup.
-If the number of the articles is greater than the value, verbose
+(defvoo nnspool-large-newsgroup 50
+  "The number of articles which indicates a large newsgroup.
+If the number of 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,262 +86,261 @@ messages will be shown to indicate the current status.")
 If nil, nnspool will load the entire file into a buffer and process it
 there.")
 
+(defvoo nnspool-rejected-article-hook nil
+  "*A hook that will be run when an article has been rejected by the server.")
+
+(defvoo nnspool-file-coding-system nnheader-file-coding-system
+  "Coding system for nnspool.")
+
 \f
 
 (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 (sequence &optional newsgroup server)
-  "Retrieve the headers for the articles in SEQUENCE.
-Newsgroup must be selected before calling this function."
+(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)
     (erase-buffer)
-    (let* ((number (length sequence))
-          (count 0)
-          (do-message (and (numberp nnspool-large-newsgroup)
-                           (> number nnspool-large-newsgroup)))
-          file beg article)
-      (if (not (nnspool-possibly-change-directory newsgroup))
-         ()
-       (if (and (numberp (car sequence))
-                (nnspool-retrieve-headers-with-nov sequence))
+    (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)))
+            (nnheader-file-coding-system nnspool-file-coding-system)
+            file beg article ag)
+       (if (and (numberp (car articles))
+                (nnspool-retrieve-headers-with-nov articles fetch-old))
+           ;; We successfully retrieved the NOV headers.
            'nov
-         (while sequence
-           (setq article (car sequence))
+         ;; No NOV headers here, so we do it the hard way.
+         (while (setq article (pop articles))
            (if (stringp article)
-               (progn
-                 (setq file (nnspool-find-article-by-message-id article))
-                 (setq article 0))
-             (setq file (concat nnspool-current-directory 
-                                (int-to-string article))))
-           (and file (file-exists-p file)
-                (progn
-                  (insert (format "221 %d Article retrieved.\n" article))
-                  (setq beg (point))
-                  (nnheader-insert-head file)
-                  (goto-char beg)
-                  (search-forward "\n\n" nil t)
-                  (forward-char -1)
-                  (insert ".\n")
-                  (delete-region (point) (point-max))))
-           (setq sequence (cdr sequence))
-           
-           (and do-message
-                (zerop (% (setq count (1+ count)) 20))
-                (message "NNSPOOL: Receiving headers... %d%%"
-                         (/ (* count 100) number))))
-         
-         (and do-message (message "NNSPOOL: Receiving headers...done"))
-         
-         ;; Fold continuation lines.
-         (goto-char (point-min))
-         (while (re-search-forward "\\(\r?\n[ \t]+\\)+" nil t)
-           (replace-match " " t t))
-         '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)))
+               ;; This is a Message-ID.
+               (setq ag (nnspool-find-id article)
+                     file (and ag (nnspool-article-pathname
+                                   (car ag) (cdr ag)))
+                     article (cdr ag))
+             ;; This is an article in the current group.
+             (setq file (int-to-string article)))
+           ;; Insert the head of the article.
+           (when (and file
+                      (file-exists-p file))
+             (insert "221 ")
+             (princ article (current-buffer))
+             (insert " Article retrieved.\n")
+             (setq beg (point))
+             (inline (nnheader-insert-head file))
+             (goto-char beg)
+             (if (search-forward "\n\n" nil t)
+                 (progn
+                   (forward-char -1)
+                   (insert ".\n"))
+               (goto-char (point-max))
+               (if (bolp)
+                   (insert ".\n")
+                 (insert "\n.\n")))
+             (delete-region (point) (point-max)))
 
-(defun nnspool-close-server (&optional server)
-  t)
+           (and do-message
+                (zerop (% (incf count) 20))
+                (nnheader-message 5 "nnspool: Receiving headers... %d%%"
+                                  (/ (* count 100) number))))
 
-(defun nnspool-server-opened (&optional server)
-  (and (equal server nnspool-current-server)
-       nntp-server-buffer
-       (buffer-name nntp-server-buffer)))
+         (when do-message
+           (nnheader-message 5 "nnspool: Receiving headers...done"))
 
-(defun nnspool-status-message (&optional server)
-  "Return server status response as string."
-  nnspool-status-string)
+         ;; Fold continuation lines.
+         (nnheader-fold-continuation-lines)
+         'headers)))))
 
-(defun nnspool-request-article (id &optional newsgroup 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 newsgroup)
-  (let ((file (if (stringp id)
-                 (nnspool-find-article-by-message-id id)
-               (concat nnspool-current-directory (prin1-to-string id))))
-       (nntp-server-buffer (or buffer nntp-server-buffer)))
-    (if (and (stringp file)
-            (file-exists-p file)
-            (not (file-directory-p file)))
-       (save-excursion
-         (nnspool-find-file file)))))
-
-(defun nnspool-request-body (id &optional newsgroup server)
+  (nnspool-possibly-change-directory group)
+  (let ((nntp-server-buffer (or buffer nntp-server-buffer))
+       file ag)
+    (if (stringp id)
+       ;; This is a Message-ID.
+       (when (setq ag (nnspool-find-id id))
+         (setq file (nnspool-article-pathname (car ag) (cdr ag))))
+      (setq file (nnspool-article-pathname nnspool-current-group id)))
+    (and file
+        (file-exists-p file)
+        (not (file-directory-p file))
+        (save-excursion (nnspool-find-file file))
+        ;; We return the article number and group name.
+        (if (numberp id)
+            (cons nnspool-current-group id)
+          ag))))
+
+(deffoo nnspool-request-body (id &optional group server)
   "Select article body by message ID (or number)."
-  (nnspool-possibly-change-directory newsgroup)
-  (if (nnspool-request-article id)
+  (nnspool-possibly-change-directory group)
+  (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 newsgroup server)
+(deffoo nnspool-request-head (id &optional group server)
   "Select article head by message ID (or number)."
-  (nnspool-possibly-change-directory newsgroup)
-  (if (nnspool-request-article id)
+  (nnspool-possibly-change-directory group)
+  (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 (1- (point)) (point-max)))
-       t)))
+       (when (search-forward "\n\n" nil t)
+         (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
-                  (nnspool-replace-chars-in-string group ?. ?/)))
+  (let ((pathname (nnspool-article-pathname group))
        dir)
     (if (not (file-directory-p pathname))
-       (progn
-         (setq nnspool-status-string
-               "Invalid group name (no such directory)")
-         nil)
+       (nnheader-report
+        'nnspool "Invalid group name (no such directory): %s" group)
       (setq nnspool-current-directory pathname)
-      (setq nnspool-status-string "")
-      (if (not dont-check)
+      (nnheader-report 'nnspool "Selected group %s" group)
+      (if dont-check
          (progn
-           (setq dir (directory-files pathname nil "^[0-9]+$" t))
-           ;; yes, completely empty spool directories *are* possible
-           ;; Fix by Sudish Joseph <joseph@cis.ohio-state.edu>
-           (and dir
-                (setq dir
-                      (sort 
-                       (mapcar
-                        (function
-                         (lambda (name)
-                           (string-to-int name)))
-                        dir)
-                       '<)))
-           (save-excursion
-             (set-buffer nntp-server-buffer)
-             (erase-buffer)
-             (if dir
-                 (insert
-                  (format "211 %d %d %d %s\n" (length dir) (car dir)
-                          (progn (while (cdr dir) (setq dir (cdr dir)))
-                                 (car dir))
-                          group))
-               (insert (format "211 0 0 0 %s\n" group))))))
-      t)))
-
-(defun nnspool-close-group (group &optional server)
+           (nnheader-report 'nnspool "Selected group %s" group)
+           t)
+       ;; 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 'string-to-number dir) '<)))
+       (if dir
+           (nnheader-insert
+            "211 %d %d %d %s\n" (length dir) (car dir)
+            (car (last 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)
+
+(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
        ;; Find the last valid line.
        (goto-char (point-max))
-       (while (and (not (looking-at 
+       (while (and (not (looking-at
                          "\\([^ ]+\\) +\\([0-9]+\\)[0-9][0-9][0-9] "))
                    (zerop (forward-line -1))))
-       (let ((seconds (nnspool-seconds-since-epoch date))
+       (let ((seconds (time-to-seconds (date-to-time date)))
              groups)
          ;; Go through lines and add the latest groups to a list.
          (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
-                       ;; too big to be stored in a lisp integer. 
+                       ;; 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")
                        (> (progn
                             (goto-char (match-end 1))
                             (read (current-buffer)))
                           seconds))
-                     (setq groups (cons (buffer-substring
-                                         (match-beginning 1) (match-end 1))
-                                        groups))
+                     (push (buffer-substring
+                            (match-beginning 1) (match-end 1))
+                           groups)
                      (zerop (forward-line -1))))
          (erase-buffer)
-         (while groups
-           (insert (car groups) " 0 0 y\n")
-