lisp/nnspool.el

   1 ;;; nnspool.el --- spool access for GNU Emacs
   2
   3 ;; Copyright (C) 1988,89,90,93,94,95 Free Software Foundation, Inc.
   4
   5 ;; Author: Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
   6 ;;      Lars Magne Ingebrigtsen <larsi@ifi.uio.no>
   7 ;; Keywords: news
   8
   9 ;; This file is part of GNU Emacs.
  10
  11 ;; GNU Emacs is free software; you can redistribute it and/or modify
  12 ;; it under the terms of the GNU General Public License as published by
  13 ;; the Free Software Foundation; either version 2, or (at your option)
  14 ;; any later version.
  15
  16 ;; GNU Emacs is distributed in the hope that it will be useful,
  17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19 ;; GNU General Public License for more details.
  20
  21 ;; You should have received a copy of the GNU General Public License
  22 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  24 ;; Boston, MA 02111-1307, USA.
  25
  26 ;;; Commentary:
  27
  28 ;;; Code:
  29
  30 (require 'nnheader)
  31 (require 'nntp)
  32 (require 'timezone)
  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 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 \f
  80
  81 (defconst nnspool-version "nnspool 2.0"
  82   "Version numbers of this version of NNSPOOL.")
  83
  84 (defvar nnspool-current-directory nil
  85   "Current news group directory.")
  86
  87 (defvar nnspool-current-group nil)
  88 (defvar nnspool-status-string "")
  89
  90 \f
  91
  92 (defvar nnspool-current-server nil)
  93 (defvar nnspool-server-alist nil)
  94 (defvar nnspool-server-variables
  95   (list
  96    (list 'nnspool-inews-program nnspool-inews-program)
  97    (list 'nnspool-inews-switches nnspool-inews-switches)
  98    (list 'nnspool-spool-directory nnspool-spool-directory)
  99    (list 'nnspool-nov-directory nnspool-nov-directory)
 100    (list 'nnspool-lib-dir nnspool-lib-dir)
 101    (list 'nnspool-active-file nnspool-active-file)
 102    (list 'nnspool-newsgroups-file nnspool-newsgroups-file)
 103    (list 'nnspool-distributions-file nnspool-distributions-file)
 104    (list 'nnspool-history-file nnspool-history-file)
 105    (list 'nnspool-active-times-file nnspool-active-times-file)
 106    (list 'nnspool-large-newsgroup nnspool-large-newsgroup)
 107    (list 'nnspool-nov-is-evil nnspool-nov-is-evil)
 108    (list 'nnspool-sift-nov-with-sed nnspool-sift-nov-with-sed)
 109    '(nnspool-current-directory nil)
 110    '(nnspool-current-group nil)
 111    '(nnspool-status-string "")))
 112
 113 \f
 114 ;;; Interface functions.
 115
 116 (defun nnspool-retrieve-headers (sequence &optional newsgroup server)
 117   "Retrieve the headers for the articles in SEQUENCE.
 118 Newsgroup must be selected before calling this function."
 119   (save-excursion
 120     (set-buffer nntp-server-buffer)
 121     (erase-buffer)
 122     (let* ((number (length sequence))
 123            (count 0)
 124            (do-message (and (numberp nnspool-large-newsgroup)
 125                             (> number nnspool-large-newsgroup)))
 126            file beg article)
 127       (if (not (nnspool-possibly-change-directory newsgroup))
 128           ()
 129         (if (and (numberp (car sequence))
 130                  (nnspool-retrieve-headers-with-nov sequence))
 131             'nov
 132           (while sequence
 133             (setq article (car sequence))
 134             (if (stringp article)
 135                 (progn
 136                   (setq file (nnspool-find-article-by-message-id article))
 137                   (setq article 0))
 138               (setq file (concat nnspool-current-directory
 139                                  (int-to-string article))))
 140             (and file (file-exists-p file)
 141                  (progn
 142                    (insert (format "221 %d Article retrieved.\n" article))
 143                    (setq beg (point))
 144                    (nnheader-insert-head file)
 145                    (goto-char beg)
 146                    (search-forward "\n\n" nil t)
 147                    (forward-char -1)
 148                    (insert ".\n")
 149                    (delete-region (point) (point-max))))
 150             (setq sequence (cdr sequence))
 151
 152             (and do-message
 153                  (zerop (% (setq count (1+ count)) 20))
 154                  (message "NNSPOOL: Receiving headers... %d%%"
 155                           (/ (* count 100) number))))
 156
 157           (and do-message (message "NNSPOOL: Receiving headers...done"))
 158
 159           ;; Fold continuation lines.
 160           (goto-char (point-min))
 161           (while (re-search-forward "\\(\r?\n[ \t]+\\)+" nil t)
 162             (replace-match " " t t))
 163           'headers)))))
 164
 165 (defun nnspool-open-server (server &optional defs)
 166   (nnheader-init-server-buffer)
 167   (if (equal server nnspool-current-server)
 168       t
 169     (if nnspool-current-server
 170         (setq nnspool-server-alist
 171               (cons (list nnspool-current-server
 172                           (nnheader-save-variables nnspool-server-variables))
 173                     nnspool-server-alist)))
 174     (let ((state (assoc server nnspool-server-alist)))
 175       (if state
 176           (progn
 177             (nnheader-restore-variables (nth 1 state))
 178             (setq nnspool-server-alist (delq state nnspool-server-alist)))
 179         (nnheader-set-init-variables nnspool-server-variables defs)))
 180     (setq nnspool-current-server server)))
 181
 182 (defun nnspool-close-server (&optional server)
 183   t)
 184
 185 (defun nnspool-server-opened (&optional server)
 186   (and (equal server nnspool-current-server)
 187        nntp-server-buffer
 188        (buffer-name nntp-server-buffer)))
 189
 190 (defun nnspool-status-message (&optional server)
 191   "Return server status response as string."
 192   nnspool-status-string)
 193
 194 (defun nnspool-request-article (id &optional newsgroup server buffer)
 195   "Select article by message ID (or number)."
 196   (nnspool-possibly-change-directory newsgroup)
 197   (let ((file (if (stringp id)
 198                   (nnspool-find-article-by-message-id id)
 199                 (concat nnspool-current-directory (prin1-to-string id))))
 200         (nntp-server-buffer (or buffer nntp-server-buffer)))
 201     (if (and (stringp file)
 202              (file-exists-p file)
 203              (not (file-directory-p file)))
 204         (save-excursion
 205           (nnspool-find-file file)))))
 206
 207 (defun nnspool-request-body (id &optional newsgroup server)
 208   "Select article body by message ID (or number)."
 209   (nnspool-possibly-change-directory newsgroup)
 210   (if (nnspool-request-article id)
 211       (save-excursion
 212         (set-buffer nntp-server-buffer)
 213         (goto-char (point-min))
 214         (if (search-forward "\n\n" nil t)
 215             (delete-region (point-min) (point)))
 216         t)))
 217
 218 (defun nnspool-request-head (id &optional newsgroup server)
 219   "Select article head by message ID (or number)."
 220   (nnspool-possibly-change-directory newsgroup)
 221   (if (nnspool-request-article id)
 222       (save-excursion
 223         (set-buffer nntp-server-buffer)
 224         (goto-char (point-min))
 225         (if (search-forward "\n\n" nil t)
 226             (delete-region (1- (point)) (point-max)))
 227         t)))
 228
 229 (defun nnspool-request-group (group &optional server dont-check)
 230   "Select news GROUP."
 231   (let ((pathname (nnspool-article-pathname
 232                    (nnspool-replace-chars-in-string group ?. ?/)))
 233         dir)
 234     (if (not (file-directory-p pathname))
 235         (progn
 236           (setq nnspool-status-string
 237                 "Invalid group name (no such directory)")
 238           nil)
 239       (setq nnspool-current-directory pathname)
 240       (setq nnspool-status-string "")
 241       (if (not dont-check)
 242           (progn
 243             (setq dir (directory-files pathname nil "^[0-9]+$" t))
 244             ;; yes, completely empty spool directories *are* possible
 245             ;; Fix by Sudish Joseph <joseph@cis.ohio-state.edu>
 246             (and dir
 247                  (setq dir
 248                        (sort
 249                         (mapcar
 250                          (function
 251                           (lambda (name)
 252                             (string-to-int name)))
 253                          dir)
 254                         '<)))
 255             (save-excursion
 256               (set-buffer nntp-server-buffer)
 257               (erase-buffer)
 258               (if dir
 259                   (insert
 260                    (format "211 %d %d %d %s\n" (length dir) (car dir)
 261                            (progn (while (cdr dir) (setq dir (cdr dir)))
 262                                   (car dir))
 263                            group))
 264                 (insert (format "211 0 0 0 %s\n" group))))))
 265       t)))
 266
 267 (defun nnspool-close-group (group &optional server)
 268   t)
 269
 270 (defun nnspool-request-list (&optional server)
 271   "List active newsgroups."
 272   (save-excursion
 273     (nnspool-find-file nnspool-active-file)))
 274
 275 (defun nnspool-request-list-newsgroups (&optional server)
 276   "List newsgroups (defined in NNTP2)."
 277   (save-excursion
 278     (nnspool-find-file nnspool-newsgroups-file)))
 279
 280 (defun nnspool-request-list-distributions (&optional server)
 281   "List distributions (defined in NNTP2)."
 282   (save-excursion
 283     (nnspool-find-file nnspool-distributions-file)))
 284
 285 ;; Suggested by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
 286 (defun nnspool-request-newgroups (date &optional server)
 287   "List groups created after DATE."
 288   (if (nnspool-find-file nnspool-active-times-file)
 289       (save-excursion
 290         ;; Find the last valid line.
 291         (goto-char (point-max))
 292         (while (and (not (looking-at
 293                           "\\([^ ]+\\) +\\([0-9]+\\)[0-9][0-9][0-9] "))
 294                     (zerop (forward-line -1))))
 295         (let ((seconds (nnspool-seconds-since-epoch date))
 296               groups)
 297           ;; Go through lines and add the latest groups to a list.
 298           (while (and (looking-at "\\([^ ]+\\) +[0-9]+ ")
 299                       (progn
 300                         ;; We insert a .0 to make the list reader
 301                         ;; interpret the number as a float. It is far
 302                         ;; too big to be stored in a lisp integer.
 303                         (goto-char (1- (match-end 0)))
 304                         (insert ".0")
 305                         (> (progn
 306                              (goto-char (match-end 1))
 307                              (read (current-buffer)))
 308                            seconds))
 309                       (setq groups (cons (buffer-substring
 310                                           (match-beginning 1) (match-end 1))
 311                                          groups))
 312                       (zerop (forward-line -1))))
 313           (erase-buffer)
 314           (while groups
 315             (insert (car groups) " 0 0 y\n")
 316             (setq groups (cdr groups))))
 317         t)
 318     nil))
 319
 320 (defun nnspool-request-post (&optional server)
 321   "Post a new news in current buffer."
 322   (save-excursion
 323     (let* ((process-connection-type nil) ; t bugs out on Solaris
 324            (inews-buffer (generate-new-buffer " *nnspool post*"))
 325            (proc (apply 'start-process "*nnspool inews*" inews-buffer
 326                         nnspool-inews-program nnspool-inews-switches)))
 327       (set-process-sentinel proc 'nnspool-inews-sentinel)
 328       (process-send-region proc (point-min) (point-max))
 329       ;; We slap a condition-case around this, because the process may
 330       ;; have exited already...
 331       (condition-case nil
 332           (process-send-eof proc)
 333         (error nil))
 334       t)))
 335
 336 (defun nnspool-inews-sentinel (proc status)
 337   (save-excursion
 338     (set-buffer (process-buffer proc))
 339     (goto-char (point-min))
 340     (if (or (zerop (buffer-size))
 341             (search-forward "spooled" nil t))
 342         (kill-buffer (current-buffer))
 343       ;; Make status message by unfolding lines.
 344       (subst-char-in-region (point-min) (point-max) ?\n ?\\ 'noundo)
 345       (setq nnspool-status-string (buffer-string))
 346       (message "nnspool: %s" nnspool-status-string)
 347                                         ;(kill-buffer (current-buffer))
 348       )))
 349
 350 (defalias 'nnspool-request-post-buffer 'nntp-request-post-buffer)
 351
 352 \f
 353 ;;; Internal functions.
 354
 355 (defun nnspool-retrieve-headers-with-nov (articles)
 356   (if (or gnus-nov-is-evil nnspool-nov-is-evil)
 357       nil
 358     (let ((nov (concat (file-name-as-directory nnspool-nov-directory)
 359                        (nnspool-replace-chars-in-string
 360                         nnspool-current-group ?. ?/)
 361                        "/.overview"))
 362           article)
 363       (if (file-exists-p nov)
 364           (save-excursion
 365             (set-buffer nntp-server-buffer)
 366             (erase-buffer)
 367             (if nnspool-sift-nov-with-sed
 368                 (nnspool-sift-nov-with-sed articles nov)
 369               (insert-file-contents nov)
 370               ;; First we find the first wanted line. We issue a number
 371               ;; of search-forwards - the first article we are looking
 372               ;; for may be expired, so we have to go on searching until
 373               ;; we find one of the articles we want.
 374               (while (and articles
 375                           (setq article (concat (int-to-string
 376                                                  (car articles)) "\t"))
 377                           (not (or (looking-at article)
 378                                    (search-forward (concat "\n" article)
 379                                                    nil t))))
 380                 (setq articles (cdr articles)))
 381               (if (not articles)
 382                   ()
 383                 (beginning-of-line)
 384                 (delete-region (point-min) (point))
 385                 ;; Then we find the last wanted line. We go to the end
 386                 ;; of the buffer and search backward much the same way
 387                 ;; we did to find the first article.
 388                 ;; !!! Perhaps it would be better just to do a (last articles),
 389                 ;; and go forward successively over each line and
 390                 ;; compare to avoid this (reverse), like this:
 391                 ;; (while (and (>= last (read nntp-server-buffer)))
 392                 ;;             (zerop (forward-line 1))))
 393                 (setq articles (reverse articles))
 394                 (goto-char (point-max))
 395                 (while (and articles
 396                             (not (search-backward
 397                                   (concat "\n" (int-to-string (car articles))
 398                                           "\t") nil t)))
 399                   (setq articles (cdr articles)))
 400                 (if articles
 401                     (progn
 402                       (forward-line 2)
 403                       (delete-region (point) (point-max)))))
 404               (or articles (progn (erase-buffer) nil))))))))
 405
 406 (defun nnspool-sift-nov-with-sed (articles file)
 407   (let ((first (car articles))
 408         (last (progn (while (cdr articles) (setq articles (cdr articles)))
 409                      (car articles))))
 410     (call-process "awk" nil t nil
 411                   (format "BEGIN {firstmsg=%d; lastmsg=%d;}\n $1 >= firstmsg && $1 <= lastmsg {print;}"
 412                           (1- first) (1+ last))
 413                   file)))
 414
 415 ;; Fixed by fdc@cliwe.ping.de (Frank D. Cringle).
 416 (defun nnspool-find-article-by-message-id (id)
 417   "Return full pathname of an article identified by message-ID."
 418   (save-excursion
 419     (let ((buf (get-buffer-create " *nnspool work*")))
 420       (set-buffer buf)
 421       (erase-buffer)
 422       (call-process "grep" nil t nil id nnspool-history-file)
 423       (goto-char (point-min))
 424       (if (looking-at "<[^>]+>[ \t]+[-0-9~]+[ \t]+\\([^ \t\n]*\\)")
 425           (concat nnspool-spool-directory
 426                   (nnspool-replace-chars-in-string
 427                    (buffer-substring (match-beginning 1) (match-end 1))
 428                    ?. ?/))))))
 429
 430 (defun nnspool-find-file (file)
 431   "Insert FILE in server buffer safely."
 432   (set-buffer nntp-server-buffer)
 433   (erase-buffer)
 434   (condition-case ()
 435       (progn (insert-file-contents file) t)
 436     (file-error nil)))
 437
 438 (defun nnspool-possibly-change-directory (newsgroup)
 439   (if newsgroup
 440       (let ((pathname (nnspool-article-pathname
 441                        (nnspool-replace-chars-in-string newsgroup ?. ?/))))
 442         (if (file-directory-p pathname)
 443             (progn
 444               (setq nnspool-current-directory pathname)
 445               (setq nnspool-current-group newsgroup))
 446           (setq nnspool-status-string
 447                 (format "No such newsgroup: %s" newsgroup))
 448           nil))
 449     t))
 450
 451 (defun nnspool-article-pathname (group)
 452   "Make pathname for GROUP."
 453   (concat (file-name-as-directory nnspool-spool-directory) group "/"))
 454
 455 (defun nnspool-replace-chars-in-string (string from to)
 456   "Replace characters in STRING from FROM to TO."
 457   (let ((string (substring string 0))   ;Copy string.
 458         (len (length string))
 459         (idx 0))
 460     ;; Replace all occurrences of FROM with TO.
 461     (while (< idx len)
 462       (if (= (aref string idx) from)
 463           (aset string idx to))
 464       (setq idx (1+ idx)))
 465     string))
 466
 467 (defun nnspool-number-base-10 (num pos)
 468   (if (<= pos 0) ""
 469     (setcdr num (+ (* (% (car num) 10) 65536) (cdr num)))
 470     (apply
 471      'concat
 472      (reverse
 473       (list
 474        (char-to-string
 475         (aref "0123456789" (% (cdr num) 10)))
 476        (progn
 477          (setcdr num (/ (cdr num) 10))
 478          (setcar num (/ (car num) 10))
 479          (nnspool-number-base-10 num (1- pos))))))))
 480
 481 (defun nnspool-seconds-since-epoch (date)
 482   (let* ((tdate (mapcar (lambda (ti) (and ti (string-to-int ti)))
 483                         (timezone-parse-date date)))
 484          (ttime (mapcar (lambda (ti) (and ti (string-to-int ti)))
 485                         (timezone-parse-time
 486                          (aref (timezone-parse-date date) 3))))
 487          (unix (encode-time (nth 2 ttime) (nth 1 ttime) (nth 0 ttime)
 488                             (nth 2 tdate) (nth 1 tdate) (nth 0 tdate) (nth 4 tdate))))
 489     (+ (* (car unix) 65536.0)
 490        (car (cdr unix)))))
 491
 492 (provide 'nnspool)
 493
 494 ;;; nnspool.el ends here