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
48 (file-name-as-directory (if (boundp 'news-directory
)
49 (symbol-value 'news-directory
)
51 "Local news spool directory.")
53 (defvoo nnspool-nov-directory
(concat nnspool-spool-directory
"over.view/")
54 "Local news nov directory.")
56 (defvoo nnspool-lib-dir
57 (if (file-exists-p "/usr/lib/news/active")
60 "Where the local news library files are stored.")
62 (defvoo nnspool-active-file
(concat nnspool-lib-dir
"active")
63 "Local news active file.")
65 (defvoo nnspool-newsgroups-file
(concat nnspool-lib-dir
"newsgroups")
66 "Local news newsgroups file.")
68 (defvoo nnspool-distributions-file
(concat nnspool-lib-dir
"distribs.pat")
69 "Local news distributions file.")
71 (defvoo nnspool-history-file
(concat nnspool-lib-dir
"history")
72 "Local news history file.")
74 (defvoo nnspool-active-times-file
(concat nnspool-lib-dir
"active.times")
75 "Local news active date file.")
77 (defvoo nnspool-large-newsgroup
50
78 "The number of articles which indicates a large newsgroup.
79 If the number of articles is greater than the value, verbose
80 messages will be shown to indicate the current status.")
82 (defvoo nnspool-nov-is-evil nil
83 "Non-nil means that nnspool will never return NOV lines instead of headers.")
85 (defconst nnspool-sift-nov-with-sed nil
86 "If non-nil, use sed to get the relevant portion from the overview file.
87 If nil, nnspool will load the entire file into a buffer and process it
90 (defvoo nnspool-rejected-article-hook nil
91 "*A hook that will be run when an article has been rejected by the server.")
93 (defvoo nnspool-file-coding-system nnheader-file-coding-system
94 "Coding system for nnspool.")
98 (defconst nnspool-version
"nnspool 2.0"
99 "Version numbers of this version of NNSPOOL.")
101 (defvoo nnspool-current-directory nil
102 "Current news group directory.")
104 (defvoo nnspool-current-group nil
)
105 (defvoo nnspool-status-string
"")
108 ;;; Interface functions.
110 (nnoo-define-basics nnspool
)
112 (deffoo nnspool-retrieve-headers
(articles &optional group server fetch-old
)
113 "Retrieve the headers of ARTICLES."
115 (set-buffer nntp-server-buffer
)
117 (when (nnspool-possibly-change-directory group
)
118 (let* ((number (length articles
))
120 (default-directory nnspool-current-directory
)
121 (do-message (and (numberp nnspool-large-newsgroup
)
122 (> number nnspool-large-newsgroup
)))
123 (nnheader-file-coding-system nnspool-file-coding-system
)
125 (if (and (numberp (car articles
))
126 (nnspool-retrieve-headers-with-nov articles fetch-old
))
127 ;; We successfully retrieved the NOV headers.
129 ;; No NOV headers here, so we do it the hard way.
130 (while (setq article
(pop articles
))
131 (if (stringp article
)
132 ;; This is a Message-ID.
133 (setq ag
(nnspool-find-id article
)
134 file
(and ag
(nnspool-article-pathname
137 ;; This is an article in the current group.
138 (setq file
(int-to-string article
)))
139 ;; Insert the head of the article.
141 (file-exists-p file
))
143 (princ article
(current-buffer))
144 (insert " Article retrieved.\n")
146 (inline (nnheader-insert-head file
))
148 (if (search-forward "\n\n" nil t
)
152 (goto-char (point-max))
156 (delete-region (point) (point-max)))
159 (zerop (%
(incf count
) 20))
160 (nnheader-message 5 "nnspool: Receiving headers... %d%%"
161 (/ (* count
100) number
))))
164 (nnheader-message 5 "nnspool: Receiving headers...done"))
166 ;; Fold continuation lines.
167 (nnheader-fold-continuation-lines)
170 (deffoo nnspool-open-server
(server &optional defs
)
171 (nnoo-change-server 'nnspool server defs
)
173 ((not (file-exists-p nnspool-spool-directory
))
174 (nnspool-close-server)
175 (nnheader-report 'nnspool
"Spool directory doesn't exist: %s"
176 nnspool-spool-directory
))
177 ((not (file-directory-p
179 (file-truename nnspool-spool-directory
))))
180 (nnspool-close-server)
181 (nnheader-report 'nnspool
"Not a directory: %s" nnspool-spool-directory
))
182 ((not (file-exists-p nnspool-active-file
))
183 (nnheader-report 'nnspool
"The active file doesn't exist: %s"
184 nnspool-active-file
))
186 (nnheader-report 'nnspool
"Opened server %s using directory %s"
187 server nnspool-spool-directory
)
190 (deffoo nnspool-request-article
(id &optional group server buffer
)
191 "Select article by message ID (or number)."
192 (nnspool-possibly-change-directory group
)
193 (let ((nntp-server-buffer (or buffer nntp-server-buffer
))
196 ;; This is a Message-ID.
197 (when (setq ag
(nnspool-find-id id
))
198 (setq file
(nnspool-article-pathname (car ag
) (cdr ag
))))
199 (setq file
(nnspool-article-pathname nnspool-current-group id
)))
202 (not (file-directory-p file
))
203 (save-excursion (nnspool-find-file file
))
204 ;; We return the article number and group name.
206 (cons nnspool-current-group id
)
209 (deffoo nnspool-request-body
(id &optional group server
)
210 "Select article body by message ID (or number)."
211 (nnspool-possibly-change-directory group
)
212 (let ((res (nnspool-request-article id
)))
215 (set-buffer nntp-server-buffer
)
216 (goto-char (point-min))
217 (when (search-forward "\n\n" nil t
)
218 (delete-region (point-min) (point)))
221 (deffoo nnspool-request-head
(id &optional group server
)
222 "Select article head by message ID (or number)."
223 (nnspool-possibly-change-directory group
)
224 (let ((res (nnspool-request-article id
)))
227 (set-buffer nntp-server-buffer
)
228 (goto-char (point-min))
229 (when (search-forward "\n\n" nil t
)
230 (delete-region (1- (point)) (point-max)))
231 (nnheader-fold-continuation-lines)))
234 (deffoo nnspool-request-group
(group &optional server dont-check
)
236 (let ((pathname (nnspool-article-pathname group
))
238 (if (not (file-directory-p pathname
))
240 'nnspool
"Invalid group name (no such directory): %s" group
)
241 (setq nnspool-current-directory pathname
)
242 (nnheader-report 'nnspool
"Selected group %s" group
)
245 (nnheader-report 'nnspool
"Selected group %s" group
)
247 ;; Yes, completely empty spool directories *are* possible.
248 ;; Fix by Sudish Joseph <joseph@cis.ohio-state.edu>
249 (when (setq dir
(directory-files pathname nil
"^[0-9]+$" t
))
251 (sort (mapcar (lambda (name) (string-to-number name
)) dir
) '<)))
254 "211 %d %d %d %s\n" (length dir
) (car dir
)
255 (progn (while (cdr dir
) (setq dir
(cdr dir
))) (car dir
))
257 (nnheader-report 'nnspool
"Empty group %s" group
)
258 (nnheader-insert "211 0 0 0 %s\n" group
))))))
260 (deffoo nnspool-request-type
(group &optional article
)
263 (deffoo nnspool-close-group
(group &optional server
)
266 (deffoo nnspool-request-list
(&optional server
)
267 "List active newsgroups."
269 (or (nnspool-find-file nnspool-active-file
)
270 (nnheader-report 'nnspool
(nnheader-file-error nnspool-active-file
)))))
272 (deffoo nnspool-request-list-newsgroups
(&optional server
)
273 "List newsgroups (defined in NNTP2)."
275 (or (nnspool-find-file nnspool-newsgroups-file
)
276 (nnheader-report 'nnspool
(nnheader-file-error
277 nnspool-newsgroups-file
)))))
279 (deffoo nnspool-request-list-distributions
(&optional server
)
280 "List distributions (defined in NNTP2)."
282 (or (nnspool-find-file nnspool-distributions-file
)
283 (nnheader-report 'nnspool
(nnheader-file-error
284 nnspool-distributions-file
)))))
286 ;; Suggested by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
287 (deffoo nnspool-request-newgroups
(date &optional server
)
288 "List groups created after DATE."
289 (if (nnspool-find-file nnspool-active-times-file
)
291 ;; Find the last valid line.
292 (goto-char (point-max))
293 (while (and (not (looking-at
294 "\\([^ ]+\\) +\\([0-9]+\\)[0-9][0-9][0-9] "))
295 (zerop (forward-line -
1))))
296 (let ((seconds (time-to-seconds (date-to-time date
)))
298 ;; Go through lines and add the latest groups to a list.
299 (while (and (looking-at "\\([^ ]+\\) +[0-9]+ ")
301 ;; We insert a .0 to make the list reader
302 ;; interpret the number as a float. It is far
303 ;; too big to be stored in a lisp integer.
304 (goto-char (1- (match-end 0)))
307 (goto-char (match-end 1))
308 (read (current-buffer)))
310 (push (buffer-substring
311 (match-beginning 1) (match-end 1))
313 (zerop (forward-line -
1))))
316 (insert (car groups
) " 0 0 y\n")
317 (setq groups
(cdr groups
))))
321 (deffoo nnspool-request-post
(&optional server
)
322 "Post a new news in current buffer."
324 (let* ((process-connection-type nil
) ; t bugs out on Solaris
325 (inews-buffer (generate-new-buffer " *nnspool post*"))
328 (apply 'start-process
"*nnspool inews*" inews-buffer
329 nnspool-inews-program nnspool-inews-switches
)
331 (nnheader-report 'nnspool
"inews error: %S" err
)))))
333 ;; The inews program failed.
335 (nnheader-report 'nnspool
"")
336 (set-process-sentinel proc
'nnspool-inews-sentinel
)
337 (mm-with-unibyte-current-buffer
338 (process-send-region proc
(point-min) (point-max)))
339 ;; We slap a condition-case around this, because the process may
340 ;; have exited already...
342 (process-send-eof proc
))
347 ;;; Internal functions.
349 (defun nnspool-inews-sentinel (proc status
)
351 (set-buffer (process-buffer proc
))
352 (goto-char (point-min))
353 (if (or (zerop (buffer-size))
354 (search-forward "spooled" nil t
))
355 (kill-buffer (current-buffer))
356 ;; Make status message by folding lines.
357 (while (re-search-forward "[ \t\n]+" nil t
)
358 (replace-match " " t t
))
359 (nnheader-report 'nnspool
"%s" (buffer-string))
360 (nnheader-message 5 "nnspool: %s" nnspool-status-string
)
362 (run-hooks 'nnspool-rejected-article-hook
))))
364 (defun nnspool-retrieve-headers-with-nov (articles &optional fetch-old
)
365 (if (or gnus-nov-is-evil nnspool-nov-is-evil
)
367 (let ((nov (nnheader-group-pathname
368 nnspool-current-group nnspool-nov-directory
".overview"))
370 (nnheader-file-coding-system nnspool-file-coding-system
)
372 (if (not (file-exists-p nov
))
375 (set-buffer nntp-server-buffer
)
377 (if nnspool-sift-nov-with-sed
378 (nnspool-sift-nov-with-sed articles nov
)
379 (nnheader-insert-file-contents nov
)
381 (not (numberp fetch-old
)))
382 t
; We want all the headers.
384 ;; Delete unwanted NOV lines.
385 (nnheader-nov-delete-outside-range
386 (if fetch-old
(max 1 (- (car articles
) fetch-old
))
388 (car (last articles
)))
389 ;; If the buffer is empty, this wasn't very successful.
390 (unless (zerop (buffer-size))
391 ;; We check what the last article number was.
392 ;; The NOV file may be out of sync with the articles
395 (setq last
(read (current-buffer)))
396 (if (= last
(car articles
))
397 ;; Yup, it's all there.
399 ;; Perhaps not. We try to find the missing articles.
401 (<= last
(car arts
)))
403 ;; The articles in `arts' are missing from the buffer.
405 (nnspool-insert-nov-head (pop arts
)))
408 (defun nnspool-insert-nov-head (article)
409 "Read the head of ARTICLE, convert to NOV headers, and insert."
411 (let ((cur (current-buffer))
413 (setq buf
(nnheader-set-temp-buffer " *nnspool head*"))
414 (when (nnheader-insert-head
415 (nnspool-article-pathname nnspool-current-group article
))
416 (nnheader-insert-article-line article
)
417 (let ((headers (nnheader-parse-head)))
419 (goto-char (point-max))
420 (nnheader-insert-nov headers
)))
423 (defun nnspool-sift-nov-with-sed (articles file
)
424 (let ((first (car articles
))
425 (last (progn (while (cdr articles
) (setq articles
(cdr articles
)))
427 (call-process "awk" nil t nil
428 (format "BEGIN {firstmsg=%d; lastmsg=%d;}\n $1 >= firstmsg && $1 <= lastmsg {print;}"
429 (1- first
) (1+ last
))
432 ;; Fixed by fdc@cliwe.ping.de (Frank D. Cringle).
433 ;; Find out what group an article identified by a Message-ID is in.
434 (defun nnspool-find-id (id)
436 (set-buffer (get-buffer-create " *nnspool work*"))
439 (call-process "grep" nil t nil
(regexp-quote id
) nnspool-history-file
))
440 (goto-char (point-min))
442 (when (looking-at "<[^>]+>[ \t]+[-0-9~]+[ \t]+\\([^ /\t\n]+\\)/\\([0-9]+\\)[ \t\n]")
443 (cons (match-string 1) (string-to-number (match-string 2))))
444 (kill-buffer (current-buffer)))))
446 (defun nnspool-find-file (file)
447 "Insert FILE in server buffer safely."
448 (set-buffer nntp-server-buffer
)
451 (let ((coding-system-for-read nnspool-file-coding-system
))
452 (mm-insert-file-contents file
)
456 (defun nnspool-possibly-change-directory (group)
459 (let ((pathname (nnspool-article-pathname group
)))
460 (if (file-directory-p pathname
)
461 (setq nnspool-current-directory pathname
462 nnspool-current-group group
)
463 (nnheader-report 'nnspool
"No such newsgroup: %s" group
)))))
465 (defun nnspool-article-pathname (group &optional article
)
466 "Find the file name for GROUP."
467 (nnheader-group-pathname group nnspool-spool-directory article
))
471 ;;; arch-tag: bdac8d27-2934-4eee-bad0-49e6b90c0d05
472 ;;; nnspool.el ends here