1 ;;; nnspool.el --- spool access for GNU Emacs
2 ;; Copyright (C) 1988,89,90,93,94,95,96 Free Software Foundation, Inc.
4 ;; Author: Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
5 ;; Lars Magne Ingebrigtsen <larsi@ifi.uio.no>
8 ;; This file is part of GNU Emacs.
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)
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.
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.
33 (eval-when-compile (require 'cl))
35 (nnoo-declare nnspool)
37 (defvoo nnspool-inews-program news-inews-program
38 "Program to post news.
39 This is most commonly `inews' or `injnews'.")
41 (defvoo nnspool-inews-switches '("-h" "-S")
42 "Switches for nnspool-request-post to pass to `inews' for posting news.
43 If you are using Cnews, you probably should set this variable to nil.")
45 (defvoo nnspool-spool-directory (file-name-as-directory news-path)
46 "Local news spool directory.")
48 (defvoo nnspool-nov-directory (concat nnspool-spool-directory "over.view/")
49 "Local news nov directory.")
51 (defvoo nnspool-lib-dir "/usr/lib/news/"
52 "Where the local news library files are stored.")
54 (defvoo nnspool-active-file (concat nnspool-lib-dir "active")
55 "Local news active file.")
57 (defvoo nnspool-newsgroups-file (concat nnspool-lib-dir "newsgroups")
58 "Local news newsgroups file.")
60 (defvoo nnspool-distributions-file (concat nnspool-lib-dir "distribs.pat")
61 "Local news distributions file.")
63 (defvoo nnspool-history-file (concat nnspool-lib-dir "history")
64 "Local news history file.")
66 (defvoo nnspool-active-times-file (concat nnspool-lib-dir "active.times")
67 "Local news active date file.")
69 (defvoo nnspool-large-newsgroup 50
70 "The number of the articles which indicates a large newsgroup.
71 If the number of the articles is greater than the value, verbose
72 messages will be shown to indicate the current status.")
74 (defvoo nnspool-nov-is-evil nil
75 "Non-nil means that nnspool will never return NOV lines instead of headers.")
77 (defconst nnspool-sift-nov-with-sed nil
78 "If non-nil, use sed to get the relevant portion from the overview file.
79 If nil, nnspool will load the entire file into a buffer and process it
82 (defvoo nnspool-rejected-article-hook nil
83 "*A hook that will be run when an article has been rejected by the server.")
87 (defconst nnspool-version "nnspool 2.0"
88 "Version numbers of this version of NNSPOOL.")
90 (defvoo nnspool-current-directory nil
91 "Current news group directory.")
93 (defvoo nnspool-current-group nil)
94 (defvoo nnspool-status-string "")
97 ;;; Interface functions.
99 (nnoo-define-basics nnspool)
101 (deffoo nnspool-retrieve-headers (articles &optional group server fetch-old)
102 "Retrieve the headers of ARTICLES."
104 (set-buffer nntp-server-buffer)
106 (when (nnspool-possibly-change-directory group)
107 (let* ((number (length articles))
109 (default-directory nnspool-current-directory)
110 (do-message (and (numberp nnspool-large-newsgroup)
111 (> number nnspool-large-newsgroup)))
113 (if (and (numberp (car articles))
114 (nnspool-retrieve-headers-with-nov articles fetch-old))
115 ;; We successfully retrieved the NOV headers.
117 ;; No NOV headers here, so we do it the hard way.
118 (while (setq article (pop articles))
119 (if (stringp article)
120 ;; This is a Message-ID.
121 (setq ag (nnspool-find-id article)
122 file (and ag (nnspool-article-pathname
125 ;; This is an article in the current group.
126 (setq file (int-to-string article)))
127 ;; Insert the head of the article.
129 (file-exists-p file))
131 (princ article (current-buffer))
132 (insert " Article retrieved.\n")
134 (inline (nnheader-insert-head file))
136 (search-forward "\n\n" nil t)
139 (delete-region (point) (point-max)))
142 (zerop (% (incf count) 20))
143 (message "nnspool: Receiving headers... %d%%"
144 (/ (* count 100) number))))
147 (message "nnspool: Receiving headers...done"))
149 ;; Fold continuation lines.
150 (nnheader-fold-continuation-lines)
153 (deffoo nnspool-open-server (server &optional defs)
154 (nnoo-change-server 'nnspool server defs)
156 ((not (file-exists-p nnspool-spool-directory))
157 (nnspool-close-server)
158 (nnheader-report 'nnspool "Spool directory doesn't exist: %s"
159 nnspool-spool-directory))
160 ((not (file-directory-p
162 (file-truename nnspool-spool-directory))))
163 (nnspool-close-server)
164 (nnheader-report 'nnspool "Not a directory: %s" nnspool-spool-directory))
165 ((not (file-exists-p nnspool-active-file))
166 (nnheader-report 'nnspool "The active file doesn't exist: %s"
167 nnspool-active-file))
169 (nnheader-report 'nnspool "Opened server %s using directory %s"
170 server nnspool-spool-directory)
173 (deffoo nnspool-request-article (id &optional group server buffer)
174 "Select article by message ID (or number)."
175 (nnspool-possibly-change-directory group)
176 (let ((nntp-server-buffer (or buffer nntp-server-buffer))
179 ;; This is a Message-ID.
180 (when (setq ag (nnspool-find-id id))
181 (setq file (nnspool-article-pathname (car ag) (cdr ag))))
182 (setq file (nnspool-article-pathname nnspool-current-group id)))
185 (not (file-directory-p file))
186 (save-excursion (nnspool-find-file file))
187 ;; We return the article number and group name.
189 (cons nnspool-current-group id)
192 (deffoo nnspool-request-body (id &optional group server)
193 "Select article body by message ID (or number)."
194 (nnspool-possibly-change-directory group)
195 (let ((res (nnspool-request-article id)))
198 (set-buffer nntp-server-buffer)
199 (goto-char (point-min))
200 (when (search-forward "\n\n" nil t)
201 (delete-region (point-min) (point)))
204 (deffoo nnspool-request-head (id &optional group server)
205 "Select article head by message ID (or number)."
206 (nnspool-possibly-change-directory group)
207 (let ((res (nnspool-request-article id)))
210 (set-buffer nntp-server-buffer)
211 (goto-char (point-min))
212 (when (search-forward "\n\n" nil t)
213 (delete-region (1- (point)) (point-max)))))
216 (deffoo nnspool-request-group (group &optional server dont-check)
218 (let ((pathname (nnspool-article-pathname group))
220 (if (not (file-directory-p pathname))
222 'nnspool "Invalid group name (no such directory): %s" group)
223 (setq nnspool-current-directory pathname)
224 (nnheader-report 'nnspool "Selected group %s" group)
227 (nnheader-report 'nnspool "Selected group %s" group)
229 ;; Yes, completely empty spool directories *are* possible.
230 ;; Fix by Sudish Joseph <joseph@cis.ohio-state.edu>
231 (when (setq dir (directory-files pathname nil "^[0-9]+$" t))
233 (sort (mapcar (lambda (name) (string-to-int name)) dir) '<)))
236 "211 %d %d %d %s\n" (length dir) (car dir)
237 (progn (while (cdr dir) (setq dir (cdr dir))) (car dir))
239 (nnheader-report 'nnspool "Empty group %s" group)
240 (nnheader-insert "211 0 0 0 %s\n" group))))))
242 (deffoo nnspool-request-type (group &optional article)
245 (deffoo nnspool-close-group (group &optional server)
248 (deffoo nnspool-request-list (&optional server)
249 "List active newsgroups."
251 (or (nnspool-find-file nnspool-active-file)
252 (nnheader-report 'nnspool (nnheader-file-error nnspool-active-file)))))
254 (deffoo nnspool-request-list-newsgroups (&optional server)
255 "List newsgroups (defined in NNTP2)."
257 (or (nnspool-find-file nnspool-newsgroups-file)
258 (nnheader-report 'nnspool (nnheader-file-error
259 nnspool-newsgroups-file)))))
261 (deffoo nnspool-request-list-distributions (&optional server)
262 "List distributions (defined in NNTP2)."
264 (or (nnspool-find-file nnspool-distributions-file)
265 (nnheader-report 'nnspool (nnheader-file-error
266 nnspool-distributions-file)))))
268 ;; Suggested by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
269 (deffoo nnspool-request-newgroups (date &optional server)
270 "List groups created after DATE."
271 (if (nnspool-find-file nnspool-active-times-file)
273 ;; Find the last valid line.
274 (goto-char (point-max))
275 (while (and (not (looking-at
276 "\\([^ ]+\\) +\\([0-9]+\\)[0-9][0-9][0-9] "))
277 (zerop (forward-line -1))))
278 (let ((seconds (nnspool-seconds-since-epoch date))
280 ;; Go through lines and add the latest groups to a list.
281 (while (and (looking-at "\\([^ ]+\\) +[0-9]+ ")
283 ;; We insert a .0 to make the list reader
284 ;; interpret the number as a float. It is far
285 ;; too big to be stored in a lisp integer.
286 (goto-char (1- (match-end 0)))
289 (goto-char (match-end 1))
290 (read (current-buffer)))
292 (setq groups (cons (buffer-substring
293 (match-beginning 1) (match-end 1))
295 (zerop (forward-line -1))))
298 (insert (car groups) " 0 0 y\n")
299 (setq groups (cdr groups))))
303 (deffoo nnspool-request-post (&optional server)
304 "Post a new news in current buffer."
306 (let* ((process-connection-type nil) ; t bugs out on Solaris
307 (inews-buffer (generate-new-buffer " *nnspool post*"))
310 (apply 'start-process "*nnspool inews*" inews-buffer
311 nnspool-inews-program nnspool-inews-switches)
313 (nnheader-report 'nnspool "inews error: %S" err)))))
315 ;; The inews program failed.
317 (nnheader-report 'nnspool "")
318 (set-process-sentinel proc 'nnspool-inews-sentinel)
319 (process-send-region proc (point-min) (point-max))
320 ;; We slap a condition-case around this, because the process may
321 ;; have exited already...
323 (process-send-eof proc)
329 ;;; Internal functions.
331 (defun nnspool-inews-sentinel (proc status)
333 (set-buffer (process-buffer proc))
334 (goto-char (point-min))
335 (if (or (zerop (buffer-size))
336 (search-forward "spooled" nil t))
337 (kill-buffer (current-buffer))
338 ;; Make status message by folding lines.
339 (while (re-search-forward "[ \t\n]+" nil t)
340 (replace-match " " t t))
341 (nnheader-report 'nnspool "%s" (buffer-string))
342 (message "nnspool: %s" nnspool-status-string)
344 (run-hooks 'nnspool-rejected-article-hook))))
346 (defun nnspool-retrieve-headers-with-nov (articles &optional fetch-old)
347 (if (or gnus-nov-is-evil nnspool-nov-is-evil)
349 (let ((nov (nnheader-group-pathname
350 nnspool-current-group nnspool-nov-directory ".overview"))
353 (if (not (file-exists-p nov))
356 (set-buffer nntp-server-buffer)
358 (if nnspool-sift-nov-with-sed
359 (nnspool-sift-nov-with-sed articles nov)
360 (insert-file-contents nov)
362 (not (numberp fetch-old)))
363 t ; We want all the headers.
366 ;; First we find the first wanted line.
367 (nnspool-find-nov-line
368 (if fetch-old (max 1 (- (car articles) fetch-old))
370 (delete-region (point-min) (point))
371 ;; Then we find the last wanted line.
372 (if (nnspool-find-nov-line
373 (progn (while (cdr articles)
374 (setq articles (cdr articles)))
377 (delete-region (point) (point-max))
378 ;; If the buffer is empty, this wasn't very successful.
379 (unless (zerop (buffer-size))
380 ;; We check what the last article number was.
381 ;; The NOV file may be out of sync with the articles
384 (setq last (read (current-buffer)))
385 (if (= last (car articles))
386 ;; Yup, it's all there.
388 ;; Perhaps not. We try to find the missing articles.
390 (<= last (car arts)))
392 ;; The articles in `arts' are missing from the buffer.
394 (nnspool-insert-nov-head (pop arts)))
396 ;; The NOV file was corrupted.
399 (defun nnspool-insert-nov-head (article)
400 "Read the head of ARTICLE, convert to NOV headers, and insert."
402 (let ((cur (current-buffer))
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)))
410 (goto-char (point-max))
411 (nnheader-insert-nov headers)))
414 (defun nnspool-find-nov-line (article)
415 (let ((max (point-max))
416 (min (goto-char (point-min)))
417 (cur (current-buffer))
421 (goto-char (/ (+ max min) 2))
423 (if (or (= (point) prev)
427 (cond ((> (setq num (read cur)) article)
432 (setq found 'yes)))))
433 ;; Now we may have found the article we're looking for, or we
434 ;; may be somewhere near it.
435 (when (and (not (eq found 'yes))
436 (not (eq num article)))
438 (while (and (< (point) max)
439 (or (not (numberp num))
444 (= (setq num (read cur)) article)))
445 (unless (eq num article)
450 (defun nnspool-sift-nov-with-sed (articles file)
451 (let ((first (car articles))
452 (last (progn (while (cdr articles) (setq articles (cdr articles)))
454 (call-process "awk" nil t nil
455 (format "BEGIN {firstmsg=%d; lastmsg=%d;}\n $1 >= firstmsg && $1 <= lastmsg {print;}"
456 (1- first) (1+ last))
459 ;; Fixed by fdc@cliwe.ping.de (Frank D. Cringle).
460 ;; Find out what group an article identified by a Message-ID is in.
461 (defun nnspool-find-id (id)
463 (set-buffer (get-buffer-create " *nnspool work*"))
464 (buffer-disable-undo (current-buffer))
467 (call-process "grep" nil t nil id nnspool-history-file)
469 (goto-char (point-min))
471 (if (looking-at "<[^>]+>[ \t]+[-0-9~]+[ \t]+\\([^ /\t\n]+\\)/\\([0-9]+\\)[ \t\n]")
472 (cons (match-string 1) (string-to-int (match-string 2))))
473 (kill-buffer (current-buffer)))))
475 (defun nnspool-find-file (file)
476 "Insert FILE in server buffer safely."
477 (set-buffer nntp-server-buffer)
480 (progn (nnheader-insert-file-contents-literally file) t)
483 (defun nnspool-possibly-change-directory (group)
486 (let ((pathname (nnspool-article-pathname group)))
487 (if (file-directory-p pathname)
488 (setq nnspool-current-directory pathname
489 nnspool-current-group group)
490 (nnheader-report 'nnspool "No such newsgroup: %s" group)))))
492 (defun nnspool-article-pathname (group &optional article)
493 "Find the path for GROUP."
494 (nnheader-group-pathname group nnspool-spool-directory article))
496 (defun nnspool-seconds-since-epoch (date)
497 (let* ((tdate (mapcar (lambda (ti) (and ti (string-to-int ti)))
498 (timezone-parse-date date)))
499 (ttime (mapcar (lambda (ti) (and ti (string-to-int ti)))
501 (aref (timezone-parse-date date) 3))))
502 (unix (encode-time (nth 2 ttime) (nth 1 ttime) (nth 0 ttime)
503 (nth 2 tdate) (nth 1 tdate) (nth 0 tdate)
505 (+ (* (car unix) 65536.0)
510 ;;; nnspool.el ends here