<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[50954] trunk: XML-RPC: Set HTTP status code in accordance with the spec.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/50954">50954</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/50954","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>peterwilsoncc</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2021-05-24 02:17:36 +0000 (Mon, 24 May 2021)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>XML-RPC: Set HTTP status code in accordance with the spec.
When the XML-RPC endpoint is enabled, always return a HTTP `200 OK` status code in accordance with the XML-RPC specification. Continue to return an HTTP `405 Method Not Allowed` status code when the endpoint is disabled.
Props ariskataoka, johnbillion.
Fixes <a href="https://core.trac.wordpress.org/ticket/52958">#52958</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesIXRclassIXRserverphp">trunk/src/wp-includes/IXR/class-IXR-server.php</a></li>
<li><a href="#trunksrcwpincludesclasswpxmlrpcserverphp">trunk/src/wp-includes/class-wp-xmlrpc-server.php</a></li>
<li><a href="#trunktestsphpunittestsxmlrpcbasicphp">trunk/tests/phpunit/tests/xmlrpc/basic.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesIXRclassIXRserverphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/IXR/class-IXR-server.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/IXR/class-IXR-server.php 2021-05-23 08:50:44 UTC (rev 50953)
+++ trunk/src/wp-includes/IXR/class-IXR-server.php 2021-05-24 02:17:36 UTC (rev 50954)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -130,10 +130,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $error = new IXR_Error($error, $message);
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( function_exists( 'status_header' ) ) {
- status_header( $error->code );
- }
-
</del><span class="cx" style="display: block; padding: 0 10px"> $this->output($error->getXml());
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunksrcwpincludesclasswpxmlrpcserverphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/class-wp-xmlrpc-server.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-xmlrpc-server.php 2021-05-23 08:50:44 UTC (rev 50953)
+++ trunk/src/wp-includes/class-wp-xmlrpc-server.php 2021-05-24 02:17:36 UTC (rev 50954)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -14,7 +14,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * options, etc.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * As of WordPress 3.5.0, XML-RPC is enabled by default. It can be disabled
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * via the {@see 'xmlrpc_enabled'} filter found in wp_xmlrpc_server::login().
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * via the {@see 'xmlrpc_enabled'} filter found in wp_xmlrpc_server::set_is_enabled().
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 1.5.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -50,6 +50,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> protected $auth_failed = false;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Flags that XML-RPC is enabled
+ *
+ * @var bool
+ */
+ private $is_enabled;
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Registers all of the XMLRPC methods that XMLRPC server understands.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Sets up server and method property. Passes XMLRPC
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -164,9 +171,54 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string[] $methods An array of XML-RPC methods, keyed by their methodName.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> $this->methods = apply_filters( 'xmlrpc_methods', $this->methods );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ $this->set_is_enabled();
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Set wp_xmlrpc_server::$is_enabled property.
+ *
+ * Determine whether the xmlrpc server is enabled on this WordPress install
+ * and set the is_enabled property accordingly.
+ *
+ * @since 5.7.3
+ */
+ private function set_is_enabled() {
+ /*
+ * Respect old get_option() filters left for back-compat when the 'enable_xmlrpc'
+ * option was deprecated in 3.5.0. Use the 'xmlrpc_enabled' hook instead.
+ */
+ $is_enabled = apply_filters( 'pre_option_enable_xmlrpc', false );
+ if ( false === $is_enabled ) {
+ $is_enabled = apply_filters( 'option_enable_xmlrpc', true );
+ }
+
+ /**
+ * Filters whether XML-RPC methods requiring authentication are enabled.
+ *
+ * Contrary to the way it's named, this filter does not control whether XML-RPC is *fully*
+ * enabled, rather, it only controls whether XML-RPC methods requiring authentication - such
+ * as for publishing purposes - are enabled.
+ *
+ * Further, the filter does not control whether pingbacks or other custom endpoints that don't
+ * require authentication are enabled. This behavior is expected, and due to how parity was matched
+ * with the `enable_xmlrpc` UI option the filter replaced when it was introduced in 3.5.
+ *
+ * To disable XML-RPC methods that require authentication, use:
+ *
+ * add_filter( 'xmlrpc_enabled', '__return_false' );
+ *
+ * For more granular control over all XML-RPC methods and requests, see the {@see 'xmlrpc_methods'}
+ * and {@see 'xmlrpc_element_limit'} hooks.
+ *
+ * @since 3.5.0
+ *
+ * @param bool $is_enabled Whether XML-RPC is enabled. Default true.
+ */
+ $this->is_enabled = apply_filters( 'xmlrpc_enabled', $is_enabled );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Make private/protected methods readable for backward compatibility.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.0.0
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -231,40 +283,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @return WP_User|false WP_User object if authentication passed, false otherwise
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function login( $username, $password ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- /*
- * Respect old get_option() filters left for back-compat when the 'enable_xmlrpc'
- * option was deprecated in 3.5.0. Use the 'xmlrpc_enabled' hook instead.
- */
- $enabled = apply_filters( 'pre_option_enable_xmlrpc', false );
- if ( false === $enabled ) {
- $enabled = apply_filters( 'option_enable_xmlrpc', true );
- }
-
- /**
- * Filters whether XML-RPC methods requiring authentication are enabled.
- *
- * Contrary to the way it's named, this filter does not control whether XML-RPC is *fully*
- * enabled, rather, it only controls whether XML-RPC methods requiring authentication - such
- * as for publishing purposes - are enabled.
- *
- * Further, the filter does not control whether pingbacks or other custom endpoints that don't
- * require authentication are enabled. This behavior is expected, and due to how parity was matched
- * with the `enable_xmlrpc` UI option the filter replaced when it was introduced in 3.5.
- *
- * To disable XML-RPC methods that require authentication, use:
- *
- * add_filter( 'xmlrpc_enabled', '__return_false' );
- *
- * For more granular control over all XML-RPC methods and requests, see the {@see 'xmlrpc_methods'}
- * and {@see 'xmlrpc_element_limit'} hooks.
- *
- * @since 3.5.0
- *
- * @param bool $enabled Whether XML-RPC is enabled. Default true.
- */
- $enabled = apply_filters( 'xmlrpc_enabled', $enabled );
-
- if ( ! $enabled ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! $this->is_enabled ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->error = new IXR_Error( 405, sprintf( __( 'XML-RPC services are disabled on this site.' ) ) );
</span><span class="cx" style="display: block; padding: 0 10px"> return false;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -336,6 +355,30 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Send error response to client.
+ *
+ * Send an XML error response to the client. If the endpoint is enabled
+ * an HTTP 200 response is always sent per the XML-RPC specification.
+ *
+ * @since 5.7.3
+ *
+ * @param IXR_Error|string $error Error code or an error object.
+ * @param false $message Error message. Optional.
+ */
+ public function error( $error, $message = false ) {
+ // Accepts either an error object or an error code and message
+ if ( $message && ! is_object( $error ) ) {
+ $error = new IXR_Error( $error, $message );
+ }
+
+ if ( ! $this->is_enabled ) {
+ status_header( $error->code );
+ }
+
+ $this->output( $error->getXml() );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Retrieve custom fields for post.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.5.0
</span></span></pre></div>
<a id="trunktestsphpunittestsxmlrpcbasicphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/xmlrpc/basic.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/xmlrpc/basic.php 2021-05-23 08:50:44 UTC (rev 50953)
+++ trunk/tests/phpunit/tests/xmlrpc/basic.php 2021-05-24 02:17:36 UTC (rev 50954)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -16,17 +16,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( 403, $result->code );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- function test_disabled() {
- add_filter( 'xmlrpc_enabled', '__return_false' );
-
- $result = $this->myxmlrpcserver->wp_getOptions( array( 1, 'username', 'password' ) );
-
- $this->assertIXRError( $result );
- $this->assertSame( 405, $result->code );
- }
-
</del><span class="cx" style="display: block; padding: 0 10px"> function test_login_pass_ok() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $user_id = $this->make_user_by_role( 'subscriber' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->make_user_by_role( 'subscriber' );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertTrue( $this->myxmlrpcserver->login_pass_ok( 'subscriber', 'subscriber' ) );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertInstanceOf( 'WP_User', $this->myxmlrpcserver->login( 'subscriber', 'subscriber' ) );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -33,7 +24,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> function test_login_pass_bad() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $user_id = $this->make_user_by_role( 'subscriber' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->make_user_by_role( 'subscriber' );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertFalse( $this->myxmlrpcserver->login_pass_ok( 'username', 'password' ) );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertFalse( $this->myxmlrpcserver->login( 'username', 'password' ) );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -117,4 +108,13 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertXmlStringEqualsXmlString( $return, $value->getXML() );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ function test_disabled() {
+ add_filter( 'xmlrpc_enabled', '__return_false' );
+ $testcase_xmlrpc_server = new wp_xmlrpc_server();
+ $result = $testcase_xmlrpc_server->wp_getOptions( array( 1, 'username', 'password' ) );
+
+ $this->assertIXRError( $result );
+ $this->assertSame( 405, $result->code );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>