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.
35 (eval-when-compile (require 'cl
))
37 (nnoo-declare nnspool
)
39 (defvoo nnspool-inews-program news-inews-program
40 "Program to post news.
41 This is most commonly `inews' or `injnews'.")
43 (defvoo nnspool-inews-switches
'("-h" "-S")
44 "Switches for nnspool-request-post to pass to `inews' for posting news.
45 If you are using Cnews, you probably should set this variable to nil.")
47 (defvoo nnspool-spool-directory
(file-name-as-directory news-path
)
48 "Local news spool directory.")
50 (defvoo nnspool-nov-directory
(concat nnspool-spool-directory
"over.view/")
51 "Local news nov directory.")
53 (defvoo nnspool-lib-dir
"/usr/lib/news/"
54 "Where the local news library files are stored.")
56 (defvoo nnspool-active-file
(concat nnspool-lib-dir
"active")
57 "Local news active file.")
59 (defvoo nnspool-newsgroups-file
(concat nnspool-lib-dir
"newsgroups")
60 "Local news newsgroups file.")
62 (defvoo nnspool-distributions-file
(concat nnspool-lib-dir
"distribs.pat")
63 "Local news distributions file.")
65 (defvoo nnspool-history-file
(concat nnspool-lib-dir
"history")
66 "Local news history file.")
68 (defvoo nnspool-active-times-file
(concat nnspool-lib-dir
"active.times")
69 "Local news active date file.")
71 (defvoo nnspool-large-newsgroup
50
72 "The number of the articles which indicates a large newsgroup.
73 If the number of the articles is greater than the value, verbose
74 messages will be shown to indicate the current status.")
76 (defvoo nnspool-nov-is-evil nil
77 "Non-nil means that nnspool will never return NOV lines instead of headers.")
79 (defconst nnspool-sift-nov-with-sed nil
80 "If non-nil, use sed to get the relevant portion from the overview file.
81 If nil, nnspool will load the entire file into a buffer and process it
84 (defvoo nnspool-rejected-article-hook nil
85 "*A hook that will be run when an article has been rejected by the server.")
87 (defvoo nnspool-file-coding-system nnheader-file-coding-system
88 "Coding system for nnspool.")
92 (defconst nnspool-version
"nnspool 2.0"
93 "Version numbers of this version of NNSPOOL.")
95 (defvoo nnspool-current-directory nil
96 "Current news group directory.")
98 (defvoo nnspool-current-group nil
)
99 (defvoo nnspool-status-string
"")
102 ;;; Interface functions.
104 (nnoo-define-basics nnspool
)
106 (deffoo nnspool-retrieve-headers
(articles &optional group server fetch-old
)
107 "Retrieve the headers of ARTICLES."
109 (set-buffer nntp-server-buffer
)
111 (when (nnspool-possibly-change-directory group
)
112 (let* ((number (length articles
))
114 (default-directory nnspool-current-directory
)
115 (do-message (and (numberp nnspool-large-newsgroup
)
116 (> number nnspool-large-newsgroup
)))
117 (nnheader-file-coding-system nnspool-file-coding-system
)
119 (if (and (numberp (car articles
))
120 (nnspool-retrieve-headers-with-nov articles fetch-old
))
121 ;; We successfully retrieved the NOV headers.
123 ;; No NOV headers here, so we do it the hard way.
124 (while (setq article
(pop articles
))
125 (if (stringp article
)
126 ;; This is a Message-ID.
127 (setq ag
(nnspool-find-id article
)
128 file
(and ag
(nnspool-article-pathname
131 ;; This is an article in the current group.
132 (setq file
(int-to-string article
)))
133 ;; Insert the head of the article.
135 (file-exists-p file
))
137 (princ article
(current-buffer))
138 (insert " Article retrieved.\n")
140 (inline (nnheader-insert-head file
))
142 (if (search-forward "\n\n" nil t
)
146 (goto-char (point-max))
150 (delete-region (point) (point-max)))
153 (zerop (%
(incf count
) 20))
154 (nnheader-message 5 "nnspool: Receiving headers... %d%%"
155 (/ (* count
100) number
))))
158 (nnheader-message 5 "nnspool: Receiving headers...done"))
160 ;; Fold continuation lines.
161 (nnheader-fold-continuation-lines)
164 (deffoo nnspool-open-server
(server &optional defs
)
165 (nnoo-change-server 'nnspool server defs
)
167 ((not (file-exists-p nnspool-spool-directory
))
168 (nnspool-close-server)
169 (nnheader-report 'nnspool
"Spool directory doesn't exist: %s"
170 nnspool-spool-directory
))
171 ((not (file-directory-p
173 (file-truename nnspool-spool-directory
))))
174 (nnspool-close-server)
175 (nnheader-report 'nnspool
"Not a directory: %s" nnspool-spool-directory
))
176 ((not (file-exists-p nnspool-active-file
))
177 (nnheader-report 'nnspool
"The active file doesn't exist: %s"
178 nnspool-active-file
))
180 (nnheader-report 'nnspool
"Opened server %s using directory %s"
181 server nnspool-spool-directory
)
184 (deffoo nnspool-request-article
(id &optional group server buffer
)
185 "Select article by message ID (or number)."
186 (nnspool-possibly-change-directory group
)
187 (let ((nntp-server-buffer (or buffer nntp-server-buffer
))
190 ;; This is a Message-ID.
191 (when (setq ag
(nnspool-find-id id
))
192 (setq file
(nnspool-article-pathname (car ag
) (cdr ag
))))
193 (setq file
(nnspool-article-pathname nnspool-current-group id
)))
196 (not (file-directory-p file
))
197 (save-excursion (nnspool-find-file file
))
198 ;; We return the article number and group name.
200 (cons nnspool-current-group id
)
203 (deffoo nnspool-request-body
(id &optional group server
)
204 "Select article body by message ID (or number)."
205 (nnspool-possibly-change-directory group
)
206 (let ((res (nnspool-request-article id
)))
209 (set-buffer nntp-server-buffer
)
210 (goto-char (point-min))
211 (when (search-forward "\n\n" nil t
)
212 (delete-region (point-min) (point)))
215 (deffoo nnspool-request-head
(id &optional group server
)
216 "Select article head by message ID (or number)."
217 (nnspool-possibly-change-directory group
)
218 (let ((res (nnspool-request-article id
)))
221 (set-buffer nntp-server-buffer
)
222 (goto-char (point-min))
223 (when (search-forward "\n\n" nil t
)
224 (delete-region (1- (point)) (point-max)))
225 (nnheader-fold-continuation-lines)))
228 (deffoo nnspool-request-group
(group &optional server dont-check
)
230 (let ((pathname (nnspool-article-pathname group
))
232 (if (not (file-directory-p pathname
))
234 'nnspool
"Invalid group name (no such directory): %s" group
)
235 (setq nnspool-current-directory pathname
)
236 (nnheader-report 'nnspool
"Selected group %s" group
)
239 (nnheader-report 'nnspool
"Selected group %s" group
)
241 ;; Yes, completely empty spool directories *are* possible.
242 ;; Fix by Sudish Joseph <joseph@cis.ohio-state.edu>
243 (when (setq dir
(directory-files pathname nil
"^[0-9]+$" t
))
245 (sort (mapcar (lambda (name) (string-to-int name
)) dir
) '<)))
248 "211 %d %d %d %s\n" (length dir
) (car dir
)
249 (progn (while (cdr dir
) (setq dir
(cdr dir
))) (car dir
))
251 (nnheader-report 'nnspool
"Empty group %s" group
)
252 (nnheader-insert "211 0 0 0 %s\n" group
))))))
254 (deffoo nnspool-request-type
(group &optional article
)
257 (deffoo nnspool-close-group
(group &optional server
)
260 (deffoo nnspool-request-list
(&optional server
)
261 "List active newsgroups."
263 (or (nnspool-find-file nnspool-active-file
)
264 (nnheader-report 'nnspool
(nnheader-file-error nnspool-active-file
)))))
266 (deffoo nnspool-request-list-newsgroups
(&optional server
)
267 "List newsgroups (defined in NNTP2)."
269 (or (nnspool-find-file nnspool-newsgroups-file
)
270 (nnheader-report 'nnspool
(nnheader-file-error
271 nnspool-newsgroups-file
)))))
273 (deffoo nnspool-request-list-distributions
(&optional server
)
274 "List distributions (defined in NNTP2)."
276 (or (nnspool-find-file nnspool-distributions-file
)
277 (nnheader-report 'nnspool
(nnheader-file-error
278 nnspool-distributions-file
)))))
280 ;; Suggested by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
281 (deffoo nnspool-request-newgroups
(date &optional server
)
282 "List groups created after DATE."
283 (if (nnspool-find-file nnspool-active-times-file
)
285 ;; Find the last valid line.
286 (goto-char (point-max))
287 (while (and (not (looking-at
288 "\\([^ ]+\\) +\\([0-9]+\\)[0-9][0-9][0-9] "))
289 (zerop (forward-line -
1))))
290 (let ((seconds (time-to-seconds (date-to-time date
)))
292 ;; Go through lines and add the latest groups to a list.
293 (while (and (looking-at "\\([^ ]+\\) +[0-9]+ ")
295 ;; We insert a .0 to make the list reader
296 ;; interpret the number as a float. It is far
297 ;; too big to be stored in a lisp integer.
298 (goto-char (1- (match-end 0)))
301 (goto-char (match-end 1))
302 (read (current-buffer)))
304 (push (buffer-substring
305 (match-beginning 1) (match-end 1))
307 (zerop (forward-line -
1))))
310 (insert (car groups
) " 0 0 y\n")
311 (setq groups
(cdr groups
))))
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.
399 (nnspool-insert-nov-head (pop arts
)))
402 (defun nnspool-insert-nov-head (article)
403 "Read the head of ARTICLE, convert to NOV headers, and insert."
405 (let ((cur (current-buffer))
407 (setq buf
(nnheader-set-temp-buffer " *nnspool head*"))
408 (when (nnheader-insert-head
409 (nnspool-article-pathname nnspool-current-group article
))
410 (nnheader-insert-article-line article
)
411 (let ((headers (nnheader-parse-head)))
413 (goto-char (point-max))
414 (nnheader-insert-nov headers
)))
417 (defun nnspool-sift-nov-with-sed (articles file
)
418 (let ((first (car articles
))
419 (last (progn (while (cdr articles
) (setq articles
(cdr articles
)))
421 (call-process "awk" nil t nil
422 (format "BEGIN {firstmsg=%d; lastmsg=%d;}\n $1 >= firstmsg && $1 <= lastmsg {print;}"
423 (1- first
) (1+ last
))
426 ;; Fixed by fdc@cliwe.ping.de (Frank D. Cringle).
427 ;; Find out what group an article identified by a Message-ID is in.
428 (defun nnspool-find-id (id)
430 (set-buffer (get-buffer-create " *nnspool work*"))
433 (call-process "grep" nil t nil
(regexp-quote id
) nnspool-history-file
))
434 (goto-char (point-min))
436 (when (looking-at "<[^>]+>[ \t]+[-0-9~]+[ \t]+\\([^ /\t\n]+\\)/\\([0-9]+\\)[ \t\n]")
437 (cons (match-string 1) (string-to-int (match-string 2))))
438 (kill-buffer (current-buffer)))))
440 (defun nnspool-find-file (file)
441 "Insert FILE in server buffer safely."
442 (set-buffer nntp-server-buffer
)
445 (let ((coding-system-for-read nnspool-file-coding-system
))
446 (mm-insert-file-contents file
)
450 (defun nnspool-possibly-change-directory (group)
453 (let ((pathname (nnspool-article-pathname group
)))
454 (if (file-directory-p pathname
)
455 (setq nnspool-current-directory pathname
456 nnspool-current-group group
)
457 (nnheader-report 'nnspool
"No such newsgroup: %s" group
)))))
459 (defun nnspool-article-pathname (group &optional article
)
460 "Find the file name for GROUP."
461 (nnheader-group-pathname group nnspool-spool-directory article
))
465 ;;; nnspool.el ends here