1 ;;; nnspool.el --- spool access for GNU Emacs
2 ;; Copyright (C) 1988,89,90,93,94,95,96,97,98 Free Software Foundation, Inc.
4 ;; Author: Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
5 ;; Lars Magne Ingebrigtsen <larsi@gnus.org>
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.
32 (eval-when-compile (require 'cl))
34 (nnoo-declare nnspool)
36 (defvoo nnspool-inews-program news-inews-program
37 "Program to post news.
38 This is most commonly `inews' or `injnews'.")
40 (defvoo nnspool-inews-switches '("-h" "-S")
41 "Switches for nnspool-request-post to pass to `inews' for posting news.
42 If you are using Cnews, you probably should set this variable to nil.")
44 (defvoo nnspool-spool-directory (file-name-as-directory news-path)
45 "Local news spool directory.")
47 (defvoo nnspool-nov-directory (concat nnspool-spool-directory "over.view/")
48 "Local news nov directory.")
50 (defvoo nnspool-lib-dir "/usr/lib/news/"
51 "Where the local news library files are stored.")
53 (defvoo nnspool-active-file (concat nnspool-lib-dir "active")
54 "Local news active file.")
56 (defvoo nnspool-newsgroups-file (concat nnspool-lib-dir "newsgroups")
57 "Local news newsgroups file.")
59 (defvoo nnspool-distributions-file (concat nnspool-lib-dir "distribs.pat")
60 "Local news distributions file.")
62 (defvoo nnspool-history-file (concat nnspool-lib-dir "history")
63 "Local news history file.")
65 (defvoo nnspool-active-times-file (concat nnspool-lib-dir "active.times")
66 "Local news active date file.")
68 (defvoo nnspool-large-newsgroup 50
69 "The number of the articles which indicates a large newsgroup.
70 If the number of the articles is greater than the value, verbose
71 messages will be shown to indicate the current status.")
73 (defvoo nnspool-nov-is-evil nil
74 "Non-nil means that nnspool will never return NOV lines instead of headers.")
76 (defconst nnspool-sift-nov-with-sed nil
77 "If non-nil, use sed to get the relevant portion from the overview file.
78 If nil, nnspool will load the entire file into a buffer and process it
81 (defvoo nnspool-rejected-article-hook nil
82 "*A hook that will be run when an article has been rejected by the server.")
84 (defvoo nnspool-file-coding-system nnheader-file-coding-system
85 "Coding system for nnspool.")
89 (defconst nnspool-version "nnspool 2.0"
90 "Version numbers of this version of NNSPOOL.")
92 (defvoo nnspool-current-directory nil
93 "Current news group directory.")
95 (defvoo nnspool-current-group nil)
96 (defvoo nnspool-status-string "")
99 ;;; Interface functions.
101 (nnoo-define-basics nnspool)
103 (deffoo nnspool-retrieve-headers (articles &optional group server fetch-old)
104 "Retrieve the headers of ARTICLES."
106 (set-buffer nntp-server-buffer)
108 (when (nnspool-possibly-change-directory group)
109 (let* ((number (length articles))
111 (default-directory nnspool-current-directory)
112 (do-message (and (numberp nnspool-large-newsgroup)
113 (> number nnspool-large-newsgroup)))
114 (nnheader-file-coding-system nnspool-file-coding-system)
116 (if (and (numberp (car articles))
117 (nnspool-retrieve-headers-with-nov articles fetch-old))
118 ;; We successfully retrieved the NOV headers.
120 ;; No NOV headers here, so we do it the hard way.
121 (while (setq article (pop articles))
122 (if (stringp article)
123 ;; This is a Message-ID.
124 (setq ag (nnspool-find-id article)
125 file (and ag (nnspool-article-pathname
128 ;; This is an article in the current group.
129 (setq file (int-to-string article)))
130 ;; Insert the head of the article.
132 (file-exists-p file))
134 (princ article (current-buffer))
135 (insert " Article retrieved.\n")
137 (inline (nnheader-insert-head file))
139 (if (search-forward "\n\n" nil t)
143 (goto-char (point-max))
147 (delete-region (point) (point-max)))
150 (zerop (% (incf count) 20))
151 (nnheader-message 5 "nnspool: Receiving headers... %d%%"
152 (/ (* count 100) number))))
155 (nnheader-message 5 "nnspool: Receiving headers...done"))
157 ;; Fold continuation lines.
158 (nnheader-fold-continuation-lines)
161 (deffoo nnspool-open-server (server &optional defs)
162 (nnoo-change-server 'nnspool server defs)
164 ((not (file-exists-p nnspool-spool-directory))
165 (nnspool-close-server)
166 (nnheader-report 'nnspool "Spool directory doesn't exist: %s"
167 nnspool-spool-directory))
168 ((not (file-directory-p
170 (file-truename nnspool-spool-directory))))
171 (nnspool-close-server)
172 (nnheader-report 'nnspool "Not a directory: %s" nnspool-spool-directory))
173 ((not (file-exists-p nnspool-active-file))
174 (nnheader-report 'nnspool "The active file doesn't exist: %s"
175 nnspool-active-file))
177 (nnheader-report 'nnspool "Opened server %s using directory %s"
178 server nnspool-spool-directory)
181 (deffoo nnspool-request-article (id &optional group server buffer)
182 "Select article by message ID (or number)."
183 (nnspool-possibly-change-directory group)
184 (let ((nntp-server-buffer (or buffer nntp-server-buffer))
187 ;; This is a Message-ID.
188 (when (setq ag (nnspool-find-id id))
189 (setq file (nnspool-article-pathname (car ag) (cdr ag))))
190 (setq file (nnspool-article-pathname nnspool-current-group id)))
193 (not (file-directory-p file))
194 (save-excursion (nnspool-find-file file))
195 ;; We return the article number and group name.
197 (cons nnspool-current-group id)
200 (deffoo nnspool-request-body (id &optional group server)
201 "Select article body by message ID (or number)."
202 (nnspool-possibly-change-directory group)
203 (let ((res (nnspool-request-article id)))
206 (set-buffer nntp-server-buffer)
207 (goto-char (point-min))
208 (when (search-forward "\n\n" nil t)
209 (delete-region (point-min) (point)))
212 (deffoo nnspool-request-head (id &optional group server)
213 "Select article head by message ID (or number)."
214 (nnspool-possibly-change-directory group)
215 (let ((res (nnspool-request-article id)))
218 (set-buffer nntp-server-buffer)
219 (goto-char (point-min))
220 (when (search-forward "\n\n" nil t)
221 (delete-region (1- (point)) (point-max)))
222 (nnheader-fold-continuation-lines)))
225 (deffoo nnspool-request-group (group &optional server dont-check)
227 (let ((pathname (nnspool-article-pathname group))
229 (if (not (file-directory-p pathname))
231 'nnspool "Invalid group name (no such directory): %s" group)
232 (setq nnspool-current-directory pathname)
233 (nnheader-report 'nnspool "Selected group %s" group)
236 (nnheader-report 'nnspool "Selected group %s" group)
238 ;; Yes, completely empty spool directories *are* possible.
239 ;; Fix by Sudish Joseph <joseph@cis.ohio-state.edu>
240 (when (setq dir (directory-files pathname nil "^[0-9]+$" t))
242 (sort (mapcar (lambda (name) (string-to-int name)) dir) '<)))
245 "211 %d %d %d %s\n" (length dir) (car dir)
246 (progn (while (cdr dir) (setq dir (cdr dir))) (car dir))
248 (nnheader-report 'nnspool "Empty group %s" group)
249 (nnheader-insert "211 0 0 0 %s\n" group))))))
251 (deffoo nnspool-request-type (group &optional article)
254 (deffoo nnspool-close-group (group &optional server)
257 (deffoo nnspool-request-list (&optional server)
258 "List active newsgroups."
260 (or (nnspool-find-file nnspool-active-file)
261 (nnheader-report 'nnspool (nnheader-file-error nnspool-active-file)))))
263 (deffoo nnspool-request-list-newsgroups (&optional server)
264 "List newsgroups (defined in NNTP2)."
266 (or (nnspool-find-file nnspool-newsgroups-file)
267 (nnheader-report 'nnspool (nnheader-file-error
268 nnspool-newsgroups-file)))))
270 (deffoo nnspool-request-list-distributions (&optional server)
271 "List distributions (defined in NNTP2)."
273 (or (nnspool-find-file nnspool-distributions-file)
274 (nnheader-report 'nnspool (nnheader-file-error
275 nnspool-distributions-file)))))
277 ;; Suggested by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
278 (deffoo nnspool-request-newgroups (date &optional server)
279 "List groups created after DATE."
280 (if (nnspool-find-file nnspool-active-times-file)
282 ;; Find the last valid line.
283 (goto-char (point-max))
284 (while (and (not (looking-at
285 "\\([^ ]+\\) +\\([0-9]+\\)[0-9][0-9][0-9] "))
286 (zerop (forward-line -1))))
287 (let ((seconds (time-to-seconds (date-to-time date)))
289 ;; Go through lines and add the latest groups to a list.
290 (while (and (looking-at "\\([^ ]+\\) +[0-9]+ ")
292 ;; We insert a .0 to make the list reader
293 ;; interpret the number as a float. It is far
294 ;; too big to be stored in a lisp integer.
295 (goto-char (1- (match-end 0)))
298 (goto-char (match-end 1))
299 (read (current-buffer)))
301 (push (buffer-substring
302 (match-beginning 1) (match-end 1))
304 (zerop (forward-line -1))))
307 (insert (car groups) " 0 0 y\n")
308 (setq groups (cdr groups))))
312 (deffoo nnspool-request-post (&optional server)
313 "Post a new news in current buffer."
315 (let* ((process-connection-type nil) ; t bugs out on Solaris
316 (inews-buffer (generate-new-buffer " *nnspool post*"))
319 (apply 'start-process "*nnspool inews*" inews-buffer
320 nnspool-inews-program nnspool-inews-switches)
322 (nnheader-report 'nnspool "inews error: %S" err)))))
324 ;; The inews program failed.
326 (nnheader-report 'nnspool "")
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...
332 (process-send-eof proc))
337 ;;; Internal functions.
339 (defun nnspool-inews-sentinel (proc status)
341 (set-buffer (process-buffer proc))
342 (goto-char (point-min))
343 (if (or (zerop (buffer-size))
344 (search-forward "spooled" nil t))
345 (kill-buffer (current-buffer))
346 ;; Make status message by folding lines.
347 (while (re-search-forward "[ \t\n]+" nil t)
348 (replace-match " " t t))
349 (nnheader-report 'nnspool "%s" (buffer-string))
350 (nnheader-message 5 "nnspool: %s" nnspool-status-string)
352 (run-hooks 'nnspool-rejected-article-hook))))
354 (defun nnspool-retrieve-headers-with-nov (articles &optional fetch-old)
355 (if (or gnus-nov-is-evil nnspool-nov-is-evil)
357 (let ((nov (nnheader-group-pathname
358 nnspool-current-group nnspool-nov-directory ".overview"))
360 (nnheader-file-coding-system nnspool-file-coding-system)
362 (if (not (file-exists-p nov))
365 (set-buffer nntp-server-buffer)
367 (if nnspool-sift-nov-with-sed
368 (nnspool-sift-nov-with-sed articles nov)
369 (nnheader-insert-file-contents nov)
371 (not (numberp fetch-old)))
372 t ; We want all the headers.
374 ;; Delete unwanted NOV lines.
375 (nnheader-nov-delete-outside-range
376 (if fetch-old (max 1 (- (car articles) fetch-old))
378 (car (last articles)))
379 ;; If the buffer is empty, this wasn't very successful.
380 (unless (zerop (buffer-size))
381 ;; We check what the last article number was.
382 ;; The NOV file may be out of sync with the articles
385 (setq last (read (current-buffer)))
386 (if (= last (car articles))
387 ;; Yup, it's all there.
389 ;; Perhaps not. We try to find the missing articles.
391 (<= last (car arts)))
393 ;; The articles in `arts' are missing from the buffer.
395 (nnspool-insert-nov-head (pop arts)))
398 (defun nnspool-insert-nov-head (article)
399 "Read the head of ARTICLE, convert to NOV headers, and insert."
401 (let ((cur (current-buffer))
403 (setq buf (nnheader-set-temp-buffer " *nnspool head*"))
404 (when (nnheader-insert-head
405 (nnspool-article-pathname nnspool-current-group article))
406 (nnheader-insert-article-line article)
407 (let ((headers (nnheader-parse-head)))
409 (goto-char (point-max))
410 (nnheader-insert-nov headers)))
413 (defun nnspool-sift-nov-with-sed (articles file)
414 (let ((first (car articles))
415 (last (progn (while (cdr articles) (setq articles (cdr articles)))
417 (call-process "awk" nil t nil
418 (format "BEGIN {firstmsg=%d; lastmsg=%d;}\n $1 >= firstmsg && $1 <= lastmsg {print;}"
419 (1- first) (1+ last))
422 ;; Fixed by fdc@cliwe.ping.de (Frank D. Cringle).
423 ;; Find out what group an article identified by a Message-ID is in.
424 (defun nnspool-find-id (id)
426 (set-buffer (get-buffer-create " *nnspool work*"))
429 (call-process "grep" nil t nil (regexp-quote id) nnspool-history-file))
430 (goto-char (point-min))
432 (when (looking-at "<[^>]+>[ \t]+[-0-9~]+[ \t]+\\([^ /\t\n]+\\)/\\([0-9]+\\)[ \t\n]")
433 (cons (match-string 1) (string-to-int (match-string 2))))
434 (kill-buffer (current-buffer)))))
436 (defun nnspool-find-file (file)
437 "Insert FILE in server buffer safely."
438 (set-buffer nntp-server-buffer)
441 (let ((coding-system-for-read nnspool-file-coding-system))
442 (mm-insert-file-contents file)
446 (defun nnspool-possibly-change-directory (group)
449 (let ((pathname (nnspool-article-pathname group)))
450 (if (file-directory-p pathname)
451 (setq nnspool-current-directory pathname
452 nnspool-current-group group)
453 (nnheader-report 'nnspool "No such newsgroup: %s" group)))))
455 (defun nnspool-article-pathname (group &optional article)
456 "Find the path for GROUP."
457 (nnheader-group-pathname group nnspool-spool-directory article))
461 ;;; nnspool.el ends here