[Emacs-diffs] /srv/bzr/emacs/trunk r103778: Change default type of open-protocol-stream.

[Chong Yidong]

------------------------------------------------------------
revno: 103778
committer: Chong Yidong <address@hidden>
branch nick: trunk
timestamp: Tue 2011-03-29 22:21:28 -0400
message:
  Change default type of open-protocol-stream.
  
  * nnimap.el (nnimap-stream, nnimap-open-connection-1): Accept `network'
  value.
  
  * nntp.el (nntp-open-connection-function): Document the fact that some
  values are not functions but are instead handled specially.  Recognize
  nntp-open-plain-stream value.
  (nntp-open-connection): Recognize that value.
  
  * proto-stream.el (open-protocol-stream): Bring back `network' type.
  Make this the default type.
  (proto-stream-open-plain): Rename from proto-stream-open-default.
  (open-protocol-stream, proto-stream-open-starttls)
  (proto-stream-open-tls, proto-stream-open-shell): Replace `default'
  with `plain'.
modified:
  lisp/gnus/ChangeLog
  lisp/gnus/nnimap.el
  lisp/gnus/nntp.el
  lisp/gnus/proto-stream.el

=== modified file 'lisp/gnus/ChangeLog'
--- a/lisp/gnus/ChangeLog       2011-03-29 13:23:38 +0000
+++ b/lisp/gnus/ChangeLog       2011-03-30 02:21:28 +0000
@@ -1,3 +1,20 @@
+2011-03-30  Chong Yidong  <address@hidden>
+
+       * proto-stream.el (open-protocol-stream): Bring back `network' type.
+       Make this the default type.
+       (proto-stream-open-plain): Rename from proto-stream-open-default.
+       (open-protocol-stream, proto-stream-open-starttls)
+       (proto-stream-open-tls, proto-stream-open-shell): Replace `default'
+       with `plain'.
+
+       * nnimap.el (nnimap-stream, nnimap-open-connection-1): Accept `network'
+       value.
+
+       * nntp.el (nntp-open-connection-function): Document the fact that some
+       values are not functions but are instead handled specially.  Recognize
+       nntp-open-plain-stream value.
+       (nntp-open-connection): Recognize that value.
+
 2011-03-29  Julien Danjou  <address@hidden>
 
        * mm-view.el (mm-display-inline-fontify): Use `set-normal-mode' with

=== modified file 'lisp/gnus/nnimap.el'
--- a/lisp/gnus/nnimap.el       2011-03-26 23:18:42 +0000
+++ b/lisp/gnus/nnimap.el       2011-03-30 02:21:28 +0000
@@ -61,10 +61,12 @@
 it will default to `imap'.")
 
 (defvoo nnimap-stream 'undecided
-  "How nnimap will talk to the IMAP server.
-Values are `ssl', `default', `try-starttls', `starttls' or
-`shell'.  The default is to try `ssl' first, and then
-`try-starttls'.")
+  "How nnimap talks to the IMAP server.
+The value should be either `undecided', `ssl' or `tls',
+`network', `starttls', `plain', or `shell'.
+
+If the value is `undecided', nnimap tries `ssl' first, then falls
+back on `network'.")
 
 (defvoo nnimap-shell-program (if (boundp 'imap-shell-program)
                                 (if (listp imap-shell-program)
@@ -319,7 +321,7 @@
     (setq nnimap-stream 'ssl))
   (let ((stream
         (if (eq nnimap-stream 'undecided)
-            (loop for type in '(ssl try-starttls)
+            (loop for type in '(ssl network)
                   for stream = (let ((nnimap-stream type))
                                  (nnimap-open-connection-1 buffer))
                   while (eq stream 'no-connect)
@@ -339,7 +341,7 @@
           (port nil)
           (ports
            (cond
-            ((memq nnimap-stream '(try-starttls default starttls))
+            ((memq nnimap-stream '(network plain starttls))
              (nnheader-message 7 "Opening connection to %s..."
                                nnimap-address)
              '("imap" "143"))

=== modified file 'lisp/gnus/nntp.el'
--- a/lisp/gnus/nntp.el 2011-03-26 23:18:42 +0000
+++ b/lisp/gnus/nntp.el 2011-03-30 02:21:28 +0000
@@ -76,27 +76,27 @@
 You probably don't want to do that, though.")
 
 (defvoo nntp-open-connection-function 'nntp-open-network-stream
-  "*Function used for connecting to a remote system.
-It will be called with the buffer to output in as argument.
-
-Currently, five such functions are provided (please refer to their
-respective doc string for more information), three of them establishing
-direct connections to the nntp server, and two of them using an indirect
-host.
-
-Direct connections:
-- `nntp-open-network-stream' (the default),
-- `network-only' (the same as the above, but don't do automatic
-  STARTTLS upgrades).
-- `nntp-open-ssl-stream',
-- `nntp-open-tls-stream',
-- `nntp-open-netcat-stream'.
-- `nntp-open-telnet-stream'.
-
-Indirect connections:
-- `nntp-open-via-rlogin-and-netcat',
-- `nntp-open-via-rlogin-and-telnet',
-- `nntp-open-via-telnet-and-telnet'.")
+  "Method for connecting to a remote system.
+It should be a function, which is called with the output buffer
+as its single argument, or one of the following special values:
+
+- `nntp-open-network-stream' specifies a network connection,
+  upgrading to a TLS connection via STARTTLS if possible.
+- `nntp-open-plain-stream' specifies an unencrypted network
+  connection (no STARTTLS upgrade is attempted).
+- `nntp-open-ssl-stream' or `nntp-open-tls-stream' specify a TLS
+  network connection.
+
+Apart from the above special values, valid functions are as
+follows; please refer to their respective doc string for more
+information.
+For direct connections:
+- `nntp-open-netcat-stream'
+- `nntp-open-telnet-stream'
+For indirect connections:
+- `nntp-open-via-rlogin-and-netcat'
+- `nntp-open-via-rlogin-and-telnet'
+- `nntp-open-via-telnet-and-telnet'")
 
 (defvoo nntp-never-echoes-commands nil
   "*Non-nil means the nntp server never echoes commands.
@@ -1339,15 +1339,15 @@
          (condition-case err
              (let ((coding-system-for-read nntp-coding-system-for-read)
                    (coding-system-for-write nntp-coding-system-for-write)
-                   (map '((nntp-open-network-stream try-starttls)
-                          (network-only default)
+                   (map '((nntp-open-network-stream network)
+                          (network-only plain) ; compat
+                          (nntp-open-plain-stream plain)
                           (nntp-open-ssl-stream tls)
                           (nntp-open-tls-stream tls))))
                (if (assoc nntp-open-connection-function map)
                    (open-protocol-stream
                     "nntpd" pbuffer nntp-address nntp-port-number
-                    :type (or (cadr (assoc nntp-open-connection-function map))
-                              'try-starttls)
+                    :type (cadr (assoc nntp-open-connection-function map))
                     :end-of-command "^\\([2345]\\|[.]\\).*\n"
                     :capability-command "CAPABILITIES\r\n"
                     :success "^3"

=== modified file 'lisp/gnus/proto-stream.el'
--- a/lisp/gnus/proto-stream.el 2011-03-26 23:18:42 +0000
+++ b/lisp/gnus/proto-stream.el 2011-03-30 02:21:28 +0000
@@ -37,7 +37,7 @@
 
 ;; (open-protocol-stream
 ;;  "*nnimap*" buffer address port
-;;  :type 'try-starttls
+;;  :type 'network
 ;;  :capability-command "1 CAPABILITY\r\n"
 ;;  :success " OK "
 ;;  :starttls-function
@@ -65,17 +65,20 @@
 PARAMETERS should be a sequence of keywords and values:
 
 :type specifies the connection type, one of the following:
-  `default'  -- An ordinary network connection.
-  `try-starttls'
-             -- Begin an ordinary network connection, and try
-                upgrading it to an encrypted connection via
-                STARTTLS if both HOST and Emacs support TLS.  If
-                that fails, keep the unencrypted connection.
-  `starttls' -- Begin an ordinary connection, and try upgrading
-                it via STARTTLS.  If that fails for any reason,
-                drop the connection; in this case, the returned
-                process object is a killed process.
-  `tls' or `ssl' -- A TLS connection.
+  nil or `network'
+             -- Begin with an ordinary network connection, and if
+                the parameters :success and :capability-command
+                are also supplied, try to upgrade to an encrypted
+                connection via STARTTLS.  Even if that
+                fails (e.g. if HOST does not support TLS), retain
+                an unencrypted connection.
+  `plain'    -- An ordinary, unencrypted network connection.
+  `starttls' -- Begin with an ordinary connection, and try
+                upgrading via STARTTLS.  If that fails for any
+                reason, drop the connection; in that case the
+                returned object is a killed process.
+  `tls'      -- A TLS connection.
+  `ssl'      -- Equivalent to `tls'.
   `shell'    -- A shell connection.
 
 :return-list specifies this function's return value.
@@ -85,16 +88,15 @@
    :greeting -- the greeting returned by HOST (a string), or nil.
    :capabilities -- a string representing HOST's capabilities,
                     or nil if none could be found.
-   :type -- the actual connection type; either `default' for an
-            unencrypted connection, or `tls'.
+   :type -- the resulting connection type; `plain' (unencrypted)
+            or `tls' (TLS-encrypted).
 
 :end-of-command specifies a regexp matching the end of a command.
   If non-nil, it defaults to \"\\n\".
 
 :success specifies a regexp matching a message indicating a
   successful STARTTLS negotiation.  For instance, the default
-  should be \"^3\" for an NNTP connection.  If this is not
-  supplied, STARTTLS will always fail.
+  should be \"^3\" for an NNTP connection.
 
 :capability-command specifies a command used to query the HOST
   for its capabilities.  For instance, for IMAP this should be
@@ -106,27 +108,24 @@
   STARTTLS if the server supports STARTTLS, and nil otherwise."
   (let ((type (plist-get parameters :type))
        (return-list (plist-get parameters :return-list)))
-    (if (and (null return-list) (memq type '(nil default)))
-       ;; The simplest case---no encryption, and no need to report
-       ;; connection properties.  Like `open-network-stream', this
-       ;; doesn't read anything into BUFFER yet.
+    (if (and (not return-list)
+            (or (eq type 'plain)
+                (and (memq type '(nil network))
+                     (not (and (plist-get parameters :success)
+                               (plist-get parameters :capability-command))))))
+       ;; The simplest case is equivalent to `open-network-stream'.
        (open-network-stream name buffer host service)
       ;; For everything else, refer to proto-stream-open-*.
       (unless (plist-get parameters :end-of-command)
-       (setq parameters
-             (append '(:end-of-command "\r\n") parameters)))
+       (setq parameters (append '(:end-of-command "\r\n") parameters)))
       (let* ((connection-function
              (cond
-              ((memq type '(nil default))
-               'proto-stream-open-default)
-              ((memq type '(try-starttls starttls))
+              ((eq type 'plain) 'proto-stream-open-plain)
+              ((memq type '(nil network starttls))
                'proto-stream-open-starttls)
-              ((memq type '(tls ssl))
-               'proto-stream-open-tls)
-              ((eq type 'shell)
-               'proto-stream-open-shell)
-              (t
-               (error "Invalid connection type %s" type))))
+              ((memq type '(tls ssl)) 'proto-stream-open-tls)
+              ((eq type 'shell) 'proto-stream-open-shell)
+              (t (error "Invalid connection type %s" type))))
             (result (funcall connection-function
                              name buffer host service parameters)))
        (if return-list
@@ -136,19 +135,18 @@
                  :type         (nth 3 result))
          (car result))))))
 
-(defun proto-stream-open-default (name buffer host service parameters)
+(defun proto-stream-open-plain (name buffer host service parameters)
   (let ((start (with-current-buffer buffer (point)))
        (stream (open-network-stream name buffer host service)))
     (list stream
          (proto-stream-get-response stream start
                                     (plist-get parameters :end-of-command))
          nil
-         'default)))
+         'plain)))
 
 (defun proto-stream-open-starttls (name buffer host service parameters)
   (let* ((start (with-current-buffer buffer (point)))
-        ;; This should be `starttls' or `try-starttls'.
-        (type               (plist-get parameters :type))
+        (require-tls    (eq (plist-get parameters :type) 'starttls))
         (starttls-function  (plist-get parameters :starttls-function))
         (success-string     (plist-get parameters :success))
         (capability-command (plist-get parameters :capability-command))
@@ -159,7 +157,7 @@
         (capabilities (when capability-command
                         (proto-stream-command stream
                                               capability-command eoc)))
-        (resulting-type 'default)
+        (resulting-type 'plain)
         starttls-command)
 
     ;; If we have STARTTLS support, try to upgrade the connection.
@@ -175,11 +173,11 @@
        (setq start (with-current-buffer buffer (point-max)))
        (let* ((starttls-use-gnutls t)
               (starttls-extra-arguments
-               (if (not (eq type 'starttls))
-                   ;; For opportunistic TLS upgrades, we don't
-                   ;; really care about the identity of the peer.
-                   (cons "--insecure" starttls-extra-arguments)
-                 starttls-extra-arguments)))
+               (if require-tls
+                   starttls-extra-arguments
+                 ;; For opportunistic TLS upgrades, we don't really
+                 ;; care about the identity of the peer.
+                 (cons "--insecure" starttls-extra-arguments))))
          (setq stream (starttls-open-stream name buffer host service)))
        (proto-stream-get-response stream start eoc))
       (when (string-match success-string
@@ -193,7 +191,7 @@
            (setq resulting-type 'tls)
          ;; We didn't successfully negotiate STARTTLS; if TLS
          ;; isn't demanded, reopen an unencrypted connection.
-         (when (eq type 'try-starttls)
+         (unless require-tls
            (setq stream (open-network-stream name buffer host service))
            (proto-stream-get-response stream start eoc)))
        ;; Re-get the capabilities, which may have now changed.
@@ -201,8 +199,8 @@
              (proto-stream-command stream capability-command eoc))))
 
     ;; If TLS is mandatory, close the connection if it's unencrypted.
-    (and (eq type 'starttls)
-        (eq resulting-type 'default)
+    (and require-tls
+        (eq resulting-type 'plain)
         (delete-process stream))
     ;; Return value:
     (list stream greeting capabilities resulting-type)))
@@ -237,7 +235,7 @@
                    name buffer host service))
          (eoc (plist-get parameters :end-of-command)))
       (if (null stream)
-         (list nil nil nil 'default)
+         (list nil nil nil 'plain)
        ;; If we're using tls.el, we have to delete the output from
        ;; openssl/gnutls-cli.
        (unless (fboundp 'open-gnutls-stream)
@@ -260,7 +258,7 @@
                     (format-spec-make
                      ?s host
                      ?p service))))
-   parameters 'default))
+   parameters 'plain))
 
 (defun proto-stream-capability-open (start stream parameters stream-type)
   (let* ((capability-command (plist-get parameters :capability-command))