Remove nnml-retrieve-groups that is unnecessary and somewhat problematic
[gnus] / lisp / nnspool.el
index dbb56e0..f10b1ad 100644 (file)
@@ -1,16 +1,18 @@
 ;;; nnspool.el --- spool access for GNU Emacs
-;; Copyright (C) 1988,89,90,93,94,95,96 Free Software Foundation, Inc.
+
+;; Copyright (C) 1988-1990, 1993-1998, 2000-2015 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.
 
-;; GNU Emacs is free software; you can redistribute it and/or modify
+;; 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.
+;; the Free Software Foundation, either version 3 of the License, 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
@@ -18,9 +20,7 @@
 ;; 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.
+;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
 
 ;;; Commentary:
 
 
 (require 'nnheader)
 (require 'nntp)
-(require 'timezone)
 (require 'nnoo)
 (eval-when-compile (require 'cl))
 
+;; Probably this entire thing should be obsolete.
+;; It's only used to init nnspool-spool-directory, so why not just
+;; set that variable's default directly?
+(eval-and-compile
+  (defvar news-directory (if (file-exists-p "/usr/spool/news/")
+                            "/usr/spool/news/"
+                          "/var/spool/news/")
+    "The root directory below which all news files are stored.")
+  (defvaralias 'news-path 'news-directory))
+
+;; Ditto re obsolescence.
+(defvar news-inews-program
+  (cond ((file-exists-p "/usr/bin/inews") "/usr/bin/inews")
+       ((file-exists-p "/usr/local/inews") "/usr/local/inews")
+       ((file-exists-p "/usr/local/bin/inews") "/usr/local/bin/inews")
+       ((file-exists-p "/usr/contrib/lib/news/inews") "/usr/contrib/lib/news/inews")
+       ((file-exists-p "/usr/lib/news/inews") "/usr/lib/news/inews")
+       (t "inews"))
+  "Program to post news.")
+
 (nnoo-declare nnspool)
 
 (defvoo nnspool-inews-program news-inews-program
@@ -42,13 +61,19 @@ This is most commonly `inews' or `injnews'.")
   "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.")
 
-(defvoo nnspool-spool-directory (file-name-as-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.")
 
 (defvoo nnspool-nov-directory (concat nnspool-spool-directory "over.view/")
   "Local news nov directory.")
 
-(defvoo 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.")
 
 (defvoo nnspool-active-file (concat nnspool-lib-dir "active")
@@ -57,7 +82,7 @@ If you are using Cnews, you probably should set this variable to nil.")
 (defvoo nnspool-newsgroups-file (concat nnspool-lib-dir "newsgroups")
   "Local news newsgroups file.")
 
-(defvoo nnspool-distributions-file (concat nnspool-lib-dir "distributions")
+(defvoo nnspool-distributions-file (concat nnspool-lib-dir "distribs.pat")
   "Local news distributions file.")
 
 (defvoo nnspool-history-file (concat nnspool-lib-dir "history")
@@ -67,8 +92,8 @@ If you are using Cnews, you probably should set this variable to nil.")
   "Local news active date file.")
 
 (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
+  "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.")
 
 (defvoo nnspool-nov-is-evil nil
@@ -82,6 +107,9 @@ 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"
@@ -100,8 +128,7 @@ there.")
 
 (deffoo nnspool-retrieve-headers (articles &optional group server fetch-old)
   "Retrieve the headers of ARTICLES."
-  (save-excursion
-    (set-buffer nntp-server-buffer)
+  (with-current-buffer nntp-server-buffer
     (erase-buffer)
     (when (nnspool-possibly-change-directory group)
       (let* ((number (length articles))
@@ -109,6 +136,7 @@ there.")
             (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))
@@ -119,7 +147,7 @@ there.")
            (if (stringp article)
                ;; This is a Message-ID.
                (setq ag (nnspool-find-id article)
-                     file (and ag (nnspool-article-pathname 
+                     file (and ag (nnspool-article-pathname
                                    (car ag) (cdr ag)))
                      article (cdr ag))
              ;; This is an article in the current group.
@@ -133,26 +161,31 @@ there.")
              (setq beg (point))
              (inline (nnheader-insert-head file))
              (goto-char beg)
-             (search-forward "\n\n" nil t)
-             (forward-char -1)
-             (insert ".\n")
+             (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)))
-           
+
            (and do-message
                 (zerop (% (incf count) 20))
-                (message "nnspool: Receiving headers... %d%%"
-                         (/ (* count 100) number))))
-         
-         (and do-message
-              (message "nnspool: Receiving headers...done"))
-         
+                (nnheader-message 5 "nnspool: Receiving headers... %d%%"
+                                  (floor (* count 100.0) number))))
+
+         (when do-message
+           (nnheader-message 5 "nnspool: Receiving headers...done"))
+
          ;; Fold continuation lines.
          (nnheader-fold-continuation-lines)
          'headers)))))
 
 (deffoo nnspool-open-server (server &optional defs)
   (nnoo-change-server 'nnspool server defs)
-  (cond 
+  (cond
    ((not (file-exists-p nnspool-spool-directory))
     (nnspool-close-server)
     (nnheader-report 'nnspool "Spool directory doesn't exist: %s"
@@ -163,7 +196,7 @@ there.")
     (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" 
+    (nnheader-report 'nnspool "The active file doesn't exist: %s"
                     nnspool-active-file))
    (t
     (nnheader-report 'nnspool "Opened server %s using directory %s"
@@ -176,7 +209,7 @@ there.")
   (let ((nntp-server-buffer (or buffer nntp-server-buffer))
        file ag)
     (if (stringp id)
-       ;; This is a Message-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)))
@@ -188,14 +221,13 @@ there.")
         (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 group)
   (let ((res (nnspool-request-article id)))
     (when res
-      (save-excursion
-       (set-buffer nntp-server-buffer)
+      (with-current-buffer nntp-server-buffer
        (goto-char (point-min))
        (when (search-forward "\n\n" nil t)
          (delete-region (point-min) (point)))
@@ -206,19 +238,19 @@ there.")
   (nnspool-possibly-change-directory group)
   (let ((res (nnspool-request-article id)))
     (when res
-      (save-excursion
-       (set-buffer nntp-server-buffer)
+      (with-current-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))
 
-(deffoo nnspool-request-group (group &optional server dont-check)
+(deffoo nnspool-request-group (group &optional server dont-check info)
   "Select news GROUP."
   (let ((pathname (nnspool-article-pathname group))
        dir)
     (if (not (file-directory-p pathname))
-       (nnheader-report 
+       (nnheader-report
         'nnspool "Invalid group name (no such directory): %s" group)
       (setq nnspool-current-directory pathname)
       (nnheader-report 'nnspool "Selected group %s" group)
@@ -229,13 +261,11 @@ there.")
        ;; 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) '<)))
+         (setq dir (sort (mapcar 'string-to-number dir) '<)))
        (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)
+            (car (last dir)) group)
          (nnheader-report 'nnspool "Empty group %s" group)
          (nnheader-insert "211 0 0 0 %s\n" group))))))
 
@@ -255,14 +285,14 @@ there.")
   "List newsgroups (defined in NNTP2)."
   (save-excursion
     (or (nnspool-find-file nnspool-newsgroups-file)
-       (nnheader-report 'nnspool (nnheader-file-error 
+       (nnheader-report 'nnspool (nnheader-file-error
                                   nnspool-newsgroups-file)))))
 
 (deffoo nnspool-request-list-distributions (&optional server)
   "List distributions (defined in NNTP2)."
   (save-excursion
     (or (nnspool-find-file nnspool-distributions-file)
-       (nnheader-report 'nnspool (nnheader-file-error 
+       (nnheader-report 'nnspool (nnheader-file-error
                                   nnspool-distributions-file)))))
 
 ;; Suggested by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
@@ -272,31 +302,31 @@ there.")
       (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))
+       ;; We require nnheader which requires gnus-util.
+       (let ((seconds (gnus-float-time (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")
-           (setq groups (cdr groups))))
+         (dolist (group groups)
+           (insert group " 0 0 y\n")))
        t)
     nil))
 
@@ -305,7 +335,7 @@ there.")
   (save-excursion
     (let* ((process-connection-type nil) ; t bugs out on Solaris
           (inews-buffer (generate-new-buffer " *nnspool post*"))
-          (proc 
+          (proc
            (condition-case err
                (apply 'start-process "*nnspool inews*" inews-buffer
                       nnspool-inews-program nnspool-inews-switches)
@@ -316,12 +346,12 @@ there.")
          ()
        (nnheader-report 'nnspool "")
        (set-process-sentinel proc 'nnspool-inews-sentinel)
-       (process-send-region proc (point-min) (point-max))
+       (mm-with-unibyte-current-buffer
+         (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))))
 
 
@@ -329,8 +359,7 @@ there.")
 ;;; Internal functions.
 
 (defun nnspool-inews-sentinel (proc status)
-  (save-excursion
-    (set-buffer (process-buffer proc))
+  (with-current-buffer (process-buffer proc)
     (goto-char (point-min))
     (if (or (zerop (buffer-size))
            (search-forward "spooled" nil t))
@@ -339,145 +368,94 @@ there.")
       (while (re-search-forward "[ \t\n]+" nil t)
        (replace-match " " t t))
       (nnheader-report 'nnspool "%s" (buffer-string))
-      (message "nnspool: %s" nnspool-status-string)
+      (nnheader-message 5 "nnspool: %s" nnspool-status-string)
       (ding)
       (run-hooks 'nnspool-rejected-article-hook))))
 
 (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 
+    (let ((nov (nnheader-group-pathname
                nnspool-current-group nnspool-nov-directory ".overview"))
          (arts articles)
+         (nnheader-file-coding-system nnspool-file-coding-system)
          last)
       (if (not (file-exists-p nov))
          ()
-       (save-excursion
-         (set-buffer nntp-server-buffer)
+       (with-current-buffer nntp-server-buffer
          (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.
-             (condition-case ()
-                 (progn
-                   ;; 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.
-                   (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)))
-               ;; The NOV file was corrupted.
-               (error nil)))))))))
+             (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.
+                   (mapc 'nnspool-insert-nov-head 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)
+          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)))
+             (nnspool-article-pathname nnspool-current-group article))
+        (nnheader-insert-article-line article)
+        (goto-char (point-min))
+        (let ((headers (nnheader-parse-head)))
+          (set-buffer cur)
+          (goto-char (point-max))
+          (nnheader-insert-nov headers)))
       (kill-buffer buf))))
 
-(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 'yes)))))
-    ;; Now we may have found the article we're looking for, or we
-    ;; may be somewhere near it.
-    (when (and (not (eq found 'yes))
-              (not (eq num article)))
-      (setq found (point))
-      (while (and (< (point) max)
-                 (or (not (numberp num))
-                     (< num article)))
-       (forward-line 1)
-       (setq found (point))
-       (or (eobp)
-           (= (setq num (read cur)) article)))
-      (unless (eq num article)
-       (goto-char found)))
-    (beginning-of-line)
-    (eq num article)))
-    
 (defun nnspool-sift-nov-with-sed (articles file)
   (let ((first (car articles))
-       (last (progn (while (cdr articles) (setq articles (cdr articles)))
-                    (car articles))))
-    (call-process "awk" nil t nil 
+       (last (car (last articles))))
+    (call-process "awk" nil t nil
                  (format "BEGIN {firstmsg=%d; lastmsg=%d;}\n $1 >= firstmsg && $1 <= lastmsg {print;}"
                          (1- first) (1+ last))
                  file)))
 
-;; Fixed by fdc@cliwe.ping.de (Frank D. Cringle). 
+;; Fixed by fdc@cliwe.ping.de (Frank D. Cringle).
 ;; Find out what group an article identified by a Message-ID is in.
 (defun nnspool-find-id (id)
-  (save-excursion
-    (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))
+  (with-temp-buffer
+    (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))))
-      (kill-buffer (current-buffer)))))
+    (when (looking-at "<[^>]+>[ \t]+[-0-9~]+[ \t]+\\([^ /\t\n]+\\)/\\([0-9]+\\)[ \t\n]")
+      (cons (match-string 1) (string-to-number (match-string 2))))))
 
 (defun nnspool-find-file (file)
   "Insert FILE in server buffer safely."
   (set-buffer nntp-server-buffer)
   (erase-buffer)
   (condition-case ()
-      (progn (nnheader-insert-file-contents-literally file) t)
+      (let ((coding-system-for-read nnspool-file-coding-system))
+       (mm-insert-file-contents file)
+       t)
     (file-error nil)))
 
 (defun nnspool-possibly-change-directory (group)
@@ -490,21 +468,9 @@ there.")
        (nnheader-report 'nnspool "No such newsgroup: %s" group)))))
 
 (defun nnspool-article-pathname (group &optional article)
-  "Find the path for GROUP."
+  "Find the file name for GROUP."
   (nnheader-group-pathname group nnspool-spool-directory article))
 
-(defun nnspool-seconds-since-epoch (date)
-  (let* ((tdate (mapcar (lambda (ti) (and ti (string-to-int ti)))
-                       (timezone-parse-date date)))
-        (ttime (mapcar (lambda (ti) (and ti (string-to-int ti)))
-                       (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 4 tdate))))
-    (+ (* (car unix) 65536.0)
-       (cadr unix))))
-
 (provide 'nnspool)
 
 ;;; nnspool.el ends here