Add newlines between pictures and text.
[gnus] / lisp / nntp.el
1 ;;; nntp.el --- nntp access for Gnus
2
3 ;; Copyright (C) 1987, 1988, 1989, 1990, 1992, 1993,
4 ;;   1994, 1995, 1996, 1997, 1998, 2000, 2001, 2002,
5 ;;   2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
6
7 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
8 ;; Keywords: news
9
10 ;; This file is part of GNU Emacs.
11
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
16
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.
21
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
24
25 ;;; Commentary:
26
27 ;;; Code:
28
29 ;; For Emacs < 22.2.
30 (eval-and-compile
31   (unless (fboundp 'declare-function) (defmacro declare-function (&rest r))))
32
33 (require 'nnheader)
34 (require 'nnoo)
35 (require 'gnus-util)
36 (require 'gnus)
37 (require 'gnus-group) ;; gnus-group-name-charset
38
39 (nnoo-declare nntp)
40
41 (eval-when-compile (require 'cl))
42
43 (autoload 'auth-source-user-or-password "auth-source")
44
45 (defgroup nntp nil
46   "NNTP access for Gnus."
47   :group 'gnus)
48
49 (defvoo nntp-address nil
50   "Address of the physical nntp server.")
51
52 (defvoo nntp-port-number "nntp"
53   "Port number on the physical nntp server.")
54
55 (defvoo nntp-server-opened-hook '(nntp-send-mode-reader)
56   "*Hook used for sending commands to the server at startup.
57 The default value is `nntp-send-mode-reader', which makes an innd
58 server spawn an nnrpd server.")
59
60 (defvoo nntp-authinfo-function 'nntp-send-authinfo
61   "Function used to send AUTHINFO to the server.
62 It is called with no parameters.")
63
64 (defvoo nntp-server-action-alist
65     '(("nntpd 1\\.5\\.11t"
66        (remove-hook 'nntp-server-opened-hook 'nntp-send-mode-reader))
67       ("NNRP server Netscape"
68        (setq nntp-server-list-active-group nil)))
69   "Alist of regexps to match on server types and actions to be taken.
70 For instance, if you want Gnus to beep every time you connect
71 to innd, you could say something like:
72
73 \(setq nntp-server-action-alist
74        '((\"innd\" (ding))))
75
76 You probably don't want to do that, though.")
77
78 (defvoo nntp-open-connection-function 'nntp-open-network-stream
79   "*Function used for connecting to a remote system.
80 It will be called with the buffer to output in as argument.
81
82 Currently, five such functions are provided (please refer to their
83 respective doc string for more information), three of them establishing
84 direct connections to the nntp server, and two of them using an indirect
85 host.
86
87 Direct connections:
88 - `nntp-open-network-stream' (the default),
89 - `nntp-open-ssl-stream',
90 - `nntp-open-tls-stream',
91 - `nntp-open-netcat-stream'.
92 - `nntp-open-telnet-stream'.
93
94 Indirect connections:
95 - `nntp-open-via-rlogin-and-netcat',
96 - `nntp-open-via-rlogin-and-telnet',
97 - `nntp-open-via-telnet-and-telnet'.")
98
99 (defvoo nntp-never-echoes-commands nil
100   "*Non-nil means the nntp server never echoes commands.
101 It is reported that some nntps server doesn't echo commands.  So, you
102 may want to set this to non-nil in the method for such a server setting
103 `nntp-open-connection-function' to `nntp-open-ssl-stream' for example.
104 Note that the `nntp-open-connection-functions-never-echo-commands'
105 variable overrides the nil value of this variable.")
106
107 (defvoo nntp-open-connection-functions-never-echo-commands
108     '(nntp-open-network-stream)
109   "*List of functions that never echo commands.
110 Add or set a function which you set to `nntp-open-connection-function'
111 to this list if it does not echo commands.  Note that a non-nil value
112 of the `nntp-never-echoes-commands' variable overrides this variable.")
113
114 (defvoo nntp-pre-command nil
115   "*Pre-command to use with the various nntp-open-via-* methods.
116 This is where you would put \"runsocks\" or stuff like that.")
117
118 (defvoo nntp-telnet-command "telnet"
119   "*Telnet command used to connect to the nntp server.
120 This command is used by the methods `nntp-open-telnet-stream',
121 `nntp-open-via-rlogin-and-telnet' and `nntp-open-via-telnet-and-telnet'.")
122
123 (defvoo nntp-telnet-switches '("-8")
124   "*Switches given to the telnet command `nntp-telnet-command'.")
125
126 (defvoo nntp-end-of-line "\r\n"
127   "*String to use on the end of lines when talking to the NNTP server.
128 This is \"\\r\\n\" by default, but should be \"\\n\" when using an indirect
129 connection method (nntp-open-via-*).")
130
131 (defvoo nntp-via-rlogin-command "rsh"
132   "*Rlogin command used to connect to an intermediate host.
133 This command is used by the methods `nntp-open-via-rlogin-and-telnet'
134 and `nntp-open-via-rlogin-and-netcat'.  The default is \"rsh\", but \"ssh\"
135 is a popular alternative.")
136
137 (defvoo nntp-via-rlogin-command-switches nil
138   "*Switches given to the rlogin command `nntp-via-rlogin-command'.
139 If you use \"ssh\" for `nntp-via-rlogin-command', you may set this to
140 \(\"-C\") in order to compress all data connections, otherwise set this
141 to \(\"-t\" \"-e\" \"none\") or (\"-C\" \"-t\" \"-e\" \"none\") if the telnet
142 command requires a pseudo-tty allocation on an intermediate host.")
143
144 (defvoo nntp-via-telnet-command "telnet"
145   "*Telnet command used to connect to an intermediate host.
146 This command is used by the `nntp-open-via-telnet-and-telnet' method.")
147
148 (defvoo nntp-via-telnet-switches '("-8")
149   "*Switches given to the telnet command `nntp-via-telnet-command'.")
150
151 (defvoo nntp-netcat-command "nc"
152   "*Netcat command used to connect to the nntp server.
153 This command is used by the `nntp-open-netcat-stream' and
154 `nntp-open-via-rlogin-and-netcat' methods.")
155
156 (defvoo nntp-netcat-switches nil
157   "*Switches given to the netcat command `nntp-netcat-command'.")
158
159 (defvoo nntp-via-user-name nil
160   "*User name to log in on an intermediate host with.
161 This variable is used by the various nntp-open-via-* methods.")
162
163 (defvoo nntp-via-user-password nil
164   "*Password to use to log in on an intermediate host with.
165 This variable is used by the `nntp-open-via-telnet-and-telnet' method.")
166
167 (defvoo nntp-via-address nil
168   "*Address of an intermediate host to connect to.
169 This variable is used by the various nntp-open-via-* methods.")
170
171 (defvoo nntp-via-envuser nil
172   "*Whether both telnet client and server support the ENVIRON option.
173 If non-nil, there will be no prompt for a login name.")
174
175 (defvoo nntp-via-shell-prompt "bash\\|\$ *\r?$\\|> *\r?"
176   "*Regular expression to match the shell prompt on an intermediate host.
177 This variable is used by the `nntp-open-via-telnet-and-telnet' method.")
178
179 (defvoo nntp-large-newsgroup 50
180   "*The number of articles which indicates a large newsgroup.
181 If the number of articles is greater than the value, verbose
182 messages will be shown to indicate the current status.")
183
184 (defvoo nntp-maximum-request 400
185   "*The maximum number of the requests sent to the NNTP server at one time.
186 If Emacs hangs up while retrieving headers, set the variable to a
187 lower value.")
188
189 (defvoo nntp-nov-is-evil nil
190   "*If non-nil, nntp will never attempt to use XOVER when talking to the server.")
191
192 (defvoo nntp-xover-commands '("XOVER" "XOVERVIEW")
193   "*List of strings that are used as commands to fetch NOV lines from a server.
194 The strings are tried in turn until a positive response is gotten.  If
195 none of the commands are successful, nntp will just grab headers one
196 by one.")
197
198 (defvoo nntp-nov-gap 5
199   "*Maximum allowed gap between two articles.
200 If the gap between two consecutive articles is bigger than this
201 variable, split the XOVER request into two requests.")
202
203 (defvoo nntp-xref-number-is-evil nil
204   "*If non-nil, Gnus never trusts article numbers in the Xref header.
205 Some news servers, e.g., ones running Diablo, run multiple engines
206 having the same articles but article numbers are not kept synchronized
207 between them.  If you connect to such a server, set this to a non-nil
208 value, and Gnus never uses article numbers (that appear in the Xref
209 header and vary by which engine is chosen) to refer to articles.")
210
211 (defvoo nntp-prepare-server-hook nil
212   "*Hook run before a server is opened.
213 If can be used to set up a server remotely, for instance.  Say you
214 have an account at the machine \"other.machine\".  This machine has
215 access to an NNTP server that you can't access locally.  You could
216 then use this hook to rsh to the remote machine and start a proxy NNTP
217 server there that you can connect to.  See also
218 `nntp-open-connection-function'")
219
220 (defvoo nntp-coding-system-for-read 'binary
221   "*Coding system to read from NNTP.")
222
223 (defvoo nntp-coding-system-for-write 'binary
224   "*Coding system to write to NNTP.")
225
226 ;; Marks
227 (defvoo nntp-marks-is-evil nil
228   "*If non-nil, Gnus will never generate and use marks file for nntp groups.
229 See `nnml-marks-is-evil' for more information.")
230
231 (defvoo nntp-marks-file-name ".marks")
232 (defvoo nntp-marks nil)
233 (defvar nntp-marks-modtime (gnus-make-hashtable))
234
235 (defcustom nntp-marks-directory
236   (nnheader-concat gnus-directory "marks/")
237   "*The directory where marks for nntp groups will be stored."
238   :group 'nntp
239   :type 'directory)
240
241 (defcustom nntp-authinfo-file "~/.authinfo"
242   ".netrc-like file that holds nntp authinfo passwords."
243   :group 'nntp
244   :type
245   '(choice file
246            (repeat :tag "Entries"
247                    :menu-tag "Inline"
248                    (list :format "%v"
249                          :value ("" ("login" . "") ("password" . ""))
250                          (string :tag "Host")
251                          (checklist :inline t
252                                     (cons :format "%v"
253                                           (const :format "" "login")
254                                           (string :format "Login: %v"))
255                                     (cons :format "%v"
256                                           (const :format "" "password")
257                                           (string :format "Password: %v")))))))
258
259 \f
260
261 (defvoo nntp-connection-timeout nil
262   "*Number of seconds to wait before an nntp connection times out.
263 If this variable is nil, which is the default, no timers are set.
264 NOTE: This variable is never seen to work in Emacs 20 and XEmacs 21.")
265
266 (defvoo nntp-prepare-post-hook nil
267   "*Hook run just before posting an article.  It is supposed to be used
268 to insert Cancel-Lock headers.")
269
270 (defvoo nntp-server-list-active-group 'try
271   "If nil, then always use GROUP instead of LIST ACTIVE.
272 This is usually slower, but on misconfigured servers that don't
273 update their active files often, this can help.")
274
275 ;;; Internal variables.
276
277 (defvar nntp-record-commands nil
278   "*If non-nil, nntp will record all commands in the \"*nntp-log*\" buffer.")
279
280 (defvar nntp-have-messaged nil)
281
282 (defvar nntp-process-wait-for nil)
283 (defvar nntp-process-to-buffer nil)
284 (defvar nntp-process-callback nil)
285 (defvar nntp-process-decode nil)
286 (defvar nntp-process-start-point nil)
287 (defvar nntp-inside-change-function nil)
288 (defvoo nntp-last-command-time nil)
289 (defvoo nntp-last-command nil)
290 (defvoo nntp-authinfo-password nil)
291 (defvoo nntp-authinfo-user nil)
292 (defvoo nntp-authinfo-force nil)
293
294 (defvar nntp-connection-list nil)
295
296 (defvoo nntp-server-type nil)
297 (defvoo nntp-connection-alist nil)
298 (defvoo nntp-status-string "")
299 (defconst nntp-version "nntp 5.0")
300 (defvoo nntp-inhibit-erase nil)
301 (defvoo nntp-inhibit-output nil)
302
303 (defvoo nntp-server-xover 'try)
304
305 (defvar nntp-async-timer nil)
306 (defvar nntp-async-process-list nil)
307
308 (defvar nntp-ssl-program
309   "openssl s_client -quiet -ssl3 -connect %s:%p"
310 "A string containing commands for SSL connections.
311 Within a string, %s is replaced with the server address and %p with
312 port number on server.  The program should accept IMAP commands on
313 stdin and return responses to stdout.")
314
315 (defvar nntp-authinfo-rejected nil
316 "A custom error condition used to report 'Authentication Rejected' errors.
317 Condition handlers that match just this condition ensure that the nntp
318 backend doesn't catch this error.")
319 (put 'nntp-authinfo-rejected 'error-conditions '(error nntp-authinfo-rejected))
320 (put 'nntp-authinfo-rejected 'error-message "Authorization Rejected")
321
322 \f
323
324 ;;; Internal functions.
325
326 (defsubst nntp-send-string (process string)
327   "Send STRING to PROCESS."
328   ;; We need to store the time to provide timeouts, and
329   ;; to store the command so the we can replay the command
330   ;; if the server gives us an AUTHINFO challenge.
331   (setq nntp-last-command-time (current-time)
332         nntp-last-command string)
333   (when nntp-record-commands
334     (nntp-record-command string))
335   (process-send-string process (concat string nntp-end-of-line))
336   (or (memq (process-status process) '(open run))
337       (nntp-report "Server closed connection")))
338
339 (defun nntp-record-command (string)
340   "Record the command STRING."
341   (with-current-buffer (get-buffer-create "*nntp-log*")
342     (goto-char (point-max))
343     (let ((time (current-time)))
344       (insert (format-time-string "%Y%m%dT%H%M%S" time)
345               "." (format "%03d" (/ (nth 2 time) 1000))
346               " " nntp-address " " string "\n"))))
347
348 (defun nntp-report (&rest args)
349   "Report an error from the nntp backend.  The first string in ARGS
350 can be a format string.  For some commands, the failed command may be
351 retried once before actually displaying the error report."
352
353   (when nntp-record-commands
354     (nntp-record-command "*** CALLED nntp-report ***"))
355
356   (nnheader-report 'nntp args)
357
358   (apply 'error args))
359
360 (defun nntp-report-1 (&rest args)
361   "Throws out to nntp-with-open-group-error so that the connection may
362 be restored and the command retried."
363
364   (when nntp-record-commands
365     (nntp-record-command "*** CONNECTION LOST ***"))
366
367   (throw 'nntp-with-open-group-error t))
368
369 (defmacro nntp-insert-buffer-substring (buffer &optional start end)
370   "Copy string from unibyte buffer to multibyte current buffer."
371   (if (featurep 'xemacs)
372       `(insert-buffer-substring ,buffer ,start ,end)
373     `(if enable-multibyte-characters
374          (insert (with-current-buffer ,buffer
375                    (mm-string-to-multibyte
376                     ,(if (or start end)
377                          `(buffer-substring (or ,start (point-min))
378                                             (or ,end (point-max)))
379                        '(buffer-string)))))
380        (insert-buffer-substring ,buffer ,start ,end))))
381
382 (defmacro nntp-copy-to-buffer (buffer start end)
383   "Copy string from unibyte current buffer to multibyte buffer."
384   (if (featurep 'xemacs)
385       `(copy-to-buffer ,buffer ,start ,end)
386     `(let ((string (buffer-substring ,start ,end)))
387        (with-current-buffer ,buffer
388          (erase-buffer)
389          (insert (if enable-multibyte-characters
390                      (mm-string-to-multibyte string)
391                    string))
392          (goto-char (point-min))
393          nil))))
394
395 (defsubst nntp-wait-for (process wait-for buffer &optional decode discard)
396   "Wait for WAIT-FOR to arrive from PROCESS."
397
398   (with-current-buffer (process-buffer process)
399     (goto-char (point-min))
400
401     (while (and (or (not (memq (char-after (point)) '(?2 ?3 ?4 ?5)))
402                     (looking-at "48[02]"))
403                 (memq (process-status process) '(open run)))
404       (cond ((looking-at "480")
405              (nntp-handle-authinfo process))
406             ((looking-at "482")
407              (nnheader-report 'nntp (get 'nntp-authinfo-rejected 'error-message))
408              (signal 'nntp-authinfo-rejected nil))
409             ((looking-at "^.*\n")
410              (delete-region (point) (progn (forward-line 1) (point)))))
411       (nntp-accept-process-output process)
412       (goto-char (point-min)))
413     (prog1
414         (cond
415          ((looking-at "[45]")
416           (progn
417             (nntp-snarf-error-message)
418             nil))
419          ((not (memq (process-status process) '(open run)))
420           (nntp-report "Server closed connection"))
421          (t
422           (goto-char (point-max))
423           (let ((limit (point-min))
424                 response)
425             (while (not (re-search-backward wait-for limit t))
426               (nntp-accept-process-output process)
427               ;; We assume that whatever we wait for is less than 1000
428               ;; characters long.
429               (setq limit (max (- (point-max) 1000) (point-min)))
430               (goto-char (point-max)))
431             (setq response (match-string 0))
432             (with-current-buffer nntp-server-buffer
433               (setq nntp-process-response response)))
434           (nntp-decode-text (not decode))
435           (unless discard
436             (with-current-buffer buffer
437               (goto-char (point-max))
438               (nntp-insert-buffer-substring (process-buffer process))
439               ;; Nix out "nntp reading...." message.
440               (when nntp-have-messaged
441                 (setq nntp-have-messaged nil)
442                 (nnheader-message 5 ""))))
443           t))
444       (unless discard
445         (erase-buffer)))))
446
447 (defun nntp-kill-buffer (buffer)
448   (when (buffer-name buffer)
449     (kill-buffer buffer)
450     (nnheader-init-server-buffer)))
451
452 (defun nntp-erase-buffer (buffer)
453   "Erase contents of BUFFER."
454   (with-current-buffer buffer
455     (erase-buffer)))
456
457 (defsubst nntp-find-connection (buffer)
458   "Find the connection delivering to BUFFER."
459   (let ((alist nntp-connection-alist)
460         (buffer (if (stringp buffer) (get-buffer buffer) buffer))
461         process entry)
462     (while (and alist (setq entry (pop alist)))
463       (when (eq buffer (cadr entry))
464         (setq process (car entry)
465               alist nil)))
466     (when process
467       (if (memq (process-status process) '(open run))
468           process
469         (nntp-kill-buffer (process-buffer process))
470         (setq nntp-connection-alist (delq entry nntp-connection-alist))
471         nil))))
472
473 (defsubst nntp-find-connection-entry (buffer)
474   "Return the entry for the connection to BUFFER."
475   (assq (nntp-find-connection buffer) nntp-connection-alist))
476
477 (defun nntp-find-connection-buffer (buffer)
478   "Return the process connection buffer tied to BUFFER."
479   (let ((process (nntp-find-connection buffer)))
480     (when process
481       (process-buffer process))))
482
483 (defsubst nntp-retrieve-data (command address port buffer
484                                       &optional wait-for callback decode)
485   "Use COMMAND to retrieve data into BUFFER from PORT on ADDRESS."
486   (let ((process (or (nntp-find-connection buffer)
487                      (nntp-open-connection buffer))))
488     (if process
489         (progn
490           (unless (or nntp-inhibit-erase nnheader-callback-function)
491             (nntp-erase-buffer (process-buffer process)))
492           (condition-case err
493               (progn
494                 (when command
495                   (nntp-send-string process command))
496                 (cond
497                  ((eq callback 'ignore)
498                   t)
499                  ((and callback wait-for)
500                   (nntp-async-wait process wait-for buffer decode callback)
501                   t)
502                  (wait-for
503                   (nntp-wait-for process wait-for buffer decode))
504                  (t t)))
505             (nntp-authinfo-rejected
506              (signal 'nntp-authinfo-rejected (cdr err)))
507             (error
508              (nnheader-report 'nntp "Couldn't open connection to %s: %s"
509                               address err))
510             (quit
511              (message "Quit retrieving data from nntp")
512              (signal 'quit nil)
513              nil)))
514       (nnheader-report 'nntp "Couldn't open connection to %s" address))))
515
516 (defsubst nntp-send-command (wait-for &rest strings)
517   "Send STRINGS to server and wait until WAIT-FOR returns."
518   (when (and (not nnheader-callback-function)
519              (not nntp-inhibit-output))
520     (nntp-erase-buffer nntp-server-buffer))
521   (let* ((command (mapconcat 'identity strings " "))
522          (process (nntp-find-connection nntp-server-buffer))
523          (buffer (and process (process-buffer process)))
524          (pos (and buffer (with-current-buffer buffer (point)))))
525     (if process
526         (prog1
527             (nntp-retrieve-data command
528                                 nntp-address nntp-port-number
529                                 nntp-server-buffer
530                                 wait-for nnheader-callback-function)
531           ;; If nothing to wait for, still remove possibly echo'ed commands.
532           ;; We don't have echoes if `nntp-never-echoes-commands' is non-nil
533           ;; or the value of `nntp-open-connection-function' is in
534           ;; `nntp-open-connection-functions-never-echo-commands', so we
535           ;; skip this in that cases.
536           (unless (or wait-for
537                       nntp-never-echoes-commands
538                       (memq
539                        nntp-open-connection-function
540                        nntp-open-connection-functions-never-echo-commands))
541             (nntp-accept-response)
542             (with-current-buffer buffer
543               (goto-char pos)
544               (if (looking-at (regexp-quote command))
545                   (delete-region pos (progn (forward-line 1)
546                                             (point-at-bol)))))))
547       (nnheader-report 'nntp "Couldn't open connection to %s."
548                        nntp-address))))
549
550 (defun nntp-send-command-nodelete (wait-for &rest strings)
551   "Send STRINGS to server and wait until WAIT-FOR returns."
552   (let* ((command (mapconcat 'identity strings " "))
553          (process (nntp-find-connection nntp-server-buffer))
554          (buffer (and process (process-buffer process)))
555          (pos (and buffer (with-current-buffer buffer (point)))))
556     (if process
557         (prog1
558             (nntp-retrieve-data command
559                                 nntp-address nntp-port-number
560                                 nntp-server-buffer
561                                 wait-for nnheader-callback-function)
562           ;; If nothing to wait for, still remove possibly echo'ed commands
563           (unless wait-for
564             (nntp-accept-response)
565             (with-current-buffer buffer
566               (goto-char pos)
567               (if (looking-at (regexp-quote command))
568                   (delete-region pos (progn (forward-line 1)
569                                             (point-at-bol)))))))
570       (nnheader-report 'nntp "Couldn't open connection to %s."
571                        nntp-address))))
572
573 (defun nntp-send-command-and-decode (wait-for &rest strings)
574   "Send STRINGS to server and wait until WAIT-FOR returns."
575   (when (and (not nnheader-callback-function)
576              (not nntp-inhibit-output))
577     (nntp-erase-buffer nntp-server-buffer))
578   (let* ((command (mapconcat 'identity strings " "))
579          (process (nntp-find-connection nntp-server-buffer))
580          (buffer (and process (process-buffer process)))
581          (pos (and buffer (with-current-buffer buffer (point)))))
582     (if process
583         (prog1
584             (nntp-retrieve-data command
585                                 nntp-address nntp-port-number
586                                 nntp-server-buffer
587                                 wait-for nnheader-callback-function t)
588           ;; If nothing to wait for, still remove possibly echo'ed commands
589           (unless wait-for
590             (nntp-accept-response)
591             (with-current-buffer buffer
592               (goto-char pos)
593               (if (looking-at (regexp-quote command))
594                   (delete-region pos (progn (forward-line 1) (point-at-bol))))
595               )))
596       (nnheader-report 'nntp "Couldn't open connection to %s."
597                        nntp-address))))
598
599
600 (defun nntp-send-buffer (wait-for)
601   "Send the current buffer to server and wait until WAIT-FOR returns."
602   (when (and (not nnheader-callback-function)
603              (not nntp-inhibit-output))
604     (nntp-erase-buffer
605      (nntp-find-connection-buffer nntp-server-buffer)))
606   (nntp-encode-text)
607   ;; Make sure we did not forget to encode some of the content.
608   (assert (save-excursion (goto-char (point-min))
609                           (not (re-search-forward "[^\000-\377]" nil t))))
610   (mm-disable-multibyte)
611   (process-send-region (nntp-find-connection nntp-server-buffer)
612                        (point-min) (point-max))
613   (nntp-retrieve-data
614    nil nntp-address nntp-port-number nntp-server-buffer
615    wait-for nnheader-callback-function))
616
617 \f
618
619 ;;; Interface functions.
620
621 (nnoo-define-basics nntp)
622
623 (defsubst nntp-next-result-arrived-p ()
624   (cond
625    ;; A result that starts with a 2xx code is terminated by
626    ;; a line with only a "." on it.
627    ((eq (char-after) ?2)
628     (if (re-search-forward "\n\\.\r?\n" nil t)
629         (progn
630           ;; Some broken news servers add another dot at the end.
631           ;; Protect against inflooping there.
632           (while (looking-at "^\\.\r?\n")
633             (forward-line 1))
634           t)
635       nil))
636    ;; A result that starts with a 3xx or 4xx code is terminated
637    ;; by a newline.
638    ((looking-at "[34]")
639     (if (search-forward "\n" nil t)
640         t
641       nil))
642    ;; No result here.
643    (t
644     nil)))
645
646 (eval-when-compile
647   (defvar nntp-with-open-group-internal nil)
648   (defvar nntp-report-n nil))
649
650 (defun nntp-with-open-group-function (-group -server -connectionless -bodyfun)
651   "Protect against servers that don't like clients that keep idle connections opens.
652 The problem being that these servers may either close a connection or
653 simply ignore any further requests on a connection.  Closed
654 connections are not detected until `accept-process-output' has updated
655 the `process-status'.  Dropped connections are not detected until the
656 connection timeouts (which may be several minutes) or
657 `nntp-connection-timeout' has expired.  When these occur
658 `nntp-with-open-group', opens a new connection then re-issues the NNTP
659 command whose response triggered the error."
660   (letf ((nntp-report-n (symbol-function 'nntp-report))
661          ((symbol-function 'nntp-report) (symbol-function 'nntp-report-1))
662          (nntp-with-open-group-internal nil))
663     (while (catch 'nntp-with-open-group-error
664              ;; Open the connection to the server
665              ;; NOTE: Existing connections are NOT tested.
666              (nntp-possibly-change-group -group -server -connectionless)
667
668              (let ((-timer
669                     (and nntp-connection-timeout
670                          (run-at-time
671                           nntp-connection-timeout nil
672                           (lambda ()
673                             (let* ((-process (nntp-find-connection
674                                              nntp-server-buffer))
675                                    (-buffer  (and -process
676                                                   (process-buffer -process))))
677                               ;; When I an able to identify the
678                               ;; connection to the server AND I've
679                               ;; received NO reponse for
680                               ;; nntp-connection-timeout seconds.
681                               (when (and -buffer (eq 0 (buffer-size -buffer)))
682                                 ;; Close the connection.  Take no
683                                 ;; other action as the accept input
684                                 ;; code will handle the closed
685                                 ;; connection.
686                                 (nntp-kill-buffer -buffer))))))))
687                (unwind-protect
688                    (setq nntp-with-open-group-internal
689                          (condition-case nil
690                              (funcall -bodyfun)
691                            (quit
692                             (unless debug-on-quit
693                               (nntp-close-server))
694                             (signal 'quit nil))))
695                  (when -timer
696                    (nnheader-cancel-timer -timer)))
697                nil))
698       (setf (symbol-function 'nntp-report) nntp-report-n))
699     nntp-with-open-group-internal))
700
701 (defmacro nntp-with-open-group (group server &optional connectionless &rest forms)
702   "Protect against servers that don't like clients that keep idle connections opens.
703 The problem being that these servers may either close a connection or
704 simply ignore any further requests on a connection.  Closed
705 connections are not detected until `accept-process-output' has updated
706 the `process-status'.  Dropped connections are not detected until the
707 connection timeouts (which may be several minutes) or
708 `nntp-connection-timeout' has expired.  When these occur
709 `nntp-with-open-group', opens a new connection then re-issues the NNTP
710 command whose response triggered the error."
711   (declare (indent 2) (debug (form form [&optional symbolp] def-body)))
712   (when (and (listp connectionless)
713              (not (eq connectionless nil)))
714     (setq forms (cons connectionless forms)
715           connectionless nil))
716   `(nntp-with-open-group-function ,group ,server ,connectionless (lambda () ,@forms)))
717
718 (deffoo nntp-retrieve-headers (articles &optional group server fetch-old)
719   "Retrieve the headers of ARTICLES."
720   (nntp-with-open-group
721    group server
722    (with-current-buffer (nntp-find-connection-buffer nntp-server-buffer)
723      (erase-buffer)
724      (if (and (not gnus-nov-is-evil)
725               (not nntp-nov-is-evil)
726               (nntp-retrieve-headers-with-xover articles fetch-old))
727          ;; We successfully retrieved the headers via XOVER.
728          'nov
729        ;; XOVER didn't work, so we do it the hard, slow and inefficient
730        ;; way.
731        (let ((number (length articles))
732              (articles articles)
733              (count 0)
734              (received 0)
735              (last-point (point-min))
736              (buf (nntp-find-connection-buffer nntp-server-buffer))
737              (nntp-inhibit-erase t)
738              article)
739          ;; Send HEAD commands.
740          (while (setq article (pop articles))
741            (nntp-send-command
742             nil
743             "HEAD" (if (numberp article)
744                        (int-to-string article)
745                      ;; `articles' is either a list of article numbers
746                      ;; or a list of article IDs.
747                      article))
748            (incf count)
749            ;; Every 400 requests we have to read the stream in
750            ;; order to avoid deadlocks.
751            (when (or (null articles)    ;All requests have been sent.
752                      (zerop (% count nntp-maximum-request)))
753              (nntp-accept-response)
754              (while (progn
755                       (set-buffer buf)
756                       (goto-char last-point)
757                       ;; Count replies.
758                       (while (nntp-next-result-arrived-p)
759                         (setq last-point (point))
760                         (incf received))
761                       (< received count))
762                ;; If number of headers is greater than 100, give
763                ;;  informative messages.
764                (and (numberp nntp-large-newsgroup)
765                     (> number nntp-large-newsgroup)
766                     (zerop (% received 20))
767                     (nnheader-message 6 "NNTP: Receiving headers... %d%%"
768                                       (/ (* received 100) number)))
769                (nntp-accept-response))))
770          (and (numberp nntp-large-newsgroup)
771               (> number nntp-large-newsgroup)
772               (nnheader-message 6 "NNTP: Receiving headers...done"))
773
774          ;; Now all of replies are received.  Fold continuation lines.
775          (nnheader-fold-continuation-lines)
776          ;; Remove all "\r"'s.
777          (nnheader-strip-cr)
778          (nntp-copy-to-buffer nntp-server-buffer (point-min) (point-max))
779          'headers)))))
780
781 (deffoo nntp-retrieve-groups (groups &optional server)
782   "Retrieve group info on GROUPS."
783   (nntp-with-open-group
784    nil server
785    (when (nntp-find-connection-buffer nntp-server-buffer)
786      (catch 'done
787        (save-excursion
788          ;; Erase nntp-server-buffer before nntp-inhibit-erase.
789          (nntp-erase-buffer nntp-server-buffer)
790          (set-buffer (nntp-find-connection-buffer nntp-server-buffer))
791          ;; The first time this is run, this variable is `try'.  So we
792          ;; try.
793          (when (eq nntp-server-list-active-group 'try)
794            (nntp-try-list-active (car groups)))
795          (erase-buffer)
796          (let ((count 0)
797                (groups groups)
798                (received 0)
799                (last-point (point-min))
800                (nntp-inhibit-erase t)
801                (buf (nntp-find-connection-buffer nntp-server-buffer))
802                (command (if nntp-server-list-active-group
803                             "LIST ACTIVE" "GROUP")))
804            (while groups
805              ;; Timeout may have killed the buffer.
806              (unless (gnus-buffer-live-p buf)
807                (nnheader-report 'nntp "Connection to %s is closed." server)
808                (throw 'done nil))
809              ;; Send the command to the server.
810              (nntp-send-command nil command (pop groups))
811              (incf count)
812              ;; Every 400 requests we have to read the stream in
813              ;; order to avoid deadlocks.
814              (when (or (null groups)    ;All requests have been sent.
815                        (zerop (% count nntp-maximum-request)))
816                (nntp-accept-response)
817                (while (and (gnus-buffer-live-p buf)
818                            (progn
819                              ;; Search `blue moon' in this file for the
820                              ;; reason why set-buffer here.
821                              (set-buffer buf)
822                              (goto-char last-point)
823                              ;; Count replies.
824                              (while (re-search-forward "^[0-9]" nil t)
825                                (incf received))
826                              (setq last-point (point))
827                              (< received count)))
828                  (nntp-accept-response))))
829
830            ;; Wait for the reply from the final command.
831            (unless (gnus-buffer-live-p buf)
832              (nnheader-report 'nntp "Connection to %s is closed." server)
833              (throw 'done nil))
834            (set-buffer buf)
835            (goto-char (point-max))
836            (re-search-backward "^[0-9]" nil t)
837            (when (looking-at "^[23]")
838              (while (and (gnus-buffer-live-p buf)
839                          (progn
840                            (set-buffer buf)
841                            (goto-char (point-max))
842                            (if (not nntp-server-list-active-group)
843                                (not (re-search-backward "\r?\n"
844                                                         (- (point) 3) t))
845                              (not (re-search-backward "^\\.\r?\n"
846                                                       (- (point) 4) t)))))
847                (nntp-accept-response)))
848
849            ;; Now all replies are received.  We remove CRs.
850            (unless (gnus-buffer-live-p buf)
851              (nnheader-report 'nntp "Connection to %s is closed." server)
852              (throw 'done nil))
853            (set-buffer buf)
854            (goto-char (point-min))
855            (while (search-forward "\r" nil t)
856              (replace-match "" t t))
857
858            (if (not nntp-server-list-active-group)
859                (progn
860                  (nntp-copy-to-buffer nntp-server-buffer
861                                       (point-min) (point-max))
862                  'group)
863              ;; We have read active entries, so we just delete the
864              ;; superfluous gunk.
865              (goto-char (point-min))
866              (while (re-search-forward "^[.2-5]" nil t)
867                (delete-region (match-beginning 0)
868                               (progn (forward-line 1) (point))))
869              (nntp-copy-to-buffer nntp-server-buffer (point-min) (point-max))
870              'active)))))))
871
872 (deffoo nntp-retrieve-articles (articles &optional group server)
873   (nntp-with-open-group
874     group server
875    (save-excursion
876      (let ((number (length articles))
877            (articles articles)
878            (count 0)
879            (received 0)
880            (last-point (point-min))
881            (buf (nntp-find-connection-buffer nntp-server-buffer))
882            (nntp-inhibit-erase t)
883            (map (apply 'vector articles))
884            (point 1)
885            article)
886        (set-buffer buf)
887        (erase-buffer)
888        ;; Send ARTICLE command.
889        (while (setq article (pop articles))
890          (nntp-send-command
891           nil
892           "ARTICLE" (if (numberp article)
893                         (int-to-string article)
894                       ;; `articles' is either a list of article numbers
895                       ;; or a list of article IDs.
896                       article))
897          (incf count)
898          ;; Every 400 requests we have to read the stream in
899          ;; order to avoid deadlocks.
900          (when (or (null articles)      ;All requests have been sent.
901                    (zerop (% count nntp-maximum-request)))
902            (nntp-accept-response)
903            (while (progn
904                     (set-buffer buf)
905                     (goto-char last-point)
906                     ;; Count replies.
907                     (while (nntp-next-result-arrived-p)
908                       (aset map received (cons (aref map received) (point)))
909                       (setq last-point (point))
910                       (incf received))
911                     (< received count))
912              ;; If number of headers is greater than 100, give
913              ;;  informative messages.
914              (and (numberp nntp-large-newsgroup)
915                   (> number nntp-large-newsgroup)
916                   (zerop (% received 20))
917                   (nnheader-message 6 "NNTP: Receiving articles... %d%%"
918                                     (/ (* received 100) number)))
919              (nntp-accept-response))))
920        (and (numberp nntp-large-newsgroup)
921             (> number nntp-large-newsgroup)
922             (nnheader-message 6 "NNTP: Receiving articles...done"))
923
924        ;; Now we have all the responses.  We go through the results,
925        ;; wash it and copy it over to the server buffer.
926        (set-buffer nntp-server-buffer)
927        (erase-buffer)
928        (setq last-point (point-min))
929        (mapcar
930         (lambda (entry)
931           (narrow-to-region
932            (setq point (goto-char (point-max)))
933            (progn
934              (nntp-insert-buffer-substring buf last-point (cdr entry))
935              (point-max)))
936           (setq last-point (cdr entry))
937           (nntp-decode-text)
938           (widen)
939           (cons (car entry) point))
940         map)))))
941
942 (defun nntp-try-list-active (group)
943   (nntp-list-active-group group)
944   (with-current-buffer nntp-server-buffer
945     (goto-char (point-min))
946     (cond ((or (eobp)
947                (looking-at "5[0-9]+"))
948            (setq nntp-server-list-active-group nil))
949           (t
950            (setq nntp-server-list-active-group t)))))
951
952 (deffoo nntp-list-active-group (group &optional server)
953   "Return the active info on GROUP (which can be a regexp)."
954   (nntp-with-open-group
955    nil server
956    (nntp-send-command "^\\.*\r?\n" "LIST ACTIVE" group)))
957
958 (deffoo nntp-request-group-articles (group &optional server)
959   "Return the list of existing articles in GROUP."
960   (nntp-with-open-group
961    nil server
962    (nntp-send-command "^\\.*\r?\n" "LISTGROUP" group)))
963
964 (deffoo nntp-request-article (article &optional group server buffer command)
965   (nntp-with-open-group
966     group server
967     (when (nntp-send-command-and-decode
968            "\r?\n\\.\r?\n" "ARTICLE"
969            (if (numberp article) (int-to-string article) article))
970       (if (and buffer
971                (not (equal buffer nntp-server-buffer)))
972           (with-current-buffer nntp-server-buffer
973             (copy-to-buffer buffer (point-min) (point-max))
974             (nntp-find-group-and-number group))
975         (nntp-find-group-and-number group)))))
976
977 (deffoo nntp-request-head (article &optional group server)
978   (nntp-with-open-group
979    group server
980    (when (nntp-send-command
981           "\r?\n\\.\r?\n" "HEAD"
982           (if (numberp article) (int-to-string article) article))
983      (prog1
984          (nntp-find-group-and-number group)
985        (nntp-decode-text)))))
986
987 (deffoo nntp-request-body (article &optional group server)
988   (nntp-with-open-group
989    group server
990    (nntp-send-command-and-decode
991     "\r?\n\\.\r?\n" "BODY"
992     (if (numberp article) (int-to-string article) article))))
993
994 (deffoo nntp-request-group (group &optional server dont-check info)
995   (nntp-with-open-group
996     nil server
997     (when (nntp-send-command "^[245].*\n" "GROUP" group)
998       (let ((entry (nntp-find-connection-entry nntp-server-buffer)))
999         (setcar (cddr entry) group)))))
1000
1001 (deffoo nntp-close-group (group &optional server)
1002   t)
1003
1004 (deffoo nntp-server-opened (&optional server)
1005   "Say whether a connection to SERVER has been opened."
1006   (and (nnoo-current-server-p 'nntp server)
1007        nntp-server-buffer
1008        (gnus-buffer-live-p nntp-server-buffer)
1009        (nntp-find-connection nntp-server-buffer)))
1010
1011 (deffoo nntp-open-server (server &optional defs connectionless)
1012   (nnheader-init-server-buffer)
1013   (if (nntp-server-opened server)
1014       t
1015     (when (or (stringp (car defs))
1016               (numberp (car defs)))
1017       (setq defs (cons (list 'nntp-port-number (car defs)) (cdr defs))))
1018     (unless (assq 'nntp-address defs)
1019       (setq defs (append defs (list (list 'nntp-address server)))))
1020     (nnoo-change-server 'nntp server defs)
1021     (if connectionless
1022         t
1023       (or (nntp-find-connection nntp-server-buffer)
1024           (nntp-open-connection nntp-server-buffer)))))
1025
1026 (deffoo nntp-close-server (&optional server)
1027   (nntp-possibly-change-group nil server t)
1028   (let ((process (nntp-find-connection nntp-server-buffer)))
1029     (while process
1030       (when (memq (process-status process) '(open run))
1031         (ignore-errors
1032           (nntp-send-string process "QUIT")
1033           (unless (eq nntp-open-connection-function 'nntp-open-network-stream)
1034             ;; Ok, this is evil, but when using telnet and stuff
1035             ;; as the connection method, it's important that the
1036             ;; QUIT command actually is sent out before we kill
1037             ;; the process.
1038             (sleep-for 1))))
1039       (nntp-kill-buffer (process-buffer process))
1040       (setq process (car (pop nntp-connection-alist))))
1041     (nnoo-close-server 'nntp)))
1042
1043 (deffoo nntp-request-close ()
1044   (let (process)
1045     (while (setq process (pop nntp-connection-list))
1046       (when (memq (process-status process) '(open run))
1047         (ignore-errors
1048           (nntp-send-string process "QUIT")
1049           (unless (eq nntp-open-connection-function 'nntp-open-network-stream)
1050             ;; Ok, this is evil, but when using telnet and stuff
1051             ;; as the connection method, it's important that the
1052             ;; QUIT command actually is sent out before we kill
1053             ;; the process.
1054             (sleep-for 1))))
1055       (nntp-kill-buffer (process-buffer process)))))
1056
1057 (deffoo nntp-request-list (&optional server)
1058   (nntp-with-open-group
1059    nil server
1060    (nntp-send-command-and-decode "\r?\n\\.\r?\n" "LIST")))
1061
1062 (deffoo nntp-request-list-newsgroups (&optional server)
1063   (nntp-with-open-group
1064    nil server
1065    (nntp-send-command "\r?\n\\.\r?\n" "LIST NEWSGROUPS")))
1066
1067 (deffoo nntp-request-newgroups (date &optional server)
1068   (nntp-with-open-group
1069    nil server
1070    (with-current-buffer nntp-server-buffer
1071      (let* ((time (date-to-time date))
1072             (ls (- (cadr time) (nth 8 (decode-time time)))))
1073        (cond ((< ls 0)
1074               (setcar time (1- (car time)))
1075               (setcar (cdr time) (+ ls 65536)))
1076              ((>= ls 65536)
1077               (setcar time (1+ (car time)))
1078               (setcar (cdr time) (- ls 65536)))
1079              (t
1080               (setcar (cdr time) ls)))
1081        (prog1
1082            (nntp-send-command
1083             "^\\.\r?\n" "NEWGROUPS"
1084             (format-time-string "%y%m%d %H%M%S" time)
1085             "GMT")
1086          (nntp-decode-text))))))
1087
1088 (deffoo nntp-request-post (&optional server)
1089   (nntp-with-open-group
1090    nil server
1091    (when (nntp-send-command "^[23].*\r?\n" "POST")
1092      (let ((response (with-current-buffer nntp-server-buffer
1093                        nntp-process-response))
1094            server-id)
1095        (when (and response
1096                   (string-match "^[23].*\\(<[^\t\n @<>]+@[^\t\n @<>]+>\\)"
1097                                 response))
1098          (setq server-id (match-string 1 response))
1099          (narrow-to-region (goto-char (point-min))
1100                            (if (search-forward "\n\n" nil t)
1101                                (1- (point))
1102                              (point-max)))
1103          (unless (mail-fetch-field "Message-ID")
1104            (goto-char (point-min))
1105            (insert "Message-ID: " server-id "\n"))
1106          (widen))
1107        (run-hooks 'nntp-prepare-post-hook)
1108        (nntp-send-buffer "^[23].*\n")))))
1109
1110 (deffoo nntp-request-type (group article)
1111   'news)
1112
1113 (deffoo nntp-asynchronous-p ()
1114   t)
1115
1116 (deffoo nntp-request-set-mark (group actions &optional server)
1117   (when (and (not nntp-marks-is-evil)
1118              nntp-marks-file-name)
1119     (nntp-possibly-create-directory group server)
1120     (nntp-open-marks group server)
1121     (dolist (action actions)
1122       (let ((range (nth 0 action))
1123             (what  (nth 1 action))
1124             (marks (nth 2 action)))
1125         (assert (or (eq what 'add) (eq what 'del)) nil
1126                 "Unknown request-set-mark action: %s" what)
1127         (dolist (mark marks)
1128           (setq nntp-marks (gnus-update-alist-soft
1129                             mark
1130                             (funcall (if (eq what 'add) 'gnus-range-add
1131                                        'gnus-remove-from-range)
1132                                      (cdr (assoc mark nntp-marks)) range)
1133                             nntp-marks)))))
1134     (nntp-save-marks group server))
1135   nil)
1136
1137 (deffoo nntp-request-marks (group info &optional server)
1138   (when (and (not nntp-marks-is-evil)
1139              nntp-marks-file-name)
1140     (nntp-possibly-create-directory group server)
1141     (when (nntp-marks-changed-p group server)
1142       (nnheader-message 8 "Updating marks for %s..." group)
1143       (nntp-open-marks group server)
1144       ;; Update info using `nntp-marks'.
1145       (mapc (lambda (pred)
1146               (unless (memq (cdr pred) gnus-article-unpropagated-mark-lists)
1147                 (gnus-info-set-marks
1148                  info
1149                  (gnus-update-alist-soft
1150                   (cdr pred)
1151                   (cdr (assq (cdr pred) nntp-marks))
1152                   (gnus-info-marks info))
1153                  t)))
1154             gnus-article-mark-lists)
1155       (let ((seen (cdr (assq 'read nntp-marks))))
1156         (gnus-info-set-read info
1157                             (if (and (integerp (car seen))
1158                                      (null (cdr seen)))
1159                                 (list (cons (car seen) (car seen)))
1160                               seen)))
1161       (nnheader-message 8 "Updating marks for %s...done" group)))
1162   nil)
1163
1164
1165
1166 ;;; Hooky functions.
1167
1168 (defun nntp-send-mode-reader ()
1169   "Send the MODE READER command to the nntp server.
1170 This function is supposed to be called from `nntp-server-opened-hook'.
1171 It will make innd servers spawn an nnrpd process to allow actual article
1172 reading."
1173   (nntp-send-command "^.*\n" "MODE READER"))
1174
1175 (declare-function netrc-parse "netrc" (file))
1176 (declare-function netrc-machine "netrc"
1177                   (list machine &optional port defaultport))
1178 (declare-function netrc-get "netrc" (alist type))
1179
1180 (defun nntp-send-authinfo (&optional send-if-force)
1181   "Send the AUTHINFO to the nntp server.
1182 It will look in the \"~/.authinfo\" file for matching entries.  If
1183 nothing suitable is found there, it will prompt for a user name
1184 and a password.
1185
1186 If SEND-IF-FORCE, only send authinfo to the server if the
1187 .authinfo file has the FORCE token."
1188   (require 'netrc)
1189   (let* ((list (netrc-parse nntp-authinfo-file))
1190          (alist (netrc-machine list nntp-address "nntp"))
1191          (force (or (netrc-get alist "force") nntp-authinfo-force))
1192          (auth-info
1193           (auth-source-user-or-password '("login" "password") nntp-address "nntp"))
1194          (auth-user (nth 0 auth-info))
1195          (auth-passwd (nth 1 auth-info))
1196          (user (or
1197                 ;; this is preferred to netrc-*
1198                 auth-user
1199                 (netrc-get alist "login")
1200                 nntp-authinfo-user))
1201          (passwd (or
1202                   ;; this is preferred to netrc-*
1203                   auth-passwd
1204                   (netrc-get alist "password"))))
1205     (when (or (not send-if-force)
1206               force)
1207       (unless user
1208         (setq user (read-string (format "NNTP (%s) user name: " nntp-address))
1209               nntp-authinfo-user user))
1210       (unless (member user '(nil ""))
1211         (nntp-send-command "^3.*\r?\n" "AUTHINFO USER" user)
1212         (when t                         ;???Should check if AUTHINFO succeeded
1213           (nntp-send-command
1214            "^2.*\r?\n" "AUTHINFO PASS"
1215            (or passwd
1216                nntp-authinfo-password
1217                (setq nntp-authinfo-password
1218                      (read-passwd (format "NNTP (%s@%s) password: "
1219                                           user nntp-address))))))))))
1220
1221 (defun nntp-send-nosy-authinfo ()
1222   "Send the AUTHINFO to the nntp server."
1223   (let ((user (read-string (format "NNTP (%s) user name: " nntp-address))))
1224     (unless (member user '(nil ""))
1225       (nntp-send-command "^3.*\r?\n" "AUTHINFO USER" user)
1226       (when t                           ;???Should check if AUTHINFO succeeded
1227         (nntp-send-command "^2.*\r?\n" "AUTHINFO PASS"
1228                            (read-passwd (format "NNTP (%s@%s) password: "
1229                                                 user nntp-address)))))))
1230
1231 (defun nntp-send-authinfo-from-file ()
1232   "Send the AUTHINFO to the nntp server.
1233
1234 The authinfo login name is taken from the user's login name and the
1235 password contained in '~/.nntp-authinfo'."
1236   (when (file-exists-p "~/.nntp-authinfo")
1237     (with-temp-buffer
1238       (insert-file-contents "~/.nntp-authinfo")
1239       (goto-char (point-min))
1240       (nntp-send-command "^3.*\r?\n" "AUTHINFO USER" (user-login-name))
1241       (nntp-send-command
1242        "^2.*\r?\n" "AUTHINFO PASS"
1243        (buffer-substring (point) (point-at-eol))))))
1244
1245 ;;; Internal functions.
1246
1247 (defun nntp-handle-authinfo (process)
1248   "Take care of an authinfo response from the server."
1249   (let ((last nntp-last-command))
1250     (funcall nntp-authinfo-function)
1251     ;; We have to re-send the function that was interrupted by
1252     ;; the authinfo request.
1253     (nntp-erase-buffer nntp-server-buffer)
1254     (nntp-send-string process last)))
1255
1256 (defun nntp-make-process-buffer (buffer)
1257   "Create a new, fresh buffer usable for nntp process connections."
1258   (with-current-buffer
1259       (generate-new-buffer
1260        (format " *server %s %s %s*"
1261                nntp-address nntp-port-number
1262                (gnus-buffer-exists-p buffer)))
1263     (mm-disable-multibyte)
1264     (set (make-local-variable 'after-change-functions) nil)
1265     (set (make-local-variable 'nntp-process-wait-for) nil)
1266     (set (make-local-variable 'nntp-process-callback) nil)
1267     (set (make-local-variable 'nntp-process-to-buffer) nil)
1268     (set (make-local-variable 'nntp-process-start-point) nil)
1269     (set (make-local-variable 'nntp-process-decode) nil)
1270     (current-buffer)))
1271
1272 (defun nntp-open-connection (buffer)
1273   "Open a connection to PORT on ADDRESS delivering output to BUFFER."
1274   (run-hooks 'nntp-prepare-server-hook)
1275   (let* ((pbuffer (nntp-make-process-buffer buffer))
1276          (timer
1277           (and nntp-connection-timeout
1278                (run-at-time
1279                 nntp-connection-timeout nil
1280                 `(lambda ()
1281                    (nntp-kill-buffer ,pbuffer)))))
1282          (process
1283           (condition-case ()
1284               (let ((coding-system-for-read nntp-coding-system-for-read)
1285                     (coding-system-for-write nntp-coding-system-for-write))
1286                 (funcall nntp-open-connection-function pbuffer))
1287             (error nil)
1288             (quit
1289              (message "Quit opening connection to %s" nntp-address)
1290              (nntp-kill-buffer pbuffer)
1291              (signal 'quit nil)
1292              nil))))
1293     (when timer
1294       (nnheader-cancel-timer timer))
1295     (unless process
1296       (nntp-kill-buffer pbuffer))
1297     (when (and (buffer-name pbuffer)
1298                process)
1299       (gnus-set-process-query-on-exit-flag process nil)
1300       (if (and (nntp-wait-for process "^2.*\n" buffer nil t)
1301                (memq (process-status process) '(open run)))
1302           (prog1
1303               (caar (push (list process buffer nil) nntp-connection-alist))
1304             (push process nntp-connection-list)
1305             (with-current-buffer pbuffer
1306               (nntp-read-server-type)
1307               (erase-buffer)
1308               (set-buffer nntp-server-buffer)
1309               (let ((nnheader-callback-function nil))
1310                 (run-hooks 'nntp-server-opened-hook)
1311                 (nntp-send-authinfo t))))
1312         (nntp-kill-buffer (process-buffer process))
1313         nil))))
1314
1315 (defun nntp-open-network-stream (buffer)
1316   (open-network-stream "nntpd" buffer nntp-address nntp-port-number))
1317
1318 (autoload 'format-spec "format-spec")
1319 (autoload 'format-spec-make "format-spec")
1320 (autoload 'open-tls-stream "tls")
1321
1322 (defun nntp-open-ssl-stream (buffer)
1323   (let* ((process-connection-type nil)
1324          (proc (start-process "nntpd" buffer
1325                               shell-file-name
1326                               shell-command-switch
1327                               (format-spec nntp-ssl-program
1328                                            (format-spec-make
1329                                             ?s nntp-address
1330                                             ?p nntp-port-number)))))
1331     (gnus-set-process-query-on-exit-flag proc nil)
1332     (with-current-buffer buffer
1333       (let ((nntp-connection-alist (list proc buffer nil)))
1334         (nntp-wait-for-string "^\r*20[01]"))
1335       (beginning-of-line)
1336       (delete-region (point-min) (point))
1337       proc)))
1338
1339 (defun nntp-open-tls-stream (buffer)
1340   (let ((proc (open-tls-stream "nntpd" buffer nntp-address nntp-port-number)))
1341     (gnus-set-process-query-on-exit-flag proc nil)
1342     (with-current-buffer buffer
1343       (let ((nntp-connection-alist (list proc buffer nil)))
1344         (nntp-wait-for-string "^\r*20[01]"))
1345       (beginning-of-line)
1346       (delete-region (point-min) (point))
1347       proc)))
1348
1349 (defun nntp-read-server-type ()
1350   "Find out what the name of the server we have connected to is."
1351   ;; Wait for the status string to arrive.
1352   (setq nntp-server-type (buffer-string))
1353   (let ((case-fold-search t))
1354     ;; Run server-specific commands.
1355     (dolist (entry nntp-server-action-alist)
1356       (when (string-match (car entry) nntp-server-type)
1357         (if (and (listp (cadr entry))
1358                  (not (eq 'lambda (caadr entry))))
1359             (eval (cadr entry))
1360           (funcall (cadr entry)))))))
1361
1362 (defun nntp-async-wait (process wait-for buffer decode callback)
1363   (with-current-buffer (process-buffer process)
1364     (unless nntp-inside-change-function
1365       (erase-buffer))
1366     (setq nntp-process-wait-for wait-for
1367           nntp-process-to-buffer buffer
1368           nntp-process-decode decode
1369           nntp-process-callback callback
1370           nntp-process-start-point (point-max))
1371     (setq after-change-functions '(nntp-after-change-function))))
1372
1373 (defun nntp-async-timer-handler ()
1374   (mapcar
1375    (lambda (proc)
1376      (if (memq (process-status proc) '(open run))
1377          (nntp-async-trigger proc)
1378        (nntp-async-stop proc)))
1379    nntp-async-process-list))
1380
1381 (defun nntp-async-stop (proc)
1382   (setq nntp-async-process-list (delq proc nntp-async-process-list))
1383   (when (and nntp-async-timer (not nntp-async-process-list))
1384     (nnheader-cancel-timer nntp-async-timer)
1385     (setq nntp-async-timer nil)))
1386
1387 (defun nntp-after-change-function (beg end len)
1388   (unwind-protect
1389       ;; we only care about insertions at eob
1390       (when (and (eq 0 len) (eq (point-max) end))
1391         (save-match-data
1392           (let ((proc (get-buffer-process (current-buffer))))
1393             (when proc
1394               (nntp-async-trigger proc)))))
1395     ;; any throw from after-change-functions will leave it
1396     ;; set to nil.  so we reset it here, if necessary.
1397     (when quit-flag
1398       (setq after-change-functions '(nntp-after-change-function)))))
1399
1400 (defun nntp-async-trigger (process)
1401   (with-current-buffer (process-buffer process)
1402     (when nntp-process-callback
1403       ;; do we have an error message?
1404       (goto-char nntp-process-start-point)
1405       (if (memq (following-char) '(?4 ?5))
1406           ;; wants credentials?
1407           (if (looking-at "480")
1408               (nntp-handle-authinfo process)
1409             ;; report error message.
1410             (nntp-snarf-error-message)
1411             (nntp-do-callback nil))
1412
1413         ;; got what we expect?
1414         (goto-char (point-max))
1415         (when (re-search-backward
1416                nntp-process-wait-for nntp-process-start-point t)
1417           (let ((response (match-string 0)))
1418             (with-current-buffer nntp-server-buffer
1419               (setq nntp-process-response response)))
1420           (nntp-async-stop process)
1421           ;; convert it.
1422           (when (gnus-buffer-exists-p nntp-process-to-buffer)
1423             (let ((buf (current-buffer))
1424                   (start nntp-process-start-point)
1425                   (decode nntp-process-decode))
1426               (with-current-buffer nntp-process-to-buffer
1427                 (goto-char (point-max))
1428                 (save-restriction
1429                   (narrow-to-region (point) (point))
1430                   (nntp-insert-buffer-substring buf start)
1431                   (when decode
1432                     (nntp-decode-text))))))
1433           ;; report it.
1434           (goto-char (point-max))
1435           (nntp-do-callback
1436            (buffer-name (get-buffer nntp-process-to-buffer))))))))
1437
1438 (defun nntp-do-callback (arg)
1439   (let ((callback nntp-process-callback)
1440         (nntp-inside-change-function t))
1441     (setq nntp-process-callback nil)
1442     (funcall callback arg)))
1443
1444 (defun nntp-snarf-error-message ()
1445   "Save the error message in the current buffer."
1446   (let ((message (buffer-string)))
1447     (while (string-match "[\r\n]+" message)
1448       (setq message (replace-match " " t t message)))
1449     (nnheader-report 'nntp message)
1450     message))
1451
1452 (defun nntp-accept-process-output (process)
1453   "Wait for output from PROCESS and message some dots."
1454   (with-current-buffer (or (nntp-find-connection-buffer nntp-server-buffer)
1455                            nntp-server-buffer)
1456     (let ((len (/ (buffer-size) 1024))
1457           message-log-max)
1458       (unless (< len 10)
1459         (setq nntp-have-messaged t)
1460         (nnheader-message 7 "nntp read: %dk" len)))
1461     (prog1
1462         (nnheader-accept-process-output process)
1463       ;; accept-process-output may update status of process to indicate
1464       ;; that the server has closed the connection.  This MUST be
1465       ;; handled here as the buffer restored by the save-excursion may
1466       ;; be the process's former output buffer (i.e. now killed)
1467       (or (and process
1468                (memq (process-status process) '(open run)))
1469           (nntp-report "Server closed connection")))))
1470
1471 (defun nntp-accept-response ()
1472   "Wait for output from the process that outputs to BUFFER."
1473   (nntp-accept-process-output (nntp-find-connection nntp-server-buffer)))
1474
1475 (defun nntp-possibly-change-group (group server &optional connectionless)
1476   (let ((nnheader-callback-function nil))
1477     (when server
1478       (or (nntp-server-opened server)
1479           (nntp-open-server server nil connectionless)))
1480
1481     (unless connectionless
1482       (or (nntp-find-connection nntp-server-buffer)
1483           (nntp-open-connection nntp-server-buffer))))
1484
1485   (when group
1486     (let ((entry (nntp-find-connection-entry nntp-server-buffer)))
1487       (cond ((not entry)
1488              (nntp-report "Server closed connection"))
1489             ((not (equal group (caddr entry)))
1490              (with-current-buffer (process-buffer (car entry))
1491                (erase-buffer)
1492                (nntp-send-command "^[245].*\n" "GROUP" group)
1493                (setcar (cddr entry) group)
1494                (erase-buffer)
1495                (nntp-erase-buffer nntp-server-buffer)))))))
1496
1497 (defun nntp-decode-text (&optional cr-only)
1498   "Decode the text in the current buffer."
1499   (goto-char (point-min))
1500   (while (search-forward "\r" nil t)
1501     (delete-char -1))
1502   (unless cr-only
1503     ;; Remove trailing ".\n" end-of-transfer marker.
1504     (goto-char (point-max))
1505     (forward-line -1)
1506     (when (looking-at ".\n")
1507       (delete-char 2))
1508     ;; Delete status line.
1509     (goto-char (point-min))
1510     (while (looking-at "[1-5][0-9][0-9] .*\n")
1511       ;; For some unknown reason, there is more than one status line.
1512       (delete-region (point) (progn (forward-line 1) (point))))
1513     ;; Remove "." -> ".." encoding.
1514     (while (search-forward "\n.." nil t)
1515       (delete-char -1))))
1516
1517 (defun nntp-encode-text ()
1518   "Encode the text in the current buffer."
1519   (save-excursion
1520     ;; Replace "." at beginning of line with "..".
1521     (goto-char (point-min))
1522     (while (re-search-forward "^\\." nil t)
1523       (insert "."))
1524     (goto-char (point-max))
1525     ;; Insert newline at the end of the buffer.
1526     (unless (bolp)
1527       (insert "\n"))
1528     ;; Insert `.' at end of buffer (end of text mark).
1529     (goto-char (point-max))
1530     (insert ".\n")
1531     (goto-char (point-min))
1532     (while (not (eobp))
1533       (end-of-line)
1534       (delete-char 1)
1535       (insert nntp-end-of-line))))
1536
1537 (defun nntp-retrieve-headers-with-xover (articles &optional fetch-old)
1538   (set-buffer nntp-server-buffer)
1539   (erase-buffer)
1540   (cond
1541
1542    ;; This server does not talk NOV.
1543    ((not nntp-server-xover)
1544     nil)
1545
1546    ;; We don't care about gaps.
1547    ((or (not nntp-nov-gap)
1548         fetch-old)
1549     (nntp-send-xover-command
1550      (if fetch-old
1551          (if (numberp fetch-old)
1552              (max 1 (- (car articles) fetch-old))
1553            1)
1554        (car articles))
1555      (car (last articles)) 'wait)
1556
1557     (goto-char (point-min))
1558     (when (looking-at "[1-5][0-9][0-9] .*\n")
1559       (delete-region (point) (progn (forward-line 1) (point))))
1560     (while (search-forward "\r" nil t)
1561       (replace-match "" t t))
1562     (goto-char (point-max))
1563     (forward-line -1)
1564     (when (looking-at "\\.")
1565       (delete-region (point) (progn (forward-line 1) (point)))))
1566
1567    ;; We do it the hard way.  For each gap, an XOVER command is sent
1568    ;; to the server.  We do not wait for a reply from the server, we
1569    ;; just send them off as fast as we can.  That means that we have
1570    ;; to count the number of responses we get back to find out when we
1571    ;; have gotten all we asked for.
1572    ((numberp nntp-nov-gap)
1573     (let ((count 0)
1574           (received 0)
1575           last-point
1576           in-process-buffer-p
1577           (buf nntp-server-buffer)
1578           (process-buffer (nntp-find-connection-buffer nntp-server-buffer))
1579           first last status)
1580       ;; We have to check `nntp-server-xover'.  If it gets set to nil,
1581       ;; that means that the server does not understand XOVER, but we
1582       ;; won't know that until we try.
1583       (while (and nntp-server-xover articles)
1584         (setq first (car articles))
1585         ;; Search forward until we find a gap, or until we run out of
1586         ;; articles.
1587         (while (and (cdr articles)
1588                     (< (- (nth 1 articles) (car articles)) nntp-nov-gap))
1589           (setq articles (cdr articles)))
1590
1591         (setq in-process-buffer-p (stringp nntp-server-xover))
1592         (nntp-send-xover-command first (setq last (car articles)))
1593         (setq articles (cdr articles))
1594
1595         (when (and nntp-server-xover in-process-buffer-p)
1596           ;; Don't count tried request.
1597           (setq count (1+ count))
1598
1599           ;; Every 400 requests we have to read the stream in
1600           ;; order to avoid deadlocks.
1601           (when (or (null articles)     ;All requests have been sent.
1602                     (= 1 (% count nntp-maximum-request)))
1603
1604             (nntp-accept-response)
1605             ;; On some Emacs versions the preceding function has a
1606             ;; tendency to change the buffer.  Perhaps.  It's quite
1607             ;; difficult to reproduce, because it only seems to happen
1608             ;; once in a blue moon.
1609             (set-buffer process-buffer)
1610             (while (progn
1611                      (goto-char (or last-point (point-min)))
1612                      ;; Count replies.
1613                      (while (re-search-forward "^\\([0-9][0-9][0-9]\\) .*\n"
1614                                                nil t)
1615                        (incf received)
1616                        (setq status (match-string 1))
1617                        (if (string-match "^[45]" status)
1618                            (setq status 'error)
1619                          (setq status 'ok)))
1620                      (setq last-point (point))
1621                      (or (< received count)
1622                          (if (eq status 'error)
1623                              nil
1624                            ;; I haven't started reading the final response
1625                            (progn
1626                              (goto-char (point-max))
1627                              (forward-line -1)
1628                              (not (looking-at "^\\.\r?\n"))))))
1629               ;; I haven't read the end of the final response
1630               (nntp-accept-response)
1631               (set-buffer process-buffer))))
1632
1633         ;; Some nntp servers seem to have an extension to the XOVER
1634         ;; extension.  On these servers, requesting an article range
1635         ;; preceeding the active range does not return an error as
1636         ;; specified in the RFC.  What we instead get is the NOV entry
1637         ;; for the first available article.  Obviously, a client can
1638         ;; use that entry to avoid making unnecessary requests.  The
1639         ;; only problem is for a client that assumes that the response
1640         ;; will always be within the requested ranage.  For such a
1641         ;; client, we can get N copies of the same entry (one for each
1642         ;; XOVER command sent to the server).
1643
1644         (when (<= count 1)
1645           (goto-char (point-min))
1646           (when (re-search-forward "^[0-9][0-9][0-9] .*\n\\([0-9]+\\)" nil t)
1647             (let ((low-limit (string-to-number
1648                               (buffer-substring (match-beginning 1)
1649                                                 (match-end 1)))))
1650               (while (and articles (<= (car articles) low-limit))
1651                 (setq articles (cdr articles))))))
1652         (set-buffer buf))
1653
1654       (when nntp-server-xover
1655         (when in-process-buffer-p
1656           (set-buffer buf)
1657           (goto-char (point-max))
1658           (nntp-insert-buffer-substring process-buffer)
1659           (set-buffer process-buffer)
1660           (erase-buffer)
1661           (set-buffer buf))
1662
1663         ;; We remove any "." lines and status lines.
1664         (goto-char (point-min))
1665         (while (search-forward "\r" nil t)
1666           (delete-char -1))
1667         (goto-char (point-min))
1668         (delete-matching-lines "^\\.$\\|^[1-5][0-9][0-9] ")
1669         t))))
1670
1671   nntp-server-xover)
1672
1673 (defun nntp-send-xover-command (beg end &optional wait-for-reply)
1674   "Send the XOVER command to the server."
1675   (let ((range (format "%d-%d" beg end))
1676         (nntp-inhibit-erase t))
1677     (if (stringp nntp-server-xover)
1678         ;; If `nntp-server-xover' is a string, then we just send this
1679         ;; command.
1680         (if wait-for-reply
1681             (nntp-send-command-nodelete
1682              "\r?\n\\.\r?\n" nntp-server-xover range)
1683           ;; We do not wait for the reply.
1684           (nntp-send-command-nodelete nil nntp-server-xover range))
1685       (let ((commands nntp-xover-commands))
1686         ;; `nntp-xover-commands' is a list of possible XOVER commands.
1687         ;; We try them all until we get at positive response.
1688         (while (and commands (eq nntp-server-xover 'try))
1689           (nntp-send-command-nodelete "\r?\n\\.\r?\n" (car commands) range)
1690           (with-current-buffer nntp-server-buffer
1691             (goto-char (point-min))
1692             (and (looking-at "[23]")    ; No error message.
1693                  ;; We also have to look at the lines.  Some buggy
1694                  ;; servers give back simple lines with just the
1695                  ;; article number.  How... helpful.
1696                  (progn
1697                    (forward-line 1)
1698                    ;; More text after number, or a dot.
1699                    (looking-at "[0-9]+\t...\\|\\.\r?\n"))
1700                  (setq nntp-server-xover (car commands))))
1701           (setq commands (cdr commands)))
1702         ;; If none of the commands worked, we disable XOVER.
1703         (when (eq nntp-server-xover 'try)
1704           (nntp-erase-buffer nntp-server-buffer)
1705           (setq nntp-server-xover nil))
1706         nntp-server-xover))))
1707
1708 (defun nntp-find-group-and-number (&optional group)
1709   (save-excursion
1710     (save-restriction
1711       ;; FIXME: This is REALLY FISHY: set-buffer after save-restriction?!?
1712       (set-buffer nntp-server-buffer)
1713       (narrow-to-region (goto-char (point-min))
1714                         (or (search-forward "\n\n" nil t) (point-max)))
1715       (goto-char (point-min))
1716       ;; We first find the number by looking at the status line.
1717       (let ((number (and (looking-at "2[0-9][0-9] +\\([0-9]+\\) ")
1718                          (string-to-number
1719                           (buffer-substring (match-beginning 1)
1720                                             (match-end 1)))))
1721             newsgroups xref)
1722         (and number (zerop number) (setq number nil))
1723         (if number
1724             ;; Then we find the group name.
1725             (setq group
1726                   (cond
1727                    ;; If there is only one group in the Newsgroups
1728                    ;; header, then it seems quite likely that this
1729                    ;; article comes from that group, I'd say.
1730                    ((and (setq newsgroups
1731                                (mail-fetch-field "newsgroups"))
1732                          (not (string-match "," newsgroups)))
1733                     newsgroups)
1734                    ;; If there is more than one group in the
1735                    ;; Newsgroups header, then the Xref header should
1736                    ;; be filled out.  We hazard a guess that the group
1737                    ;; that has this article number in the Xref header
1738                    ;; is the one we are looking for.  This might very
1739                    ;; well be wrong if this article happens to have
1740                    ;; the same number in several groups, but that's
1741                    ;; life.
1742                    ((and (setq xref (mail-fetch-field "xref"))
1743                          number
1744                          (string-match
1745                           (format "\\([^ :]+\\):%d" number) xref))
1746                     (match-string 1 xref))
1747                    (t "")))
1748           (cond
1749            ((and (not nntp-xref-number-is-evil)
1750                  (setq xref (mail-fetch-field "xref"))
1751                  (string-match
1752                   (if group
1753                       (concat "\\(" (regexp-quote group) "\\):\\([0-9]+\\)")
1754                     "\\([^ :]+\\):\\([0-9]+\\)")
1755                   xref))
1756             (setq group (match-string 1 xref)
1757                   number (string-to-number (match-string 2 xref))))
1758            ((and (setq newsgroups
1759                        (mail-fetch-field "newsgroups"))
1760                  (not (string-match "," newsgroups)))
1761             (setq group newsgroups))
1762            (group)
1763            (t (setq group ""))))
1764         (when (string-match "\r" group)
1765           (setq group (substring group 0 (match-beginning 0))))
1766         (cons group number)))))
1767
1768 (defun nntp-wait-for-string (regexp)
1769   "Wait until string arrives in the buffer."
1770   (let ((buf (current-buffer))
1771         proc)
1772     (goto-char (point-min))
1773     (while (and (setq proc (get-buffer-process buf))
1774                 (memq (process-status proc) '(open run))
1775                 (not (re-search-forward regexp nil t)))
1776       (accept-process-output proc 0.1)
1777       (set-buffer buf)
1778       (goto-char (point-min)))))
1779
1780
1781 ;; ==========================================================================
1782 ;; Obsolete nntp-open-* connection methods -- drv
1783 ;; ==========================================================================
1784
1785 (defvoo nntp-open-telnet-envuser nil
1786   "*If non-nil, telnet session (client and server both) will support the ENVIRON option and not prompt for login name.")
1787
1788 (defvoo nntp-telnet-shell-prompt "bash\\|\$ *\r?$\\|> *\r?"
1789   "*Regular expression to match the shell prompt on the remote machine.")
1790
1791 (defvoo nntp-rlogin-program "rsh"
1792   "*Program used to log in on remote machines.
1793 The default is \"rsh\", but \"ssh\" is a popular alternative.")
1794
1795 (defvoo nntp-rlogin-parameters '("telnet" "-8" "${NNTPSERVER:=news}" "nntp")
1796   "*Parameters to `nntp-open-rlogin'.
1797 That function may be used as `nntp-open-connection-function'.  In that
1798 case, this list will be used as the parameter list given to rsh.")
1799
1800 (defvoo nntp-rlogin-user-name nil
1801   "*User name on remote system when using the rlogin connect method.")
1802
1803 (defvoo nntp-telnet-parameters
1804     '("exec" "telnet" "-8" "${NNTPSERVER:=news}" "nntp")
1805   "*Parameters to `nntp-open-telnet'.
1806 That function may be used as `nntp-open-connection-function'.  In that
1807 case, this list will be executed as a command after logging in
1808 via telnet.")
1809
1810 (defvoo nntp-telnet-user-name nil
1811   "User name to log in via telnet with.")
1812
1813 (defvoo nntp-telnet-passwd nil
1814   "Password to use to log in via telnet with.")
1815
1816 (defun nntp-service-to-port (svc)
1817   (cond
1818    ((integerp svc) (number-to-string svc))
1819    ((string-match "\\`[0-9]+\\'" svc) svc)
1820    (t
1821     (with-temp-buffer
1822       (ignore-errors (insert-file-contents "/etc/services"))
1823       (goto-char (point-min))
1824       (if (re-search-forward (concat "^" (regexp-quote svc)
1825                                      "[ \t]+\\([0-9]+\\)/tcp"))
1826           (match-string 1)
1827         svc)))))
1828
1829 (defun nntp-open-telnet (buffer)
1830   (with-current-buffer buffer
1831     (erase-buffer)
1832     (let ((proc (apply
1833                  'start-process
1834                  "nntpd" buffer nntp-telnet-command nntp-telnet-switches))
1835           (case-fold-search t))
1836       (when (memq (process-status proc) '(open run))
1837         (nntp-wait-for-string "^r?telnet")
1838         (process-send-string proc "set escape \^X\n")
1839         (cond
1840          ((and nntp-open-telnet-envuser nntp-telnet-user-name)
1841           (process-send-string proc (concat "open " "-l" nntp-telnet-user-name
1842                                             nntp-address "\n")))
1843          (t
1844           (process-send-string proc (concat "open " nntp-address "\n"))))
1845         (cond
1846          ((not nntp-open-telnet-envuser)
1847           (nntp-wait-for-string "^\r*.?login:")
1848           (process-send-string
1849            proc (concat
1850                  (or nntp-telnet-user-name
1851                      (setq nntp-telnet-user-name (read-string "login: ")))
1852                  "\n"))))
1853         (nntp-wait-for-string "^\r*.?password:")
1854         (process-send-string
1855          proc (concat
1856                (or nntp-telnet-passwd
1857                    (setq nntp-telnet-passwd
1858                          (read-passwd "Password: ")))
1859                "\n"))
1860         (nntp-wait-for-string nntp-telnet-shell-prompt)
1861         (process-send-string
1862          proc (concat (mapconcat 'identity nntp-telnet-parameters " ") "\n"))
1863         (nntp-wait-for-string "^\r*20[01]")
1864         (beginning-of-line)
1865         (delete-region (point-min) (point))
1866         (process-send-string proc "\^]")
1867         (nntp-wait-for-string "^r?telnet")
1868         (process-send-string proc "mode character\n")
1869         (accept-process-output proc 1)
1870         (sit-for 1)
1871         (goto-char (point-min))
1872         (forward-line 1)
1873         (delete-region (point) (point-max)))
1874       proc)))
1875
1876 (defun nntp-open-rlogin (buffer)
1877   "Open a connection to SERVER using rsh."
1878   (let ((proc (if nntp-rlogin-user-name
1879                   (apply 'start-process
1880                          "nntpd" buffer nntp-rlogin-program
1881                          nntp-address "-l" nntp-rlogin-user-name
1882                          nntp-rlogin-parameters)
1883                 (apply 'start-process
1884                        "nntpd" buffer nntp-rlogin-program nntp-address
1885                        nntp-rlogin-parameters))))
1886     (with-current-buffer buffer
1887       (nntp-wait-for-string "^\r*20[01]")
1888       (beginning-of-line)
1889       (delete-region (point-min) (point))
1890       proc)))
1891
1892
1893 ;; ==========================================================================
1894 ;; Replacements for the nntp-open-* functions -- drv
1895 ;; ==========================================================================
1896
1897 (defun nntp-open-telnet-stream (buffer)
1898   "Open a nntp connection by telnet'ing the news server.
1899 `nntp-open-netcat-stream' is recommended in place of this function
1900 because it is more reliable.
1901
1902 Please refer to the following variables to customize the connection:
1903 - `nntp-pre-command',
1904 - `nntp-telnet-command',
1905 - `nntp-telnet-switches',
1906 - `nntp-address',
1907 - `nntp-port-number',
1908 - `nntp-end-of-line'."
1909   (let ((command `(,nntp-telnet-command
1910                    ,@nntp-telnet-switches
1911                    ,nntp-address
1912                    ,(nntp-service-to-port nntp-port-number)))
1913         proc)
1914     (and nntp-pre-command
1915          (push nntp-pre-command command))
1916     (setq proc (apply 'start-process "nntpd" buffer command))
1917     (with-current-buffer buffer
1918       (nntp-wait-for-string "^\r*20[01]")
1919       (beginning-of-line)
1920       (delete-region (point-min) (point))
1921       proc)))
1922
1923 (defun nntp-open-via-rlogin-and-telnet (buffer)
1924   "Open a connection to an nntp server through an intermediate host.
1925 First rlogin to the remote host, and then telnet the real news server
1926 from there.
1927 `nntp-open-via-rlogin-and-netcat' is recommended in place of this function
1928 because it is more reliable.
1929
1930 Please refer to the following variables to customize the connection:
1931 - `nntp-pre-command',
1932 - `nntp-via-rlogin-command',
1933 - `nntp-via-rlogin-command-switches',
1934 - `nntp-via-user-name',
1935 - `nntp-via-address',
1936 - `nntp-telnet-command',
1937 - `nntp-telnet-switches',
1938 - `nntp-address',
1939 - `nntp-port-number',
1940 - `nntp-end-of-line'."
1941   (let ((command `(,nntp-via-address
1942                    ,nntp-telnet-command
1943                    ,@nntp-telnet-switches))
1944         proc)
1945     (when nntp-via-user-name
1946       (setq command `("-l" ,nntp-via-user-name ,@command)))
1947     (when nntp-via-rlogin-command-switches
1948       (setq command (append nntp-via-rlogin-command-switches command)))
1949     (push nntp-via-rlogin-command command)
1950     (and nntp-pre-command
1951          (push nntp-pre-command command))
1952     (setq proc (apply 'start-process "nntpd" buffer command))
1953     (with-current-buffer buffer
1954       (nntp-wait-for-string "^r?telnet")
1955       (process-send-string proc (concat "open " nntp-address " "
1956                                         (nntp-service-to-port nntp-port-number)
1957                                         "\n"))
1958       (nntp-wait-for-string "^\r*20[01]")
1959       (beginning-of-line)
1960       (delete-region (point-min) (point))
1961       (process-send-string proc "\^]")
1962       (nntp-wait-for-string "^r?telnet")
1963       (process-send-string proc "mode character\n")
1964       (accept-process-output proc 1)
1965       (sit-for 1)
1966       (goto-char (point-min))
1967       (forward-line 1)
1968       (delete-region (point) (point-max)))
1969     proc))
1970
1971 (defun nntp-open-via-rlogin-and-netcat (buffer)
1972   "Open a connection to an nntp server through an intermediate host.
1973 First rlogin to the remote host, and then connect to the real news
1974 server from there using the netcat command.
1975
1976 Please refer to the following variables to customize the connection:
1977 - `nntp-pre-command',
1978 - `nntp-via-rlogin-command',
1979 - `nntp-via-rlogin-command-switches',
1980 - `nntp-via-user-name',
1981 - `nntp-via-address',
1982 - `nntp-netcat-command',
1983 - `nntp-netcat-switches',
1984 - `nntp-address',
1985 - `nntp-port-number'."
1986   (let ((command `(,@(when nntp-pre-command
1987                        (list nntp-pre-command))
1988                    ,nntp-via-rlogin-command
1989                    ,@nntp-via-rlogin-command-switches
1990                    ,@(when nntp-via-user-name
1991                        (list "-l" nntp-via-user-name))
1992                    ,nntp-via-address
1993                    ,nntp-netcat-command
1994                    ,@nntp-netcat-switches
1995                    ,nntp-address
1996                    ,(nntp-service-to-port nntp-port-number))))
1997     ;; A non-nil connection type results in mightily odd behavior where
1998     ;; (process-send-string proc "\^M") ends up sending a "\n" to the
1999     ;; ssh process.  --Stef
2000     ;; Also a nil connection allow ssh-askpass to work under X11.
2001     (let ((process-connection-type nil))
2002       (apply 'start-process "nntpd" buffer command))))
2003
2004 (defun nntp-open-netcat-stream (buffer)
2005   "Open a connection to an nntp server through netcat.
2006 I.e. use the `nc' command rather than Emacs's builtin networking code.
2007
2008 Please refer to the following variables to customize the connection:
2009 - `nntp-pre-command',
2010 - `nntp-netcat-command',
2011 - `nntp-netcat-switches',
2012 - `nntp-address',
2013 - `nntp-port-number'."
2014   (let ((command `(,nntp-netcat-command
2015                    ,@nntp-netcat-switches
2016                    ,nntp-address
2017                    ,(nntp-service-to-port nntp-port-number))))
2018     (and nntp-pre-command (push nntp-pre-command command))
2019     (let ((process-connection-type nil)) ;See `nntp-open-via-rlogin-and-netcat'.
2020       (apply 'start-process "nntpd" buffer command))))
2021
2022
2023 (defun nntp-open-via-telnet-and-telnet (buffer)
2024   "Open a connection to an nntp server through an intermediate host.
2025 First telnet the remote host, and then telnet the real news server
2026 from there.
2027
2028 Please refer to the following variables to customize the connection:
2029 - `nntp-pre-command',
2030 - `nntp-via-telnet-command',
2031 - `nntp-via-telnet-switches',
2032 - `nntp-via-address',
2033 - `nntp-via-envuser',
2034 - `nntp-via-user-name',
2035 - `nntp-via-user-password',
2036 - `nntp-via-shell-prompt',
2037 - `nntp-telnet-command',
2038 - `nntp-telnet-switches',
2039 - `nntp-address',
2040 - `nntp-port-number',
2041 - `nntp-end-of-line'."
2042   (with-current-buffer buffer
2043     (erase-buffer)
2044     (let ((command `(,nntp-via-telnet-command ,@nntp-via-telnet-switches))
2045           (case-fold-search t)
2046           proc)
2047       (and nntp-pre-command (push nntp-pre-command command))
2048       (setq proc (apply 'start-process "nntpd" buffer command))
2049       (when (memq (process-status proc) '(open run))
2050         (nntp-wait-for-string "^r?telnet")
2051         (process-send-string proc "set escape \^X\n")
2052         (cond
2053          ((and nntp-via-envuser nntp-via-user-name)
2054           (process-send-string proc (concat "open " "-l" nntp-via-user-name
2055                                             nntp-via-address "\n")))
2056          (t
2057           (process-send-string proc (concat "open " nntp-via-address
2058                                             "\n"))))
2059         (when (not nntp-via-envuser)
2060           (nntp-wait-for-string "^\r*.?login:")
2061           (process-send-string proc
2062                                (concat
2063                                 (or nntp-via-user-name
2064                                     (setq nntp-via-user-name
2065                                           (read-string "login: ")))
2066                                 "\n")))
2067         (nntp-wait-for-string "^\r*.?password:")
2068         (process-send-string proc
2069                              (concat
2070                               (or nntp-via-user-password
2071                                   (setq nntp-via-user-password
2072                                         (read-passwd "Password: ")))
2073                               "\n"))
2074         (nntp-wait-for-string nntp-via-shell-prompt)
2075         (let ((real-telnet-command `("exec"
2076                                      ,nntp-telnet-command
2077                                      ,@nntp-telnet-switches
2078                                      ,nntp-address
2079                                      ,(nntp-service-to-port nntp-port-number))))
2080           (process-send-string proc
2081                                (concat (mapconcat 'identity
2082                                                   real-telnet-command " ")
2083                                        "\n")))
2084         (nntp-wait-for-string "^\r*20[01]")
2085         (beginning-of-line)
2086         (delete-region (point-min) (point))
2087         (process-send-string proc "\^]")
2088         (nntp-wait-for-string "^r?telnet")
2089         (process-send-string proc "mode character\n")
2090         (accept-process-output proc 1)
2091         (sit-for 1)
2092         (goto-char (point-min))
2093         (forward-line 1)
2094         (delete-region (point) (point-max)))
2095       proc)))
2096
2097 ;; Marks handling
2098
2099 (defun nntp-marks-directory (server)
2100   (expand-file-name server nntp-marks-directory))
2101
2102 (defvar nntp-server-to-method-cache nil
2103   "Alist of servers and select methods.")
2104
2105 (defun nntp-group-pathname (server group &optional file)
2106   "Return an absolute file name of FILE for GROUP on SERVER."
2107   (let ((method (cdr (assoc server nntp-server-to-method-cache))))
2108     (unless method
2109       (push (cons server (setq method (or (gnus-server-to-method server)
2110                                           (gnus-find-method-for-group group))))
2111             nntp-server-to-method-cache))
2112     (nnmail-group-pathname
2113      (mm-decode-coding-string group
2114                               (inline (gnus-group-name-charset method group)))
2115      (nntp-marks-directory server)
2116      file)))
2117
2118 (defun nntp-possibly-create-directory (group server)
2119   (let ((dir (nntp-group-pathname server group))
2120         (file-name-coding-system nnmail-pathname-coding-system))
2121     (unless (file-exists-p dir)
2122       (make-directory (directory-file-name dir) t)
2123       (nnheader-message 5 "Creating nntp marks directory %s" dir))))
2124
2125 (autoload 'time-less-p "time-date")
2126
2127 (defun nntp-marks-changed-p (group server)
2128   (let ((file (nntp-group-pathname server group nntp-marks-file-name))
2129         (file-name-coding-system nnmail-pathname-coding-system))
2130     (if (null (gnus-gethash file nntp-marks-modtime))
2131         t ;; never looked at marks file, assume it has changed
2132       (time-less-p (gnus-gethash file nntp-marks-modtime)
2133                    (nth 5 (file-attributes file))))))
2134
2135 (defun nntp-save-marks (group server)
2136   (let ((file-name-coding-system nnmail-pathname-coding-system)
2137         (file (nntp-group-pathname server group nntp-marks-file-name)))
2138     (condition-case err
2139         (progn
2140           (nntp-possibly-create-directory group server)
2141           (with-temp-file file
2142             (erase-buffer)
2143             (gnus-prin1 nntp-marks)
2144             (insert "\n"))
2145           (gnus-sethash file
2146                         (nth 5 (file-attributes file))
2147                         nntp-marks-modtime))
2148       (error (or (gnus-yes-or-no-p
2149                   (format "Could not write to %s (%s).  Continue? " file err))
2150                  (error "Cannot write to %s (%s)" file err))))))
2151
2152 (defun nntp-open-marks (group server)
2153   (let ((file (nntp-group-pathname server group nntp-marks-file-name))
2154         (file-name-coding-system nnmail-pathname-coding-system))
2155     (if (file-exists-p file)
2156         (condition-case err
2157             (with-temp-buffer
2158               (gnus-sethash file (nth 5 (file-attributes file))
2159                             nntp-marks-modtime)
2160               (nnheader-insert-file-contents file)
2161               (setq nntp-marks (read (current-buffer)))
2162               (dolist (el gnus-article-unpropagated-mark-lists)
2163                 (setq nntp-marks (gnus-remassoc el nntp-marks))))
2164           (error (or (gnus-yes-or-no-p
2165                       (format "Error reading nntp marks file %s (%s).  Continuing will use marks from .newsrc.eld.  Continue? " file err))
2166                      (error "Cannot read nntp marks file %s (%s)" file err))))
2167       ;; User didn't have a .marks file.  Probably first time
2168       ;; user of the .marks stuff.  Bootstrap it from .newsrc.eld.
2169       (let ((info (gnus-get-info
2170                    (gnus-group-prefixed-name
2171                     group
2172                     (gnus-server-to-method (format "nntp:%s" server)))))
2173             (decoded-name (mm-decode-coding-string
2174                            group
2175                            (gnus-group-name-charset
2176                             (gnus-server-to-method server) group))))
2177         (nnheader-message 7 "Bootstrapping marks for %s..." decoded-name)
2178         (setq nntp-marks (gnus-info-marks info))
2179         (push (cons 'read (gnus-info-read info)) nntp-marks)
2180         (dolist (el gnus-article-unpropagated-mark-lists)
2181           (setq nntp-marks (gnus-remassoc el nntp-marks)))
2182         (nntp-save-marks group server)
2183         (nnheader-message 7 "Bootstrapping marks for %s...done"
2184                           decoded-name)))))
2185
2186 (provide 'nntp)
2187
2188 ;;; nntp.el ends here