1 ;;; nnspool.el --- spool access for GNU Emacs
3 ;; Copyright (C) 1988, 1989, 1990, 1993, 1994, 1995, 1996, 1997, 1998,
5 ;; Free Software Foundation, Inc.
7 ;; Author: Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
8 ;; Lars Magne Ingebrigtsen <larsi@gnus.org>
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software; you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation; either version 2, or (at your option)
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs; see the file COPYING. If not, write to the
25 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
26 ;; Boston, MA 02111-1307, USA.
32 (eval-when-compile (require 'cl))
38 (nnoo-declare nnspool)
40 (defvoo nnspool-inews-program news-inews-program
41 "Program to post news.
42 This is most commonly `inews' or `injnews'.")
44 (defvoo nnspool-inews-switches '("-h" "-S")
45 "Switches for nnspool-request-post to pass to `inews' for posting news.
46 If you are using Cnews, you probably should set this variable to nil.")
48 (defvoo nnspool-spool-directory (file-name-as-directory news-path)
49 "Local news spool directory.")
51 (defvoo nnspool-nov-directory (concat nnspool-spool-directory "over.view/")
52 "Local news nov directory.")
54 (defvoo nnspool-lib-dir
55 (if (file-exists-p "/usr/lib/news/active")
58 "Where the local news library files are stored.")
60 (defvoo nnspool-active-file (concat nnspool-lib-dir "active")
61 "Local news active file.")
63 (defvoo nnspool-newsgroups-file (concat nnspool-lib-dir "newsgroups")
64 "Local news newsgroups file.")
66 (defvoo nnspool-distributions-file (concat nnspool-lib-dir "distribs.pat")
67 "Local news distributions file.")
69 (defvoo nnspool-history-file (concat nnspool-lib-dir "history")
70 "Local news history file.")
72 (defvoo nnspool-active-times-file (concat nnspool-lib-dir "active.times")
73 "Local news active date file.")
75 (defvoo nnspool-large-newsgroup 50
76 "The number of articles which indicates a large newsgroup.
77 If the number of articles is greater than the value, verbose
78 messages will be shown to indicate the current status.")
80 (defvoo nnspool-nov-is-evil nil
81 "Non-nil means that nnspool will never return NOV lines instead of headers.")
83 (defconst nnspool-sift-nov-with-sed nil
84 "If non-nil, use sed to get the relevant portion from the overview file.
85 If nil, nnspool will load the entire file into a buffer and process it
88 (defvoo nnspool-rejected-article-hook nil
89 "*A hook that will be run when an article has been rejected by the server.")
91 (defvoo nnspool-file-coding-system nnheader-file-coding-system
92 "Coding system for nnspool.")
96 (defconst nnspool-version "nnspool 2.0"
97 "Version numbers of this version of NNSPOOL.")
99 (defvoo nnspool-current-directory nil
100 "Current news group directory.")
102 (defvoo nnspool-current-group nil)
103 (defvoo nnspool-status-string "")
106 ;;; Interface functions.
108 (nnoo-define-basics nnspool)
110 (deffoo nnspool-retrieve-headers (articles &optional group server fetch-old)
111 "Retrieve the headers of ARTICLES."
113 (set-buffer nntp-server-buffer)
115 (when (nnspool-possibly-change-directory group)
116 (let* ((number (length articles))
118 (default-directory nnspool-current-directory)
119 (do-message (and (numberp nnspool-large-newsgroup)
120 (> number nnspool-large-newsgroup)))
121 (nnheader-file-coding-system nnspool-file-coding-system)
123 (if (and (numberp (car articles))
124 (nnspool-retrieve-headers-with-nov articles fetch-old))
125 ;; We successfully retrieved the NOV headers.
127 ;; No NOV headers here, so we do it the hard way.
128 (while (setq article (pop articles))
129 (if (stringp article)
130 ;; This is a Message-ID.
131 (setq ag (nnspool-find-id article)
132 file (and ag (nnspool-article-pathname
135 ;; This is an article in the current group.
136 (setq file (int-to-string article)))
137 ;; Insert the head of the article.
139 (file-exists-p file))
141 (princ article (current-buffer))
142 (insert " Article retrieved.\n")
144 (inline (nnheader-insert-head file))
146 (if (search-forward "\n\n" nil t)
147 (progn (forward-char -1)
149 (goto-char (point-max))
153 (delete-region (point) (point-max)))
156 (zerop (% (incf count) 20))
157 (nnheader-message 5 "nnspool: Receiving headers... %d%%"
158 (/ (* count 100) number))))
161 (nnheader-message 5 "nnspool: Receiving headers...done"))
163 ;; Fold continuation lines.
164 (nnheader-fold-continuation-lines)
167 (deffoo nnspool-open-server (server &optional defs)
168 (nnoo-change-server 'nnspool server defs)
170 ((not (file-exists-p nnspool-spool-directory))
171 (nnspool-close-server)
172 (nnheader-report 'nnspool "Spool directory doesn't exist: %s"
173 nnspool-spool-directory))
174 ((not (file-directory-p
176 (file-truename nnspool-spool-directory))))
177 (nnspool-close-server)
178 (nnheader-report 'nnspool "Not a directory: %s" nnspool-spool-directory))
179 ((not (file-exists-p nnspool-active-file))
180 (nnheader-report 'nnspool "The active file doesn't exist: %s"
181 nnspool-active-file))
183 (nnheader-report 'nnspool "Opened server %s using directory %s"
184 server nnspool-spool-directory)
187 (deffoo nnspool-request-article (id &optional group server buffer)
188 "Select article by message ID (or number)."
189 (nnspool-possibly-change-directory group)
190 (let ((nntp-server-buffer (or buffer nntp-server-buffer))
193 ;; This is a Message-ID.
194 (when (setq ag (nnspool-find-id id))
195 (setq file (nnspool-article-pathname (car ag) (cdr ag))))
196 (setq file (nnspool-article-pathname nnspool-current-group id)))
199 (not (file-directory-p file))
200 (save-excursion (nnspool-find-file file))
201 ;; We return the article number and group name.
203 (cons nnspool-current-group id)
206 (deffoo nnspool-request-body (id &optional group server)
207 "Select article body by message ID (or number)."
208 (nnspool-possibly-change-directory group)
209 (let ((res (nnspool-request-article id)))
212 (set-buffer nntp-server-buffer)
213 (goto-char (point-min))
214 (when (search-forward "\n\n" nil t)
215 (delete-region (point-min) (point)))
218 (deffoo nnspool-request-head (id &optional group server)
219 "Select article head by message ID (or number)."
220 (nnspool-possibly-change-directory group)
221 (let ((res (nnspool-request-article id)))
224 (set-buffer nntp-server-buffer)
225 (goto-char (point-min))
226 (when (search-forward "\n\n" nil t)
227 (delete-region (1- (point)) (point-max)))
228 (nnheader-fold-continuation-lines)))
231 (deffoo nnspool-request-group (group &optional server dont-check)
233 (let ((pathname (nnspool-article-pathname group))
235 (if (not (file-directory-p pathname))
237 'nnspool "Invalid group name (no such directory): %s" group)
238 (setq nnspool-current-directory pathname)
239 (nnheader-report 'nnspool "Selected group %s" group)
242 (nnheader-report 'nnspool "Selected group %s" group)
244 ;; Yes, completely empty spool directories *are* possible.
245 ;; Fix by Sudish Joseph <joseph@cis.ohio-state.edu>
246 (when (setq dir (directory-files pathname nil "^[0-9]+$" t))
247 (setq dir (sort (mapcar 'string-to-int dir) '<)))
250 "211 %d %d %d %s\n" (length dir) (car dir)
251 (car (last dir)) group)
252 (nnheader-report 'nnspool "Empty group %s" group)
253 (nnheader-insert "211 0 0 0 %s\n" group))))))
255 (deffoo nnspool-request-type (group &optional article)
258 (deffoo nnspool-close-group (group &optional server)
261 (deffoo nnspool-request-list (&optional server)
262 "List active newsgroups."
264 (or (nnspool-find-file nnspool-active-file)
265 (nnheader-report 'nnspool (nnheader-file-error nnspool-active-file)))))
267 (deffoo nnspool-request-list-newsgroups (&optional server)
268 "List newsgroups (defined in NNTP2)."
270 (or (nnspool-find-file nnspool-newsgroups-file)
271 (nnheader-report 'nnspool (nnheader-file-error
272 nnspool-newsgroups-file)))))
274 (deffoo nnspool-request-list-distributions (&optional server)
275 "List distributions (defined in NNTP2)."
277 (or (nnspool-find-file nnspool-distributions-file)
278 (nnheader-report 'nnspool (nnheader-file-error
279 nnspool-distributions-file)))))
281 ;; Suggested by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
282 (deffoo nnspool-request-newgroups (date &optional server)
283 "List groups created after DATE."
284 (if (nnspool-find-file nnspool-active-times-file)
286 ;; Find the last valid line.
287 (goto-char (point-max))
288 (while (and (not (looking-at
289 "\\([^ ]+\\) +\\([0-9]+\\)[0-9][0-9][0-9] "))
290 (zerop (forward-line -1))))
291 (let ((seconds (time-to-seconds (date-to-time date)))
293 ;; Go through lines and add the latest groups to a list.
294 (while (and (looking-at "\\([^ ]+\\) +[0-9]+ ")
296 ;; We insert a .0 to make the list reader
297 ;; interpret the number as a float. It is far
298 ;; too big to be stored in a lisp integer.
299 (goto-char (1- (match-end 0)))
302 (goto-char (match-end 1))
303 (read (current-buffer)))
305 (push (buffer-substring
306 (match-beginning 1) (match-end 1))
308 (zerop (forward-line -1))))
310 (dolist (group groups)
311 (insert group " 0 0 y\n")))
315 (deffoo nnspool-request-post (&optional server)
316 "Post a new news in current buffer."
318 (let* ((process-connection-type nil) ; t bugs out on Solaris
319 (inews-buffer (generate-new-buffer " *nnspool post*"))
322 (apply 'start-process "*nnspool inews*" inews-buffer
323 nnspool-inews-program nnspool-inews-switches)
325 (nnheader-report 'nnspool "inews error: %S" err)))))
327 ;; The inews program failed.
329 (nnheader-report 'nnspool "")
330 (set-process-sentinel proc 'nnspool-inews-sentinel)
331 (mm-with-unibyte-current-buffer
332 (process-send-region proc (point-min) (point-max)))
333 ;; We slap a condition-case around this, because the process may
334 ;; have exited already...
336 (process-send-eof proc))
341 ;;; Internal functions.
343 (defun nnspool-inews-sentinel (proc status)
345 (set-buffer (process-buffer proc))
346 (goto-char (point-min))
347 (if (or (zerop (buffer-size))
348 (search-forward "spooled" nil t))
349 (kill-buffer (current-buffer))
350 ;; Make status message by folding lines.
351 (while (re-search-forward "[ \t\n]+" nil t)
352 (replace-match " " t t))
353 (nnheader-report 'nnspool "%s" (buffer-string))
354 (nnheader-message 5 "nnspool: %s" nnspool-status-string)
356 (run-hooks 'nnspool-rejected-article-hook))))
358 (defun nnspool-retrieve-headers-with-nov (articles &optional fetch-old)
359 (if (or gnus-nov-is-evil nnspool-nov-is-evil)
361 (let ((nov (nnheader-group-pathname
362 nnspool-current-group nnspool-nov-directory ".overview"))
364 (nnheader-file-coding-system nnspool-file-coding-system)
366 (if (not (file-exists-p nov))
369 (set-buffer nntp-server-buffer)
371 (if nnspool-sift-nov-with-sed
372 (nnspool-sift-nov-with-sed articles nov)
373 (nnheader-insert-file-contents nov)
375 (not (numberp fetch-old)))
376 t ; We want all the headers.
378 ;; Delete unwanted NOV lines.
379 (nnheader-nov-delete-outside-range
380 (if fetch-old (max 1 (- (car articles) fetch-old))
382 (car (last articles)))
383 ;; If the buffer is empty, this wasn't very successful.
384 (unless (zerop (buffer-size))
385 ;; We check what the last article number was.
386 ;; The NOV file may be out of sync with the articles
389 (setq last (read (current-buffer)))
390 (if (= last (car articles))
391 ;; Yup, it's all there.
393 ;; Perhaps not. We try to find the missing articles.
395 (<= last (car arts)))
397 ;; The articles in `arts' are missing from the buffer.
398 (mapc 'nnspool-insert-nov-head arts)
401 (defun nnspool-insert-nov-head (article)
402 "Read the head of ARTICLE, convert to NOV headers, and insert."
404 (let ((cur (current-buffer))
406 (setq buf (nnheader-set-temp-buffer " *nnspool head*"))
407 (when (nnheader-insert-head
408 (nnspool-article-pathname nnspool-current-group article))
409 (nnheader-insert-article-line article)
410 (let ((headers (nnheader-parse-head)))
412 (goto-char (point-max))
413 (nnheader-insert-nov headers)))
416 (defun nnspool-sift-nov-with-sed (articles file)
417 (let ((first (car articles))
418 (last (car (last articles))))
419 (call-process "awk" nil t nil
420 (format "BEGIN {firstmsg=%d; lastmsg=%d;}\n $1 >= firstmsg && $1 <= lastmsg {print;}"
421 (1- first) (1+ last))
424 ;; Fixed by fdc@cliwe.ping.de (Frank D. Cringle).
425 ;; Find out what group an article identified by a Message-ID is in.
426 (defun nnspool-find-id (id)
429 (call-process "grep" nil t nil (regexp-quote id) nnspool-history-file))
430 (goto-char (point-min))
431 (when (looking-at "<[^>]+>[ \t]+[-0-9~]+[ \t]+\\([^ /\t\n]+\\)/\\([0-9]+\\)[ \t\n]")
432 (cons (match-string 1) (string-to-int (match-string 2))))))
434 (defun nnspool-find-file (file)
435 "Insert FILE in server buffer safely."
436 (set-buffer nntp-server-buffer)
439 (let ((nnheader-file-coding-system nnspool-file-coding-system))
440 (nnheader-insert-file-contents file)
444 (defun nnspool-possibly-change-directory (group)
447 (let ((pathname (nnspool-article-pathname group)))
448 (if (file-directory-p pathname)
449 (setq nnspool-current-directory pathname
450 nnspool-current-group group)
451 (nnheader-report 'nnspool "No such newsgroup: %s" group)))))
453 (defun nnspool-article-pathname (group &optional article)
454 "Find the file name for GROUP."
455 (nnheader-group-pathname group nnspool-spool-directory article))
459 ;;; nnspool.el ends here