1 ;;; nnspool.el --- spool access for GNU Emacs
3 ;; Copyright (C) 1988,89,90,93,94,95 Free Software Foundation, Inc.
5 ;; Author: Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
6 ;; Lars Magne Ingebrigtsen <larsi@ifi.uio.no>
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 2, or (at your option)
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
24 ;; Boston, MA 02111-1307, USA.
34 (defvar nnspool-inews-program news-inews-program
35 "Program to post news.
36 This is most commonly `inews' or `injnews'.")
38 (defvar nnspool-inews-switches
'("-h")
39 "Switches for nnspool-request-post to pass to `inews' for posting news.
40 If you are using Cnews, you probably should set this variable to nil.")
42 (defvar nnspool-spool-directory news-path
43 "Local news spool directory.")
45 (defvar nnspool-nov-directory
(concat nnspool-spool-directory
"over.view/")
46 "Local news nov directory.")
48 (defvar nnspool-lib-dir
"/usr/lib/news/"
49 "Where the local news library files are stored.")
51 (defvar nnspool-active-file
(concat nnspool-lib-dir
"active")
52 "Local news active file.")
54 (defvar nnspool-newsgroups-file
(concat nnspool-lib-dir
"newsgroups")
55 "Local news newsgroups file.")
57 (defvar nnspool-distributions-file
(concat nnspool-lib-dir
"distributions")
58 "Local news distributions file.")
60 (defvar nnspool-history-file
(concat nnspool-lib-dir
"history")
61 "Local news history file.")
63 (defvar nnspool-active-times-file
(concat nnspool-lib-dir
"active.times")
64 "Local news active date file.")
66 (defvar nnspool-large-newsgroup
50
67 "The number of the articles which indicates a large newsgroup.
68 If the number of the articles is greater than the value, verbose
69 messages will be shown to indicate the current status.")
71 (defvar nnspool-nov-is-evil nil
72 "Non-nil means that nnspool will never return NOV lines instead of headers.")
74 (defconst nnspool-sift-nov-with-sed nil
75 "If non-nil, use sed to get the relevant portion from the overview file.
76 If nil, nnspool will load the entire file into a buffer and process it
81 (defconst nnspool-version
"nnspool 2.0"
82 "Version numbers of this version of NNSPOOL.")
84 (defvar nnspool-current-directory nil
85 "Current news group directory.")
87 (defvar nnspool-current-group nil
)
88 (defvar nnspool-status-string
"")
92 (defvar nnspool-current-server nil
)
93 (defvar nnspool-server-alist nil
)
94 (defvar nnspool-server-variables
96 (list 'nnspool-inews-program nnspool-inews-program
)
97 (list 'nnspool-inews-switches nnspool-inews-switches
)
98 (list 'nnspool-spool-directory nnspool-spool-directory
)
99 (list 'nnspool-nov-directory nnspool-nov-directory
)
100 (list 'nnspool-lib-dir nnspool-lib-dir
)
101 (list 'nnspool-active-file nnspool-active-file
)
102 (list 'nnspool-newsgroups-file nnspool-newsgroups-file
)
103 (list 'nnspool-distributions-file nnspool-distributions-file
)
104 (list 'nnspool-history-file nnspool-history-file
)
105 (list 'nnspool-active-times-file nnspool-active-times-file
)
106 (list 'nnspool-large-newsgroup nnspool-large-newsgroup
)
107 (list 'nnspool-nov-is-evil nnspool-nov-is-evil
)
108 (list 'nnspool-sift-nov-with-sed nnspool-sift-nov-with-sed
)
109 '(nnspool-current-directory nil
)
110 '(nnspool-current-group nil
)
111 '(nnspool-status-string "")))
114 ;;; Interface functions.
116 (defun nnspool-retrieve-headers (sequence &optional newsgroup server
)
117 "Retrieve the headers for the articles in SEQUENCE.
118 Newsgroup must be selected before calling this function."
120 (set-buffer nntp-server-buffer
)
122 (let* ((number (length sequence
))
124 (do-message (and (numberp nnspool-large-newsgroup
)
125 (> number nnspool-large-newsgroup
)))
127 (if (not (nnspool-possibly-change-directory newsgroup
))
129 (if (and (numberp (car sequence
))
130 (nnspool-retrieve-headers-with-nov sequence
))
133 (setq article
(car sequence
))
134 (if (stringp article
)
136 (setq file
(nnspool-find-article-by-message-id article
))
138 (setq file
(concat nnspool-current-directory
139 (int-to-string article
))))
140 (and file
(file-exists-p file
)
142 (insert (format "221 %d Article retrieved.\n" article
))
144 (nnheader-insert-head file
)
146 (search-forward "\n\n" nil t
)
149 (delete-region (point) (point-max))))
150 (setq sequence
(cdr sequence
))
153 (zerop (%
(setq count
(1+ count
)) 20))
154 (message "NNSPOOL: Receiving headers... %d%%"
155 (/ (* count
100) number
))))
157 (and do-message
(message "NNSPOOL: Receiving headers...done"))
159 ;; Fold continuation lines.
160 (goto-char (point-min))
161 (while (re-search-forward "\\(\r?\n[ \t]+\\)+" nil t
)
162 (replace-match " " t t
))
165 (defun nnspool-open-server (server &optional defs
)
166 (nnheader-init-server-buffer)
167 (if (equal server nnspool-current-server
)
169 (if nnspool-current-server
170 (setq nnspool-server-alist
171 (cons (list nnspool-current-server
172 (nnheader-save-variables nnspool-server-variables
))
173 nnspool-server-alist
)))
174 (let ((state (assoc server nnspool-server-alist
)))
177 (nnheader-restore-variables (nth 1 state
))
178 (setq nnspool-server-alist
(delq state nnspool-server-alist
)))
179 (nnheader-set-init-variables nnspool-server-variables defs
)))
180 (setq nnspool-current-server server
)))
182 (defun nnspool-close-server (&optional server
)
185 (defun nnspool-server-opened (&optional server
)
186 (and (equal server nnspool-current-server
)
188 (buffer-name nntp-server-buffer
)))
190 (defun nnspool-status-message (&optional server
)
191 "Return server status response as string."
192 nnspool-status-string
)
194 (defun nnspool-request-article (id &optional newsgroup server buffer
)
195 "Select article by message ID (or number)."
196 (nnspool-possibly-change-directory newsgroup
)
197 (let ((file (if (stringp id
)
198 (nnspool-find-article-by-message-id id
)
199 (concat nnspool-current-directory
(prin1-to-string id
))))
200 (nntp-server-buffer (or buffer nntp-server-buffer
)))
201 (if (and (stringp file
)
203 (not (file-directory-p file
)))
205 (nnspool-find-file file
)))))
207 (defun nnspool-request-body (id &optional newsgroup server
)
208 "Select article body by message ID (or number)."
209 (nnspool-possibly-change-directory newsgroup
)
210 (if (nnspool-request-article id
)
212 (set-buffer nntp-server-buffer
)
213 (goto-char (point-min))
214 (if (search-forward "\n\n" nil t
)
215 (delete-region (point-min) (point)))
218 (defun nnspool-request-head (id &optional newsgroup server
)
219 "Select article head by message ID (or number)."
220 (nnspool-possibly-change-directory newsgroup
)
221 (if (nnspool-request-article id
)
223 (set-buffer nntp-server-buffer
)
224 (goto-char (point-min))
225 (if (search-forward "\n\n" nil t
)
226 (delete-region (1- (point)) (point-max)))
229 (defun nnspool-request-group (group &optional server dont-check
)
231 (let ((pathname (nnspool-article-pathname
232 (nnspool-replace-chars-in-string group ?. ?
/)))
234 (if (not (file-directory-p pathname
))
236 (setq nnspool-status-string
237 "Invalid group name (no such directory)")
239 (setq nnspool-current-directory pathname
)
240 (setq nnspool-status-string
"")
243 (setq dir
(directory-files pathname nil
"^[0-9]+$" t
))
244 ;; yes, completely empty spool directories *are* possible
245 ;; Fix by Sudish Joseph <joseph@cis.ohio-state.edu>
252 (string-to-int name
)))
256 (set-buffer nntp-server-buffer
)
260 (format "211 %d %d %d %s\n" (length dir
) (car dir
)
261 (progn (while (cdr dir
) (setq dir
(cdr dir
)))
264 (insert (format "211 0 0 0 %s\n" group
))))))
267 (defun nnspool-close-group (group &optional server
)
270 (defun nnspool-request-list (&optional server
)
271 "List active newsgroups."
273 (nnspool-find-file nnspool-active-file
)))
275 (defun nnspool-request-list-newsgroups (&optional server
)
276 "List newsgroups (defined in NNTP2)."
278 (nnspool-find-file nnspool-newsgroups-file
)))
280 (defun nnspool-request-list-distributions (&optional server
)
281 "List distributions (defined in NNTP2)."
283 (nnspool-find-file nnspool-distributions-file
)))
285 ;; Suggested by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
286 (defun 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 (nnspool-seconds-since-epoch 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 (setq groups
(cons (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 (defun 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*"))
325 (proc (apply 'start-process
"*nnspool inews*" inews-buffer
326 nnspool-inews-program nnspool-inews-switches
)))
327 (set-process-sentinel proc
'nnspool-inews-sentinel
)
328 (process-send-region proc
(point-min) (point-max))
329 ;; We slap a condition-case around this, because the process may
330 ;; have exited already...
332 (process-send-eof proc
)
336 (defun nnspool-inews-sentinel (proc status
)
338 (set-buffer (process-buffer proc
))
339 (goto-char (point-min))
340 (if (or (zerop (buffer-size))
341 (search-forward "spooled" nil t
))
342 (kill-buffer (current-buffer))
343 ;; Make status message by unfolding lines.
344 (subst-char-in-region (point-min) (point-max) ?
\n ?
\\ 'noundo
)
345 (setq nnspool-status-string
(buffer-string))
346 (message "nnspool: %s" nnspool-status-string
)
347 ;(kill-buffer (current-buffer))
350 (defalias 'nnspool-request-post-buffer
'nntp-request-post-buffer
)
353 ;;; Internal functions.
355 (defun nnspool-retrieve-headers-with-nov (articles)
356 (if (or gnus-nov-is-evil nnspool-nov-is-evil
)
358 (let ((nov (concat (file-name-as-directory nnspool-nov-directory
)
359 (nnspool-replace-chars-in-string
360 nnspool-current-group ?. ?
/)
363 (if (file-exists-p nov
)
365 (set-buffer nntp-server-buffer
)
367 (if nnspool-sift-nov-with-sed
368 (nnspool-sift-nov-with-sed articles nov
)
369 (insert-file-contents nov
)
370 ;; First we find the first wanted line. We issue a number
371 ;; of search-forwards - the first article we are looking
372 ;; for may be expired, so we have to go on searching until
373 ;; we find one of the articles we want.
375 (setq article
(concat (int-to-string
376 (car articles
)) "\t"))
377 (not (or (looking-at article
)
378 (search-forward (concat "\n" article
)
380 (setq articles
(cdr articles
)))
384 (delete-region (point-min) (point))
385 ;; Then we find the last wanted line. We go to the end
386 ;; of the buffer and search backward much the same way
387 ;; we did to find the first article.
388 ;; !!! Perhaps it would be better just to do a (last articles),
389 ;; and go forward successively over each line and
390 ;; compare to avoid this (reverse), like this:
391 ;; (while (and (>= last (read nntp-server-buffer)))
392 ;; (zerop (forward-line 1))))
393 (setq articles
(reverse articles
))
394 (goto-char (point-max))
396 (not (search-backward
397 (concat "\n" (int-to-string (car articles
))
399 (setq articles
(cdr articles
)))
403 (delete-region (point) (point-max)))))
404 (or articles
(progn (erase-buffer) nil
))))))))
406 (defun nnspool-sift-nov-with-sed (articles file
)
407 (let ((first (car articles
))
408 (last (progn (while (cdr articles
) (setq articles
(cdr articles
)))
410 (call-process "awk" nil t nil
411 (format "BEGIN {firstmsg=%d; lastmsg=%d;}\n $1 >= firstmsg && $1 <= lastmsg {print;}"
412 (1- first
) (1+ last
))
415 ;; Fixed by fdc@cliwe.ping.de (Frank D. Cringle).
416 (defun nnspool-find-article-by-message-id (id)
417 "Return full pathname of an article identified by message-ID."
419 (let ((buf (get-buffer-create " *nnspool work*")))
422 (call-process "grep" nil t nil id nnspool-history-file
)
423 (goto-char (point-min))
424 (if (looking-at "<[^>]+>[ \t]+[-0-9~]+[ \t]+\\([^ \t\n]*\\)")
425 (concat nnspool-spool-directory
426 (nnspool-replace-chars-in-string
427 (buffer-substring (match-beginning 1) (match-end 1))
430 (defun nnspool-find-file (file)
431 "Insert FILE in server buffer safely."
432 (set-buffer nntp-server-buffer
)
435 (progn (insert-file-contents file
) t
)
438 (defun nnspool-possibly-change-directory (newsgroup)
440 (let ((pathname (nnspool-article-pathname
441 (nnspool-replace-chars-in-string newsgroup ?. ?
/))))
442 (if (file-directory-p pathname
)
444 (setq nnspool-current-directory pathname
)
445 (setq nnspool-current-group newsgroup
))
446 (setq nnspool-status-string
447 (format "No such newsgroup: %s" newsgroup
))
451 (defun nnspool-article-pathname (group)
452 "Make pathname for GROUP."
453 (concat (file-name-as-directory nnspool-spool-directory
) group
"/"))
455 (defun nnspool-replace-chars-in-string (string from to
)
456 "Replace characters in STRING from FROM to TO."
457 (let ((string (substring string
0)) ;Copy string.
458 (len (length string
))
460 ;; Replace all occurrences of FROM with TO.
462 (if (= (aref string idx
) from
)
463 (aset string idx to
))
467 (defun nnspool-number-base-10 (num pos
)
469 (setcdr num
(+ (* (%
(car num
) 10) 65536) (cdr num
)))
475 (aref "0123456789" (%
(cdr num
) 10)))
477 (setcdr num
(/ (cdr num
) 10))
478 (setcar num
(/ (car num
) 10))
479 (nnspool-number-base-10 num
(1- pos
))))))))
481 (defun nnspool-seconds-since-epoch (date)
482 (let* ((tdate (mapcar (lambda (ti) (and ti
(string-to-int ti
)))
483 (timezone-parse-date date
)))
484 (ttime (mapcar (lambda (ti) (and ti
(string-to-int ti
)))
486 (aref (timezone-parse-date date
) 3))))
487 (unix (encode-time (nth 2 ttime
) (nth 1 ttime
) (nth 0 ttime
)
488 (nth 2 tdate
) (nth 1 tdate
) (nth 0 tdate
) (nth 4 tdate
))))
489 (+ (* (car unix
) 65536.0)
494 ;;; nnspool.el ends here