1 ;;; nntp.el --- nntp access for Gnus
3 ;; Copyright (C) 1987-1990, 1992-1998, 2000-2013 Free Software
6 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
9 ;; This file is part of GNU Emacs.
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.
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.
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/>.
28 ;; For Emacs <22.2 and XEmacs.
30 (unless (fboundp 'declare-function) (defmacro declare-function (&rest r)))
31 ;; In Emacs 24, `open-protocol-stream' is an autoloaded alias for
32 ;; `make-network-stream'.
33 (unless (fboundp 'open-protocol-stream)
34 (require 'proto-stream)))
40 (require 'gnus-group) ;; gnus-group-name-charset
44 (eval-when-compile (require 'cl))
46 (autoload 'auth-source-search "auth-source")
49 "NNTP access for Gnus."
52 (defvoo nntp-address nil
53 "Address of the physical nntp server.")
55 (defvoo nntp-port-number "nntp"
56 "Port number on the physical nntp server.")
58 (defvoo nntp-server-opened-hook '(nntp-send-mode-reader)
59 "*Hook used for sending commands to the server at startup.
60 The default value is `nntp-send-mode-reader', which makes an innd
61 server spawn an nnrpd server.")
63 (defvoo nntp-authinfo-function 'nntp-send-authinfo
64 "Function used to send AUTHINFO to the server.
65 It is called with no parameters.")
67 (defvoo nntp-server-action-alist
68 '(("nntpd 1\\.5\\.11t"
69 (remove-hook 'nntp-server-opened-hook 'nntp-send-mode-reader))
70 ("NNRP server Netscape"
71 (setq nntp-server-list-active-group nil)))
72 "Alist of regexps to match on server types and actions to be taken.
73 For instance, if you want Gnus to beep every time you connect
74 to innd, you could say something like:
76 \(setq nntp-server-action-alist
79 You probably don't want to do that, though.")
81 (defvoo nntp-open-connection-function 'nntp-open-network-stream
82 "Method for connecting to a remote system.
83 It should be a function, which is called with the output buffer
84 as its single argument, or one of the following special values:
86 - `nntp-open-network-stream' specifies a network connection,
87 upgrading to a TLS connection via STARTTLS if possible.
88 - `nntp-open-plain-stream' specifies an unencrypted network
89 connection (no STARTTLS upgrade is attempted).
90 - `nntp-open-ssl-stream' or `nntp-open-tls-stream' specify a TLS
93 Apart from the above special values, valid functions are as
94 follows; please refer to their respective doc string for more
96 For direct connections:
97 - `nntp-open-netcat-stream'
98 - `nntp-open-telnet-stream'
99 For indirect connections:
100 - `nntp-open-via-rlogin-and-netcat'
101 - `nntp-open-via-rlogin-and-telnet'
102 - `nntp-open-via-telnet-and-telnet'")
104 (defvoo nntp-never-echoes-commands nil
105 "*Non-nil means the nntp server never echoes commands.
106 It is reported that some nntps server doesn't echo commands. So, you
107 may want to set this to non-nil in the method for such a server setting
108 `nntp-open-connection-function' to `nntp-open-ssl-stream' for example.
109 Note that the `nntp-open-connection-functions-never-echo-commands'
110 variable overrides the nil value of this variable.")
112 (defvoo nntp-open-connection-functions-never-echo-commands
113 '(nntp-open-network-stream)
114 "*List of functions that never echo commands.
115 Add or set a function which you set to `nntp-open-connection-function'
116 to this list if it does not echo commands. Note that a non-nil value
117 of the `nntp-never-echoes-commands' variable overrides this variable.")
119 (defvoo nntp-pre-command nil
120 "*Pre-command to use with the various nntp-open-via-* methods.
121 This is where you would put \"runsocks\" or stuff like that.")
123 (defvoo nntp-telnet-command "telnet"
124 "*Telnet command used to connect to the nntp server.
125 This command is used by the methods `nntp-open-telnet-stream',
126 `nntp-open-via-rlogin-and-telnet' and `nntp-open-via-telnet-and-telnet'.")
128 (defvoo nntp-telnet-switches '("-8")
129 "*Switches given to the telnet command `nntp-telnet-command'.")
131 (defvoo nntp-end-of-line "\r\n"
132 "*String to use on the end of lines when talking to the NNTP server.
133 This is \"\\r\\n\" by default, but should be \"\\n\" when using an indirect
134 connection method (nntp-open-via-*).")
136 (defvoo nntp-via-rlogin-command "rsh"
137 "*Rlogin command used to connect to an intermediate host.
138 This command is used by the methods `nntp-open-via-rlogin-and-telnet'
139 and `nntp-open-via-rlogin-and-netcat'. The default is \"rsh\", but \"ssh\"
140 is a popular alternative.")
142 (defvoo nntp-via-rlogin-command-switches nil
143 "*Switches given to the rlogin command `nntp-via-rlogin-command'.
144 If you use \"ssh\" for `nntp-via-rlogin-command', you may set this to
145 \(\"-C\") in order to compress all data connections, otherwise set this
146 to \(\"-t\" \"-e\" \"none\") or (\"-C\" \"-t\" \"-e\" \"none\") if the telnet
147 command requires a pseudo-tty allocation on an intermediate host.")
149 (defvoo nntp-via-telnet-command "telnet"
150 "*Telnet command used to connect to an intermediate host.
151 This command is used by the `nntp-open-via-telnet-and-telnet' method.")
153 (defvoo nntp-via-telnet-switches '("-8")
154 "*Switches given to the telnet command `nntp-via-telnet-command'.")
156 (defvoo nntp-netcat-command "nc"
157 "*Netcat command used to connect to the nntp server.
158 This command is used by the `nntp-open-netcat-stream' and
159 `nntp-open-via-rlogin-and-netcat' methods.")
161 (defvoo nntp-netcat-switches nil
162 "*Switches given to the netcat command `nntp-netcat-command'.")
164 (defvoo nntp-via-user-name nil
165 "*User name to log in on an intermediate host with.
166 This variable is used by the various nntp-open-via-* methods.")
168 (defvoo nntp-via-user-password nil
169 "*Password to use to log in on an intermediate host with.
170 This variable is used by the `nntp-open-via-telnet-and-telnet' method.")
172 (defvoo nntp-via-address nil
173 "*Address of an intermediate host to connect to.
174 This variable is used by the various nntp-open-via-* methods.")
176 (defvoo nntp-via-envuser nil
177 "*Whether both telnet client and server support the ENVIRON option.
178 If non-nil, there will be no prompt for a login name.")
180 (defvoo nntp-via-shell-prompt "bash\\|\$ *\r?$\\|> *\r?"
181 "*Regular expression to match the shell prompt on an intermediate host.
182 This variable is used by the `nntp-open-via-telnet-and-telnet' method.")
184 (defvoo nntp-large-newsgroup 50
185 "*The number of articles which indicates a large newsgroup.
186 If the number of articles is greater than the value, verbose
187 messages will be shown to indicate the current status.")
189 (defvoo nntp-maximum-request 400
190 "*The maximum number of the requests sent to the NNTP server at one time.
191 If Emacs hangs up while retrieving headers, set the variable to a
194 (defvoo nntp-nov-is-evil nil
195 "*If non-nil, nntp will never attempt to use XOVER when talking to the server.")
197 (defvoo nntp-xover-commands '("XOVER" "XOVERVIEW")
198 "*List of strings that are used as commands to fetch NOV lines from a server.
199 The strings are tried in turn until a positive response is gotten. If
200 none of the commands are successful, nntp will just grab headers one
203 (defvoo nntp-nov-gap 5
204 "*Maximum allowed gap between two articles.
205 If the gap between two consecutive articles is bigger than this
206 variable, split the XOVER request into two requests.")
208 (defvoo nntp-xref-number-is-evil nil
209 "*If non-nil, Gnus never trusts article numbers in the Xref header.
210 Some news servers, e.g., ones running Diablo, run multiple engines
211 having the same articles but article numbers are not kept synchronized
212 between them. If you connect to such a server, set this to a non-nil
213 value, and Gnus never uses article numbers (that appear in the Xref
214 header and vary by which engine is chosen) to refer to articles.")
216 (defvoo nntp-prepare-server-hook nil
217 "*Hook run before a server is opened.
218 If can be used to set up a server remotely, for instance. Say you
219 have an account at the machine \"other.machine\". This machine has
220 access to an NNTP server that you can't access locally. You could
221 then use this hook to rsh to the remote machine and start a proxy NNTP
222 server there that you can connect to. See also
223 `nntp-open-connection-function'")
225 (defcustom nntp-authinfo-file "~/.authinfo"
226 ".netrc-like file that holds nntp authinfo passwords."
230 (repeat :tag "Entries"
233 :value ("" ("login" . "") ("password" . ""))
237 (const :format "" "login")
238 (string :format "Login: %v"))
240 (const :format "" "password")
241 (string :format "Password: %v")))))))
243 (make-obsolete 'nntp-authinfo-file nil "Emacs 24.1")
247 (defvoo nntp-connection-timeout nil
248 "*Number of seconds to wait before an nntp connection times out.
249 If this variable is nil, which is the default, no timers are set.
250 NOTE: This variable is never seen to work in Emacs 20 and XEmacs 21.")
252 (defvoo nntp-prepare-post-hook nil
253 "*Hook run just before posting an article. It is supposed to be used
254 to insert Cancel-Lock headers.")
256 (defvoo nntp-server-list-active-group 'try
257 "If nil, then always use GROUP instead of LIST ACTIVE.
258 This is usually slower, but on misconfigured servers that don't
259 update their active files often, this can help.")
261 ;;; Internal variables.
263 (defvoo nntp-retrieval-in-progress nil)
264 (defvar nntp-record-commands nil
265 "*If non-nil, nntp will record all commands in the \"*nntp-log*\" buffer.")
267 (defvar nntp-have-messaged nil)
269 (defvar nntp-process-wait-for nil)
270 (defvar nntp-process-to-buffer nil)
271 (defvar nntp-process-callback nil)
272 (defvar nntp-process-decode nil)
273 (defvar nntp-process-start-point nil)
274 (defvar nntp-inside-change-function nil)
275 (defvoo nntp-last-command-time nil)
276 (defvoo nntp-last-command nil)
277 (defvoo nntp-authinfo-password nil)
278 (defvoo nntp-authinfo-user nil)
279 (defvoo nntp-authinfo-force nil)
281 (defvar nntp-connection-list nil)
283 (defvoo nntp-server-type nil)
284 (defvoo nntp-connection-alist nil)
285 (defvoo nntp-status-string "")
286 (defconst nntp-version "nntp 5.0")
287 (defvoo nntp-inhibit-erase nil)
288 (defvoo nntp-inhibit-output nil)
290 (defvoo nntp-server-xover 'try)
292 (defvar nntp-async-timer nil)
293 (defvar nntp-async-process-list nil)
295 (defvar nntp-authinfo-rejected nil
296 "A custom error condition used to report 'Authentication Rejected' errors.
297 Condition handlers that match just this condition ensure that the nntp
298 backend doesn't catch this error.")
299 (put 'nntp-authinfo-rejected 'error-conditions '(error nntp-authinfo-rejected))
300 (put 'nntp-authinfo-rejected 'error-message "Authorization Rejected")
304 ;;; Internal functions.
306 (defsubst nntp-send-string (process string)
307 "Send STRING to PROCESS."
308 ;; We need to store the time to provide timeouts, and
309 ;; to store the command so the we can replay the command
310 ;; if the server gives us an AUTHINFO challenge.
311 (setq nntp-last-command-time (current-time)
312 nntp-last-command string)
313 (when nntp-record-commands
314 (nntp-record-command string))
315 (process-send-string process (concat string nntp-end-of-line))
316 (or (memq (process-status process) '(open run))
317 (nntp-report "Server closed connection")))
319 (defun nntp-record-command (string)
320 "Record the command STRING."
321 (with-current-buffer (get-buffer-create "*nntp-log*")
322 (goto-char (point-max))
323 (insert (format-time-string "%Y%m%dT%H%M%S.%3N")
324 " " nntp-address " " string "\n")))
326 (defvar nntp--report-1 nil)
328 (defun nntp-report (&rest args)
329 "Report an error from the nntp backend. The first string in ARGS
330 can be a format string. For some commands, the failed command may be
331 retried once before actually displaying the error report."
334 ;; Throw out to nntp-with-open-group-error so that the connection may
335 ;; be restored and the command retried."
336 (when nntp-record-commands
337 (nntp-record-command "*** CONNECTION LOST ***"))
338 (throw 'nntp-with-open-group-error t))
340 (when nntp-record-commands
341 (nntp-record-command "*** CALLED nntp-report ***"))
343 (nnheader-report 'nntp args)
345 (apply 'error args)))
347 (defmacro nntp-copy-to-buffer (buffer start end)
348 "Copy string from unibyte current buffer to multibyte buffer."
349 (if (featurep 'xemacs)
350 `(copy-to-buffer ,buffer ,start ,end)
351 `(let ((string (buffer-substring ,start ,end)))
352 (with-current-buffer ,buffer
354 (insert (if enable-multibyte-characters
355 (mm-string-to-multibyte string)
357 (goto-char (point-min))
360 (defsubst nntp-wait-for (process wait-for buffer &optional decode discard)
361 "Wait for WAIT-FOR to arrive from PROCESS."
363 (with-current-buffer (process-buffer process)
364 (goto-char (point-min))
366 (while (and (or (not (memq (char-after (point)) '(?2 ?3 ?4 ?5)))
367 (looking-at "48[02]"))
368 (memq (process-status process) '(open run)))
369 (cond ((looking-at "480")
370 (nntp-handle-authinfo process))
372 (nnheader-report 'nntp "%s"
373 (get 'nntp-authinfo-rejected 'error-message))
374 (signal 'nntp-authinfo-rejected nil))
375 ((looking-at "^.*\n")
376 (delete-region (point) (progn (forward-line 1) (point)))))
377 (nntp-accept-process-output process)
378 (goto-char (point-min)))
383 (nntp-snarf-error-message)
385 ((not (memq (process-status process) '(open run)))
386 (nntp-report "Server closed connection"))
388 (goto-char (point-max))
389 (let ((limit (point-min))
391 (while (not (re-search-backward wait-for limit t))
392 (nntp-accept-process-output process)
393 ;; We assume that whatever we wait for is less than 1000
395 (setq limit (max (- (point-max) 1000) (point-min)))
396 (goto-char (point-max)))
397 (setq response (match-string 0))
398 (with-current-buffer nntp-server-buffer
399 (setq nntp-process-response response)))
400 (nntp-decode-text (not decode))
402 (with-current-buffer buffer
403 (goto-char (point-max))
404 (nnheader-insert-buffer-substring (process-buffer process))
405 ;; Nix out "nntp reading...." message.
406 (when nntp-have-messaged
407 (setq nntp-have-messaged nil)
408 (nnheader-message 5 ""))))
413 (defun nntp-kill-buffer (buffer)
414 (when (buffer-name buffer)
415 (let ((process (get-buffer-process buffer)))
417 (delete-process process)))
419 (nnheader-init-server-buffer)))
421 (defun nntp-erase-buffer (buffer)
422 "Erase contents of BUFFER."
423 (with-current-buffer buffer
426 (defsubst nntp-find-connection (buffer)
427 "Find the connection delivering to BUFFER."
428 (let ((alist nntp-connection-alist)
429 (buffer (if (stringp buffer) (get-buffer buffer) buffer))
431 (while (and alist (setq entry (pop alist)))
432 (when (eq buffer (cadr entry))
433 (setq process (car entry)
436 (if (memq (process-status process) '(open run))
438 (nntp-kill-buffer (process-buffer process))
439 (setq nntp-connection-alist (delq entry nntp-connection-alist))
442 (defsubst nntp-find-connection-entry (buffer)
443 "Return the entry for the connection to BUFFER."
444 (assq (nntp-find-connection buffer) nntp-connection-alist))
446 (defun nntp-find-connection-buffer (buffer)
447 "Return the process connection buffer tied to BUFFER."
448 (let ((process (nntp-find-connection buffer)))
450 (process-buffer process))))
452 (defsubst nntp-retrieve-data (command address port buffer
453 &optional wait-for callback decode)
454 "Use COMMAND to retrieve data into BUFFER from PORT on ADDRESS."
455 (let ((process (or (nntp-find-connection buffer)
456 (nntp-open-connection buffer))))
459 (unless (or nntp-inhibit-erase nnheader-callback-function)
460 (nntp-erase-buffer (process-buffer process)))
464 (nntp-send-string process command))
466 ((eq callback 'ignore)
468 ((and callback wait-for)
469 (nntp-async-wait process wait-for buffer decode callback)
472 (nntp-wait-for process wait-for buffer decode))
474 (nntp-authinfo-rejected
475 (signal 'nntp-authinfo-rejected (cdr err)))
477 (nnheader-report 'nntp "Couldn't open connection to %s: %s"
480 (message "Quit retrieving data from nntp")
483 (nnheader-report 'nntp "Couldn't open connection to %s" address))))
485 (defsubst nntp-send-command (wait-for &rest strings)
486 "Send STRINGS to server and wait until WAIT-FOR returns."
487 (when (and (not nnheader-callback-function)
488 (not nntp-inhibit-output))
489 (nntp-erase-buffer nntp-server-buffer))
490 (let* ((command (mapconcat 'identity strings " "))
491 (process (nntp-find-connection nntp-server-buffer))
492 (buffer (and process (process-buffer process)))
493 (pos (and buffer (with-current-buffer buffer (point)))))
496 (nntp-retrieve-data command
497 nntp-address nntp-port-number
499 wait-for nnheader-callback-function)
500 ;; If nothing to wait for, still remove possibly echo'ed commands.
501 ;; We don't have echoes if `nntp-never-echoes-commands' is non-nil
502 ;; or the value of `nntp-open-connection-function' is in
503 ;; `nntp-open-connection-functions-never-echo-commands', so we
504 ;; skip this in that cases.
506 nntp-never-echoes-commands
508 nntp-open-connection-function
509 nntp-open-connection-functions-never-echo-commands))
510 (nntp-accept-response)
511 (with-current-buffer buffer
513 (if (looking-at (regexp-quote command))
514 (delete-region pos (progn (forward-line 1)
516 (nnheader-report 'nntp "Couldn't open connection to %s."
519 (defun nntp-send-command-nodelete (wait-for &rest strings)
520 "Send STRINGS to server and wait until WAIT-FOR returns."
521 (let* ((command (mapconcat 'identity strings " "))
522 (process (nntp-find-connection nntp-server-buffer))
523 (buffer (and process (process-buffer process)))
524 (pos (and buffer (with-current-buffer buffer (point)))))
527 (nntp-retrieve-data command
528 nntp-address nntp-port-number
530 wait-for nnheader-callback-function)
531 ;; If nothing to wait for, still remove possibly echo'ed commands
533 (nntp-accept-response)
534 (with-current-buffer buffer
536 (if (looking-at (regexp-quote command))
537 (delete-region pos (progn (forward-line 1)
539 (nnheader-report 'nntp "Couldn't open connection to %s."
542 (defun nntp-send-command-and-decode (wait-for &rest strings)
543 "Send STRINGS to server and wait until WAIT-FOR returns."
544 (when (and (not nnheader-callback-function)
545 (not nntp-inhibit-output))
546 (nntp-erase-buffer nntp-server-buffer))
547 (let* ((command (mapconcat 'identity strings " "))
548 (process (nntp-find-connection nntp-server-buffer))
549 (buffer (and process (process-buffer process)))
550 (pos (and buffer (with-current-buffer buffer (point)))))
553 (nntp-retrieve-data command
554 nntp-address nntp-port-number
556 wait-for nnheader-callback-function t)
557 ;; If nothing to wait for, still remove possibly echo'ed commands
559 (nntp-accept-response)
560 (with-current-buffer buffer
562 (if (looking-at (regexp-quote command))
563 (delete-region pos (progn (forward-line 1) (point-at-bol))))
565 (nnheader-report 'nntp "Couldn't open connection to %s."
569 (defun nntp-send-buffer (wait-for)
570 "Send the current buffer to server and wait until WAIT-FOR returns."
571 (when (and (not nnheader-callback-function)
572 (not nntp-inhibit-output))
574 (nntp-find-connection-buffer nntp-server-buffer)))
576 ;; Make sure we did not forget to encode some of the content.
577 (assert (save-excursion (goto-char (point-min))
578 (not (re-search-forward "[^\000-\377]" nil t))))
579 (mm-disable-multibyte)
580 (process-send-region (nntp-find-connection nntp-server-buffer)
581 (point-min) (point-max))
583 nil nntp-address nntp-port-number nntp-server-buffer
584 wait-for nnheader-callback-function))
588 ;;; Interface functions.
590 (nnoo-define-basics nntp)
592 (defsubst nntp-next-result-arrived-p ()