*** empty log message ***
[gnus] / lisp / nntp.el
1 ;;; Copyright (C) 1987,88,89,90,92,93,94,95,96 Free Software Foundation, Inc.
2
3 ;; Author: Lars Magne Ingebrigtsen <larsi@ifi.uio.no>
4 ;; Keywords: news
5
6 ;; This file is part of GNU Emacs.
7
8 ;; GNU Emacs is free software; you can redistribute it and/or modify
9 ;; it under the terms of the GNU General Public License as published by
10 ;; the Free Software Foundation; either version 2, or (at your option)
11 ;; any later version.
12
13 ;; GNU Emacs is distributed in the hope that it will be useful,
14 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
15 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 ;; GNU General Public License for more details.
17
18 ;; You should have received a copy of the GNU General Public License
19 ;; along with GNU Emacs; see the file COPYING.  If not, write to
20 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
21
22 ;;; Commentary:
23
24 ;;; Code:
25
26 (require 'nnheader)
27 (require 'nnoo)
28 (require 'gnus-util)
29
30 (nnoo-declare nntp)
31
32 (eval-and-compile
33   (unless (fboundp 'open-network-stream)
34     (require 'tcp)))
35
36 (eval-when-compile (require 'cl))
37
38 (defvoo nntp-address nil
39   "Address of the physical nntp server.")
40
41 (defvoo nntp-port-number "nntp"
42   "Port number on the physical nntp server.")
43
44 (defvoo nntp-server-opened-hook '(nntp-send-mode-reader)
45   "*Hook used for sending commands to the server at startup.  
46 The default value is `nntp-send-mode-reader', which makes an innd
47 server spawn an nnrpd server.  Another useful function to put in this
48 hook might be `nntp-send-authinfo', which will prompt for a password
49 to allow posting from the server.  Note that this is only necessary to
50 do on servers that use strict access control.")  
51
52 (defvoo nntp-authinfo-function 'nntp-send-authinfo
53   "Function used to send AUTHINFO to the server.")
54
55 (defvoo nntp-server-action-alist 
56   '(("nntpd 1\\.5\\.11t" 
57      (remove-hook 'nntp-server-opened-hook 'nntp-send-mode-reader))
58     ("NNRP server Netscape" 
59      (setq nntp-server-list-active-group nil)))
60   "Alist of regexps to match on server types and actions to be taken.
61 For instance, if you want Gnus to beep every time you connect
62 to innd, you could say something like:
63
64 \(setq nntp-server-action-alist
65        '((\"innd\" (ding))))
66
67 You probably don't want to do that, though.")
68
69 (defvoo nntp-open-connection-function 'nntp-open-network-stream
70   "*Function used for connecting to a remote system.
71 It will be called with the buffer to output in.
72
73 Two pre-made functions are `nntp-open-network-stream', which is the
74 default, and simply connects to some port or other on the remote
75 system (see nntp-port-number).  The other are `nntp-open-rlogin', which
76 does an rlogin on the remote system, and then does a telnet to the
77 NNTP server available there (see nntp-rlogin-parameters) and `nntp-open-telnet' which
78 telnets to a remote system, logs in and does the same")
79
80 (defvoo nntp-rlogin-parameters '("telnet" "-8" "${NNTPSERVER:=news}" "nntp")
81   "*Parameters to `nntp-open-login'.
82 That function may be used as `nntp-open-server-function'.  In that
83 case, this list will be used as the parameter list given to rsh.")
84
85 (defvoo nntp-rlogin-user-name nil
86   "*User name on remote system when using the rlogin connect method.")
87
88 (defvoo nntp-telnet-parameters '("exec" "telnet" "-8" "${NNTPSERVER:=news}" "nntp")
89   "*Parameters to `nntp-open-telnet'.
90 That function may be used as `nntp-open-server-function'.  In that
91 case, this list will be executed as a command after logging in
92 via telnet.")
93
94 (defvoo nntp-telnet-user-name nil
95   "User name to log in via telnet with.")
96
97 (defvoo nntp-telnet-passwd nil
98   "Password to use to log in via telnet with.")
99
100 (defvoo nntp-end-of-line "\r\n"
101   "String to use on the end of lines when talking to the NNTP server.
102 This is \"\\r\\n\" by default, but should be \"\\n\" when
103 using rlogin or telnet to communicate with the server.")
104
105 (defvoo nntp-large-newsgroup 50
106   "*The number of the articles which indicates a large newsgroup.
107 If the number of the articles is greater than the value, verbose
108 messages will be shown to indicate the current status.")
109
110 (defvoo nntp-maximum-request 400
111   "*The maximum number of the requests sent to the NNTP server at one time.
112 If Emacs hangs up while retrieving headers, set the variable to a
113 lower value.")
114
115 (defvoo nntp-nov-is-evil nil
116   "*If non-nil, nntp will never attempt to use XOVER when talking to the server.")
117
118 (defvoo nntp-xover-commands '("XOVER" "XOVERVIEW")
119   "*List of strings that are used as commands to fetch NOV lines from a server.
120 The strings are tried in turn until a positive response is gotten.  If
121 none of the commands are successful, nntp will just grab headers one
122 by one.")
123
124 (defvoo nntp-nov-gap 20
125   "*Maximum allowed gap between two articles.
126 If the gap between two consecutive articles is bigger than this
127 variable, split the XOVER request into two requests.")
128
129 (defvoo nntp-connection-timeout nil
130   "*Number of seconds to wait before an nntp connection times out.
131 If this variable is nil, which is the default, no timers are set.")
132
133 (defvoo nntp-prepare-server-hook nil
134   "*Hook run before a server is opened.
135 If can be used to set up a server remotely, for instance.  Say you
136 have an account at the machine \"other.machine\".  This machine has
137 access to an NNTP server that you can't access locally.  You could
138 then use this hook to rsh to the remote machine and start a proxy NNTP
139 server there that you can connect to.  See also `nntp-open-connection-function'")
140
141 (defvoo nntp-warn-about-losing-connection t
142   "*If non-nil, beep when a server closes connection.")
143
144 \f
145
146 ;;; Internal variables.
147
148 (defvar nntp-process-wait-for nil)
149 (defvar nntp-process-to-buffer nil)
150 (defvar nntp-process-callback nil)
151 (defvar nntp-process-decode nil)
152 (defvar nntp-process-start-point nil)
153 (defvar nntp-inside-change-function nil)
154
155 (defvar nntp-connection-list nil)
156
157 (defvoo nntp-server-type nil)
158 (defvoo nntp-connection-alist nil)
159 (defvoo nntp-status-string "")
160 (defconst nntp-version "nntp 5.0")
161 (defvoo nntp-inhibit-erase nil)
162
163 (defvoo nntp-server-xover 'try)
164 (defvoo nntp-server-list-active-group 'try)
165
166 (eval-and-compile
167   (autoload 'nnmail-read-passwd "nnmail"))
168
169 \f
170
171 ;;; Interface functions.
172
173 (nnoo-define-basics nntp)
174
175 (deffoo nntp-retrieve-headers (articles &optional group server fetch-old)
176   "Retrieve the headers of ARTICLES."
177   (nntp-possibly-change-group group server)
178   (save-excursion
179     (set-buffer (nntp-find-connection-buffer nntp-server-buffer))
180     (erase-buffer)
181     (if (and (not gnus-nov-is-evil) 
182              (not nntp-nov-is-evil)
183              (nntp-retrieve-headers-with-xover articles fetch-old))
184         ;; We successfully retrieved the headers via XOVER.
185         'nov
186       ;; XOVER didn't work, so we do it the hard, slow and inefficient
187       ;; way.  
188       (let ((number (length articles))
189             (count 0)
190             (received 0)
191             (last-point (point-min))
192             (buf (nntp-find-connection-buffer nntp-server-buffer))
193             (nntp-inhibit-erase t))
194         ;; Send HEAD command.
195         (while articles
196           (nntp-send-command 
197            nil
198            "HEAD" (if (numberp (car articles)) 
199                       (int-to-string (car articles))
200                     ;; `articles' is either a list of article numbers
201                     ;; or a list of article IDs.
202                     (car articles)))
203           (setq articles (cdr articles)
204                 count (1+ count))
205           ;; Every 400 header requests we have to read the stream in
206           ;; order to avoid deadlocks.
207           (when (or (null articles)     ;All requests have been sent.
208                     (zerop (% count nntp-maximum-request)))
209             (nntp-accept-response)
210             (while (progn
211                      (progn
212                        (set-buffer buf)
213                        (goto-char last-point))
214                      ;; Count replies.
215                      (while (re-search-forward "^[0-9]" nil t)
216                        (incf received))
217                      (setq last-point (point))
218                      (< received count))
219               ;; If number of headers is greater than 100, give
220               ;;  informative messages.
221               (and (numberp nntp-large-newsgroup)
222                    (> number nntp-large-newsgroup)
223                    (zerop (% received 20))
224                    (message "NNTP: Receiving headers... %d%%"
225                             (/ (* received 100) number)))
226               (nntp-accept-response))))
227         ;; Wait for text of last command.
228         (goto-char (point-max))
229         (re-search-backward "^[0-9]" nil t)
230         (when (looking-at "^[23]")
231           (while (progn
232                    (goto-char (- (point-max) 3))
233                    (not (looking-at "^\\.\r?\n")))
234             (nntp-accept-response)))
235         (and (numberp nntp-large-newsgroup)
236              (> number nntp-large-newsgroup)
237              (message "NNTP: Receiving headers...done"))
238
239         ;; Now all of replies are received.  Fold continuation lines.
240         (nnheader-fold-continuation-lines)
241         ;; Remove all "\r"'s.
242         (goto-char (point-min))
243         (while (search-forward "\r" nil t)
244           (replace-match "" t t))
245         (copy-to-buffer nntp-server-buffer (point-min) (point-max))
246         'headers))))
247
248 (deffoo nntp-retrieve-groups (groups &optional server)
249   "Retrieve group info on GROUPS."
250   (nntp-possibly-change-group nil server)
251   (save-excursion
252     (set-buffer (nntp-find-connection-buffer nntp-server-buffer))
253     ;; The first time this is run, this variable is `try'.  So we
254     ;; try.   
255     (when (eq nntp-server-list-active-group 'try)
256       (nntp-try-list-active (car groups)))
257     (erase-buffer)
258     (let ((count 0)
259           (received 0)
260           (last-point (point-min))
261           (nntp-inhibit-erase t)
262           (command (if nntp-server-list-active-group "LIST ACTIVE" "GROUP")))
263       (while groups
264         ;; Send the command to the server.
265         (nntp-send-command nil command (pop groups))
266         (incf count)
267         ;; Every 400 requests we have to read the stream in
268         ;; order to avoid deadlocks.
269         (when (or (null groups)         ;All requests have been sent.
270                   (zerop (% count nntp-maximum-request)))
271           (nntp-accept-response)
272           (while (progn
273                    (goto-char last-point)
274                    ;; Count replies.
275                    (while (re-search-forward "^[0-9]" nil t)
276                      (incf received))
277                    (setq last-point (point))
278                    (< received count))
279             (nntp-accept-response))))
280
281       ;; Wait for the reply from the final command.
282       (goto-char (point-max))
283       (re-search-backward "^[0-9]" nil t)
284       (when (looking-at "^[23]")
285         (while (progn
286                  (goto-char (point-max))
287                  (if (not nntp-server-list-active-group)
288                      (not (re-search-backward "\r?\n" (- (point) 3) t))
289                    (not (re-search-backward "^\\.\r?\n" (- (point) 4) t))))
290           (nntp-accept-response)))
291
292       ;; Now all replies are received.  We remove CRs.
293       (goto-char (point-min))
294       (while (search-forward "\r" nil t)
295         (replace-match "" t t))
296
297       (if (not nntp-server-list-active-group)
298           (progn
299             (copy-to-buffer nntp-server-buffer (point-min) (point-max))
300             'group)
301         ;; We have read active entries, so we just delete the
302         ;; superfluous gunk.
303         (goto-char (point-min))
304         (while (re-search-forward "^[.2-5]" nil t)
305           (delete-region (match-beginning 0) 
306                          (progn (forward-line 1) (point))))
307         (copy-to-buffer nntp-server-buffer (point-min) (point-max))
308         'active))))
309
310 (defun nntp-try-list-active (group)
311   (nntp-list-active-group group)
312   (save-excursion
313     (goto-char (point-min))
314     (cond ((looking-at "5[0-9]+")
315            (setq nntp-server-list-active-group nil))
316           (t
317            (setq nntp-server-list-active-group t)))))
318
319 (deffoo nntp-list-active-group (group &optional server)
320   "Return the active info on GROUP (which can be a regexp."
321   (nntp-possibly-change-group nil server)
322   (nntp-send-command "^.*\r?\n" "LIST ACTIVE" group))
323
324 (deffoo nntp-request-article (article &optional group server buffer command)
325   (nntp-possibly-change-group group server)
326   (when (nntp-send-command-and-decode
327          "\r?\n\\.\r?\n" "ARTICLE"
328          (if (numberp article) (int-to-string article) article))
329     (when (and buffer
330                (not (equal buffer nntp-server-buffer)))
331       (save-excursion
332         (set-buffer nntp-server-buffer)
333         (copy-to-buffer buffer (point-min) (point-max))
334         (nntp-find-group-and-number)))
335     (nntp-find-group-and-number)))
336
337 (deffoo nntp-request-head (article &optional group server)
338   (nntp-possibly-change-group group server)
339   (when (nntp-send-command-and-decode
340          "\r\n\\.\r\n" "HEAD"
341          (if (numberp article) (int-to-string article) article))
342     (nntp-find-group-and-number)))
343
344 (deffoo nntp-request-body (article &optional group server)
345   (nntp-possibly-change-group group server)
346   (nntp-send-command-and-decode
347    "\r?\n\\.\r?\n" "BODY"
348    (if (numberp article) (int-to-string article) article)))
349
350 (deffoo nntp-request-group (group &optional server dont-check)
351   (nntp-possibly-change-group nil server)
352   (when (nntp-send-command "^2.*\n" "GROUP" group)
353     (let ((entry (nntp-find-connection-entry nntp-server-buffer)))
354       (setcar (cddr entry) group))))
355
356 (deffoo nntp-close-group (group &optional server)
357   t)
358
359 (deffoo nntp-server-opened (&optional server)
360   "Say whether a connection to SERVER has been opened."
361   (and (nnoo-current-server-p 'nntp server)
362        nntp-server-buffer
363        (gnus-buffer-live-p nntp-server-buffer)
364        (nntp-find-connection nntp-server-buffer)))
365
366 (deffoo nntp-open-server (server &optional defs connectionless)
367   (nnheader-init-server-buffer)
368   (if (nntp-server-opened server)
369       t
370     (when (or (stringp (car defs))
371               (numberp (car defs)))
372       (setq defs (cons (list 'nntp-port-number (car defs)) (cdr defs))))
373     (unless (assq 'nntp-address defs)
374       (setq defs (append defs (list (list 'nntp-address server)))))
375     (nnoo-change-server 'nntp server defs)
376     (unless connectionless
377       (or (nntp-find-connection nntp-server-buffer)
378           (nntp-open-connection nntp-server-buffer)))))
379
380 (deffoo nntp-close-server (&optional server)
381   (nntp-possibly-change-group nil server t)
382   (let (process)
383     (while (setq process (car (pop nntp-connection-alist)))
384       (when (memq (process-status process) '(open run))
385         (set-process-sentinel process nil)
386         (nntp-send-string process "QUIT"))
387       (when (buffer-name (process-buffer process))
388         (kill-buffer (process-buffer process))))
389     (nnoo-close-server 'nntp)))
390
391 (deffoo nntp-request-close ()
392   (let (process)
393     (while (setq process (pop nntp-connection-list))
394       (when (memq (process-status process) '(open run))
395         (set-process-sentinel process nil)
396         (nntp-send-string process "QUIT"))
397       (when (buffer-name (process-buffer process))
398         (kill-buffer (process-buffer process))))))
399
400 (deffoo nntp-request-list (&optional server)
401   (nntp-possibly-change-group nil server)
402   (nntp-send-command-and-decode "\r?\n\\.\r?\n" "LIST"))
403
404 (deffoo nntp-request-list-newsgroups (&optional server)
405   (nntp-possibly-change-group nil server)
406   (nntp-send-command "\r?\n\\.\r?\n" "LIST NEWSGROUPS"))
407
408 (deffoo nntp-request-newgroups (date &optional server)
409   (nntp-possibly-change-group nil server)
410   (save-excursion
411     (set-buffer nntp-server-buffer)
412     (let* ((date (timezone-parse-date date))
413            (time-string
414             (format "%s%02d%02d %s%s%s"
415                     (substring (aref date 0) 2) (string-to-int (aref date 1)) 
416                     (string-to-int (aref date 2)) (substring (aref date 3) 0 2)
417                     (substring 
418                      (aref date 3) 3 5) (substring (aref date 3) 6 8))))
419       (prog1
420           (nntp-send-command "^\\.\r?\n" "NEWGROUPS" time-string)
421         (nntp-decode-text)))))
422
423 (deffoo nntp-request-post (&optional server)
424   (nntp-possibly-change-group nil server)
425   (when (nntp-send-command "^[23].*\r?\n" "POST")
426     (nntp-send-buffer "^[23].*\n")))
427
428 (deffoo nntp-request-type (group article)
429   'news)
430   
431 (deffoo nntp-asynchronous-p ()
432   t)
433
434 ;;; Hooky functions.
435
436 (defun nntp-send-mode-reader ()
437   "Send the MODE READER command to the nntp server.
438 This function is supposed to be called from `nntp-server-opened-hook'.
439 It will make innd servers spawn an nnrpd process to allow actual article
440 reading."
441   (nntp-send-command "^.*\r?\n" "MODE READER"))
442
443 (defun nntp-send-nosy-authinfo ()
444   "Send the AUTHINFO to the nntp server.
445 This function is supposed to be called from `nntp-server-opened-hook'.
446 It will prompt for a password."
447   (nntp-send-command "^.*\r?\n" "AUTHINFO USER"
448                      (read-string "NNTP user name: "))
449   (nntp-send-command "^.*\r?\n" "AUTHINFO PASS" 
450                      (nnmail-read-passwd "NNTP password: ")))
451
452 (defun nntp-send-authinfo ()
453   "Send the AUTHINFO to the nntp server.
454 This function is supposed to be called from `nntp-server-opened-hook'.
455 It will prompt for a password."
456   (nntp-send-command "^.*\r?\n" "AUTHINFO USER" (user-login-name))
457   (nntp-send-command "^.*\r?\n" "AUTHINFO PASS" 
458                      (read-string "NNTP password: ")))
459
460 (defun nntp-send-authinfo-from-file ()
461   "Send the AUTHINFO to the nntp server.
462 This function is supposed to be called from `nntp-server-opened-hook'.
463 It will prompt for a password."
464   (when (file-exists-p "~/.nntp-authinfo")
465     (save-excursion
466       (set-buffer (get-buffer-create " *authinfo*"))
467       (buffer-disable-undo (current-buffer))
468       (erase-buffer)
469       (insert-file-contents "~/.nntp-authinfo")
470       (goto-char (point-min))
471       (nntp-send-command "^.*\r?\n" "AUTHINFO USER" (user-login-name))
472       (nntp-send-command 
473        "^.*\r?\n" "AUTHINFO PASS" 
474        (buffer-substring (point) (progn (end-of-line) (point))))
475       (kill-buffer (current-buffer)))))
476
477 ;;; Internal functions.
478
479 (defun nntp-send-command (wait-for &rest strings)
480   "Send STRINGS to server and wait until WAIT-FOR returns."
481   (unless nnheader-callback-function
482     (save-excursion
483       (set-buffer nntp-server-buffer)
484       (erase-buffer)))
485   (nntp-retrieve-data
486    (mapconcat 'identity strings " ") 
487    nntp-address nntp-port-number nntp-server-buffer
488    wait-for nnheader-callback-function))
489
490 (defun nntp-send-command-nodelete (wait-for &rest strings)
491   "Send STRINGS to server and wait until WAIT-FOR returns."
492   (nntp-retrieve-data
493    (mapconcat 'identity strings " ") 
494    nntp-address nntp-port-number nntp-server-buffer
495    wait-for nnheader-callback-function))
496
497 (defun nntp-send-command-and-decode (wait-for &rest strings)
498   "Send STRINGS to server and wait until WAIT-FOR returns."
499   (unless nnheader-callback-function
500     (save-excursion
501       (set-buffer nntp-server-buffer)
502       (erase-buffer)))
503   (nntp-retrieve-data
504    (mapconcat 'identity strings " ") 
505    nntp-address nntp-port-number nntp-server-buffer
506    wait-for nnheader-callback-function t))
507
508 (defun nntp-send-buffer (wait-for)
509   "Send the current buffer to server and wait until WAIT-FOR returns."
510   (unless nnheader-callback-function
511     (save-excursion
512       (set-buffer (nntp-find-connection-buffer nntp-server-buffer))
513       (erase-buffer)))
514   (nntp-encode-text)
515   (process-send-region (nntp-find-connection nntp-server-buffer)
516                        (point-min) (point-max))
517   (nntp-retrieve-data
518    nil nntp-address nntp-port-number nntp-server-buffer
519    wait-for nnheader-callback-function))
520
521 (defun nntp-find-connection (buffer)
522   "Find the connection delivering to BUFFER."
523   (let ((alist nntp-connection-alist)
524         (buffer (if (stringp buffer) (get-buffer buffer) buffer))
525         process entry)
526     (while (setq entry (pop alist))
527       (when (eq buffer (cadr entry))
528         (setq process (car entry)
529               alist nil)))
530     (when process
531       (if (memq (process-status process) '(open run))
532           process
533         (when (buffer-name (process-buffer process))
534           (kill-buffer (process-buffer process)))
535         (setq nntp-connection-alist (delq entry nntp-connection-alist))
536         nil))))
537
538 (defun nntp-find-connection-entry (buffer)
539   "Return the entry for the connection to BUFFER."
540   (assq (nntp-find-connection buffer) nntp-connection-alist))
541
542 (defun nntp-find-connection-buffer (buffer)
543   "Return the process connection buffer tied to BUFFER."
544   (let ((process (nntp-find-connection buffer)))
545     (when process
546       (process-buffer process))))
547
548 (defun nntp-make-process-buffer (buffer)
549   "Create a new, fresh buffer usable for nntp process connections."
550   (save-excursion
551     (set-buffer 
552      (generate-new-buffer
553       (format " *server %s %s %s*"
554               nntp-address nntp-port-number
555               (buffer-name (get-buffer buffer)))))
556     (buffer-disable-undo (current-buffer))
557     (set (make-local-variable 'after-change-functions) nil)
558     (set (make-local-variable 'nntp-process-wait-for) nil)
559     (set (make-local-variable 'nntp-process-callback) nil)
560     (set (make-local-variable 'nntp-process-to-buffer) nil)
561     (set (make-local-variable 'nntp-process-start-point) nil)
562     (set (make-local-variable 'nntp-process-decode) nil)
563     (current-buffer)))
564
565 (defun nntp-open-connection (buffer)
566   "Open a connection to PORT on ADDRESS delivering output to BUFFER."
567   (run-hooks 'nntp-prepare-server-hook)
568   (let* ((pbuffer (nntp-make-process-buffer buffer))
569          (process
570           (condition-case ()
571               (funcall
572                nntp-open-connection-function pbuffer)
573             (error nil))))
574     (when process
575       (process-kill-without-query process)
576       (nntp-wait-for process "^.*\n" buffer)
577       (if (memq (process-status process) '(open run))
578           (prog1
579               (caar (push (list process buffer nil) 
580                           nntp-connection-alist))
581             (push process nntp-connection-list)
582             (nntp-read-server-type)
583             (run-hooks 'nntp-server-opened-hook))
584         (when (buffer-name (process-buffer process))
585           (kill-buffer (process-buffer process)))
586         nil))))
587
588 (defun nntp-open-network-stream (buffer)
589   (open-network-stream "nntpd" buffer nntp-address nntp-port-number))
590
591 (defun nntp-read-server-type ()
592   "Find out what the name of the server we have connected to is."
593   ;; Wait for the status string to arrive.
594   (setq nntp-server-type (buffer-string))
595   (let ((alist nntp-server-action-alist)
596         entry)
597     ;; Run server-specific commands.
598     (while alist
599       (setq entry (pop alist))
600       (when (string-match (car entry) nntp-server-type)
601         (if (and (listp (cadr entry))
602                  (not (eq 'lambda (caadr entry))))
603             (eval (cadr entry))
604           (funcall (cadr entry)))))))
605
606 (defun nntp-after-change-function-callback (beg end len)
607   (when nntp-process-callback
608     (save-match-data
609       (if (and (= beg (point-min))
610                (memq (char-after beg) '(?4 ?5)))
611           ;; Report back error messages.
612           (save-excursion
613             (goto-char beg)
614             (if (looking-at "480")
615                 (funcall nntp-authinfo-function)
616               (nntp-snarf-error-message)
617               (funcall nntp-process-callback nil)))
618         (goto-char end)
619         (when (and (> (point) nntp-process-start-point)
620                    (re-search-backward nntp-process-wait-for
621                                        nntp-process-start-point t))
622           (when (buffer-name (get-buffer nntp-process-to-buffer))
623             (let ((cur (current-buffer))
624                   (start nntp-process-start-point))
625               (save-excursion
626                 (set-buffer (get-buffer nntp-process-to-buffer))
627                 (goto-char (point-max))
628                 (let ((b (point)))
629                   (insert-buffer-substring cur start)
630                   (narrow-to-region b (point-max))
631                   (nntp-decode-text)
632                   (goto-char (point-min))
633                   (gnus-delete-line)
634                   (widen)))))
635           (goto-char end)
636           (let ((callback nntp-process-callback)
637                 (nntp-inside-change-function t))
638             (setq nntp-process-callback nil)
639             (save-excursion
640               (funcall callback t))))))))
641
642 (defun nntp-retrieve-data (command address port buffer
643                                    &optional wait-for callback decode)
644   "Use COMMAND to retrieve data into BUFFER from PORT on ADDRESS."
645   (let ((process (or (nntp-find-connection buffer)
646                      (nntp-open-connection buffer))))
647     (if (not process)
648         (nnheader-report 'nntp "Couldn't open connection to %s" address)
649       (unless (or nntp-inhibit-erase nnheader-callback-function)
650         (save-excursion
651           (set-buffer (process-buffer process))
652           (erase-buffer)))
653       (when command
654         (nntp-send-string process command))
655       (cond 
656        ((eq callback 'ignore)
657         t)
658        ((and callback wait-for)
659         (save-excursion
660           (set-buffer (process-buffer process))
661           (unless nntp-inside-change-function 
662             (erase-buffer))
663           (setq nntp-process-decode decode
664                 nntp-process-to-buffer buffer
665                 nntp-process-wait-for wait-for
666                 nntp-process-callback callback
667                 nntp-process-start-point (point-max)
668                 after-change-functions 
669                 (list 'nntp-after-change-function-callback)))
670         t)
671        (wait-for 
672         (nntp-wait-for process wait-for buffer decode))
673        (t t)))))
674
675 (defun nntp-send-string (process string)
676   "Send STRING to PROCESS."
677   (process-send-string process (concat string nntp-end-of-line)))
678
679 (defun nntp-wait-for (process wait-for buffer &optional decode)
680   "Wait for WAIT-FOR to arrive from PROCESS."
681   (save-excursion
682     (set-buffer (process-buffer process))
683     (goto-char (point-min))
684     (while (or (not (memq (following-char) '(?2 ?3 ?4 ?5)))
685                (looking-at "480"))
686       (when (looking-at "480")
687         (erase-buffer)
688         (funcall nntp-authinfo-function))
689       (nntp-accept-process-output process)
690       (goto-char (point-min)))
691     (prog1
692         (if (looking-at "[45]")
693             (progn
694               (nntp-snarf-error-message)
695               nil)
696           (goto-char (point-max))
697           (while (not (re-search-backward wait-for nil t))
698             (nntp-accept-process-output process)
699             (goto-char (point-max)))
700           (nntp-decode-text (not decode))
701           (save-excursion
702             (set-buffer buffer)
703             (goto-char (point-max))
704             (insert-buffer-substring (process-buffer process))
705             t))
706       (erase-buffer))))
707
708 (defun nntp-snarf-error-message ()
709   "Save the error message in the current buffer."
710   (setq nntp-status-string (buffer-string)))
711
712 (defun nntp-accept-process-output (process)
713   "Wait for output from PROCESS and message some dots."
714   (save-excursion
715     (set-buffer (or (nntp-find-connection-buffer nntp-server-buffer)
716                     nntp-server-buffer))
717     (let ((len (/ (point-max) 10000)))
718       (unless (zerop len)
719         (message "nntp reading%s" (make-string len ?.))))
720     (accept-process-output process 1)))
721
722 (defun nntp-accept-response ()
723   "Wait for output from the process that outputs to BUFFER."
724   (nntp-accept-process-output (nntp-find-connection nntp-server-buffer)))
725
726 (defun nntp-possibly-change-group (group server &optional connectionless)
727   (when server
728     (or (nntp-server-opened server)
729         (nntp-open-server server nil connectionless)))
730
731   (unless connectionless
732     (or (nntp-find-connection nntp-server-buffer)
733         (nntp-open-connection nntp-server-buffer)))
734
735   (when group
736     (let ((entry (nntp-find-connection-entry nntp-server-buffer)))
737       (when (not (equal group (caddr entry)))
738         (nntp-request-group group)))))
739
740 (defun nntp-decode-text (&optional cr-only)
741   "Decode the text in the current buffer."
742   (goto-char (point-min))
743   (while (search-forward "\r" nil t)
744     (delete-char -1))
745   (unless cr-only
746     (goto-char (point-max))
747     (forward-line -1)
748     (when (looking-at ".\n")
749       (delete-char 2))
750     (goto-char (point-min))
751     (delete-region (point) (progn (forward-line 1) (point)))
752     (while (search-forward "\n.." nil t)
753       (delete-char -1))))
754
755 (defun nntp-encode-text ()
756   "Encode the text in the current buffer."
757   (save-excursion
758     ;; Replace "." at beginning of line with "..".
759     (goto-char (point-min))
760     (while (re-search-forward "^\\." nil t)
761       (insert "."))
762     (goto-char (point-max))
763     ;; Insert newline at the end of the buffer.
764     (unless (bolp)
765       (insert "\n"))
766     ;; Insert `.' at end of buffer (end of text mark).
767     (goto-char (point-max))
768     (insert "." nntp-end-of-line)))
769
770 (defun nntp-retrieve-headers-with-xover (articles &optional fetch-old)
771   (set-buffer nntp-server-buffer)
772   (erase-buffer)
773   (cond 
774
775    ;; This server does not talk NOV.
776    ((not nntp-server-xover)
777     nil)
778
779    ;; We don't care about gaps.
780    ((or (not nntp-nov-gap)
781         fetch-old)
782     (nntp-send-xover-command 
783      (if fetch-old
784          (if (numberp fetch-old) 
785              (max 1 (- (car articles) fetch-old)) 
786            1)
787        (car articles))
788      (car (last articles)) 'wait)
789
790     (goto-char (point-min))
791     (when (looking-at "[1-5][0-9][0-9] ")
792       (delete-region (point) (progn (forward-line 1) (point))))
793     (while (search-forward "\r" nil t)
794       (replace-match "" t t))
795     (goto-char (point-max))
796     (forward-line -1)
797     (when (looking-at "\\.")
798       (delete-region (point) (progn (forward-line 1) (point)))))
799
800    ;; We do it the hard way.  For each gap, an XOVER command is sent
801    ;; to the server.  We do not wait for a reply from the server, we
802    ;; just send them off as fast as we can.  That means that we have
803    ;; to count the number of responses we get back to find out when we
804    ;; have gotten all we asked for.
805    ((numberp nntp-nov-gap)
806     (let ((count 0)
807           (received 0)
808           (last-point (point-min))
809           (buf nntp-server-buffer)
810           ;;(process-buffer (nntp-find-connection (current-buffer))))
811           first)
812       ;; We have to check `nntp-server-xover'.  If it gets set to nil,
813       ;; that means that the server does not understand XOVER, but we
814       ;; won't know that until we try.
815       (while (and nntp-server-xover articles)
816         (setq first (car articles))
817         ;; Search forward until we find a gap, or until we run out of
818         ;; articles. 
819         (while (and (cdr articles) 
820                     (< (- (nth 1 articles) (car articles)) nntp-nov-gap))
821           (setq articles (cdr articles)))
822
823         (when (nntp-send-xover-command first (car articles))
824           (setq articles (cdr articles)
825                 count (1+ count))
826
827           ;; Every 400 requests we have to read the stream in
828           ;; order to avoid deadlocks.
829           (when (or (null articles)     ;All requests have been sent.
830                     (zerop (% count nntp-maximum-request)))
831             (accept-process-output)
832             ;; On some Emacs versions the preceding function has
833             ;; a tendency to change the buffer.  Perhaps.  It's
834             ;; quite difficult to reproduce, because it only
835             ;; seems to happen once in a blue moon. 
836             (set-buffer buf) 
837             (while (progn
838                      (goto-char last-point)
839                      ;; Count replies.
840                      (while (re-search-forward "^[0-9][0-9][0-9] " nil t)
841                        (setq received (1+ received)))
842                      (setq last-point (point))
843                      (< received count))
844               (accept-process-output)
845               (set-buffer buf)))))
846
847       (when nntp-server-xover
848         ;; Wait for the reply from the final command.
849         (goto-char (point-max))
850         (re-search-backward "^[0-9][0-9][0-9] " nil t)
851         (when (looking-at "^[23]")
852           (while (progn
853                    (goto-char (point-max))
854                    (forward-line -1)
855                    (not (looking-at "^\\.\r?\n")))
856             (nntp-accept-response)))
857         
858         ;; We remove any "." lines and status lines.
859         (goto-char (point-min))
860         (while (search-forward "\r" nil t)
861           (delete-char -1))
862         (goto-char (point-min))
863         (delete-matching-lines "^\\.$\\|^[1-5][0-9][0-9] ")
864         ;;(copy-to-buffer nntp-server-buffer (point-min) (point-max))
865         t))))
866
867   nntp-server-xover)
868
869 (defun nntp-send-xover-command (beg end &optional wait-for-reply)
870   "Send the XOVER command to the server."
871   (let ((range (format "%d-%d" beg end))
872         (nntp-inhibit-erase t))
873     (if (stringp nntp-server-xover)
874         ;; If `nntp-server-xover' is a string, then we just send this
875         ;; command.
876         (if wait-for-reply
877             (nntp-send-command-nodelete "\r?\n\\.\r?\n" nntp-server-xover range)
878           ;; We do not wait for the reply.
879           (nntp-send-command-nodelete "\r?\n\\.\r?\n" nntp-server-xover range))
880       (let ((commands nntp-xover-commands))
881         ;; `nntp-xover-commands' is a list of possible XOVER commands.
882         ;; We try them all until we get at positive response. 
883         (while (and commands (eq nntp-server-xover 'try))
884           (nntp-send-command-nodelete "\r?\n\\.\r?\n" (car commands) range)
885           (save-excursion
886             (set-buffer nntp-server-buffer)
887             (goto-char (point-min))
888             (and (looking-at "[23]")    ; No error message.
889                  ;; We also have to look at the lines.  Some buggy
890                  ;; servers give back simple lines with just the
891                  ;; article number.  How... helpful.
892                  (progn
893                    (forward-line 1)
894                    (looking-at "[0-9]+\t...")) ; More text after number.
895                  (setq nntp-server-xover (car commands))))
896           (setq commands (cdr commands)))
897         ;; If none of the commands worked, we disable XOVER.
898         (when (eq nntp-server-xover 'try)
899           (save-excursion
900             (set-buffer nntp-server-buffer)
901             (erase-buffer)
902             (setq nntp-server-xover nil)))
903         nntp-server-xover))))
904
905 ;;; Alternative connection methods.
906
907 (defun nntp-wait-for-string (regexp)
908   "Wait until string arrives in the buffer."
909   (let ((buf (current-buffer)))
910     (goto-char (point-min))
911     (while (not (re-search-forward regexp nil t))
912       (accept-process-output (nntp-find-connection nntp-server-buffer))
913       (set-buffer buf)
914       (goto-char (point-min)))))
915
916 (defun nntp-open-telnet (buffer)
917   (save-excursion
918     (set-buffer buffer)
919     (erase-buffer)
920     (let ((proc (start-process
921                  "nntpd" buffer "telnet" "-8"))
922           (case-fold-search t))
923       (when (memq (process-status proc) '(open run))
924         (process-send-string proc "set escape \^X\n")
925         (process-send-string proc (concat "open " nntp-address "\n"))
926         (nntp-wait-for-string "^\r*.?login:")
927         (process-send-string
928          proc (concat
929                (or nntp-telnet-user-name
930                    (setq nntp-telnet-user-name (read-string "login: ")))
931                "\n"))
932         (nntp-wait-for-string "^\r*.?password:")
933         (process-send-string
934          proc (concat
935                (or nntp-telnet-passwd
936                    (setq nntp-telnet-passwd
937                          (nnmail-read-passwd "Password: ")))
938                "\n"))
939         (erase-buffer)
940         (nntp-wait-for-string "bash\\|\$ *\r?$\\|> *\r?")
941         (process-send-string
942          proc (concat (mapconcat 'identity nntp-telnet-parameters " ") "\n"))
943         (nntp-wait-for-string "^\r*200")
944         (beginning-of-line)
945         (delete-region (point-min) (point))
946         (process-send-string proc "\^]")
947         (nntp-wait-for-string "^telnet")
948         (process-send-string proc "mode character\n")
949         (accept-process-output proc 1)
950         (sit-for 1)
951         (goto-char (point-min))
952         (forward-line 1)
953         (delete-region (point) (point-max)))
954       proc)))
955
956 (defun nntp-open-rlogin (buffer)
957   "Open a connection to SERVER using rsh."
958   (let ((proc (if nntp-rlogin-user-name
959                   (start-process
960                    "nntpd" buffer "rsh"
961                    nntp-address "-l" nntp-rlogin-user-name
962                    (mapconcat 'identity
963                               nntp-rlogin-parameters " "))
964                 (start-process
965                  "nntpd" buffer "rsh" nntp-address
966                  (mapconcat 'identity
967                             nntp-rlogin-parameters " ")))))
968     (set-buffer buffer)
969     (nntp-wait-for-string "^\r*200")
970     (beginning-of-line)
971     (delete-region (point-min) (point))
972     proc)
973   )
974
975 (defun nntp-find-group-and-number ()
976   (save-excursion
977     (save-restriction
978       (set-buffer nntp-server-buffer)
979       (narrow-to-region (goto-char (point-min))
980                         (or (search-forward "\n\n" nil t) (point-max)))
981       (goto-char (point-min))
982       ;; We first find the number by looking at the status line.
983       (let ((number (and (looking-at "2[0-9][0-9] +\\([0-9]+\\) ")
984                          (string-to-int
985                           (buffer-substring (match-beginning 1)
986                                             (match-end 1)))))
987             group newsgroups xref)
988         (and number (zerop number) (setq number nil))
989         ;; Then we find the group name.
990         (setq group
991               (cond 
992                ;; If there is only one group in the Newsgroups header,
993                ;; then it seems quite likely that this article comes
994                ;; from that group, I'd say.
995                ((and (setq newsgroups (mail-fetch-field "newsgroups"))
996                      (not (string-match "," newsgroups)))
997                 newsgroups)
998                ;; If there is more than one group in the Newsgroups
999                ;; header, then the Xref header should be filled out.
1000                ;; We hazard a guess that the group that has this
1001                ;; article number in the Xref header is the one we are
1002                ;; looking for.  This might very well be wrong if this
1003                ;; article happens to have the same number in several
1004                ;; groups, but that's life. 
1005                ((and (setq xref (mail-fetch-field "xref"))
1006                      number
1007                      (string-match (format "\\([^ :]+\\):%d" number) xref))
1008                 (substring xref (match-beginning 1) (match-end 1)))
1009                (t "")))
1010         (when (string-match "\r" group) 
1011           (setq group (substring group 0 (match-beginning 0))))
1012         (cons group number)))))
1013
1014 (provide 'nntp)
1015
1016 ;;; nntp.el ends here