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