<!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>[38694] trunk: HTTP API: Add a `$component` parameter to `wp_parse_url()` to give it parity with PHP's `parse_url()` function.</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 { 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/38694">38694</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/38694","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>johnbillion</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2016-09-30 21:46:43 +0000 (Fri, 30 Sep 2016)</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'>HTTP API: Add a `$component` parameter to `wp_parse_url()` to give it parity with PHP's `parse_url()` function.
Fixes <a href="https://core.trac.wordpress.org/ticket/36356">#36356</a>
Props jrf</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludeshttpphp">trunk/src/wp-includes/http.php</a></li>
<li><a href="#trunktestsphpunittestshttphttpphp">trunk/tests/phpunit/tests/http/http.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludeshttpphp"></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/http.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/http.php 2016-09-30 21:42:01 UTC (rev 38693)
+++ trunk/src/wp-includes/http.php 2016-09-30 21:46:43 UTC (rev 38694)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -633,35 +633,68 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * when URL parsing failed.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.4.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.7.0 The $component parameter was added for parity with PHP's parse_url().
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $url The URL to parse.
- * @return bool|array False on failure; Array of URL components on success;
- * See parse_url()'s return values.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $url The URL to parse.
+ * @param int $component The specific component to retrieve. Use one of the PHP
+ * predefined constants to specify which one.
+ * Defaults to -1 (= return all parts as an array).
+ * @see http://php.net/manual/en/function.parse-url.php
+ * @return mixed False on failure; Array of URL components on success;
+ * When a specific component has been requested: null if the component doesn't
+ * exist in the given URL; a sting or - in the case of PHP_URL_PORT - integer
+ * when it does; See parse_url()'s return values.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function wp_parse_url( $url ) {
- $parts = @parse_url( $url );
- if ( ! $parts ) {
- // < PHP 5.4.7 compat, trouble with relative paths including a scheme break in the path
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function wp_parse_url( $url, $component = -1 ) {
+ $parts = @parse_url( $url, $component );
+
+ if ( version_compare( PHP_VERSION, '5.4.7', '>=' ) ) {
+ return $parts;
+ }
+
+ if ( false === $parts ) {
+ // < PHP 5.4.7 compat, trouble with relative paths including a scheme break in the path.
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( '/' == $url[0] && false !== strpos( $url, '://' ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Since we know it's a relative path, prefix with a scheme/host placeholder and try again
- if ( ! $parts = @parse_url( 'placeholder://placeholder' . $url ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( in_array( $component, array( PHP_URL_SCHEME, PHP_URL_HOST ), true ) ) {
+ return null;
+ }
+ // Since we know it's a relative path, prefix with a scheme/host placeholder and try again.
+ if ( ! $parts = @parse_url( 'placeholder://placeholder' . $url, $component ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> return $parts;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Remove the placeholder values
- unset( $parts['scheme'], $parts['host'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Remove the placeholder values.
+ if ( -1 === $component ) {
+ unset( $parts['scheme'], $parts['host'] );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> return $parts;
</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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // < PHP 5.4.7 compat, doesn't detect schemeless URL's host field
- if ( '//' == substr( $url, 0, 2 ) && ! isset( $parts['host'] ) ) {
- $path_parts = explode( '/', substr( $parts['path'], 2 ), 2 );
- $parts['host'] = $path_parts[0];
- if ( isset( $path_parts[1] ) ) {
- $parts['path'] = '/' . $path_parts[1];
- } else {
- unset( $parts['path'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // < PHP 5.4.7 compat, doesn't detect a schemeless URL's host field.
+ if ( '//' == substr( $url, 0, 2 ) ) {
+ if ( -1 === $component && ! isset( $parts['host'] ) ) {
+ $path_parts = explode( '/', substr( $parts['path'], 2 ), 2 );
+ $parts['host'] = $path_parts[0];
+ if ( isset( $path_parts[1] ) ) {
+ $parts['path'] = '/' . $path_parts[1];
+ } else {
+ unset( $parts['path'] );
+ }
+ } elseif ( PHP_URL_HOST === $component || PHP_URL_PATH === $component ) {
+ $all_parts = @parse_url( $url );
+ if ( ! isset( $all_parts['host'] ) ) {
+ $path_parts = explode( '/', substr( $all_parts['path'], 2 ), 2 );
+ if ( PHP_URL_PATH === $component ) {
+ if ( isset( $path_parts[1] ) ) {
+ $parts = '/' . $path_parts[1];
+ } else {
+ $parts = null;
+ }
+ } elseif ( PHP_URL_HOST === $component ) {
+ $parts = $path_parts[0];
+ }
+ }
</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></span></pre></div>
<a id="trunktestsphpunittestshttphttpphp"></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/http/http.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/http/http.php 2016-09-30 21:42:01 UTC (rev 38693)
+++ trunk/tests/phpunit/tests/http/http.php 2016-09-30 21:46:43 UTC (rev 38694)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -6,6 +6,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> class Tests_HTTP_HTTP extends WP_UnitTestCase {
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ const FULL_TEST_URL = 'http://username:password@host.name:9090/path?arg1=value1&arg2=value2#anchor';
+
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * @dataProvider make_absolute_url_testcases
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -78,6 +80,16 @@
</span><span class="cx" style="display: block; padding: 0 10px"> function parse_url_testcases() {
</span><span class="cx" style="display: block; padding: 0 10px"> // 0: The URL, 1: The expected resulting structure
</span><span class="cx" style="display: block; padding: 0 10px"> return array(
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ array( self::FULL_TEST_URL, array(
+ 'scheme' => 'http',
+ 'host' => 'host.name',
+ 'port' => 9090,
+ 'user' => 'username',
+ 'pass' => 'password',
+ 'path' => '/path',
+ 'query' => 'arg1=value1&arg2=value2',
+ 'fragment' => 'anchor',
+ ) ),
</ins><span class="cx" style="display: block; padding: 0 10px"> array( 'http://example.com/', array( 'scheme' => 'http', 'host' => 'example.com', 'path' => '/' ) ),
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // < PHP 5.4.7: Schemeless URL
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -85,7 +97,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> array( '//example.com/', array( 'host' => 'example.com', 'path' => '/' ) ),
</span><span class="cx" style="display: block; padding: 0 10px"> array( 'http://example.com//path/', array( 'scheme' => 'http', 'host' => 'example.com', 'path' => '//path/' ) ),
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // < PHP 5.4.7: Scheme seperator in the URL
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // < PHP 5.4.7: Scheme separator in the URL.
</ins><span class="cx" style="display: block; padding: 0 10px"> array( 'http://example.com/http://example.net/', array( 'scheme' => 'http', 'host' => 'example.com', 'path' => '/http://example.net/' ) ),
</span><span class="cx" style="display: block; padding: 0 10px"> array( '/path/http://example.net/', array( 'path' => '/path/http://example.net/' ) ),
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -104,6 +116,69 @@
</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">+ * @ticket 36356
+ */
+ function test_wp_parse_url_with_default_component() {
+ $actual = wp_parse_url( self::FULL_TEST_URL, -1 );
+ $this->assertEquals( array(
+ 'scheme' => 'http',
+ 'host' => 'host.name',
+ 'port' => 9090,
+ 'user' => 'username',
+ 'pass' => 'password',
+ 'path' => '/path',
+ 'query' => 'arg1=value1&arg2=value2',
+ 'fragment' => 'anchor',
+ ), $actual );
+ }
+
+ /**
+ * @ticket 36356
+ *
+ * @dataProvider parse_url_component_testcases
+ */
+ function test_wp_parse_url_with_component( $url, $component, $expected ) {
+ $actual = wp_parse_url( $url, $component );
+ $this->assertSame( $expected, $actual );
+ }
+
+ function parse_url_component_testcases() {
+ // 0: The URL, 1: The requested component, 2: The expected resulting structure.
+ return array(
+ array( self::FULL_TEST_URL, PHP_URL_SCHEME, 'http' ),
+ array( self::FULL_TEST_URL, PHP_URL_USER, 'username' ),
+ array( self::FULL_TEST_URL, PHP_URL_PASS, 'password' ),
+ array( self::FULL_TEST_URL, PHP_URL_HOST, 'host.name' ),
+ array( self::FULL_TEST_URL, PHP_URL_PORT, 9090 ),
+ array( self::FULL_TEST_URL, PHP_URL_PATH, '/path' ),
+ array( self::FULL_TEST_URL, PHP_URL_QUERY, 'arg1=value1&arg2=value2' ),
+ array( self::FULL_TEST_URL, PHP_URL_FRAGMENT, 'anchor' ),
+
+ // < PHP 5.4.7: Schemeless URL.
+ array( '//example.com/path/', PHP_URL_HOST, 'example.com' ),
+ array( '//example.com/path/', PHP_URL_PATH, '/path/' ),
+ array( '//example.com/', PHP_URL_HOST, 'example.com' ),
+ array( '//example.com/', PHP_URL_PATH, '/' ),
+ array( 'http://example.com//path/', PHP_URL_HOST, 'example.com' ),
+ array( 'http://example.com//path/', PHP_URL_PATH, '//path/' ),
+
+ // < PHP 5.4.7: Scheme separator in the URL.
+ array( 'http://example.com/http://example.net/', PHP_URL_HOST, 'example.com' ),
+ array( 'http://example.com/http://example.net/', PHP_URL_PATH, '/http://example.net/' ),
+ array( '/path/http://example.net/', PHP_URL_HOST, null ),
+ array( '/path/http://example.net/', PHP_URL_PATH, '/path/http://example.net/' ),
+
+ // < PHP 5.4.7: IPv6 literals in schemeless URLs are handled incorrectly.
+ array( '//[::FFFF::127.0.0.1]/', PHP_URL_HOST, '[::FFFF::127.0.0.1]' ),
+ array( '//[::FFFF::127.0.0.1]/', PHP_URL_PATH, '/' ),
+
+ // PHP's parse_url() calls this an invalid URL, we handle it as a path.
+ array( '/://example.com/', PHP_URL_PATH, '/://example.com/' ),
+
+ );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * @ticket 35426
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_http_response_code_constants() {
</span></span></pre>
</div>
</div>
</body>
</html>