git.chise.org Git - elisp/gnus.git-/blob - lisp/nnspool.el

   1 ;;; nnspool.el --- spool access for GNU Emacs
   2 ;; Copyright (C) 1988,89,90,93,94,95,96,97,98 Free Software Foundation, Inc.
   3
   4 ;; Author: Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
   5 ;;      Lars Magne Ingebrigtsen <larsi@gnus.org>
   6 ;; Keywords: news
   7
   8 ;; This file is part of GNU Emacs.
   9
  10 ;; GNU Emacs is free software; you can redistribute it and/or modify
  11 ;; it under the terms of the GNU General Public License as published by
  12 ;; the Free Software Foundation; either version 2, or (at your option)
  13 ;; any later version.
  14
  15 ;; GNU Emacs is distributed in the hope that it will be useful,
  16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18 ;; GNU General Public License for more details.
  19
  20 ;; You should have received a copy of the GNU General Public License
  21 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  23 ;; Boston, MA 02111-1307, USA.
  24
  25 ;;; Commentary:
  26
  27 ;;; Code:
  28
  29 (eval-when-compile (require 'cl))
  30 (eval-when-compile (require 'gnus-clfns))
  31
  32 (require 'nnheader)
  33 (require 'nntp)
  34 (require 'nnoo)
  35
  36 (nnoo-declare nnspool)
  37
  38 (defvoo nnspool-inews-program news-inews-program
  39   "Program to post news.
  40 This is most commonly `inews' or `injnews'.")
  41
  42 (defvoo nnspool-inews-switches '("-h" "-S")
  43   "Switches for nnspool-request-post to pass to `inews' for posting news.
  44 If you are using Cnews, you probably should set this variable to nil.")
  45
  46 (defvoo nnspool-spool-directory (file-name-as-directory news-path)
  47   "Local news spool directory.")
  48
  49 (defvoo nnspool-nov-directory (concat nnspool-spool-directory "over.view/")
  50   "Local news nov directory.")
  51
  52 (defvoo nnspool-lib-dir "/usr/lib/news/"
  53   "Where the local news library files are stored.")
  54
  55 (defvoo nnspool-active-file (concat nnspool-lib-dir "active")
  56   "Local news active file.")
  57
  58 (defvoo nnspool-newsgroups-file (concat nnspool-lib-dir "newsgroups")
  59   "Local news newsgroups file.")
  60
  61 (defvoo nnspool-distributions-file (concat nnspool-lib-dir "distribs.pat")
  62   "Local news distributions file.")
  63
  64 (defvoo nnspool-history-file (concat nnspool-lib-dir "history")
  65   "Local news history file.")
  66
  67 (defvoo nnspool-active-times-file (concat nnspool-lib-dir "active.times")
  68   "Local news active date file.")
  69
  70 (defvoo nnspool-large-newsgroup 50
  71   "The number of the articles which indicates a large newsgroup.
  72 If the number of the articles is greater than the value, verbose
  73 messages will be shown to indicate the current status.")
  74
  75 (defvoo nnspool-nov-is-evil nil
  76   "Non-nil means that nnspool will never return NOV lines instead of headers.")
  77
  78 (defconst nnspool-sift-nov-with-sed nil
  79   "If non-nil, use sed to get the relevant portion from the overview file.
  80 If nil, nnspool will load the entire file into a buffer and process it
  81 there.")
  82
  83 (defvoo nnspool-rejected-article-hook nil
  84   "*A hook that will be run when an article has been rejected by the server.")
  85
  86 (defvoo nnspool-file-coding-system nnheader-file-coding-system
  87   "Coding system for nnspool.")
  88
  89 \f
  90
  91 (defconst nnspool-version "nnspool 2.0"
  92   "Version numbers of this version of NNSPOOL.")
  93
  94 (defvoo nnspool-current-directory nil
  95   "Current news group directory.")
  96
  97 (defvoo nnspool-current-group nil)
  98 (defvoo nnspool-status-string "")
  99
 100 \f
 101 ;;; Interface functions.
 102
 103 (nnoo-define-basics nnspool)
 104
 105 (deffoo nnspool-retrieve-headers (articles &optional group server fetch-old)
 106   "Retrieve the headers of ARTICLES."
 107   (save-excursion
 108     (set-buffer nntp-server-buffer)
 109     (erase-buffer)
 110     (when (nnspool-possibly-change-directory group)
 111       (let* ((number (length articles))
 112              (count 0)
 113              (default-directory nnspool-current-directory)
 114              (do-message (and (numberp nnspool-large-newsgroup)
 115                               (> number nnspool-large-newsgroup)))
 116              (nnheader-file-coding-system nnspool-file-coding-system)
 117              file beg article ag)
 118         (if (and (numberp (car articles))
 119                  (nnspool-retrieve-headers-with-nov articles fetch-old))
 120             ;; We successfully retrieved the NOV headers.
 121             'nov
 122           ;; No NOV headers here, so we do it the hard way.
 123           (while (setq article (pop articles))
 124             (if (stringp article)
 125                 ;; This is a Message-ID.
 126                 (setq ag (nnspool-find-id article)
 127                       file (and ag (nnspool-article-pathname
 128                                     (car ag) (cdr ag)))
 129                       article (cdr ag))
 130               ;; This is an article in the current group.
 131               (setq file (int-to-string article)))
 132             ;; Insert the head of the article.
 133             (when (and file
 134                        (file-exists-p file))
 135               (insert "221 ")
 136               (princ article (current-buffer))
 137               (insert " Article retrieved.\n")
 138               (setq beg (point))
 139               (inline (nnheader-insert-head file))
 140               (goto-char beg)
 141               (if (search-forward "\n\n" nil t)
 142                   (progn (forward-char -1)
 143                          (insert ".\n"))
 144                 (goto-char (point-max))
 145                 (if (bolp)
 146                     (insert ".\n")
 147                   (insert "\n.\n")))
 148               (delete-region (point) (point-max)))
 149
 150             (and do-message
 151                  (zerop (% (incf count) 20))
 152                  (nnheader-message 5 "nnspool: Receiving headers... %d%%"
 153                                    (/ (* count 100) number))))
 154
 155           (when do-message
 156             (nnheader-message 5 "nnspool: Receiving headers...done"))
 157
 158           ;; Fold continuation lines.
 159           (nnheader-fold-continuation-lines)
 160           'headers)))))
 161
 162 (deffoo nnspool-open-server (server &optional defs)
 163   (nnoo-change-server 'nnspool server defs)
 164   (cond
 165    ((not (file-exists-p nnspool-spool-directory))
 166     (nnspool-close-server)
 167     (nnheader-report 'nnspool "Spool directory doesn't exist: %s"
 168                      nnspool-spool-directory))
 169    ((not (file-directory-p
 170           (directory-file-name
 171            (file-truename nnspool-spool-directory))))
 172     (nnspool-close-server)
 173     (nnheader-report 'nnspool "Not a directory: %s" nnspool-spool-directory))
 174    ((not (file-exists-p nnspool-active-file))
 175     (nnheader-report 'nnspool "The active file doesn't exist: %s"
 176                      nnspool-active-file))
 177    (t
 178     (nnheader-report 'nnspool "Opened server %s using directory %s"
 179                      server nnspool-spool-directory)
 180     t)))
 181
 182 (deffoo nnspool-request-article (id &optional group server buffer)
 183   "Select article by message ID (or number)."
 184   (nnspool-possibly-change-directory group)
 185   (let ((nntp-server-buffer (or buffer nntp-server-buffer))
 186         file ag)
 187     (if (stringp id)
 188         ;; This is a Message-ID.
 189         (when (setq ag (nnspool-find-id id))
 190           (setq file (nnspool-article-pathname (car ag) (cdr ag))))
 191       (setq file (nnspool-article-pathname nnspool-current-group id)))
 192     (and file
 193          (file-exists-p file)
 194          (not (file-directory-p file))
 195          (save-excursion (nnspool-find-file file))
 196          ;; We return the article number and group name.
 197          (if (numberp id)
 198              (cons nnspool-current-group id)
 199            ag))))
 200
 201 (deffoo nnspool-request-body (id &optional group server)
 202   "Select article body by message ID (or number)."
 203   (nnspool-possibly-change-directory group)
 204   (let ((res (nnspool-request-article id)))
 205     (when res
 206       (save-excursion
 207         (set-buffer nntp-server-buffer)
 208         (goto-char (point-min))
 209         (when (search-forward "\n\n" nil t)
 210           (delete-region (point-min) (point)))
 211         res))))
 212
 213 (deffoo nnspool-request-head (id &optional group server)
 214   "Select article head by message ID (or number)."
 215   (nnspool-possibly-change-directory group)
 216   (let ((res (nnspool-request-article id)))
 217     (when res
 218       (save-excursion
 219         (set-buffer nntp-server-buffer)
 220         (goto-char (point-min))
 221         (when (search-forward "\n\n" nil t)
 222           (delete-region (1- (point)) (point-max)))
 223         (nnheader-fold-continuation-lines)))
 224     res))
 225
 226 (deffoo nnspool-request-group (group &optional server dont-check)
 227   "Select news GROUP."
 228   (let ((pathname (nnspool-article-pathname group))
 229         dir)
 230     (if (not (file-directory-p pathname))
 231         (nnheader-report
 232          'nnspool "Invalid group name (no such directory): %s" group)
 233       (setq nnspool-current-directory pathname)
 234       (nnheader-report 'nnspool "Selected group %s" group)
 235       (if dont-check
 236           (progn
 237             (nnheader-report 'nnspool "Selected group %s" group)
 238             t)
 239         ;; Yes, completely empty spool directories *are* possible.
 240         ;; Fix by Sudish Joseph <joseph@cis.ohio-state.edu>
 241         (when (setq dir (directory-files pathname nil "^[0-9]+$" t))
 242           (setq dir
 243                 (sort (mapcar (lambda (name) (string-to-int name)) dir) '<)))
 244         (if dir
 245             (nnheader-insert
 246              "211 %d %d %d %s\n" (length dir) (car dir)
 247              (progn (while (cdr dir) (setq dir (cdr dir))) (car dir))
 248              group)
 249           (nnheader-report 'nnspool "Empty group %s" group)
 250           (nnheader-insert "211 0 0 0 %s\n" group))))))
 251
 252 (deffoo nnspool-request-type (group &optional article)
 253   'news)
 254
 255 (deffoo nnspool-close-group (group &optional server)
 256   t)
 257
 258 (deffoo nnspool-request-list (&optional server)
 259   "List active newsgroups."
 260   (save-excursion
 261     (or (nnspool-find-file nnspool-active-file)
 262         (nnheader-report 'nnspool (nnheader-file-error nnspool-active-file)))))
 263
 264 (deffoo nnspool-request-list-newsgroups (&optional server)
 265   "List newsgroups (defined in NNTP2)."
 266   (save-excursion
 267     (or (nnspool-find-file nnspool-newsgroups-file)
 268         (nnheader-report 'nnspool (nnheader-file-error
 269                                    nnspool-newsgroups-file)))))
 270
 271 (deffoo nnspool-request-list-distributions (&optional server)
 272   "List distributions (defined in NNTP2)."
 273   (save-excursion
 274     (or (nnspool-find-file nnspool-distributions-file)
 275         (nnheader-report 'nnspool (nnheader-file-error
 276                                    nnspool-distributions-file)))))
 277
 278 ;; Suggested by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
 279 (deffoo nnspool-request-newgroups (date &optional server)
 280   "List groups created after DATE."
 281   (if (nnspool-find-file nnspool-active-times-file)
 282       (save-excursion
 283         ;; Find the last valid line.
 284         (goto-char (point-max))
 285         (while (and (not (looking-at
 286                           "\\([^ ]+\\) +\\([0-9]+\\)[0-9][0-9][0-9] "))
 287                     (zerop (forward-line -1))))
 288         (let ((seconds (time-to-seconds (date-to-time date)))
 289               groups)
 290           ;; Go through lines and add the latest groups to a list.
 291           (while (and (looking-at "\\([^ ]+\\) +[0-9]+ ")
 292                       (progn
 293                         ;; We insert a .0 to make the list reader
 294                         ;; interpret the number as a float.  It is far
 295                         ;; too big to be stored in a lisp integer.
 296                         (goto-char (1- (match-end 0)))
 297                         (insert ".0")
 298                         (> (progn
 299                              (goto-char (match-end 1))
 300                              (read (current-buffer)))
 301                            seconds))
 302                       (push (buffer-substring
 303                              (match-beginning 1) (match-end 1))
 304                             groups)
 305                       (zerop (forward-line -1))))
 306           (erase-buffer)
 307           (while groups
 308             (insert (car groups) " 0 0 y\n")
 309             (setq groups (cdr groups))))
 310         t)
 311     nil))
 312
 313 (deffoo nnspool-request-post (&optional server)
 314   "Post a new news in current buffer."
 315   (save-excursion
 316     (let* ((process-connection-type nil) ; t bugs out on Solaris
 317            (inews-buffer (generate-new-buffer " *nnspool post*"))
 318            (proc
 319             (condition-case err
 320                 (apply 'start-process "*nnspool inews*" inews-buffer
 321                        nnspool-inews-program nnspool-inews-switches)
 322               (error
 323                (nnheader-report 'nnspool "inews error: %S" err)))))
 324       (if (not proc)
 325           ;; The inews program failed.
 326           ()
 327         (nnheader-report 'nnspool "")
 328         (set-process-sentinel proc 'nnspool-inews-sentinel)
 329         (process-send-region proc (point-min) (point-max))
 330         ;; We slap a condition-case around this, because the process may
 331         ;; have exited already...
 332         (ignore-errors
 333           (process-send-eof proc))
 334         t))))
 335
 336
 337 \f
 338 ;;; Internal functions.
 339
 340 (defun nnspool-inews-sentinel (proc status)
 341   (save-excursion
 342     (set-buffer (process-buffer proc))
 343     (goto-char (point-min))
 344     (if (or (zerop (buffer-size))
 345             (search-forward "spooled" nil t))
 346         (kill-buffer (current-buffer))
 347       ;; Make status message by folding lines.
 348       (while (re-search-forward "[ \t\n]+" nil t)
 349         (replace-match " " t t))
 350       (nnheader-report 'nnspool "%s" (buffer-string))
 351       (nnheader-message 5 "nnspool: %s" nnspool-status-string)
 352       (ding)
 353       (run-hooks 'nnspool-rejected-article-hook))))
 354
 355 (defun nnspool-retrieve-headers-with-nov (articles &optional fetch-old)
 356   (if (or gnus-nov-is-evil nnspool-nov-is-evil)
 357       nil
 358     (let ((nov (nnheader-group-pathname
 359                 nnspool-current-group nnspool-nov-directory ".overview"))
 360           (arts articles)
 361           (nnheader-file-coding-system nnspool-file-coding-system)
 362           last)
 363       (if (not (file-exists-p nov))
 364           ()
 365         (save-excursion
 366           (set-buffer nntp-server-buffer)
 367           (erase-buffer)
 368           (if nnspool-sift-nov-with-sed
 369               (nnspool-sift-nov-with-sed articles nov)
 370             (nnheader-insert-file-contents nov)
 371             (if (and fetch-old
 372                      (not (numberp fetch-old)))
 373                 t                       ; We want all the headers.
 374               (ignore-errors
 375                 ;; Delete unwanted NOV lines.
 376                 (nnheader-nov-delete-outside-range
 377                  (if fetch-old (max 1 (- (car articles) fetch-old))
 378                    (car articles))
 379                  (car (last articles)))
 380                 ;; If the buffer is empty, this wasn't very successful.
 381                 (unless (zerop (buffer-size))
 382                   ;; We check what the last article number was.
 383                   ;; The NOV file may be out of sync with the articles
 384                   ;; in the group.
 385                   (forward-line -1)
 386                   (setq last (read (current-buffer)))
 387                   (if (= last (car articles))
 388                       ;; Yup, it's all there.
 389                       t
 390                     ;; Perhaps not.  We try to find the missing articles.
 391                     (while (and arts
 392                                 (<= last (car arts)))
 393                       (pop arts))
 394                     ;; The articles in `arts' are missing from the buffer.
 395                     (while arts
 396                       (nnspool-insert-nov-head (pop arts)))
 397                     t))))))))))
 398
 399 (defun nnspool-insert-nov-head (article)
 400   "Read the head of ARTICLE, convert to NOV headers, and insert."
 401   (save-excursion
 402     (let ((cur (current-buffer))
 403           buf)
 404       (setq buf (nnheader-set-temp-buffer " *nnspool head*"))
 405       (when (nnheader-insert-head
 406              (nnspool-article-pathname nnspool-current-group article))
 407         (nnheader-insert-article-line article)
 408         (let ((headers (nnheader-parse-head)))
 409           (set-buffer cur)
 410           (goto-char (point-max))
 411           (nnheader-insert-nov headers)))
 412       (kill-buffer buf))))
 413
 414 (defun nnspool-sift-nov-with-sed (articles file)
 415   (let ((first (car articles))
 416         (last (progn (while (cdr articles) (setq articles (cdr articles)))
 417                      (car articles))))
 418     (call-process "awk" nil t nil
 419                   (format "BEGIN {firstmsg=%d; lastmsg=%d;}\n $1 >= firstmsg && $1 <= lastmsg {print;}"
 420                           (1- first) (1+ last))
 421                   file)))
 422
 423 ;; Fixed by fdc@cliwe.ping.de (Frank D. Cringle).
 424 ;; Find out what group an article identified by a Message-ID is in.
 425 (defun nnspool-find-id (id)
 426   (save-excursion
 427     (set-buffer (get-buffer-create " *nnspool work*"))
 428     (erase-buffer)
 429     (ignore-errors
 430       (call-process "grep" nil t nil (regexp-quote id) nnspool-history-file))
 431     (goto-char (point-min))
 432     (prog1
 433         (when (looking-at "<[^>]+>[ \t]+[-0-9~]+[ \t]+\\([^ /\t\n]+\\)/\\([0-9]+\\)[ \t\n]")
 434           (cons (match-string 1) (string-to-int (match-string 2))))
 435       (kill-buffer (current-buffer)))))
 436
 437 (defun nnspool-find-file (file)
 438   "Insert FILE in server buffer safely."
 439   (set-buffer nntp-server-buffer)
 440   (erase-buffer)
 441   (condition-case ()
 442       (let ((nnheader-file-coding-system nnspool-file-coding-system))
 443         (nnheader-insert-file-contents file)
 444         t)
 445     (file-error nil)))
 446
 447 (defun nnspool-possibly-change-directory (group)
 448   (if (not group)
 449       t
 450     (let ((pathname (nnspool-article-pathname group)))
 451       (if (file-directory-p pathname)
 452           (setq nnspool-current-directory pathname
 453                 nnspool-current-group group)
 454         (nnheader-report 'nnspool "No such newsgroup: %s" group)))))
 455
 456 (defun nnspool-article-pathname (group &optional article)
 457   "Find the path for GROUP."
 458   (nnheader-group-pathname group nnspool-spool-directory article))
 459
 460 (provide 'nnspool)
 461
 462 ;;; nnspool.el ends here