Re: emacs-25 b6b47AF: Properly encode/decode base64Binary data in SOAP

[Thomas Fitzsimmons <fitzsim@fitzsim.org>]

[-- Attachment #1: Type: text/plain, Size: 989 bytes --]

Stefan Monnier <monnier@iro.umontreal.ca> writes:

>> The interface does not return bytes, it returns a (half-)decoded lisp
>> form.
>
> My understanding is that it returns a structure whose leaves are
> all byte-strings because.

String values are returned as multibyte, e.g.:

(multibyte-string-p (cdr (assq 'severity (car (debbugs-get-status 22285)))))
=> t

because parsing happens in a temporary buffer where
enable-multibyte-characters is set, and the string value is returned
unchanged.

> In this sense, they're all "undecoded".  And the meaning of those
> byte-strings is not specified by the generic format, so the generic
> parser can't know if or how to decode them.

This is true for base64Binary values.

I'd like to change the base64Binary behavior back, but we can document
this nuance of the API.  Also, on the encoding side I think we should
force the caller to provide unibyte strings for base64Binary values.

Is the attached patch OK for master and emacs-25?

Thomas


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: emacs-soap-client-document-base64-handling.patch --]
[-- Type: text/x-patch, Size: 1824 bytes --]

diff --git a/lisp/net/soap-client.el b/lisp/net/soap-client.el
index 7402464..bee3a12 100644
--- a/lisp/net/soap-client.el
+++ b/lisp/net/soap-client.el
@@ -536,9 +536,10 @@ soap-encode-xs-basic-type
                 (number-to-string value))
 
                (base64Binary
-                (unless (stringp value)
-                  (error "Not a string value for base64Binary"))
-                (base64-encode-string (encode-coding-string value 'utf-8)))
+                (unless (and (stringp value)
+                             (not (multibyte-string-p value)))
+                  (error "Not a unibyte string value for base64Binary"))
+                (base64-encode-string value))
 
                (otherwise
                 (error "Don't know how to encode %s for type %s"
@@ -682,7 +683,7 @@ soap-decode-xs-basic-type
                decimal byte float double duration)
          (string-to-number (car contents)))
         (boolean (string= (downcase (car contents)) "true"))
-        (base64Binary (decode-coding-string (base64-decode-string (car contents)) 'utf-8))
+        (base64Binary (base64-decode-string (car contents)))
         (anyType (soap-decode-any-type node))
         (Array (soap-decode-array node))))))
 
@@ -3096,7 +3097,9 @@ soap-invoke
 NOTE: The SOAP service provider should document the available
 operations and their parameters for the service.  You can also
 use the `soap-inspect' function to browse the available
-operations in a WSDL document."
+operations in a WSDL document.  `soap-invoke' base64-decodes
+base64Binary return values into unibyte strings; these
+byte-strings require further interpretation by the caller."
   (apply #'soap-invoke-internal nil nil wsdl service operation-name parameters))
 
 (defun soap-invoke-async (callback cbargs wsdl service operation-name