Reinstate the two-part async code again so that we can debug it properly.
[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-search "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
785          (gnus-group-real-name (gnus-info-group (car infos)))))
786       (with-current-buffer (nntp-find-connection-buffer nntp-server-buffer)
787         (erase-buffer)
788         (let ((nntp-inhibit-erase t)
789               (command (if nntp-server-list-active-group
790                            "LIST ACTIVE" "GROUP")))
791           (dolist (info infos)
792             (nntp-send-command
793              nil command (gnus-group-real-name (gnus-info-group info)))))
794         (length infos)))))
795
796 (deffoo nntp-finish-retrieve-group-infos (server infos count)
797   (nntp-with-open-group nil server
798     (let ((buf (nntp-find-connection-buffer nntp-server-buffer))
799           (method (gnus-find-method-for-group
800                    (gnus-info-group (car infos))
801                    (car infos)))
802           (received 0)
803           (last-point 1))
804       (when (and buf
805                  count)
806         (with-current-buffer buf
807           (while (and (gnus-buffer-live-p buf)
808                       (progn
809                         (goto-char last-point)
810                         ;; Count replies.
811                         (while (re-search-forward "^[0-9]" nil t)
812                           (incf received))
813                         (setq last-point (point))
814                         (< received count)))
815             (nntp-accept-response))
816           ;; We now have all the entries.  Remove CRs.
817           (nnheader-strip-cr)
818           (if (not nntp-server-list-active-group)
819               (progn
820                 (nntp-copy-to-buffer nntp-server-buffer
821                                      (point-min) (point-max))
822                 (gnus-groups-to-gnus-format method gnus-active-hashtb t))
823             ;; We have read active entries, so we just delete the
824             ;; superfluous gunk.
825             (goto-char (point-min))
826             (while (re-search-forward "^[.2-5]" nil t)
827               (delete-region (match-beginning 0)
828                              (progn (forward-line 1) (point))))
829             (nntp-copy-to-buffer nntp-server-buffer (point-min) (point-max))
830             (with-current-buffer nntp-server-buffer
831               (gnus-active-to-gnus-format method gnus-active-hashtb
832                                           nil t))))))))
833
834 (deffoo nntp-retrieve-groups (groups &optional server)
835   "Retrieve group info on GROUPS."
836   (nntp-with-open-group
837    nil server
838    (when (nntp-find-connection-buffer nntp-server-buffer)
839      (catch 'done
840        (save-excursion
841          ;; Erase nntp-server-buffer before nntp-inhibit-erase.
842          (nntp-erase-buffer nntp-server-buffer)
843          (set-buffer (nntp-find-connection-buffer nntp-server-buffer))
844          ;; The first time this is run, this variable is `try'.  So we
845          ;; try.
846          (when (eq nntp-server-list-active-group 'try)
847            (nntp-try-list-active (car groups)))
848          (erase-buffer)
849          (let ((count 0)
850                (groups groups)
851                (received 0)
852                (last-point (point-min))
853                (nntp-inhibit-erase t)
854                (buf (nntp-find-connection-buffer nntp-server-buffer))
855                (command (if nntp-server-list-active-group
856                             "LIST ACTIVE" "GROUP")))
857            (while groups
858              ;; Timeout may have killed the buffer.
859              (unless (gnus-buffer-live-p buf)
860                (nnheader-report 'nntp "Connection to %s is closed." server)
861                (throw 'done nil))
862              ;; Send the command to the server.
863              (nntp-send-command nil command (pop groups))
864              (incf count)
865              ;; Every 400 requests we have to read the stream in
866              ;; order to avoid deadlocks.
867              (when (or (null groups)    ;All requests have been sent.
868                        (zerop (% count nntp-maximum-request)))
869                (nntp-accept-response)
870                (while (and (gnus-buffer-live-p buf)
871                            (progn
872                              ;; Search `blue moon' in this file for the
873                              ;; reason why set-buffer here.
874                              (set-buffer buf)
875                              (goto-char last-point)
876                              ;; Count replies.
877                              (while (re-search-forward "^[0-9]" nil t)
878                                (incf received))
879                              (setq last-point (point))
880                              (< received count)))
881                  (nntp-accept-response))))
882
883            ;; Wait for the reply from the final command.
884            (unless (gnus-buffer-live-p buf)
885              (nnheader-report 'nntp "Connection to %s is closed." server)
886              (throw 'done nil))
887            (set-buffer buf)
888            (goto-char (point-max))
889            (re-search-backward "^[0-9]" nil t)
890            (when (looking-at "^[23]")
891              (while (and (gnus-buffer-live-p buf)
892                          (progn
893                            (set-buffer buf)
894                            (goto-char (point-max))
895                            (if (not nntp-server-list-active-group)
896                                (not (re-search-backward "\r?\n"
897                                                         (- (point) 3) t))
898                              (not (re-search-backward "^\\.\r?\n"
899                                                       (- (point) 4) t)))))
900                (nntp-accept-response)))
901
902            ;; Now all replies are received.  We remove CRs.
903            (unless (gnus-buffer-live-p buf)
904              (nnheader-report 'nntp "Connection to %s is closed." server)
905              (throw 'done nil))
906            (set-buffer buf)
907            (goto-char (point-min))
908            (while (search-forward "\r" nil t)
909              (replace-match "" t t))
910
911            (if (not nntp-server-list-active-group)
912                (progn
913                  (nntp-copy-to-buffer nntp-server-buffer
914                                       (point-min) (point-max))
915                  'group)
916              ;; We have read active entries, so we just delete the
917              ;; superfluous gunk.
918              (goto-char (point-min))
919              (while (re-search-forward "^[.2-5]" nil t)
920                (delete-region (match-beginning 0)
921                               (progn (forward-line 1) (point))))
922              (nntp-copy-to-buffer nntp-server-buffer (point-min) (point-max))
923              'active)))))))
924
925 (deffoo nntp-retrieve-articles (articles &optional group server)
926   (nntp-with-open-group
927     group server
928    (save-excursion
929      (let ((number (length articles))
930            (articles articles)
931            (count 0)
932            (received 0)
933            (last-point (point-min))
934            (buf (nntp-find-connection-buffer nntp-server-buffer))
935            (nntp-inhibit-erase t)
936            (map (apply 'vector articles))
937            (point 1)
938            article)
939        (set-buffer buf)
940        (erase-buffer)
941        ;; Send ARTICLE command.
942        (while (setq article (pop articles))
943          (nntp-send-command
944           nil
945           "ARTICLE" (if (numberp article)
946                         (int-to-string article)
947                       ;; `articles' is either a list of article numbers
948                       ;; or a list of article IDs.
949                       article))
950          (incf count)
951          ;; Every 400 requests we have to read the stream in
952          ;; order to avoid deadlocks.
953          (when (or (null articles)      ;All requests have been sent.
954                    (zerop (% count nntp-maximum-request)))
955            (nntp-accept-response)
956            (while (progn
957                     (set-buffer buf)
958                     (goto-char last-point)
959                     ;; Count replies.
960                     (while (nntp-next-result-arrived-p)
961                       (aset map received (cons (aref map received) (point)))
962                       (setq last-point (point))
963                       (incf received))
964                     (< received count))
965              ;; If number of headers is greater than 100, give
966              ;;  informative messages.
967              (and (numberp nntp-large-newsgroup)
968                   (> number nntp-large-newsgroup)
969                   (zerop (% received 20))
970                   (nnheader-message 6 "NNTP: Receiving articles... %d%%"
971                                     (/ (* received 100) number)))
972              (nntp-accept-response))))
973        (and (numberp nntp-large-newsgroup)
974             (> number nntp-large-newsgroup)
975             (nnheader-message 6 "NNTP: Receiving articles...done"))
976
977        ;; Now we have all the responses.  We go through the results,
978        ;; wash it and copy it over to the server buffer.
979        (set-buffer nntp-server-buffer)
980        (erase-buffer)
981        (setq last-point (point-min))
982        (mapcar
983         (lambda (entry)
984           (narrow-to-region
985            (setq point (goto-char (point-max)))
986            (progn
987              (nntp-insert-buffer-substring buf last-point (cdr entry))
988              (point-max)))
989           (setq last-point (cdr entry))
990           (nntp-decode-text)
991           (widen)
992           (cons (car entry) point))
993         map)))))
994
995 (defun nntp-try-list-active (group)
996   (nntp-list-active-group group)
997   (with-current-buffer nntp-server-buffer
998     (goto-char (point-min))
999     (cond ((or (eobp)
1000                (looking-at "5[0-9]+"))
1001            (setq nntp-server-list-active-group nil))
1002           (t
1003            (setq nntp-server-list-active-group t)))))
1004
1005 (deffoo nntp-list-active-group (group &optional server)
1006   "Return the active info on GROUP (which can be a regexp)."
1007   (nntp-with-open-group
1008    nil server
1009    (nntp-send-command "^\\.*\r?\n" "LIST ACTIVE" group)))
1010
1011 (deffoo nntp-request-group-articles (group &optional server)
1012   "Return the list of existing articles in GROUP."
1013   (nntp-with-open-group
1014    nil server
1015    (nntp-send-command "^\\.*\r?\n" "LISTGROUP" group)))
1016
1017 (deffoo nntp-request-article (article &optional group server buffer command)
1018   (nntp-with-open-group
1019     group server
1020     (when (nntp-send-command-and-decode
1021            "\r?\n\\.\r?\n" "ARTICLE"
1022            (if (numberp article) (int-to-string article) article))
1023       (if (and buffer
1024                (not (equal buffer nntp-server-buffer)))
1025           (with-current-buffer nntp-server-buffer
1026             (copy-to-buffer buffer (point-min) (point-max))
1027             (nntp-find-group-and-number group))
1028         (nntp-find-group-and-number group)))))
1029
1030 (deffoo nntp-request-head (article &optional group server)
1031   (nntp-with-open-group
1032    group server
1033    (when (nntp-send-command
1034           "\r?\n\\.\r?\n" "HEAD"
1035           (if (numberp article) (int-to-string article) article))
1036      (prog1
1037          (nntp-find-group-and-number group)
1038        (nntp-decode-text)))))
1039
1040 (deffoo nntp-request-body (article &optional group server)
1041   (nntp-with-open-group
1042    group server
1043    (nntp-send-command-and-decode
1044     "\r?\n\\.\r?\n" "BODY"
1045     (if (numberp article) (int-to-string article) article))))
1046
1047 (deffoo nntp-request-group (group &optional server dont-check info)
1048   (nntp-with-open-group
1049     nil server
1050     (when (nntp-send-command "^[245].*\n" "GROUP" group)
1051       (let ((entry (nntp-find-connection-entry nntp-server-buffer)))
1052         (setcar (cddr entry) group)))))
1053
1054 (deffoo nntp-close-group (group &optional server)
1055   t)
1056
1057 (deffoo nntp-server-opened (&optional server)
1058   "Say whether a connection to SERVER has been opened."
1059   (and (nnoo-current-server-p 'nntp server)
1060        nntp-server-buffer
1061        (gnus-buffer-live-p nntp-server-buffer)
1062        (nntp-find-connection nntp-server-buffer)))
1063
1064 (deffoo nntp-open-server (server &optional defs connectionless)
1065   (nnheader-init-server-buffer)
1066   (if (nntp-server-opened server)
1067       t
1068     (when (or (stringp (car defs))
1069               (numberp (car defs)))
1070       (setq defs (cons (list 'nntp-port-number (car defs)) (cdr defs))))
1071     (unless (assq 'nntp-address defs)
1072       (setq defs (append defs (list (list 'nntp-address server)))))
1073     (nnoo-change-server 'nntp server defs)
1074     (if connectionless
1075         t
1076       (or (nntp-find-connection nntp-server-buffer)
1077           (nntp-open-connection nntp-server-buffer)))))
1078
1079 (deffoo nntp-close-server (&optional server)
1080   (nntp-possibly-change-group nil server t)
1081   (let ((process (nntp-find-connection nntp-server-buffer)))
1082     (while process
1083       (when (memq (process-status process) '(open run))
1084         (ignore-errors
1085           (nntp-send-string process "QUIT")
1086           (unless (eq nntp-open-connection-function 'nntp-open-network-stream)
1087             ;; Ok, this is evil, but when using telnet and stuff
1088             ;; as the connection method, it's important that the
1089             ;; QUIT command actually is sent out before we kill
1090             ;; the process.
1091             (sleep-for 1))))
1092       (nntp-kill-buffer (process-buffer process))
1093       (setq process (car (pop nntp-connection-alist))))
1094     (nnoo-close-server 'nntp)))
1095
1096 (deffoo nntp-request-close ()
1097   (let (process)
1098     (while (setq process (pop nntp-connection-list))
1099       (when (memq (process-status process) '(open run))
1100         (ignore-errors
1101           (nntp-send-string process "QUIT")
1102           (unless (eq nntp-open-connection-function 'nntp-open-network-stream)
1103             ;; Ok, this is evil, but when using telnet and stuff
1104             ;; as the connection method, it's important that the
1105             ;; QUIT command actually is sent out before we kill
1106             ;; the process.
1107             (sleep-for 1))))
1108       (nntp-kill-buffer (process-buffer process)))))
1109
1110 (deffoo nntp-request-list (&optional server)
1111   (nntp-with-open-group
1112    nil server
1113    (nntp-send-command-and-decode "\r?\n\\.\r?\n" "LIST")))
1114
1115 (deffoo nntp-request-list-newsgroups (&optional server)
1116   (nntp-with-open-group
1117    nil server
1118    (nntp-send-command "\r?\n\\.\r?\n" "LIST NEWSGROUPS")))
1119
1120 (deffoo nntp-request-newgroups (date &optional server)
1121   (nntp-with-open-group
1122    nil server
1123    (with-current-buffer nntp-server-buffer
1124      (let* ((time (date-to-time date))
1125             (ls (- (cadr time) (nth 8 (decode-time time)))))
1126        (cond ((< ls 0)
1127               (setcar time (1- (car time)))
1128               (setcar (cdr time) (+ ls 65536)))
1129              ((>= ls 65536)
1130               (setcar time (1+ (car time)))
1131               (setcar (cdr time) (- ls 65536)))
1132              (t
1133               (setcar (cdr time) ls)))
1134        (prog1
1135            (nntp-send-command
1136             "^\\.\r?\n" "NEWGROUPS"
1137             (format-time-string "%y%m%d %H%M%S" time)
1138             "GMT")
1139          (nntp-decode-text))))))
1140
1141 (deffoo nntp-request-post (&optional server)
1142   (nntp-with-open-group
1143    nil server
1144    (when (nntp-send-command "^[23].*\r?\n" "POST")
1145      (let ((response (with-current-buffer nntp-server-buffer
1146                        nntp-process-response))
1147            server-id)
1148        (when (and response
1149                   (string-match "^[23].*\\(<[^\t\n @<>]+@[^\t\n @<>]+>\\)"
1150                                 response))
1151          (setq server-id (match-string 1 response))
1152          (narrow-to-region (goto-char (point-min))
1153                            (if (search-forward "\n\n" nil t)
1154                                (1- (point))
1155                              (point-max)))
1156          (unless (mail-fetch-field "Message-ID")
1157            (goto-char (point-min))
1158            (insert "Message-ID: " server-id "\n"))
1159          (widen))
1160        (run-hooks 'nntp-prepare-post-hook)
1161        (nntp-send-buffer "^[23].*\n")))))
1162
1163 (deffoo nntp-request-type (group article)
1164   'news)
1165
1166 (deffoo nntp-asynchronous-p ()
1167   t)
1168
1169 (deffoo nntp-request-set-mark (group actions &optional server)
1170   (when (and (not nntp-marks-is-evil)
1171              nntp-marks-file-name)
1172     (nntp-possibly-create-directory group server)
1173     (nntp-open-marks group server)
1174     (setq nntp-marks (nnheader-update-marks-actions nntp-marks actions))
1175     (nntp-save-marks group server))
1176   nil)
1177
1178 (deffoo nntp-request-marks (group info &optional server)
1179   (when (and (not nntp-marks-is-evil)
1180              nntp-marks-file-name)
1181     (nntp-possibly-create-directory group server)
1182     (when (nntp-marks-changed-p group server)
1183       (nnheader-message 8 "Updating marks for %s..." group)
1184       (nntp-open-marks group server)
1185       ;; Update info using `nntp-marks'.
1186       (mapc (lambda (pred)
1187               (unless (memq (cdr pred) gnus-article-unpropagated-mark-lists)
1188                 (gnus-info-set-marks
1189                  info
1190                  (gnus-update-alist-soft
1191                   (cdr pred)
1192                   (cdr (assq (cdr pred) nntp-marks))
1193                   (gnus-info-marks info))
1194                  t)))
1195             gnus-article-mark-lists)
1196       (let ((seen (cdr (assq 'read nntp-marks))))
1197         (gnus-info-set-read info
1198                             (if (and (integerp (car seen))
1199                                      (null (cdr seen)))
1200                                 (list (cons (car seen) (car seen)))
1201                               seen)))
1202       (nnheader-message 8 "Updating marks for %s...done" group)))
1203   nil)
1204
1205
1206
1207 ;;; Hooky functions.
1208
1209 (defun nntp-send-mode-reader ()
1210   "Send the MODE READER command to the nntp server.
1211 This function is supposed to be called from `nntp-server-opened-hook'.
1212 It will make innd servers spawn an nnrpd process to allow actual article
1213 reading."
1214   (nntp-send-command "^.*\n" "MODE READER"))
1215
1216 (declare-function netrc-parse "netrc" (&optional file))
1217 (declare-function netrc-machine "netrc"
1218                   (list machine &optional port defaultport))
1219 (declare-function netrc-get "netrc" (alist type))
1220
1221 (defun nntp-send-authinfo (&optional send-if-force)
1222   "Send the AUTHINFO to the nntp server.
1223 It will look in the \"~/.authinfo\" file for matching entries.  If
1224 nothing suitable is found there, it will prompt for a user name
1225 and a password.
1226
1227 If SEND-IF-FORCE, only send authinfo to the server if the
1228 .authinfo file has the FORCE token."
1229   (require 'netrc)
1230   (let* ((list (netrc-parse nntp-authinfo-file))
1231          (alist (netrc-machine list nntp-address "nntp"))
1232          (force (or (netrc-get alist "force") nntp-authinfo-force))
1233          (auth-info
1234           (nth 0 (auth-source-search :max 1
1235                                      ;; TODO: allow the virtual server name too
1236                                      :host nntp-address
1237                                      :port '("119" "nntp"))))
1238          (auth-user (plist-get auth-info :user))
1239          (auth-passwd (plist-get auth-info :secret))
1240          (auth-passwd (if (functionp auth-passwd)
1241                           (funcall auth-passwd)
1242                         auth-passwd))
1243          (user (or
1244                 ;; this is preferred to netrc-*
1245                 auth-user
1246                 (netrc-get alist "login")
1247                 nntp-authinfo-user))
1248          (passwd (or
1249                   ;; this is preferred to netrc-*
1250                   auth-passwd
1251                   (netrc-get alist "password"))))
1252     (when (or (not send-if-force)
1253               force)
1254       (unless user
1255         (setq user (read-string (format "NNTP (%s) user name: " nntp-address))
1256               nntp-authinfo-user user))
1257       (unless (member user '(nil ""))
1258         (nntp-send-command "^3.*\r?\n" "AUTHINFO USER" user)
1259         (when t                         ;???Should check if AUTHINFO succeeded
1260           (nntp-send-command
1261            "^2.*\r?\n" "AUTHINFO PASS"
1262            (or passwd
1263                nntp-authinfo-password
1264                (setq nntp-authinfo-password
1265                      (read-passwd (format "NNTP (%s@%s) password: "
1266                                           user nntp-address))))))))))
1267
1268 (defun nntp-send-nosy-authinfo ()
1269   "Send the AUTHINFO to the nntp server."
1270   (let ((user (read-string (format "NNTP (%s) user name: " nntp-address))))
1271     (unless (member user '(nil ""))
1272       (nntp-send-command "^3.*\r?\n" "AUTHINFO USER" user)
1273       (when t                           ;???Should check if AUTHINFO succeeded
1274         (nntp-send-command "^2.*\r?\n" "AUTHINFO PASS"
1275                            (read-passwd (format "NNTP (%s@%s) password: "
1276                                                 user nntp-address)))))))
1277
1278 (defun nntp-send-authinfo-from-file ()
1279   "Send the AUTHINFO to the nntp server.
1280
1281 The authinfo login name is taken from the user's login name and the
1282 password contained in '~/.nntp-authinfo'."
1283   (when (file-exists-p "~/.nntp-authinfo")
1284     (with-temp-buffer
1285       (insert-file-contents "~/.nntp-authinfo")
1286       (goto-char (point-min))
1287       (nntp-send-command "^3.*\r?\n" "AUTHINFO USER" (user-login-name))
1288       (nntp-send-command
1289        "^2.*\r?\n" "AUTHINFO PASS"
1290        (buffer-substring (point) (point-at-eol))))))
1291
1292 ;;; Internal functions.
1293
1294 (defun nntp-handle-authinfo (process)
1295   "Take care of an authinfo response from the server."
1296   (let ((last nntp-last-command))
1297     (funcall nntp-authinfo-function)
1298     ;; We have to re-send the function that was interrupted by
1299     ;; the authinfo request.
1300     (nntp-erase-buffer nntp-server-buffer)
1301     (nntp-send-string process last)))
1302
1303 (defun nntp-make-process-buffer (buffer)
1304   "Create a new, fresh buffer usable for nntp process connections."
1305   (with-current-buffer
1306       (generate-new-buffer
1307        (format " *server %s %s %s*"
1308                nntp-address nntp-port-number
1309                (gnus-buffer-exists-p buffer)))
1310     (mm-disable-multibyte)
1311     (set (make-local-variable 'after-change-functions) nil)
1312     (set (make-local-variable 'nntp-process-wait-for) nil)
1313     (set (make-local-variable 'nntp-process-callback) nil)
1314     (set (make-local-variable 'nntp-process-to-buffer) nil)
1315     (set (make-local-variable 'nntp-process-start-point) nil)
1316     (set (make-local-variable 'nntp-process-decode) nil)
1317     (current-buffer)))
1318
1319 (defun nntp-open-connection (buffer)
1320   "Open a connection to PORT on ADDRESS delivering output to BUFFER."
1321   (run-hooks 'nntp-prepare-server-hook)
1322   (let* ((pbuffer (nntp-make-process-buffer buffer))
1323          (timer
1324           (and nntp-connection-timeout
1325                (run-at-time
1326                 nntp-connection-timeout nil
1327                 `(lambda ()
1328                    (nntp-kill-buffer ,pbuffer)))))
1329          (process
1330           (condition-case err
1331               (let ((coding-system-for-read nntp-coding-system-for-read)
1332                     (coding-system-for-write nntp-coding-system-for-write)
1333                     (map '((nntp-open-network-stream network)
1334                            (network-only network-only)
1335                            (nntp-open-ssl-stream tls)
1336                            (nntp-open-tls-stream tls))))
1337                 (if (assoc nntp-open-connection-function map)
1338                     (car (open-protocol-stream
1339                           "nntpd" pbuffer nntp-address nntp-port-number
1340                           :type (cadr
1341                                  (assoc nntp-open-connection-function map))
1342                           :end-of-command "^\\([2345]\\|[.]\\).*\n"
1343                           :capability-command "CAPABILITIES\r\n"
1344                           :success "^3"
1345                           :starttls-function
1346                           (lambda (capabilities)
1347                             (if (not (string-match "STARTTLS" capabilities))
1348                                 nil
1349                               "STARTTLS\r\n"))))
1350                   (funcall nntp-open-connection-function pbuffer)))
1351             (error
1352              (nnheader-report 'nntp "%s" err))
1353             (quit
1354              (message "Quit opening connection to %s" nntp-address)
1355              (nntp-kill-buffer pbuffer)
1356              (signal 'quit nil)
1357              nil))))
1358     (when timer
1359       (nnheader-cancel-timer timer))
1360     (unless process
1361       (nntp-kill-buffer pbuffer))
1362     (when (and (buffer-name pbuffer)
1363                process)
1364       (gnus-set-process-query-on-exit-flag process nil)
1365       (if (and (nntp-wait-for process "^2.*\n" buffer nil t)
1366                (memq (process-status process) '(open run)))
1367           (prog1
1368               (caar (push (list process buffer nil) nntp-connection-alist))
1369             (push process nntp-connection-list)
1370             (with-current-buffer pbuffer
1371               (nntp-read-server-type)
1372               (erase-buffer)
1373               (set-buffer nntp-server-buffer)
1374               (let ((nnheader-callback-function nil))
1375                 (run-hooks 'nntp-server-opened-hook)
1376                 (nntp-send-authinfo t))))
1377         (nntp-kill-buffer (process-buffer process))
1378         nil))))
1379
1380 (defun nntp-read-server-type ()
1381   "Find out what the name of the server we have connected to is."
1382   ;; Wait for the status string to arrive.
1383   (setq nntp-server-type (buffer-string))
1384   (let ((case-fold-search t))
1385     ;; Run server-specific commands.
1386     (dolist (entry nntp-server-action-alist)
1387       (when (string-match (car entry) nntp-server-type)
1388         (if (and (listp (cadr entry))
1389                  (not (eq 'lambda (caadr entry))))
1390             (eval (cadr entry))
1391           (funcall (cadr entry)))))))
1392
1393 (defun nntp-async-wait (process wait-for buffer decode callback)
1394   (with-current-buffer (process-buffer process)
1395     (unless nntp-inside-change-function
1396       (erase-buffer))
1397     (setq nntp-process-wait-for wait-for
1398           nntp-process-to-buffer buffer
1399           nntp-process-decode decode
1400           nntp-process-callback callback
1401           nntp-process-start-point (point-max))
1402     (setq after-change-functions '(nntp-after-change-function))))
1403
1404 (defun nntp-async-timer-handler ()
1405   (mapcar
1406    (lambda (proc)
1407      (if (memq (process-status proc) '(open run))
1408          (nntp-async-trigger proc)
1409        (nntp-async-stop proc)))
1410    nntp-async-process-list))
1411
1412 (defun nntp-async-stop (proc)
1413   (setq nntp-async-process-list (delq proc nntp-async-process-list))
1414   (when (and nntp-async-timer (not nntp-async-process-list))
1415     (nnheader-cancel-timer nntp-async-timer)
1416     (setq nntp-async-timer nil)))
1417
1418 (defun nntp-after-change-function (beg end len)
1419   (unwind-protect
1420       ;; we only care about insertions at eob
1421       (when (and (eq 0 len) (eq (point-max) end))
1422         (save-match-data
1423           (let ((proc (get-buffer-process (current-buffer))))
1424             (when proc
1425               (nntp-async-trigger proc)))))
1426     ;; any throw from after-change-functions will leave it
1427     ;; set to nil.  so we reset it here, if necessary.
1428     (when quit-flag
1429       (setq after-change-functions '(nntp-after-change-function)))))
1430
1431 (defun nntp-async-trigger (process)
1432   (with-current-buffer (process-buffer process)
1433     (when nntp-process-callback
1434       ;; do we have an error message?
1435       (goto-char nntp-process-start-point)
1436       (if (memq (following-char) '(?4 ?5))
1437           ;; wants credentials?
1438           (if (looking-at "480")
1439               (nntp-handle-authinfo process)
1440             ;; report error message.
1441             (nntp-snarf-error-message)
1442             (nntp-do-callback nil))
1443
1444         ;; got what we expect?
1445         (goto-char (point-max))
1446         (when (re-search-backward
1447                nntp-process-wait-for nntp-process-start-point t)
1448           (let ((response (match-string 0)))
1449             (with-current-buffer nntp-server-buffer
1450               (setq nntp-process-response response)))
1451           (nntp-async-stop process)
1452           ;; convert it.
1453           (when (gnus-buffer-exists-p nntp-process-to-buffer)
1454             (let ((buf (current-buffer))
1455                   (start nntp-process-start-point)
1456                   (decode nntp-process-decode))
1457               (with-current-buffer nntp-process-to-buffer
1458                 (goto-char (point-max))
1459                 (save-restriction
1460                   (narrow-to-region (point) (point))
1461                   (nntp-insert-buffer-substring buf start)
1462                   (when decode
1463                     (nntp-decode-text))))))
1464           ;; report it.
1465           (goto-char (point-max))
1466           (nntp-do-callback
1467            (buffer-name (get-buffer nntp-process-to-buffer))))))))
1468
1469 (defun nntp-do-callback (arg)
1470   (let ((callback nntp-process-callback)
1471         (nntp-inside-change-function t))
1472     (setq nntp-process-callback nil)
1473     (funcall callback arg)))
1474
1475 (defun nntp-snarf-error-message ()
1476   "Save the error message in the current buffer."
1477   (let ((message (buffer-string)))
1478     (while (string-match "[\r\n]+" message)
1479       (setq message (replace-match " " t t message)))
1480     (nnheader-report 'nntp "%s" message)
1481     message))
1482
1483 (defun nntp-accept-process-output (process)
1484   "Wait for output from PROCESS and message some dots."
1485   (with-current-buffer (or (nntp-find-connection-buffer nntp-server-buffer)
1486                            nntp-server-buffer)
1487     (let ((len (/ (buffer-size) 1024))
1488           message-log-max)
1489       (unless (< len 10)
1490         (setq nntp-have-messaged t)
1491         (nnheader-message 7 "nntp read: %dk" len)))
1492     (prog1
1493         (nnheader-accept-process-output process)
1494       ;; accept-process-output may update status of process to indicate
1495       ;; that the server has closed the connection.  This MUST be
1496       ;; handled here as the buffer restored by the save-excursion may
1497       ;; be the process's former output buffer (i.e. now killed)
1498       (or (and process
1499                (memq (process-status process) '(open run)))
1500           (nntp-report "Server closed connection")))))
1501
1502 (defun nntp-accept-response ()
1503   "Wait for output from the process that outputs to BUFFER."
1504   (nntp-accept-process-output (nntp-find-connection nntp-server-buffer)))
1505
1506 (defun nntp-possibly-change-group (group server &optional connectionless)
1507   (let ((nnheader-callback-function nil))
1508     (when server
1509       (or (nntp-server-opened server)
1510           (nntp-open-server server nil connectionless)))
1511
1512     (unless connectionless
1513       (or (nntp-find-connection nntp-server-buffer)
1514           (nntp-open-connection nntp-server-buffer))))
1515
1516   (when group
1517     (let ((entry (nntp-find-connection-entry nntp-server-buffer)))
1518       (cond ((not entry)
1519              (nntp-report "Server closed connection"))
1520             ((not (equal group (caddr entry)))
1521              (with-current-buffer (process-buffer (car entry))
1522                (erase-buffer)
1523                (nntp-send-command "^[245].*\n" "GROUP" group)
1524                (setcar (cddr entry) group)
1525                (erase-buffer)
1526                (nntp-erase-buffer nntp-server-buffer)))))))
1527
1528 (defun nntp-decode-text (&optional cr-only)
1529   "Decode the text in the current buffer."
1530   (goto-char (point-min))
1531   (while (search-forward "\r" nil t)
1532     (delete-char -1))
1533   (unless cr-only
1534     ;; Remove trailing ".\n" end-of-transfer marker.
1535     (goto-char (point-max))
1536     (forward-line -1)
1537     (when (looking-at ".\n")
1538       (delete-char 2))
1539     ;; Delete status line.
1540     (goto-char (point-min))
1541     (while (looking-at "[1-5][0-9][0-9] .*\n")
1542       ;; For some unknown reason, there is more than one status line.
1543       (delete-region (point) (progn (forward-line 1) (point))))
1544     ;; Remove "." -> ".." encoding.
1545     (while (search-forward "\n.." nil t)
1546       (delete-char -1))))
1547
1548 (defun nntp-encode-text ()
1549   "Encode the text in the current buffer."
1550   (save-excursion
1551     ;; Replace "." at beginning of line with "..".
1552     (goto-char (point-min))
1553     (while (re-search-forward "^\\." nil t)
1554       (insert "."))
1555     (goto-char (point-max))
1556     ;; Insert newline at the end of the buffer.
1557     (unless (bolp)
1558       (insert "\n"))
1559     ;; Insert `.' at end of buffer (end of text mark).
1560     (goto-char (point-max))
1561     (insert ".\n")
1562     (goto-char (point-min))
1563     (while (not (eobp))
1564       (end-of-line)
1565       (delete-char 1)
1566       (insert nntp-end-of-line))))
1567
1568 (defun nntp-retrieve-headers-with-xover (articles &optional fetch-old)
1569   (set-buffer nntp-server-buffer)
1570   (erase-buffer)
1571   (cond
1572
1573    ;; This server does not talk NOV.
1574    ((not nntp-server-xover)
1575     nil)
1576
1577    ;; We don't care about gaps.
1578    ((or (not nntp-nov-gap)
1579         fetch-old)
1580     (nntp-send-xover-command
1581      (if fetch-old
1582          (if (numberp fetch-old)
1583              (max 1 (- (car articles) fetch-old))
1584            1)
1585        (car articles))
1586      (car (last articles)) 'wait)
1587
1588     (goto-char (point-min))
1589     (when (looking-at "[1-5][0-9][0-9] .*\n")
1590       (delete-region (point) (progn (forward-line 1) (point))))
1591     (while (search-forward "\r" nil t)
1592       (replace-match "" t t))
1593     (goto-char (point-max))
1594     (forward-line -1)
1595     (when (looking-at "\\.")
1596       (delete-region (point) (progn (forward-line 1) (point)))))
1597
1598    ;; We do it the hard way.  For each gap, an XOVER command is sent
1599    ;; to the server.  We do not wait for a reply from the server, we
1600    ;; just send them off as fast as we can.  That means that we have
1601    ;; to count the number of responses we get back to find out when we
1602    ;; have gotten all we asked for.
1603    ((numberp nntp-nov-gap)
1604     (let ((count 0)
1605           (received 0)
1606           last-point
1607           in-process-buffer-p
1608           (buf nntp-server-buffer)
1609           (process-buffer (nntp-find-connection-buffer nntp-server-buffer))
1610           first last status)
1611       ;; We have to check `nntp-server-xover'.  If it gets set to nil,
1612       ;; that means that the server does not understand XOVER, but we
1613       ;; won't know that until we try.
1614       (while (and nntp-server-xover articles)
1615         (setq first (car articles))
1616         ;; Search forward until we find a gap, or until we run out of
1617         ;; articles.
1618         (while (and (cdr articles)
1619                     (< (- (nth 1 articles) (car articles)) nntp-nov-gap))
1620           (setq articles (cdr articles)))
1621
1622         (setq in-process-buffer-p (stringp nntp-server-xover))
1623         (nntp-send-xover-command first (setq last (car articles)))
1624         (setq articles (cdr articles))
1625
1626         (when (and nntp-server-xover in-process-buffer-p)
1627           ;; Don't count tried request.
1628           (setq count (1+ count))
1629
1630           ;; Every 400 requests we have to read the stream in
1631           ;; order to avoid deadlocks.
1632           (when (or (null articles)     ;All requests have been sent.
1633                     (= 1 (% count nntp-maximum-request)))
1634
1635             (nntp-accept-response)
1636             ;; On some Emacs versions the preceding function has a
1637             ;; tendency to change the buffer.  Perhaps.  It's quite
1638             ;; difficult to reproduce, because it only seems to happen
1639             ;; once in a blue moon.
1640             (set-buffer process-buffer)
1641             (while (progn
1642                      (goto-char (or last-point (point-min)))
1643                      ;; Count replies.
1644                      (while (re-search-forward "^\\([0-9][0-9][0-9]\\) .*\n"
1645                                                nil t)
1646                        (incf received)
1647                        (setq status (match-string 1))
1648                        (if (string-match "^[45]" status)
1649                            (setq status 'error)
1650                          (setq status 'ok)))
1651                      (setq last-point (point))
1652                      (or (< received count)
1653                          (if (eq status 'error)
1654                              nil
1655                            ;; I haven't started reading the final response
1656                            (progn
1657                              (goto-char (point-max))
1658                              (forward-line -1)
1659                              (not (looking-at "^\\.\r?\n"))))))
1660               ;; I haven't read the end of the final response
1661               (nntp-accept-response)
1662               (set-buffer process-buffer))))
1663
1664         ;; Some nntp servers seem to have an extension to the XOVER
1665         ;; extension.  On these servers, requesting an article range
1666         ;; preceeding the active range does not return an error as
1667         ;; specified in the RFC.  What we instead get is the NOV entry
1668         ;; for the first available article.  Obviously, a client can
1669         ;; use that entry to avoid making unnecessary requests.  The
1670         ;; only problem is for a client that assumes that the response
1671         ;; will always be within the requested ranage.  For such a
1672         ;; client, we can get N copies of the same entry (one for each
1673         ;; XOVER command sent to the server).
1674
1675         (when (<= count 1)
1676           (goto-char (point-min))
1677           (when (re-search-forward "^[0-9][0-9][0-9] .*\n\\([0-9]+\\)" nil t)
1678             (let ((low-limit (string-to-number
1679                               (buffer-substring (match-beginning 1)
1680                                                 (match-end 1)))))
1681               (while (and articles (<= (car articles) low-limit))
1682                 (setq articles (cdr articles))))))
1683         (set-buffer buf))
1684
1685       (when nntp-server-xover
1686         (when in-process-buffer-p
1687           (set-buffer buf)
1688           (goto-char (point-max))
1689           (nntp-insert-buffer-substring process-buffer)
1690           (set-buffer process-buffer)
1691           (erase-buffer)
1692           (set-buffer buf))
1693
1694         ;; We remove any "." lines and status lines.
1695         (goto-char (point-min))
1696         (while (search-forward "\r" nil t)
1697           (delete-char -1))
1698         (goto-char (point-min))
1699         (delete-matching-lines "^\\.$\\|^[1-5][0-9][0-9] ")
1700         t))))
1701
1702   nntp-server-xover)
1703
1704 (defun nntp-send-xover-command (beg end &optional wait-for-reply)
1705   "Send the XOVER command to the server."
1706   (let ((range (format "%d-%d" beg end))
1707         (nntp-inhibit-erase t))
1708     (if (stringp nntp-server-xover)
1709         ;; If `nntp-server-xover' is a string, then we just send this
1710         ;; command.
1711         (if wait-for-reply
1712             (nntp-send-command-nodelete
1713              "\r?\n\\.\r?\n" nntp-server-xover range)
1714           ;; We do not wait for the reply.
1715           (nntp-send-command-nodelete nil nntp-server-xover range))
1716       (let ((commands nntp-xover-commands))
1717         ;; `nntp-xover-commands' is a list of possible XOVER commands.
1718         ;; We try them all until we get at positive response.
1719         (while (and commands (eq nntp-server-xover 'try))
1720           (nntp-send-command-nodelete "\r?\n\\.\r?\n" (car commands) range)
1721           (with-current-buffer nntp-server-buffer
1722             (goto-char (point-min))
1723             (and (looking-at "[23]")    ; No error message.
1724                  ;; We also have to look at the lines.  Some buggy
1725                  ;; servers give back simple lines with just the
1726                  ;; article number.  How... helpful.
1727                  (progn
1728                    (forward-line 1)
1729                    ;; More text after number, or a dot.
1730                    (looking-at "[0-9]+\t...\\|\\.\r?\n"))
1731                  (setq nntp-server-xover (car commands))))
1732           (setq commands (cdr commands)))
1733         ;; If none of the commands worked, we disable XOVER.
1734         (when (eq nntp-server-xover 'try)
1735           (nntp-erase-buffer nntp-server-buffer)
1736           (setq nntp-server-xover nil))
1737         nntp-server-xover))))
1738
1739 (defun nntp-find-group-and-number (&optional group)
1740   (save-excursion
1741     (save-restriction
1742       ;; FIXME: This is REALLY FISHY: set-buffer after save-restriction?!?
1743       (set-buffer nntp-server-buffer)
1744       (narrow-to-region (goto-char (point-min))
1745                         (or (search-forward "\n\n" nil t) (point-max)))
1746       (goto-char (point-min))
1747       ;; We first find the number by looking at the status line.
1748       (let ((number (and (looking-at "2[0-9][0-9] +\\([0-9]+\\) ")
1749                          (string-to-number
1750                           (buffer-substring (match-beginning 1)
1751                                             (match-end 1)))))
1752             newsgroups xref)
1753         (and number (zerop number) (setq number nil))
1754         (if number
1755             ;; Then we find the group name.
1756             (setq group
1757                   (cond
1758                    ;; If there is only one group in the Newsgroups
1759                    ;; header, then it seems quite likely that this
1760                    ;; article comes from that group, I'd say.
1761                    ((and (setq newsgroups
1762                                (mail-fetch-field "newsgroups"))
1763                          (not (string-match "," newsgroups)))
1764                     newsgroups)
1765                    ;; If there is more than one group in the
1766                    ;; Newsgroups header, then the Xref header should
1767                    ;; be filled out.  We hazard a guess that the group
1768                    ;; that has this article number in the Xref header
1769                    ;; is the one we are looking for.  This might very
1770                    ;; well be wrong if this article happens to have
1771                    ;; the same number in several groups, but that's
1772                    ;; life.
1773                    ((and (setq xref (mail-fetch-field "xref"))
1774                          number
1775                          (string-match
1776                           (format "\\([^ :]+\\):%d" number) xref))
1777                     (match-string 1 xref))
1778                    (t "")))
1779           (cond
1780            ((and (not nntp-xref-number-is-evil)
1781                  (setq xref (mail-fetch-field "xref"))
1782                  (string-match
1783                   (if group
1784                       (concat "\\(" (regexp-quote group) "\\):\\([0-9]+\\)")
1785                     "\\([^ :]+\\):\\([0-9]+\\)")
1786                   xref))
1787             (setq group (match-string 1 xref)
1788                   number (string-to-number (match-string 2 xref))))
1789            ((and (setq newsgroups
1790                        (mail-fetch-field "newsgroups"))
1791                  (not (string-match "," newsgroups)))
1792             (setq group newsgroups))
1793            (group)
1794            (t (setq group ""))))
1795         (when (string-match "\r" group)
1796           (setq group (substring group 0 (match-beginning 0))))
1797         (cons group number)))))
1798
1799 (defun nntp-wait-for-string (regexp)
1800   "Wait until string arrives in the buffer."
1801   (let ((buf (current-buffer))
1802         proc)
1803     (goto-char (point-min))
1804     (while (and (setq proc (get-buffer-process buf))
1805                 (memq (process-status proc) '(open run))
1806                 (not (re-search-forward regexp nil t)))
1807       (accept-process-output proc 0.1)
1808       (set-buffer buf)
1809       (goto-char (point-min)))))
1810
1811
1812 ;; ==========================================================================
1813 ;; Obsolete nntp-open-* connection methods -- drv
1814 ;; ==========================================================================
1815
1816 (defvoo nntp-open-telnet-envuser nil
1817   "*If non-nil, telnet session (client and server both) will support the ENVIRON option and not prompt for login name.")
1818
1819 (defvoo nntp-telnet-shell-prompt "bash\\|\$ *\r?$\\|> *\r?"
1820   "*Regular expression to match the shell prompt on the remote machine.")
1821
1822 (defvoo nntp-rlogin-program "rsh"
1823   "*Program used to log in on remote machines.
1824 The default is \"rsh\", but \"ssh\" is a popular alternative.")
1825
1826 (defvoo nntp-rlogin-parameters '("telnet" "-8" "${NNTPSERVER:=news}" "nntp")
1827   "*Parameters to `nntp-open-rlogin'.
1828 That function may be used as `nntp-open-connection-function'.  In that
1829 case, this list will be used as the parameter list given to rsh.")
1830
1831 (defvoo nntp-rlogin-user-name nil
1832   "*User name on remote system when using the rlogin connect method.")
1833
1834 (defvoo nntp-telnet-parameters
1835     '("exec" "telnet" "-8" "${NNTPSERVER:=news}" "nntp")
1836   "*Parameters to `nntp-open-telnet'.
1837 That function may be used as `nntp-open-connection-function'.  In that
1838 case, this list will be executed as a command after logging in
1839 via telnet.")
1840
1841 (defvoo nntp-telnet-user-name nil
1842   "User name to log in via telnet with.")
1843
1844 (defvoo nntp-telnet-passwd nil
1845   "Password to use to log in via telnet with.")
1846
1847 (defun nntp-service-to-port (svc)
1848   (cond
1849    ((integerp svc) (number-to-string svc))
1850    ((string-match "\\`[0-9]+\\'" svc) svc)
1851    (t
1852     (with-temp-buffer
1853       (ignore-errors (insert-file-contents "/etc/services"))
1854       (goto-char (point-min))
1855       (if (re-search-forward (concat "^" (regexp-quote svc)
1856                                      "[ \t]+\\([0-9]+\\)/tcp"))
1857           (match-string 1)
1858         svc)))))
1859
1860 (defun nntp-open-telnet (buffer)
1861   (with-current-buffer buffer
1862     (erase-buffer)
1863     (let ((proc (apply
1864                  'start-process
1865                  "nntpd" buffer nntp-telnet-command nntp-telnet-switches))
1866           (case-fold-search t))
1867       (when (memq (process-status proc) '(open run))
1868         (nntp-wait-for-string "^r?telnet")
1869         (process-send-string proc "set escape \^X\n")
1870         (cond
1871          ((and nntp-open-telnet-envuser nntp-telnet-user-name)
1872           (process-send-string proc (concat "open " "-l" nntp-telnet-user-name
1873                                             nntp-address "\n")))
1874          (t
1875           (process-send-string proc (concat "open " nntp-address "\n"))))
1876         (cond
1877          ((not nntp-open-telnet-envuser)
1878           (nntp-wait-for-string "^\r*.?login:")
1879           (process-send-string
1880            proc (concat
1881                  (or nntp-telnet-user-name
1882                      (setq nntp-telnet-user-name (read-string "login: ")))
1883                  "\n"))))
1884         (nntp-wait-for-string "^\r*.?password:")
1885         (process-send-string
1886          proc (concat
1887                (or nntp-telnet-passwd
1888                    (setq nntp-telnet-passwd
1889                          (read-passwd "Password: ")))
1890                "\n"))
1891         (nntp-wait-for-string nntp-telnet-shell-prompt)
1892         (process-send-string
1893          proc (concat (mapconcat 'identity nntp-telnet-parameters " ") "\n"))
1894         (nntp-wait-for-string "^\r*20[01]")
1895         (beginning-of-line)
1896         (delete-region (point-min) (point))
1897         (process-send-string proc "\^]")
1898         (nntp-wait-for-string "^r?telnet")
1899         (process-send-string proc "mode character\n")
1900         (accept-process-output proc 1)
1901         (sit-for 1)
1902         (goto-char (point-min))
1903         (forward-line 1)
1904         (delete-region (point) (point-max)))
1905       proc)))
1906
1907 (defun nntp-open-rlogin (buffer)
1908   "Open a connection to SERVER using rsh."
1909   (let ((proc (if nntp-rlogin-user-name
1910                   (apply 'start-process
1911                          "nntpd" buffer nntp-rlogin-program
1912                          nntp-address "-l" nntp-rlogin-user-name
1913                          nntp-rlogin-parameters)
1914                 (apply 'start-process
1915                        "nntpd" buffer nntp-rlogin-program nntp-address
1916                        nntp-rlogin-parameters))))
1917     (with-current-buffer buffer
1918       (nntp-wait-for-string "^\r*20[01]")
1919       (beginning-of-line)
1920       (delete-region (point-min) (point))
1921       proc)))
1922
1923
1924 ;; ==========================================================================
1925 ;; Replacements for the nntp-open-* functions -- drv
1926 ;; ==========================================================================
1927
1928 (defun nntp-open-telnet-stream (buffer)
1929   "Open a nntp connection by telnet'ing the news server.
1930 `nntp-open-netcat-stream' is recommended in place of this function
1931 because it is more reliable.
1932
1933 Please refer to the following variables to customize the connection:
1934 - `nntp-pre-command',
1935 - `nntp-telnet-command',
1936 - `nntp-telnet-switches',
1937 - `nntp-address',
1938 - `nntp-port-number',
1939 - `nntp-end-of-line'."
1940   (let ((command `(,nntp-telnet-command
1941                    ,@nntp-telnet-switches
1942                    ,nntp-address
1943                    ,(nntp-service-to-port nntp-port-number)))
1944         proc)
1945     (and nntp-pre-command
1946          (push nntp-pre-command command))
1947     (setq proc (apply 'start-process "nntpd" buffer command))
1948     (with-current-buffer buffer
1949       (nntp-wait-for-string "^\r*20[01]")
1950       (beginning-of-line)
1951       (delete-region (point-min) (point))
1952       proc)))
1953
1954 (defun nntp-open-via-rlogin-and-telnet (buffer)
1955   "Open a connection to an nntp server through an intermediate host.
1956 First rlogin to the remote host, and then telnet the real news server
1957 from there.
1958 `nntp-open-via-rlogin-and-netcat' is recommended in place of this function
1959 because it is more reliable.
1960
1961 Please refer to the following variables to customize the connection:
1962 - `nntp-pre-command',
1963 - `nntp-via-rlogin-command',
1964 - `nntp-via-rlogin-command-switches',
1965 - `nntp-via-user-name',
1966 - `nntp-via-address',
1967 - `nntp-telnet-command',
1968 - `nntp-telnet-switches',
1969 - `nntp-address',
1970 - `nntp-port-number',
1971 - `nntp-end-of-line'."
1972   (let ((command `(,nntp-via-address
1973                    ,nntp-telnet-command
1974                    ,@nntp-telnet-switches))
1975         proc)
1976     (when nntp-via-user-name
1977       (setq command `("-l" ,nntp-via-user-name ,@command)))
1978     (when nntp-via-rlogin-command-switches
1979       (setq command (append nntp-via-rlogin-command-switches command)))
1980     (push nntp-via-rlogin-command command)
1981     (and nntp-pre-command
1982          (push nntp-pre-command command))
1983     (setq proc (apply 'start-process "nntpd" buffer command))
1984     (with-current-buffer buffer
1985       (nntp-wait-for-string "^r?telnet")
1986       (process-send-string proc (concat "open " nntp-address " "
1987                                         (nntp-service-to-port nntp-port-number)
1988                                         "\n"))
1989       (nntp-wait-for-string "^\r*20[01]")
1990       (beginning-of-line)
1991       (delete-region (point-min) (point))
1992       (process-send-string proc "\^]")
1993       (nntp-wait-for-string "^r?telnet")
1994       (process-send-string proc "mode character\n")
1995       (accept-process-output proc 1)
1996       (sit-for 1)
1997       (goto-char (point-min))
1998       (forward-line 1)
1999       (delete-region (point) (point-max)))
2000     proc))
2001
2002 (defun nntp-open-via-rlogin-and-netcat (buffer)
2003   "Open a connection to an nntp server through an intermediate host.
2004 First rlogin to the remote host, and then connect to the real news
2005 server from there using the netcat command.
2006
2007 Please refer to the following variables to customize the connection:
2008 - `nntp-pre-command',
2009 - `nntp-via-rlogin-command',
2010 - `nntp-via-rlogin-command-switches',
2011 - `nntp-via-user-name',
2012 - `nntp-via-address',
2013 - `nntp-netcat-command',
2014 - `nntp-netcat-switches',
2015 - `nntp-address',
2016 - `nntp-port-number'."
2017   (let ((command `(,@(when nntp-pre-command
2018                        (list nntp-pre-command))
2019                    ,nntp-via-rlogin-command
2020                    ,@nntp-via-rlogin-command-switches
2021                    ,@(when nntp-via-user-name
2022                        (list "-l" nntp-via-user-name))
2023                    ,nntp-via-address
2024                    ,nntp-netcat-command
2025                    ,@nntp-netcat-switches
2026                    ,nntp-address
2027                    ,(nntp-service-to-port nntp-port-number))))
2028     ;; A non-nil connection type results in mightily odd behavior where
2029     ;; (process-send-string proc "\^M") ends up sending a "\n" to the
2030     ;; ssh process.  --Stef
2031     ;; Also a nil connection allow ssh-askpass to work under X11.
2032     (let ((process-connection-type nil))
2033       (apply 'start-process "nntpd" buffer command))))
2034
2035 (defun nntp-open-netcat-stream (buffer)
2036   "Open a connection to an nntp server through netcat.
2037 I.e. use the `nc' command rather than Emacs's builtin networking code.
2038
2039 Please refer to the following variables to customize the connection:
2040 - `nntp-pre-command',
2041 - `nntp-netcat-command',
2042 - `nntp-netcat-switches',
2043 - `nntp-address',
2044 - `nntp-port-number'."
2045   (let ((command `(,nntp-netcat-command
2046                    ,@nntp-netcat-switches
2047                    ,nntp-address
2048                    ,(nntp-service-to-port nntp-port-number))))
2049     (and nntp-pre-command (push nntp-pre-command command))
2050     (let ((process-connection-type nil)) ;See `nntp-open-via-rlogin-and-netcat'.
2051       (apply 'start-process "nntpd" buffer command))))
2052
2053
2054 (defun nntp-open-via-telnet-and-telnet (buffer)
2055   "Open a connection to an nntp server through an intermediate host.
2056 First telnet the remote host, and then telnet the real news server
2057 from there.
2058
2059 Please refer to the following variables to customize the connection:
2060 - `nntp-pre-command',
2061 - `nntp-via-telnet-command',
2062 - `nntp-via-telnet-switches',
2063 - `nntp-via-address',
2064 - `nntp-via-envuser',
2065 - `nntp-via-user-name',
2066 - `nntp-via-user-password',
2067 - `nntp-via-shell-prompt',
2068 - `nntp-telnet-command',
2069 - `nntp-telnet-switches',
2070 - `nntp-address',
2071 - `nntp-port-number',
2072 - `nntp-end-of-line'."
2073   (with-current-buffer buffer
2074     (erase-buffer)
2075     (let ((command `(,nntp-via-telnet-command ,@nntp-via-telnet-switches))
2076           (case-fold-search t)
2077           proc)
2078       (and nntp-pre-command (push nntp-pre-command command))
2079       (setq proc (apply 'start-process "nntpd" buffer command))
2080       (when (memq (process-status proc) '(open run))
2081         (nntp-wait-for-string "^r?telnet")
2082         (process-send-string proc "set escape \^X\n")
2083         (cond
2084          ((and nntp-via-envuser nntp-via-user-name)
2085           (process-send-string proc (concat "open " "-l" nntp-via-user-name
2086                                             nntp-via-address "\n")))
2087          (t
2088           (process-send-string proc (concat "open " nntp-via-address
2089                                             "\n"))))
2090         (when (not nntp-via-envuser)
2091           (nntp-wait-for-string "^\r*.?login:")
2092           (process-send-string proc
2093                                (concat
2094                                 (or nntp-via-user-name
2095                                     (setq nntp-via-user-name
2096                                           (read-string "login: ")))
2097                                 "\n")))
2098         (nntp-wait-for-string "^\r*.?password:")
2099         (process-send-string proc
2100                              (concat
2101                               (or nntp-via-user-password
2102                                   (setq nntp-via-user-password
2103                                         (read-passwd "Password: ")))
2104                               "\n"))
2105         (nntp-wait-for-string nntp-via-shell-prompt)
2106         (let ((real-telnet-command `("exec"
2107                                      ,nntp-telnet-command
2108                                      ,@nntp-telnet-switches
2109                                      ,nntp-address
2110                                      ,(nntp-service-to-port nntp-port-number))))
2111           (process-send-string proc
2112                                (concat (mapconcat 'identity
2113                                                   real-telnet-command " ")
2114                                        "\n")))
2115         (nntp-wait-for-string "^\r*20[01]")
2116         (beginning-of-line)
2117         (delete-region (point-min) (point))
2118         (process-send-string proc "\^]")
2119         (nntp-wait-for-string "^r?telnet")
2120         (process-send-string proc "mode character\n")
2121         (accept-process-output proc 1)
2122         (sit-for 1)
2123         (goto-char (point-min))
2124         (forward-line 1)
2125         (delete-region (point) (point-max)))
2126       proc)))
2127
2128 ;; Marks handling
2129
2130 (defun nntp-marks-directory (server)
2131   (expand-file-name server nntp-marks-directory))
2132
2133 (defvar nntp-server-to-method-cache nil
2134   "Alist of servers and select methods.")
2135
2136 (defun nntp-group-pathname (server group &optional file)
2137   "Return an absolute file name of FILE for GROUP on SERVER."
2138   (let ((method (cdr (assoc server nntp-server-to-method-cache))))
2139     (unless method
2140       (push (cons server (setq method (or (gnus-server-to-method server)
2141                                           (gnus-find-method-for-group group))))
2142             nntp-server-to-method-cache))
2143     (nnmail-group-pathname
2144      (mm-decode-coding-string group
2145                               (inline (gnus-group-name-charset method group)))
2146      (nntp-marks-directory server)
2147      file)))
2148
2149 (defun nntp-possibly-create-directory (group server)
2150   (let ((dir (nntp-group-pathname server group))
2151         (file-name-coding-system nnmail-pathname-coding-system))
2152     (unless (file-exists-p dir)
2153       (make-directory (directory-file-name dir) t)
2154       (nnheader-message 5 "Creating nntp marks directory %s" dir))))
2155
2156 (autoload 'time-less-p "time-date")
2157
2158 (defun nntp-marks-changed-p (group server)
2159   (let ((file (nntp-group-pathname server group nntp-marks-file-name))
2160         (file-name-coding-system nnmail-pathname-coding-system))
2161     (if (null (gnus-gethash file nntp-marks-modtime))
2162         t ;; never looked at marks file, assume it has changed
2163       (time-less-p (gnus-gethash file nntp-marks-modtime)
2164                    (nth 5 (file-attributes file))))))
2165
2166 (defun nntp-save-marks (group server)
2167   (let ((file-name-coding-system nnmail-pathname-coding-system)
2168         (file (nntp-group-pathname server group nntp-marks-file-name)))
2169     (condition-case err
2170         (progn
2171           (nntp-possibly-create-directory group server)
2172           (with-temp-file file
2173             (erase-buffer)
2174             (gnus-prin1 nntp-marks)
2175             (insert "\n"))
2176           (gnus-sethash file
2177                         (nth 5 (file-attributes file))
2178                         nntp-marks-modtime))
2179       (error (or (gnus-yes-or-no-p
2180                   (format "Could not write to %s (%s).  Continue? " file err))
2181                  (error "Cannot write to %s (%s)" file err))))))
2182
2183 (defun nntp-open-marks (group server)
2184   (let ((file (nntp-group-pathname server group nntp-marks-file-name))
2185         (file-name-coding-system nnmail-pathname-coding-system))
2186     (if (file-exists-p file)
2187         (condition-case err
2188             (with-temp-buffer
2189               (gnus-sethash file (nth 5 (file-attributes file))
2190                             nntp-marks-modtime)
2191               (nnheader-insert-file-contents file)
2192               (setq nntp-marks (read (current-buffer)))
2193               (dolist (el gnus-article-unpropagated-mark-lists)
2194                 (setq nntp-marks (gnus-remassoc el nntp-marks))))
2195           (error (or (gnus-yes-or-no-p
2196                       (format "Error reading nntp marks file %s (%s).  Continuing will use marks from .newsrc.eld.  Continue? " file err))
2197                      (error "Cannot read nntp marks file %s (%s)" file err))))
2198       ;; User didn't have a .marks file.  Probably first time
2199       ;; user of the .marks stuff.  Bootstrap it from .newsrc.eld.
2200       (let ((info (gnus-get-info
2201                    (gnus-group-prefixed-name
2202                     group
2203                     (gnus-server-to-method (format "nntp:%s" server)))))
2204             (decoded-name (mm-decode-coding-string
2205                            group
2206                            (gnus-group-name-charset
2207                             (gnus-server-to-method server) group))))
2208         (nnheader-message 7 "Bootstrapping marks for %s..." decoded-name)
2209         (setq nntp-marks (gnus-info-marks info))
2210         (push (cons 'read (gnus-info-read info)) nntp-marks)
2211         (dolist (el gnus-article-unpropagated-mark-lists)
2212           (setq nntp-marks (gnus-remassoc el nntp-marks)))
2213         (nntp-save-marks group server)
2214         (nnheader-message 7 "Bootstrapping marks for %s...done"
2215                           decoded-name)))))
2216
2217 (provide 'nntp)
2218
2219 ;;; nntp.el ends here