1 ;;; nnspool.el --- spool access for GNU Emacs
3 ;; Copyright (C) 1988-1990, 1993-1998, 2000-2012
4 ;; 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 3 of the License, or
15 ;; (at your option) any later version.
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. If not, see <http://www.gnu.org/licenses/>.
32 (eval-when-compile (require 'cl
))
34 ;; Probably this entire thing should be obsolete.
35 ;; It's only used to init nnspool-spool-directory, so why not just
36 ;; set that variable's default directly?
37 (defvar news-directory
(if (file-exists-p "/usr/spool/news/")
40 "The root directory below which all news files are stored.")
41 (defvaralias 'news-path
'news-directory
)
43 (nnoo-declare nnspool
)
45 (defvoo nnspool-inews-program news-inews-program
46 "Program to post news.
47 This is most commonly `inews' or `injnews'.")
49 (defvoo nnspool-inews-switches
'("-h" "-S")
50 "Switches for nnspool-request-post to pass to `inews' for posting news.
51 If you are using Cnews, you probably should set this variable to nil.")
53 (defvoo nnspool-spool-directory
54 (file-name-as-directory (if (boundp 'news-directory
)
55 (symbol-value 'news-directory
)
57 "Local news spool directory.")
59 (defvoo nnspool-nov-directory
(concat nnspool-spool-directory
"over.view/")
60 "Local news nov directory.")
62 (defvoo nnspool-lib-dir
63 (if (file-exists-p "/usr/lib/news/active")
66 "Where the local news library files are stored.")
68 (defvoo nnspool-active-file
(concat nnspool-lib-dir
"active")
69 "Local news active file.")
71 (defvoo nnspool-newsgroups-file
(concat nnspool-lib-dir
"newsgroups")
72 "Local news newsgroups file.")
74 (defvoo nnspool-distributions-file
(concat nnspool-lib-dir
"distribs.pat")
75 "Local news distributions file.")
77 (defvoo nnspool-history-file
(concat nnspool-lib-dir
"history")
78 "Local news history file.")
80 (defvoo nnspool-active-times-file
(concat nnspool-lib-dir
"active.times")
81 "Local news active date file.")
83 (defvoo nnspool-large-newsgroup
50
84 "The number of articles which indicates a large newsgroup.
85 If the number of articles is greater than the value, verbose
86 messages will be shown to indicate the current status.")
88 (defvoo nnspool-nov-is-evil nil
89 "Non-nil means that nnspool will never return NOV lines instead of headers.")
91 (defconst nnspool-sift-nov-with-sed nil
92 "If non-nil, use sed to get the relevant portion from the overview file.
93 If nil, nnspool will load the entire file into a buffer and process it
96 (defvoo nnspool-rejected-article-hook nil
97 "*A hook that will be run when an article has been rejected by the server.")
99 (defvoo nnspool-file-coding-system nnheader-file-coding-system
100 "Coding system for nnspool.")
104 (defconst nnspool-version
"nnspool 2.0"
105 "Version numbers of this version of NNSPOOL.")
107 (defvoo nnspool-current-directory nil
108 "Current news group directory.")
110 (defvoo nnspool-current-group nil
)
111 (defvoo nnspool-status-string
"")
114 ;;; Interface functions.
116 (nnoo-define-basics nnspool
)
118 (deffoo nnspool-retrieve-headers
(articles &optional group server fetch-old
)
119 "Retrieve the headers of ARTICLES."
120 (with-current-buffer nntp-server-buffer
122 (when (nnspool-possibly-change-directory group
)
123 (let* ((number (length articles
))
125 (default-directory nnspool-current-directory
)
126 (do-message (and (numberp nnspool-large-newsgroup
)
127 (> number nnspool-large-newsgroup
)))
128 (nnheader-file-coding-system nnspool-file-coding-system
)
130 (if (and (numberp (car articles
))
131 (nnspool-retrieve-headers-with-nov articles fetch-old
))
132 ;; We successfully retrieved the NOV headers.
134 ;; No NOV headers here, so we do it the hard way.
135 (while (setq article
(pop articles
))
136 (if (stringp article
)
137 ;; This is a Message-ID.
138 (setq ag
(nnspool-find-id article
)
139 file
(and ag
(nnspool-article-pathname
142 ;; This is an article in the current group.
143 (setq file
(int-to-string article
)))
144 ;; Insert the head of the article.
146 (file-exists-p file
))
148 (princ article
(current-buffer))
149 (insert " Article retrieved.\n")
151 (inline (nnheader-insert-head file
))
153 (if (search-forward "\n\n" nil t
)
157 (goto-char (point-max))
161 (delete-region (point) (point-max)))
164 (zerop (%
(incf count
) 20))
165 (nnheader-message 5 "nnspool: Receiving headers... %d%%"
166 (/ (* count
100) number
))))
169 (nnheader-message 5 "nnspool: Receiving headers...done"))
171 ;; Fold continuation lines.
172 (nnheader-fold-continuation-lines)
175 (deffoo nnspool-open-server
(server &optional defs
)
176 (nnoo-change-server 'nnspool server defs
)
178 ((not (file-exists-p nnspool-spool-directory
))
179 (nnspool-close-server)
180 (nnheader-report 'nnspool
"Spool directory doesn't exist: %s"
181 nnspool-spool-directory
))
182 ((not (file-directory-p
184 (file-truename nnspool-spool-directory
))))
185 (nnspool-close-server)
186 (nnheader-report 'nnspool
"Not a directory: %s" nnspool-spool-directory
))
187 ((not (file-exists-p nnspool-active-file
))
188 (nnheader-report 'nnspool
"The active file doesn't exist: %s"
189 nnspool-active-file
))
191 (nnheader-report 'nnspool
"Opened server %s using directory %s"
192 server nnspool-spool-directory
)
195 (deffoo nnspool-request-article
(id &optional group server buffer
)
196 "Select article by message ID (or number)."
197 (nnspool-possibly-change-directory group
)
198 (let ((nntp-server-buffer (or buffer nntp-server-buffer
))
201 ;; This is a Message-ID.
202 (when (setq ag
(nnspool-find-id id
))
203 (setq file
(nnspool-article-pathname (car ag
) (cdr ag
))))
204 (setq file
(nnspool-article-pathname nnspool-current-group id
)))
207 (not (file-directory-p file
))
208 (save-excursion (nnspool-find-file file
))
209 ;; We return the article number and group name.
211 (cons nnspool-current-group id
)
214 (deffoo nnspool-request-body
(id &optional group server
)
215 "Select article body by message ID (or number)."
216 (nnspool-possibly-change-directory group
)
217 (let ((res (nnspool-request-article id
)))
219 (with-current-buffer nntp-server-buffer
220 (goto-char (point-min))
221 (when (search-forward "\n\n" nil t
)
222 (delete-region (point-min) (point)))
225 (deffoo nnspool-request-head
(id &optional group server
)
226 "Select article head by message ID (or number)."
227 (nnspool-possibly-change-directory group
)
228 (let ((res (nnspool-request-article id
)))
230 (with-current-buffer nntp-server-buffer
231 (goto-char (point-min))
232 (when (search-forward "\n\n" nil t
)
233 (delete-region (1- (point)) (point-max)))
234 (nnheader-fold-continuation-lines)))
237 (deffoo nnspool-request-group
(group &optional server dont-check info
)
239 (let ((pathname (nnspool-article-pathname group
))
241 (if (not (file-directory-p pathname
))
243 'nnspool
"Invalid group name (no such directory): %s" group
)
244 (setq nnspool-current-directory pathname
)
245 (nnheader-report 'nnspool
"Selected group %s" group
)
248 (nnheader-report 'nnspool
"Selected group %s" group
)
250 ;; Yes, completely empty spool directories *are* possible.
251 ;; Fix by Sudish Joseph <joseph@cis.ohio-state.edu>
252 (when (setq dir
(directory-files pathname nil
"^[0-9]+$" t
))
253 (setq dir
(sort (mapcar 'string-to-number dir
) '<)))
256 "211 %d %d %d %s\n" (length dir
) (car dir
)
257 (car (last dir
)) group
)
258 (nnheader-report 'nnspool
"Empty group %s" group
)
259 (nnheader-insert "211 0 0 0 %s\n" group
))))))
261 (deffoo nnspool-request-type
(group &optional article
)
264 (deffoo nnspool-close-group
(group &optional server
)
267 (deffoo nnspool-request-list
(&optional server
)
268 "List active newsgroups."
270 (or (nnspool-find-file nnspool-active-file
)
271 (nnheader-report 'nnspool
(nnheader-file-error nnspool-active-file
)))))
273 (deffoo nnspool-request-list-newsgroups
(&optional server
)
274 "List newsgroups (defined in NNTP2)."
276 (or (nnspool-find-file nnspool-newsgroups-file
)
277 (nnheader-report 'nnspool
(nnheader-file-error
278 nnspool-newsgroups-file
)))))
280 (deffoo nnspool-request-list-distributions
(&optional server
)
281 "List distributions (defined in NNTP2)."
283 (or (nnspool-find-file nnspool-distributions-file
)
284 (nnheader-report 'nnspool
(nnheader-file-error
285 nnspool-distributions-file
)))))
287 ;; Suggested by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
288 (deffoo nnspool-request-newgroups
(date &optional server
)
289 "List groups created after DATE."
290 (if (nnspool-find-file nnspool-active-times-file
)
292 ;; Find the last valid line.
293 (goto-char (point-max))
294 (while (and (not (looking-at
295 "\\([^ ]+\\) +\\([0-9]+\\)[0-9][0-9][0-9] "))
296 (zerop (forward-line -
1))))
297 ;; We require nnheader which requires gnus-util.
298 (let ((seconds (gnus-float-time (date-to-time date
)))
300 ;; Go through lines and add the latest groups to a list.
301 (while (and (looking-at "\\([^ ]+\\) +[0-9]+ ")
303 ;; We insert a .0 to make the list reader
304 ;; interpret the number as a float. It is far
305 ;; too big to be stored in a lisp integer.
306 (goto-char (1- (match-end 0)))
309 (goto-char (match-end 1))
310 (read (current-buffer)))
312 (push (buffer-substring
313 (match-beginning 1) (match-end 1))
315 (zerop (forward-line -
1))))
317 (dolist (group groups
)
318 (insert group
" 0 0 y\n")))
322 (deffoo nnspool-request-post
(&optional server
)
323 "Post a new news in current buffer."
325 (let* ((process-connection-type nil
) ; t bugs out on Solaris
326 (inews-buffer (generate-new-buffer " *nnspool post*"))
329 (apply 'start-process
"*nnspool inews*" inews-buffer
330 nnspool-inews-program nnspool-inews-switches
)
332 (nnheader-report 'nnspool
"inews error: %S" err
)))))
334 ;; The inews program failed.
336 (nnheader-report 'nnspool
"")
337 (set-process-sentinel proc
'nnspool-inews-sentinel
)
338 (mm-with-unibyte-current-buffer
339 (process-send-region proc
(point-min) (point-max)))
340 ;; We slap a condition-case around this, because the process may
341 ;; have exited already...
343 (process-send-eof proc
))
348 ;;; Internal functions.
350 (defun nnspool-inews-sentinel (proc status
)
351 (with-current-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
))
374 (with-current-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.
403 (mapc 'nnspool-insert-nov-head arts
)
406 (defun nnspool-insert-nov-head (article)
407 "Read the head of ARTICLE, convert to NOV headers, and insert."
409 (let ((cur (current-buffer))
411 (setq buf
(nnheader-set-temp-buffer " *nnspool head*"))
412 (when (nnheader-insert-head
413 (nnspool-article-pathname nnspool-current-group article
))
414 (nnheader-insert-article-line article
)
415 (goto-char (point-min))
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 (car (last articles
))))
425 (call-process "awk" nil t nil
426 (format "BEGIN {firstmsg=%d; lastmsg=%d;}\n $1 >= firstmsg && $1 <= lastmsg {print;}"
427 (1- first
) (1+ last
))
430 ;; Fixed by fdc@cliwe.ping.de (Frank D. Cringle).
431 ;; Find out what group an article identified by a Message-ID is in.
432 (defun nnspool-find-id (id)
435 (call-process "grep" nil t nil
(regexp-quote id
) nnspool-history-file
))
436 (goto-char (point-min))
437 (when (looking-at "<[^>]+>[ \t]+[-0-9~]+[ \t]+\\([^ /\t\n]+\\)/\\([0-9]+\\)[ \t\n]")
438 (cons (match-string 1) (string-to-number (match-string 2))))))
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