1 ;;; nnspool.el --- spool access for GNU Emacs
3 ;; Copyright (C) 1988, 1989, 1990, 1993, 1994, 1995, 1996, 1997, 1998,
4 ;; 2000, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
6 ;; Author: Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
7 ;; Lars Magne Ingebrigtsen <larsi@gnus.org>
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 2, or (at your option)
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
25 ;; Boston, MA 02110-1301, USA.
34 (eval-when-compile (require 'cl
))
36 (nnoo-declare nnspool
)
38 (defvoo nnspool-inews-program news-inews-program
39 "Program to post news.
40 This is most commonly `inews' or `injnews'.")
42 (defvoo nnspool-inews-switches
'("-h" "-S")
43 "Switches for nnspool-request-post to pass to `inews' for posting news.
44 If you are using Cnews, you probably should set this variable to nil.")
46 (defvoo nnspool-spool-directory
47 (file-name-as-directory (if (boundp 'news-directory
)
48 (symbol-value 'news-directory
)
50 "Local news spool directory.")
52 (defvoo nnspool-nov-directory
(concat nnspool-spool-directory
"over.view/")
53 "Local news nov directory.")
55 (defvoo nnspool-lib-dir
56 (if (file-exists-p "/usr/lib/news/active")
59 "Where the local news library files are stored.")
61 (defvoo nnspool-active-file
(concat nnspool-lib-dir
"active")
62 "Local news active file.")
64 (defvoo nnspool-newsgroups-file
(concat nnspool-lib-dir
"newsgroups")
65 "Local news newsgroups file.")
67 (defvoo nnspool-distributions-file
(concat nnspool-lib-dir
"distribs.pat")
68 "Local news distributions file.")
70 (defvoo nnspool-history-file
(concat nnspool-lib-dir
"history")
71 "Local news history file.")
73 (defvoo nnspool-active-times-file
(concat nnspool-lib-dir
"active.times")
74 "Local news active date file.")
76 (defvoo nnspool-large-newsgroup
50
77 "The number of articles which indicates a large newsgroup.
78 If the number of articles is greater than the value, verbose
79 messages will be shown to indicate the current status.")
81 (defvoo nnspool-nov-is-evil nil
82 "Non-nil means that nnspool will never return NOV lines instead of headers.")
84 (defconst nnspool-sift-nov-with-sed nil
85 "If non-nil, use sed to get the relevant portion from the overview file.
86 If nil, nnspool will load the entire file into a buffer and process it
89 (defvoo nnspool-rejected-article-hook nil
90 "*A hook that will be run when an article has been rejected by the server.")
92 (defvoo nnspool-file-coding-system nnheader-file-coding-system
93 "Coding system for nnspool.")
97 (defconst nnspool-version
"nnspool 2.0"
98 "Version numbers of this version of NNSPOOL.")
100 (defvoo nnspool-current-directory nil
101 "Current news group directory.")
103 (defvoo nnspool-current-group nil
)
104 (defvoo nnspool-status-string
"")
107 ;;; Interface functions.
109 (nnoo-define-basics nnspool
)
111 (deffoo nnspool-retrieve-headers
(articles &optional group server fetch-old
)
112 "Retrieve the headers of ARTICLES."
114 (set-buffer nntp-server-buffer
)
116 (when (nnspool-possibly-change-directory group
)
117 (let* ((number (length articles
))
119 (default-directory nnspool-current-directory
)
120 (do-message (and (numberp nnspool-large-newsgroup
)
121 (> number nnspool-large-newsgroup
)))
122 (nnheader-file-coding-system nnspool-file-coding-system
)
124 (if (and (numberp (car articles
))
125 (nnspool-retrieve-headers-with-nov articles fetch-old
))
126 ;; We successfully retrieved the NOV headers.
128 ;; No NOV headers here, so we do it the hard way.
129 (while (setq article
(pop articles
))
130 (if (stringp article
)
131 ;; This is a Message-ID.
132 (setq ag
(nnspool-find-id article
)
133 file
(and ag
(nnspool-article-pathname
136 ;; This is an article in the current group.
137 (setq file
(int-to-string article
)))
138 ;; Insert the head of the article.
140 (file-exists-p file
))
142 (princ article
(current-buffer))
143 (insert " Article retrieved.\n")
145 (inline (nnheader-insert-head file
))
147 (if (search-forward "\n\n" nil t
)
151 (goto-char (point-max))
155 (delete-region (point) (point-max)))
158 (zerop (%
(incf count
) 20))
159 (nnheader-message 5 "nnspool: Receiving headers... %d%%"
160 (/ (* count
100) number
))))
163 (nnheader-message 5 "nnspool: Receiving headers...done"))
165 ;; Fold continuation lines.
166 (nnheader-fold-continuation-lines)
169 (deffoo nnspool-open-server
(server &optional defs
)
170 (nnoo-change-server 'nnspool server defs
)
172 ((not (file-exists-p nnspool-spool-directory
))
173 (nnspool-close-server)
174 (nnheader-report 'nnspool
"Spool directory doesn't exist: %s"
175 nnspool-spool-directory
))
176 ((not (file-directory-p
178 (file-truename nnspool-spool-directory
))))
179 (nnspool-close-server)
180 (nnheader-report 'nnspool
"Not a directory: %s" nnspool-spool-directory
))
181 ((not (file-exists-p nnspool-active-file
))
182 (nnheader-report 'nnspool
"The active file doesn't exist: %s"
183 nnspool-active-file
))
185 (nnheader-report 'nnspool
"Opened server %s using directory %s"
186 server nnspool-spool-directory
)
189 (deffoo nnspool-request-article
(id &optional group server buffer
)
190 "Select article by message ID (or number)."
191 (nnspool-possibly-change-directory group
)
192 (let ((nntp-server-buffer (or buffer nntp-server-buffer
))
195 ;; This is a Message-ID.
196 (when (setq ag
(nnspool-find-id id
))
197 (setq file
(nnspool-article-pathname (car ag
) (cdr ag
))))
198 (setq file
(nnspool-article-pathname nnspool-current-group id
)))
201 (not (file-directory-p file
))
202 (save-excursion (nnspool-find-file file
))
203 ;; We return the article number and group name.
205 (cons nnspool-current-group id
)
208 (deffoo nnspool-request-body
(id &optional group server
)
209 "Select article body by message ID (or number)."
210 (nnspool-possibly-change-directory group
)
211 (let ((res (nnspool-request-article id
)))
214 (set-buffer nntp-server-buffer
)
215 (goto-char (point-min))
216 (when (search-forward "\n\n" nil t
)
217 (delete-region (point-min) (point)))
220 (deffoo nnspool-request-head
(id &optional group server
)
221 "Select article head by message ID (or number)."
222 (nnspool-possibly-change-directory group
)
223 (let ((res (nnspool-request-article id
)))
226 (set-buffer nntp-server-buffer
)
227 (goto-char (point-min))
228 (when (search-forward "\n\n" nil t
)
229 (delete-region (1- (point)) (point-max)))
230 (nnheader-fold-continuation-lines)))
233 (deffoo nnspool-request-group
(group &optional server dont-check
)
235 (let ((pathname (nnspool-article-pathname group
))
237 (if (not (file-directory-p pathname
))
239 'nnspool
"Invalid group name (no such directory): %s" group
)
240 (setq nnspool-current-directory pathname
)
241 (nnheader-report 'nnspool
"Selected group %s" group
)
244 (nnheader-report 'nnspool
"Selected group %s" group
)
246 ;; Yes, completely empty spool directories *are* possible.
247 ;; Fix by Sudish Joseph <joseph@cis.ohio-state.edu>
248 (when (setq dir
(directory-files pathname nil
"^[0-9]+$" t
))
250 (sort (mapcar (lambda (name) (string-to-number name
)) dir
) '<)))
253 "211 %d %d %d %s\n" (length dir
) (car dir
)
254 (progn (while (cdr dir
) (setq dir
(cdr dir
))) (car dir
))
256 (nnheader-report 'nnspool
"Empty group %s" group
)
257 (nnheader-insert "211 0 0 0 %s\n" group
))))))
259 (deffoo nnspool-request-type
(group &optional article
)
262 (deffoo nnspool-close-group
(group &optional server
)
265 (deffoo nnspool-request-list
(&optional server
)
266 "List active newsgroups."
268 (or (nnspool-find-file nnspool-active-file
)
269 (nnheader-report 'nnspool
(nnheader-file-error nnspool-active-file
)))))
271 (deffoo nnspool-request-list-newsgroups
(&optional server
)
272 "List newsgroups (defined in NNTP2)."
274 (or (nnspool-find-file nnspool-newsgroups-file
)
275 (nnheader-report 'nnspool
(nnheader-file-error
276 nnspool-newsgroups-file
)))))
278 (deffoo nnspool-request-list-distributions
(&optional server
)
279 "List distributions (defined in NNTP2)."
281 (or (nnspool-find-file nnspool-distributions-file
)
282 (nnheader-report 'nnspool
(nnheader-file-error
283 nnspool-distributions-file
)))))
285 ;; Suggested by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
286 (deffoo nnspool-request-newgroups
(date &optional server
)
287 "List groups created after DATE."
288 (if (nnspool-find-file nnspool-active-times-file
)
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 (time-to-seconds (date-to-time date
)))
297 ;; Go through lines and add the latest groups to a list.
298 (while (and (looking-at "\\([^ ]+\\) +[0-9]+ ")
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)))
306 (goto-char (match-end 1))
307 (read (current-buffer)))
309 (push (buffer-substring
310 (match-beginning 1) (match-end 1))
312 (zerop (forward-line -
1))))
315 (insert (car groups
) " 0 0 y\n")
316 (setq groups
(cdr groups
))))
320 (deffoo nnspool-request-post
(&optional server
)
321 "Post a new news in current buffer."
323 (let* ((process-connection-type nil
) ; t bugs out on Solaris
324 (inews-buffer (generate-new-buffer " *nnspool post*"))
327 (apply 'start-process
"*nnspool inews*" inews-buffer
328 nnspool-inews-program nnspool-inews-switches
)
330 (nnheader-report 'nnspool
"inews error: %S" err
)))))
332 ;; The inews program failed.
334 (nnheader-report 'nnspool
"")
335 (set-process-sentinel proc
'nnspool-inews-sentinel
)
336 (mm-with-unibyte-current-buffer
337 (process-send-region proc
(point-min) (point-max)))
338 ;; We slap a condition-case around this, because the process may
339 ;; have exited already...
341 (process-send-eof proc
))
346 ;;; Internal functions.
348 (defun nnspool-inews-sentinel (proc status
)
350 (set-buffer (process-buffer proc
))
351 (goto-char (point-min))
352 (if (or (zerop (buffer-size))
353 (search-forward "spooled" nil t
))
354 (kill-buffer (current-buffer))
355 ;; Make status message by folding lines.
356 (while (re-search-forward "[ \t\n]+" nil t
)
357 (replace-match " " t t
))
358 (nnheader-report 'nnspool
"%s" (buffer-string))
359 (nnheader-message 5 "nnspool: %s" nnspool-status-string
)
361 (run-hooks 'nnspool-rejected-article-hook
))))
363 (defun nnspool-retrieve-headers-with-nov (articles &optional fetch-old
)
364 (if (or gnus-nov-is-evil nnspool-nov-is-evil
)
366 (let ((nov (nnheader-group-pathname
367 nnspool-current-group nnspool-nov-directory
".overview"))
369 (nnheader-file-coding-system nnspool-file-coding-system
)
371 (if (not (file-exists-p nov
))
374 (set-buffer nntp-server-buffer
)
376 (if nnspool-sift-nov-with-sed
377 (nnspool-sift-nov-with-sed articles nov
)
378 (nnheader-insert-file-contents nov
)
380 (not (numberp fetch-old
)))
381 t
; We want all the headers.
383 ;; Delete unwanted NOV lines.
384 (nnheader-nov-delete-outside-range
385 (if fetch-old
(max 1 (- (car articles
) fetch-old
))
387 (car (last articles
)))
388 ;; If the buffer is empty, this wasn't very successful.
389 (unless (zerop (buffer-size))
390 ;; We check what the last article number was.
391 ;; The NOV file may be out of sync with the articles
394 (setq last
(read (current-buffer)))
395 (if (= last
(car articles
))
396 ;; Yup, it's all there.
398 ;; Perhaps not. We try to find the missing articles.
400 (<= last
(car arts
)))
402 ;; The articles in `arts' are missing from the buffer.
404 (nnspool-insert-nov-head (pop arts
)))
407 (defun nnspool-insert-nov-head (article)
408 "Read the head of ARTICLE, convert to NOV headers, and insert."
410 (let ((cur (current-buffer))
412 (setq buf
(nnheader-set-temp-buffer " *nnspool head*"))
413 (when (nnheader-insert-head
414 (nnspool-article-pathname nnspool-current-group article
))
415 (nnheader-insert-article-line article
)
416 (let ((headers (nnheader-parse-head)))
418 (goto-char (point-max))
419 (nnheader-insert-nov headers
)))
422 (defun nnspool-sift-nov-with-sed (articles file
)
423 (let ((first (car articles
))
424 (last (progn (while (cdr articles
) (setq articles
(cdr articles
)))
426 (call-process "awk" nil t nil
427 (format "BEGIN {firstmsg=%d; lastmsg=%d;}\n $1 >= firstmsg && $1 <= lastmsg {print;}"
428 (1- first
) (1+ last
))
431 ;; Fixed by fdc@cliwe.ping.de (Frank D. Cringle).
432 ;; Find out what group an article identified by a Message-ID is in.
433 (defun nnspool-find-id (id)
435 (set-buffer (get-buffer-create " *nnspool work*"))
438 (call-process "grep" nil t nil
(regexp-quote id
) nnspool-history-file
))
439 (goto-char (point-min))
441 (when (looking-at "<[^>]+>[ \t]+[-0-9~]+[ \t]+\\([^ /\t\n]+\\)/\\([0-9]+\\)[ \t\n]")
442 (cons (match-string 1) (string-to-number (match-string 2))))
443 (kill-buffer (current-buffer)))))
445 (defun nnspool-find-file (file)
446 "Insert FILE in server buffer safely."
447 (set-buffer nntp-server-buffer
)
450 (let ((coding-system-for-read nnspool-file-coding-system
))
451 (mm-insert-file-contents file
)
455 (defun nnspool-possibly-change-directory (group)
458 (let ((pathname (nnspool-article-pathname group
)))
459 (if (file-directory-p pathname
)
460 (setq nnspool-current-directory pathname
461 nnspool-current-group group
)
462 (nnheader-report 'nnspool
"No such newsgroup: %s" group
)))))
464 (defun nnspool-article-pathname (group &optional article
)
465 "Find the file name for GROUP."
466 (nnheader-group-pathname group nnspool-spool-directory article
))
470 ;;; arch-tag: bdac8d27-2934-4eee-bad0-49e6b90c0d05
471 ;;; nnspool.el ends here