cgit.sxemacs.org Git - gnus/blob - lisp/nnspool.el

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