5e253ad762fd0b0e5028076cd6a2ec61563e635e
[gnus] / lisp / nnspool.el
1 ;;; nnspool.el --- spool access for GNU Emacs
2 ;; Copyright (C) 1988,89,90,93,94,95 Free Software Foundation, Inc.
3
4 ;; Author: Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
5 ;;      Lars Magne Ingebrigtsen <larsi@ifi.uio.no>
6 ;; Keywords: news
7
8 ;; This file is part of GNU Emacs.
9
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
13 ;; any later version.
14
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 ;; GNU General Public License for more details.
19
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING.  If not, write to
22 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
23
24 ;;; Commentary:
25
26 ;;; Code:
27
28 (require 'nnheader)
29 (require 'nntp)
30 (require 'timezone)
31
32 (defvar nnspool-inews-program news-inews-program
33   "Program to post news.
34 This is most commonly `inews' or `injnews'.")
35
36 (defvar nnspool-inews-switches '("-h")
37   "Switches for nnspool-request-post to pass to `inews' for posting news.
38 If you are using Cnews, you probably should set this variable to nil.")
39
40 (defvar nnspool-spool-directory (file-name-as-directory news-path)
41   "Local news spool directory.")
42
43 (defvar nnspool-nov-directory (concat nnspool-spool-directory "over.view/")
44   "Local news nov directory.")
45
46 (defvar nnspool-lib-dir "/usr/lib/news/"
47   "Where the local news library files are stored.")
48
49 (defvar nnspool-active-file (concat nnspool-lib-dir "active")
50   "Local news active file.")
51
52 (defvar nnspool-newsgroups-file (concat nnspool-lib-dir "newsgroups")
53   "Local news newsgroups file.")
54
55 (defvar nnspool-distributions-file (concat nnspool-lib-dir "distributions")
56   "Local news distributions file.")
57
58 (defvar nnspool-history-file (concat nnspool-lib-dir "history")
59   "Local news history file.")
60
61 (defvar nnspool-active-times-file (concat nnspool-lib-dir "active.times")
62   "Local news active date file.")
63
64 (defvar nnspool-large-newsgroup 50
65   "The number of the articles which indicates a large newsgroup.
66 If the number of the articles is greater than the value, verbose
67 messages will be shown to indicate the current status.")
68
69 (defvar nnspool-nov-is-evil nil
70   "Non-nil means that nnspool will never return NOV lines instead of headers.")
71
72 (defconst nnspool-sift-nov-with-sed nil
73   "If non-nil, use sed to get the relevant portion from the overview file.
74 If nil, nnspool will load the entire file into a buffer and process it
75 there.")
76
77 (defvar nnspool-rejected-article-hook nil
78   "*A hook that will be run when an article has been rejected by the server.")
79
80 \f
81
82 (defconst nnspool-version "nnspool 2.0"
83   "Version numbers of this version of NNSPOOL.")
84
85 (defvar nnspool-current-directory nil
86   "Current news group directory.")
87
88 (defvar nnspool-current-group nil)
89 (defvar nnspool-status-string "")
90
91 \f
92
93 (defvar nnspool-current-server nil)
94 (defvar nnspool-server-alist nil)
95 (defvar nnspool-server-variables 
96   (list
97    (list 'nnspool-inews-program nnspool-inews-program)
98    (list 'nnspool-inews-switches nnspool-inews-switches)
99    (list 'nnspool-spool-directory nnspool-spool-directory)
100    (list 'nnspool-nov-directory nnspool-nov-directory)
101    (list 'nnspool-lib-dir nnspool-lib-dir)
102    (list 'nnspool-active-file nnspool-active-file)
103    (list 'nnspool-newsgroups-file nnspool-newsgroups-file)
104    (list 'nnspool-distributions-file nnspool-distributions-file)
105    (list 'nnspool-history-file nnspool-history-file)
106    (list 'nnspool-active-times-file nnspool-active-times-file)
107    (list 'nnspool-large-newsgroup nnspool-large-newsgroup)
108    (list 'nnspool-nov-is-evil nnspool-nov-is-evil)
109    (list 'nnspool-sift-nov-with-sed nnspool-sift-nov-with-sed)
110    '(nnspool-current-directory nil)
111    '(nnspool-current-group nil)
112    '(nnspool-status-string "")))
113
114 \f
115 ;;; Interface functions.
116
117 (defun nnspool-retrieve-headers (sequence &optional newsgroup server fetch-old)
118   "Retrieve the headers for the articles in SEQUENCE.
119 Newsgroup must be selected before calling this function."
120   (save-excursion
121     (set-buffer nntp-server-buffer)
122     (erase-buffer)
123     (let* ((number (length sequence))
124            (count 0)
125            (do-message (and (numberp nnspool-large-newsgroup)
126                             (> number nnspool-large-newsgroup)))
127            file beg article)
128       (if (not (nnspool-possibly-change-directory newsgroup))
129           ()
130         (if (and (numberp (car sequence))
131                  (nnspool-retrieve-headers-with-nov sequence fetch-old))
132             'nov
133           (while sequence
134             (setq article (car sequence))
135             (if (stringp article)
136                 (progn
137                   (setq file (nnspool-find-article-by-message-id article))
138                   (setq article 0))
139               (setq file (concat nnspool-current-directory 
140                                  (int-to-string article))))
141             (and file (file-exists-p file)
142                  (progn
143                    (insert (format "221 %d Article retrieved.\n" article))
144                    (setq beg (point))
145                    (nnheader-insert-head file)
146                    (goto-char beg)
147                    (search-forward "\n\n" nil t)
148                    (forward-char -1)
149                    (insert ".\n")
150                    (delete-region (point) (point-max))))
151             (setq sequence (cdr sequence))
152             
153             (and do-message
154                  (zerop (% (setq count (1+ count)) 20))
155                  (message "NNSPOOL: Receiving headers... %d%%"
156                           (/ (* count 100) number))))
157           
158           (and do-message (message "NNSPOOL: Receiving headers...done"))
159           
160           ;; Fold continuation lines.
161           (goto-char (point-min))
162           (while (re-search-forward "\\(\r?\n[ \t]+\\)+" nil t)
163             (replace-match " " t t))
164           'headers)))))
165
166 (defun nnspool-open-server (server &optional defs)
167   (nnheader-init-server-buffer)
168   (if (equal server nnspool-current-server)
169       t
170     (if nnspool-current-server
171         (setq nnspool-server-alist 
172               (cons (list nnspool-current-server
173                           (nnheader-save-variables nnspool-server-variables))
174                     nnspool-server-alist)))
175     (let ((state (assoc server nnspool-server-alist)))
176       (if state 
177           (progn
178             (nnheader-restore-variables (nth 1 state))
179             (setq nnspool-server-alist (delq state nnspool-server-alist)))
180         (nnheader-set-init-variables nnspool-server-variables defs)))
181     (setq nnspool-current-server server)))
182
183 (defun nnspool-close-server (&optional server)
184   (setq nnspool-current-server nil)
185   t)
186
187 (defun nnspool-server-opened (&optional server)
188   (and (equal server nnspool-current-server)
189        nntp-server-buffer
190        (buffer-name nntp-server-buffer)))
191
192 (defun nnspool-status-message (&optional server)
193   "Return server status response as string."
194   nnspool-status-string)
195
196 (defun nnspool-request-article (id &optional newsgroup server buffer)
197   "Select article by message ID (or number)."
198   (nnspool-possibly-change-directory newsgroup)
199   (let* ((group (if (stringp id)
200                     (nnspool-find-article-by-message-id id)
201                   nnspool-current-group))
202          (file (and group (nnspool-article-pathname group id)))
203          (nntp-server-buffer (or buffer nntp-server-buffer)))
204     (and file
205          (file-exists-p file)
206          (not (file-directory-p file))
207          (save-excursion (nnspool-find-file file))
208          ;; We return the article number.
209          (if (numberp id)
210              (cons newsgroup id)
211            (cons group id)))))
212             
213 (defun nnspool-request-body (id &optional newsgroup server)
214   "Select article body by message ID (or number)."
215   (nnspool-possibly-change-directory newsgroup)
216   (if (nnspool-request-article id)
217       (save-excursion
218         (set-buffer nntp-server-buffer)
219         (goto-char (point-min))
220         (if (search-forward "\n\n" nil t)
221             (delete-region (point-min) (point)))
222         t)))
223
224 (defun nnspool-request-head (id &optional newsgroup server)
225   "Select article head by message ID (or number)."
226   (nnspool-possibly-change-directory newsgroup)
227   (if (nnspool-request-article id)
228       (save-excursion
229         (set-buffer nntp-server-buffer)
230         (goto-char (point-min))
231         (if (search-forward "\n\n" nil t)
232             (delete-region (1- (point)) (point-max)))
233         t)))
234
235 (defun nnspool-request-group (group &optional server dont-check)
236   "Select news GROUP."
237   (let ((pathname (nnspool-article-pathname group))
238         dir)
239     (if (not (file-directory-p pathname))
240         (progn
241           (setq nnspool-status-string
242                 "Invalid group name (no such directory)")
243           nil)
244       (setq nnspool-current-directory pathname)
245       (setq nnspool-status-string "")
246       (if (not dont-check)
247           (progn
248             (setq dir (directory-files pathname nil "^[0-9]+$" t))
249             ;; yes, completely empty spool directories *are* possible
250             ;; Fix by Sudish Joseph <joseph@cis.ohio-state.edu>
251             (and dir
252                  (setq dir
253                        (sort 
254                         (mapcar
255                          (function
256                           (lambda (name)
257                             (string-to-int name)))
258                          dir)
259                         '<)))
260             (save-excursion
261               (set-buffer nntp-server-buffer)
262               (erase-buffer)
263               (if dir
264                   (insert
265                    (format "211 %d %d %d %s\n" (length dir) (car dir)
266                            (progn (while (cdr dir) (setq dir (cdr dir)))
267                                   (car dir))
268                            group))
269                 (insert (format "211 0 0 0 %s\n" group))))))
270       t)))
271
272 (defun nnspool-close-group (group &optional server)
273   t)
274
275 (defun nnspool-request-list (&optional server)
276   "List active newsgroups."
277   (save-excursion
278     (nnspool-find-file nnspool-active-file)))
279
280 (defun nnspool-request-list-newsgroups (&optional server)
281   "List newsgroups (defined in NNTP2)."
282   (save-excursion
283     (nnspool-find-file nnspool-newsgroups-file)))
284
285 (defun nnspool-request-list-distributions (&optional server)
286   "List distributions (defined in NNTP2)."
287   (save-excursion
288     (nnspool-find-file nnspool-distributions-file)))
289
290 ;; Suggested by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
291 (defun nnspool-request-newgroups (date &optional server)
292   "List groups created after DATE."
293   (if (nnspool-find-file nnspool-active-times-file)
294       (save-excursion
295         ;; Find the last valid line.
296         (goto-char (point-max))
297         (while (and (not (looking-at 
298                           "\\([^ ]+\\) +\\([0-9]+\\)[0-9][0-9][0-9] "))
299                     (zerop (forward-line -1))))
300         (let ((seconds (nnspool-seconds-since-epoch date))
301               groups)
302           ;; Go through lines and add the latest groups to a list.
303           (while (and (looking-at "\\([^ ]+\\) +[0-9]+ ")
304                       (progn
305                         ;; We insert a .0 to make the list reader
306                         ;; interpret the number as a float. It is far
307                         ;; too big to be stored in a lisp integer. 
308                         (goto-char (1- (match-end 0)))
309                         (insert ".0")
310                         (> (progn
311                              (goto-char (match-end 1))
312                              (read (current-buffer)))
313                            seconds))
314                       (setq groups (cons (buffer-substring
315                                           (match-beginning 1) (match-end 1))
316                                          groups))
317                       (zerop (forward-line -1))))
318           (erase-buffer)
319           (while groups
320             (insert (car groups) " 0 0 y\n")
321             (setq groups (cdr groups))))
322         t)
323     nil))
324
325 (defun nnspool-request-post (&optional server)
326   "Post a new news in current buffer."
327   (save-excursion
328     (let* ((process-connection-type nil) ; t bugs out on Solaris
329            (inews-buffer (generate-new-buffer " *nnspool post*"))
330            (proc 
331             (condition-case err
332                 (apply 'start-process "*nnspool inews*" inews-buffer
333                        nnspool-inews-program nnspool-inews-switches)
334               (error
335                (setq nnspool-status-string (format "inews error: %S" err))
336                nil))))
337       (if (not proc)
338           ;; The inews program failed.
339           ()
340         (setq nnspool-status-string "")
341         (set-process-sentinel proc 'nnspool-inews-sentinel)
342         (process-send-region proc (point-min) (point-max))
343         ;; We slap a condition-case around this, because the process may
344         ;; have exited already...
345         (condition-case nil
346             (process-send-eof proc)
347           (error nil))
348         t))))
349
350 (defun nnspool-inews-sentinel (proc status)
351   (save-excursion
352     (set-buffer (process-buffer proc))
353     (goto-char (point-min))
354     (if (or (zerop (buffer-size))
355             (search-forward "spooled" nil t))
356         (kill-buffer (current-buffer))
357       ;; Make status message by folding lines.
358       (while (re-search-forward "[ \t\n]+" nil t)
359         (replace-match " " t t))
360       (setq nnspool-status-string (buffer-string))
361       (message "nnspool: %s" nnspool-status-string)
362       (ding)
363       (run-hooks 'nnspool-rejected-article-hook))))
364
365 \f
366 ;;; Internal functions.
367
368 (defun nnspool-retrieve-headers-with-nov (articles &optional fetch-old)
369   (if (or gnus-nov-is-evil nnspool-nov-is-evil)
370       nil
371     (let ((nov (concat (file-name-as-directory nnspool-nov-directory)
372                        (nnspool-replace-chars-in-string
373                         nnspool-current-group ?. ?/)
374                        "/.overview")))
375       (if (not (file-exists-p nov))
376           ()
377         (save-excursion
378           (set-buffer nntp-server-buffer)
379           (erase-buffer)
380           (if nnspool-sift-nov-with-sed
381               (nnspool-sift-nov-with-sed articles nov)
382             (insert-file-contents nov)
383             (if (and fetch-old
384                      (not (numberp fetch-old)))
385                 t                       ; We want all the headers.
386               ;; First we find the first wanted line.
387               (nnspool-find-nov-line
388                (if fetch-old (max 1 (- (car articles) fetch-old))
389                  (car articles)))
390               (delete-region (point-min) (point))
391               ;; Then we find the last wanted line. 
392               (if (nnspool-find-nov-line 
393                    (progn (while (cdr articles) (setq articles (cdr articles)))
394                           (car articles)))
395                   (forward-line 1))
396               (delete-region (point) (point-max))
397               ;; If the buffer is empty, this wasn't very successful.
398               (not (zerop (buffer-size))))))))))
399
400 (defun nnspool-find-nov-line (article)
401   (let ((max (point-max))
402         (min (goto-char (point-min)))
403         (cur (current-buffer))
404         (prev (point-min))
405         num found)
406     (if (or (eobp)
407             (>= (read cur) article))
408         (beginning-of-line)
409       (while (not found)
410         (goto-char (/ (+ max min) 2))
411         (forward-line 1)
412         (if (or (= (point) prev)
413                 (eobp))
414             (setq found t)
415           (setq prev (point))
416           (cond ((> (setq num (read cur)) article)
417                  (setq max (point)))
418                 ((< num article)
419                  (setq min (point)))
420                 (t
421                  (setq found t))))
422         (beginning-of-line))
423       (or (not num) (= num article)))))
424     
425
426 (defun nnspool-sift-nov-with-sed (articles file)
427   (let ((first (car articles))
428         (last (progn (while (cdr articles) (setq articles (cdr articles)))
429                      (car articles))))
430     (call-process "awk" nil t nil 
431                   (format "BEGIN {firstmsg=%d; lastmsg=%d;}\n $1 >= firstmsg && $1 <= lastmsg {print;}"
432                           (1- first) (1+ last))
433                   file)))
434
435 ;; Fixed by fdc@cliwe.ping.de (Frank D. Cringle). 
436 ;; Find out what group an article identified by a Message-ID is in.
437 (defun nnspool-find-article-by-message-id (id)
438   (save-excursion
439     (set-buffer (get-buffer-create " *nnspool work*"))
440     (buffer-disable-undo (current-buffer))
441     (erase-buffer)
442     (call-process "grep" nil t nil id nnspool-history-file)
443     (goto-char (point-min))
444     (prog1
445         (if (looking-at "<[^>]+>[ \t]+[-0-9~]+[ \t]+\\([^ \t\n]*\\)")
446             (buffer-substring (match-beginning 1) (match-end 1)))
447       (kill-buffer (current-buffer)))))
448
449 (defun nnspool-find-file (file)
450   "Insert FILE in server buffer safely."
451   (set-buffer nntp-server-buffer)
452   (erase-buffer)
453   (condition-case ()
454       (progn (insert-file-contents file) t)
455     (file-error nil)))
456
457 (defun nnspool-possibly-change-directory (newsgroup)
458   (if newsgroup
459       (let ((pathname (nnspool-article-pathname newsgroup)))
460         (if (file-directory-p pathname)
461             (progn
462               (setq nnspool-current-directory pathname)
463               (setq nnspool-current-group newsgroup))
464           (setq nnspool-status-string 
465                 (format "No such newsgroup: %s" newsgroup))
466           nil))
467     t))
468
469 (defun nnspool-article-pathname (group &optional article)
470   "Find the path for GROUP."
471   (concat 
472    (file-name-as-directory nnspool-spool-directory) 
473    (nnspool-replace-chars-in-string group ?. ?/)
474    "/"
475    (if article (int-to-string article) "")))
476
477 (defun nnspool-replace-chars-in-string (string from to)
478   "Replace characters in STRING from FROM to TO."
479   (let ((string (substring string 0))   ;Copy string.
480         (len (length string))
481         (idx 0))
482     ;; Replace all occurrences of FROM with TO.
483     (while (< idx len)
484       (if (= (aref string idx) from)
485           (aset string idx to))
486       (setq idx (1+ idx)))
487     string))
488
489 (defun nnspool-number-base-10 (num pos)
490   (if (<= pos 0) ""
491     (setcdr num (+ (* (% (car num) 10) 65536) (cdr num)))
492     (apply
493      'concat
494      (reverse
495       (list
496        (char-to-string
497         (aref "0123456789" (% (cdr num) 10)))
498        (progn
499          (setcdr num (/ (cdr num) 10))
500          (setcar num (/ (car num) 10))
501          (nnspool-number-base-10 num (1- pos))))))))
502
503 (defun nnspool-seconds-since-epoch (date)
504   (let* ((tdate (mapcar (lambda (ti) (and ti (string-to-int ti)))
505                         (timezone-parse-date date)))
506          (ttime (mapcar (lambda (ti) (and ti (string-to-int ti)))
507                         (timezone-parse-time
508                          (aref (timezone-parse-date date) 3))))
509          (unix (encode-time (nth 2 ttime) (nth 1 ttime) (nth 0 ttime)
510                             (nth 2 tdate) (nth 1 tdate) (nth 0 tdate) 
511                             (nth 4 tdate))))
512     (+ (* (car unix) 65536.0)
513        (car (cdr unix)))))
514
515 (provide 'nnspool)
516
517 ;;; nnspool.el ends here