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.
31 (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)
149 (progn (forward-char -1)
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))
249 (setq dir (sort (mapcar 'string-to-number dir) '<)))
252 "211 %d %d %d %s\n" (length dir) (car dir)
253 (car (last dir)) group)
254 (nnheader-report 'nnspool "Empty group %s" group)
255 (nnheader-insert "211 0 0 0 %s\n" group))))))
257 (deffoo nnspool-request-type (group &optional article)
260 (deffoo nnspool-close-group (group &optional server)
263 (deffoo nnspool-request-list (&optional server)
264 "List active newsgroups."
266 (or (nnspool-find-file nnspool-active-file)
267 (nnheader-report 'nnspool (nnheader-file-error nnspool-active-file)))))
269 (deffoo nnspool-request-list-newsgroups (&optional server)
270 "List newsgroups (defined in NNTP2)."
272 (or (nnspool-find-file nnspool-newsgroups-file)
273 (nnheader-report 'nnspool (nnheader-file-error
274 nnspool-newsgroups-file)))))
276 (deffoo nnspool-request-list-distributions (&optional server)
277 "List distributions (defined in NNTP2)."
279 (or (nnspool-find-file nnspool-distributions-file)
280 (nnheader-report 'nnspool (nnheader-file-error
281 nnspool-distributions-file)))))
283 ;; Suggested by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
284 (deffoo nnspool-request-newgroups (date &optional server)
285 "List groups created after DATE."
286 (if (nnspool-find-file nnspool-active-times-file)
288 ;; Find the last valid line.
289 (goto-char (point-max))
290 (while (and (not (looking-at
291 "\\([^ ]+\\) +\\([0-9]+\\)[0-9][0-9][0-9] "))
292 (zerop (forward-line -1))))
293 (let ((seconds (time-to-seconds (date-to-time date)))
295 ;; Go through lines and add the latest groups to a list.
296 (while (and (looking-at "\\([^ ]+\\) +[0-9]+ ")
298 ;; We insert a .0 to make the list reader
299 ;; interpret the number as a float. It is far
300 ;; too big to be stored in a lisp integer.
301 (goto-char (1- (match-end 0)))
304 (goto-char (match-end 1))
305 (read (current-buffer)))
307 (push (buffer-substring
308 (match-beginning 1) (match-end 1))
310 (zerop (forward-line -1))))
312 (dolist (group groups)
313 (insert group " 0 0 y\n")))
317 (deffoo nnspool-request-post (&optional server)
318 "Post a new news in current buffer."
320 (let* ((process-connection-type nil) ; t bugs out on Solaris
321 (inews-buffer (generate-new-buffer " *nnspool post*"))
324 (apply 'start-process "*nnspool inews*" inews-buffer
325 nnspool-inews-program nnspool-inews-switches)
327 (nnheader-report 'nnspool "inews error: %S" err)))))
329 ;; The inews program failed.
331 (nnheader-report 'nnspool "")
332 (set-process-sentinel proc 'nnspool-inews-sentinel)
333 (mm-with-unibyte-current-buffer
334 (process-send-region proc (point-min) (point-max)))
335 ;; We slap a condition-case around this, because the process may
336 ;; have exited already...
338 (process-send-eof proc))
343 ;;; Internal functions.
345 (defun nnspool-inews-sentinel (proc status)
347 (set-buffer (process-buffer proc))
348 (goto-char (point-min))
349 (if (or (zerop (buffer-size))
350 (search-forward "spooled" nil t))
351 (kill-buffer (current-buffer))
352 ;; Make status message by folding lines.
353 (while (re-search-forward "[ \t\n]+" nil t)
354 (replace-match " " t t))
355 (nnheader-report 'nnspool "%s" (buffer-string))
356 (nnheader-message 5 "nnspool: %s" nnspool-status-string)
358 (run-hooks 'nnspool-rejected-article-hook))))
360 (defun nnspool-retrieve-headers-with-nov (articles &optional fetch-old)
361 (if (or gnus-nov-is-evil nnspool-nov-is-evil)
363 (let ((nov (nnheader-group-pathname
364 nnspool-current-group nnspool-nov-directory ".overview"))
366 (nnheader-file-coding-system nnspool-file-coding-system)
368 (if (not (file-exists-p nov))
371 (set-buffer nntp-server-buffer)
373 (if nnspool-sift-nov-with-sed
374 (nnspool-sift-nov-with-sed articles nov)
375 (nnheader-insert-file-contents nov)
377 (not (numberp fetch-old)))
378 t ; We want all the headers.
380 ;; Delete unwanted NOV lines.
381 (nnheader-nov-delete-outside-range
382 (if fetch-old (max 1 (- (car articles) fetch-old))
384 (car (last articles)))
385 ;; If the buffer is empty, this wasn't very successful.
386 (unless (zerop (buffer-size))
387 ;; We check what the last article number was.
388 ;; The NOV file may be out of sync with the articles
391 (setq last (read (current-buffer)))
392 (if (= last (car articles))
393 ;; Yup, it's all there.
395 ;; Perhaps not. We try to find the missing articles.
397 (<= last (car arts)))
399 ;; The articles in `arts' are missing from the buffer.
400 (mapc 'nnspool-insert-nov-head arts)
403 (defun nnspool-insert-nov-head (article)
404 "Read the head of ARTICLE, convert to NOV headers, and insert."
406 (let ((cur (current-buffer))
408 (setq buf (nnheader-set-temp-buffer " *nnspool head*"))
409 (when (nnheader-insert-head
410 (nnspool-article-pathname nnspool-current-group article))
411 (nnheader-insert-article-line article)
412 (let ((headers (nnheader-parse-head)))
414 (goto-char (point-max))
415 (nnheader-insert-nov headers)))
418 (defun nnspool-sift-nov-with-sed (articles file)
419 (let ((first (car articles))
420 (last (car (last 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)
431 (call-process "grep" nil t nil (regexp-quote id) nnspool-history-file))
432 (goto-char (point-min))
433 (when (looking-at "<[^>]+>[ \t]+[-0-9~]+[ \t]+\\([^ /\t\n]+\\)/\\([0-9]+\\)[ \t\n]")
434 (cons (match-string 1) (string-to-number (match-string 2))))))
436 (defun nnspool-find-file (file)
437 "Insert FILE in server buffer safely."
438 (set-buffer nntp-server-buffer)
441 (let ((nnheader-file-coding-system nnspool-file-coding-system))
442 (nnheader-insert-file-contents file)
446 (defun nnspool-possibly-change-directory (group)
449 (let ((pathname (nnspool-article-pathname group)))
450 (if (file-directory-p pathname)
451 (setq nnspool-current-directory pathname
452 nnspool-current-group group)
453 (nnheader-report 'nnspool "No such newsgroup: %s" group)))))
455 (defun nnspool-article-pathname (group &optional article)
456 "Find the file name for GROUP."
457 (nnheader-group-pathname group nnspool-spool-directory article))
461 ;;; nnspool.el ends here