add 3 new methods to make life tolerable for jsonrpc subclasses

Author: gggeek

NEWS.md

@@ -2,6 +2,10 @@
 
 - improved: allow to force usage of HTTP 1.1. when using curl for calls, via usage of 'http11_only'
 
+- improved: added new methods: `Server::generatePayload($resp, $respCharset)`,
+  `Server::printPayload($payload, $resp->getContentType(), $respEncoding)` and `HTTP::setAcceptedStatusCodes($statusCodes)`
+  to help subclasses such as the Json-Rpc server and request
+
 
 ## XML-RPC for PHP version 4.11.3 - 2025/10/3
 

src/Helper/Http.php

@@ -10,6 +10,8 @@ class Http
 {
     use LoggerAware;
 
+    protected $acceptedStatusCodes = array('200');
+
     /**
      * Decode a string that is encoded with "chunked" transfer encoding as defined in RFC 2068 par. 19.4.6.
      * Code shamelessly stolen from nusoap library by Dietrich Ayala.
@@ -131,7 +133,7 @@ public function parseResponseHeaders(&$data, $headersProcessed = false, $debug =
             $httpResponse['status_code'] = $matches[2];
         }
 
-        if ($httpResponse['status_code'] !== '200') {
+        if (!in_array($httpResponse['status_code'], $this->acceptedStatusCodes)) {
             $errstr = substr($data, 0, strpos($data, "\n") - 1);
             $this->getLogger()->error('XML-RPC: ' . __METHOD__ . ': HTTP error, got response: ' . $errstr);
             throw new HttpException(PhpXmlRpc::$xmlrpcstr['http_error'] . ' (' . $errstr . ')', PhpXmlRpc::$xmlrpcerr['http_error'], null, $httpResponse['status_code']);
@@ -280,4 +282,13 @@ public function parseAcceptHeader($header)
         arsort($accepted);
         return array_keys($accepted);
     }
+
+    /**
+     * @param string[] $statusCodes
+     * @return void
+     */
+    public function setAcceptedStatusCodes($statusCodes)
+    {
+        $this->acceptedStatusCodes = $statusCodes;
+    }
 }

src/Server.php

@@ -390,59 +390,13 @@ public function service($data = null, $returnPayload = false)
                 static::$_xmlrpcs_occurred_errors . "+++END+++");
         }
 
-        $header = $resp->xml_header($respCharset);
-        if ($this->debug > 0) {
-            $header .= $this->serializeDebug($respCharset);
-        }
-
-        // Do not create response serialization if it has already happened. Helps to build json magic
-        /// @todo what if the payload was created targeting a different charset than $respCharset?
-        ///       Also, if we do not call serialize(), the request will not set its content-type to have the charset declared
-        $payload = $resp->getPayload();
-        if (empty($payload)) {
-            $payload = $resp->serialize($respCharset);
-        }
-        $payload = $header . $payload;
+        $payload = $this->generatePayload($resp, $respCharset);
 
         if ($returnPayload) {
             return $payload;
         }
 
-        // if we get a warning/error that has output some text before here, then we cannot
-        // add a new header. We cannot say we are sending xml, either...
-        if (!headers_sent()) {
-            header('Content-Type: ' . $resp->getContentType());
-            // we do not know if client actually told us an accepted charset, but if it did we have to tell it what we did
-            header("Vary: Accept-Charset");
-
-            // http compression of output: only if we can do it, and we want to do it, and client asked us to,
-            // and php ini settings do not force it already
-            $phpNoSelfCompress = !ini_get('zlib.output_compression') && (ini_get('output_handler') != 'ob_gzhandler');
-            if ($this->compress_response && $respEncoding != '' && $phpNoSelfCompress) {
-                if (strpos($respEncoding, 'gzip') !== false && function_exists('gzencode')) {
-                    $payload = gzencode($payload);
-                    header("Content-Encoding: gzip");
-                    header("Vary: Accept-Encoding");
-                } elseif (strpos($respEncoding, 'deflate') !== false && function_exists('gzcompress')) {
-                    $payload = gzcompress($payload);
-                    header("Content-Encoding: deflate");
-                    header("Vary: Accept-Encoding");
-                }
-            }
-
-            // Do not output content-length header if php is compressing output for us: it will mess up measurements.
-            // Note that Apache/mod_php will add (and even alter!) the Content-Length header on its own, but only for
-            // responses up to 8000 bytes
-            if ($phpNoSelfCompress) {
-                header('Content-Length: ' . (int)strlen($payload));
-            }
-        } else {
-            /// @todo allow the user to easily subclass this in a way which allows the resp. headers to be already sent
-            ///       by now without flagging it as an error. Possibly check for presence of Content-Type header
-            $this->getLogger()->error('XML-RPC: ' . __METHOD__ . ': http headers already sent before response is fully generated. Check for php warning or error messages');
-        }
-
-        print $payload;
+        $this->printPayload($payload, $resp->getContentType(), $respEncoding);
 
         // return response, in case subclasses want it
         return $resp;
@@ -673,7 +627,7 @@ protected function parseRequestHeaders(&$data, &$reqEncoding, &$respEncoding, &$
      * @return Response
      * @throws \Exception in case the executed method does throw an exception (and depending on server configuration)
      *
-     * @todo either rename this function or move the 'execute' part out of it...
+     * @todo either rename this function or, probably better, move the 'execute' part out of it...
      */
     public function parseRequest($data, $reqEncoding = '')
     {
@@ -968,6 +922,74 @@ protected function execute($req, $params = null, $paramTypes = null)
         return $r;
     }
 
+    /**
+     * @param Response $resp
+     * @param string $respCharset
+     * @return string
+     */
+    protected function generatePayload($resp, $respCharset)
+    {
+        $header = $resp->xml_header($respCharset);
+        if ($this->debug > 0) {
+            $header .= $this->serializeDebug($respCharset);
+        }
+
+        // Do not create response serialization if it has already happened. Helps to build json magic
+        /// @todo what if the payload was created targeting a different charset than $respCharset?
+        ///       Also, if we do not call serialize(), the request will not set its content-type to have the charset declared
+        $payload = $resp->getPayload();
+        if (empty($payload)) {
+            $payload = $resp->serialize($respCharset);
+        }
+
+        return $header . $payload;
+    }
+
+    /**
+     * @param string $payload
+     * @param string $respContentType
+     * @param string $respEncoding
+     * @return void
+     */
+    protected function printPayload($payload, $respContentType, $respEncoding)
+    {
+        // if we get a warning/error that has output some text before here, then we cannot
+        // add a new header. We cannot say we are sending xml, either...
+        if (!headers_sent()) {
+            header('Content-Type: ' . $respContentType);
+            // we do not know if client actually told us an accepted charset, but if it did we have to tell it what we did
+            header("Vary: Accept-Charset");
+
+            // http compression of output: only if we can do it, and we want to do it, and client asked us to,
+            // and php ini settings do not force it already
+            $phpNoSelfCompress = !ini_get('zlib.output_compression') && (ini_get('output_handler') != 'ob_gzhandler');
+            if ($this->compress_response && $respEncoding != '' && $phpNoSelfCompress) {
+                if (strpos($respEncoding, 'gzip') !== false && function_exists('gzencode')) {
+                    $payload = gzencode($payload);
+                    header("Content-Encoding: gzip");
+                    header("Vary: Accept-Encoding");
+                } elseif (strpos($respEncoding, 'deflate') !== false && function_exists('gzcompress')) {
+                    $payload = gzcompress($payload);
+                    header("Content-Encoding: deflate");
+                    header("Vary: Accept-Encoding");
+                }
+            }
+
+            // Do not output content-length header if php is compressing output for us: it will mess up measurements.
+            // Note that Apache/mod_php will add (and even alter!) the Content-Length header on its own, but only for
+            // responses up to 8000 bytes
+            if ($phpNoSelfCompress) {
+                header('Content-Length: ' . (int)strlen($payload));
+            }
+        } else {
+            /// @todo allow the user to easily subclass this in a way which allows the resp. headers to be already sent
+            ///       by now without flagging it as an error. Possibly check for presence of Content-Type header
+            $this->getLogger()->error('XML-RPC: ' . __METHOD__ . ': http headers already sent before response is fully generated. Check for php warning or error messages');
+        }
+
+        print $payload;
+    }
+
     /**
      * Registered as callback for when the XMLParser has found the name of the method to execute.
      * Handling that early allows to 1. stop parsing the rest of the xml if there is no such method registered, and