<!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>[BuddyPress][9559] trunk: Improve AJAX referer determination during URI parsing.</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="http://buddypress.trac.wordpress.org/changeset/9559">9559</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://buddypress.trac.wordpress.org/changeset/9559","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>boonebgorges</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2015-02-25 14:56:18 +0000 (Wed, 25 Feb 2015)</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'>Improve AJAX referer determination during URI parsing.
When parsing referer URLs during `bp_core_set_uri_globals()`, BP has
historically used `bp_core_referrer()` to generate a "current URL" relative to
the current web root. This path is then passed to the 'bp_uri' filter before
being parsed. However, `bp_core_referrer()` incorrectly returns a URL without
a leading slash, making it a relative path rather than a webroot-absolute path.
The parsing logic later in `bp_core_set_uri_globals()` makes it so that the
error does not matter from the point of BP core, but plugins filtering 'bp_uri'
will receive a potentially incorrect URL path.
This changeset deprecates the unreliable `bp_core_referrer()` in favor of
`bp_get_referer_path()`. The latter function correctly returns URL paths with a
leading slash. `bp_get_referer_path()` is then used instead of
`bp_core_referrer()` in `bp_core_set_uri_globals()`.
Props mechter for an initial patch.
Fixes <a href="http://buddypress.trac.wordpress.org/ticket/6252">#6252</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpcorebpcorecatchuriphp">trunk/src/bp-core/bp-core-catchuri.php</a></li>
<li><a href="#trunksrcbpcorebpcorefunctionsphp">trunk/src/bp-core/bp-core-functions.php</a></li>
<li><a href="#trunksrcbploaderphp">trunk/src/bp-loader.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunksrcbpcoredeprecated23php">trunk/src/bp-core/deprecated/2.3.php</a></li>
<li>trunk/tests/phpunit/testcases/core/functions/</li>
<li><a href="#trunktestsphpunittestcasescorefunctionsbpGetRefererPathphp">trunk/tests/phpunit/testcases/core/functions/bpGetRefererPath.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpcorebpcorecatchuriphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-core/bp-core-catchuri.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-core/bp-core-catchuri.php 2015-02-25 14:46:50 UTC (rev 9558)
+++ trunk/src/bp-core/bp-core-catchuri.php 2015-02-25 14:56:18 UTC (rev 9559)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -51,7 +51,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Ajax or not?
</span><span class="cx" style="display: block; padding: 0 10px"> if ( defined( 'DOING_AJAX' ) && DOING_AJAX || strpos( $_SERVER['REQUEST_URI'], 'wp-load.php' ) )
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $path = bp_core_referrer();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $path = bp_get_referer_path();
</ins><span class="cx" style="display: block; padding: 0 10px"> else
</span><span class="cx" style="display: block; padding: 0 10px"> $path = esc_url( $_SERVER['REQUEST_URI'] );
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunksrcbpcorebpcorefunctionsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-core/bp-core-functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-core/bp-core-functions.php 2015-02-25 14:46:50 UTC (rev 9558)
+++ trunk/src/bp-core/bp-core-functions.php 2015-02-25 14:56:18 UTC (rev 9559)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -835,14 +835,27 @@
</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">- * Return the referrer URL without the http(s)://
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Return the URL path of the referring page.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return string The referrer URL.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * This is a wrapper for `wp_get_referer()` that sanitizes the referer URL to
+ * a webroot-relative path. For example, 'http://example.com/foo/' will be
+ * reduced to '/foo/'.
+ *
+ * @since BuddyPress (2.3.0)
+ *
+ * @return bool|string Returns false on error, a URL path on success.
</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 bp_core_referrer() {
- $referer = explode( '/', wp_get_referer() );
- unset( $referer[0], $referer[1], $referer[2] );
- return implode( '/', $referer );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function bp_get_referer_path() {
+ $referer = wp_get_referer();
+
+ if ( false === $referer ) {
+ return false;
+ }
+
+ // Turn into an absolute path.
+ $referer = preg_replace( '|https?\://[^/]+/|', '/', $referer );
+
+ return $referer;
</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="trunksrcbpcoredeprecated23php"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/src/bp-core/deprecated/2.3.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-core/deprecated/2.3.php (rev 0)
+++ trunk/src/bp-core/deprecated/2.3.php 2015-02-25 14:56:18 UTC (rev 9559)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,24 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+/**
+ * Deprecated functions.
+ *
+ * @deprecated 2.3.0
+ */
+
+// Exit if accessed directly.
+defined( 'ABSPATH' ) || exit;
+
+/**
+ * Return the referrer URL without the http(s)://
+ *
+ * @deprecated BuddyPress (2.3.0)
+ *
+ * @return string The referrer URL.
+ */
+function bp_core_referrer() {
+ _deprecated_function( __FUNCTION__, '2.3.0', 'bp_get_referer_path()' );
+ $referer = explode( '/', wp_get_referer() );
+ unset( $referer[0], $referer[1], $referer[2] );
+ return implode( '/', $referer );
+}
+
</ins></span></pre></div>
<a id="trunksrcbploaderphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-loader.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-loader.php 2015-02-25 14:46:50 UTC (rev 9558)
+++ trunk/src/bp-loader.php 2015-02-25 14:56:18 UTC (rev 9559)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -461,6 +461,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> require( $this->plugin_dir . 'bp-core/deprecated/2.0.php' );
</span><span class="cx" style="display: block; padding: 0 10px"> require( $this->plugin_dir . 'bp-core/deprecated/2.1.php' );
</span><span class="cx" style="display: block; padding: 0 10px"> require( $this->plugin_dir . 'bp-core/deprecated/2.2.php' );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ require( $this->plugin_dir . 'bp-core/deprecated/2.3.php' );
</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="trunktestsphpunittestcasescorefunctionsbpGetRefererPathphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/tests/phpunit/testcases/core/functions/bpGetRefererPath.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/testcases/core/functions/bpGetRefererPath.php (rev 0)
+++ trunk/tests/phpunit/testcases/core/functions/bpGetRefererPath.php 2015-02-25 14:56:18 UTC (rev 9559)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,79 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+
+/**
+ * @group core
+ * @group functions
+ * @group bp_get_referer_path
+ */
+class BP_Tests_Core_Functions_BPGetRefererPath extends BP_UnitTestCase {
+ private $_wp_http_referer = '';
+ private $http_referer = '';
+
+ public function setUp() {
+ parent::setUp();
+
+ $this->_wp_http_referer = '';
+ $this->http_referer = '';
+
+ if ( isset( $_REQUEST['_wp_http_referer'] ) ) {
+ $this->_wp_http_referer = $_REQUEST['_wp_http_referer'];
+ }
+
+ if ( isset( $_SERVER['HTTP_REFERER'] ) ) {
+ $this->http_referer = $_SERVER['HTTP_REFERER'];
+ }
+ }
+
+ public function tearDown() {
+ if ( isset( $_REQUEST['_wp_http_referer'] ) ) {
+ unset( $_REQUEST['_wp_http_referer'] );
+ }
+
+ if ( isset( $_SERVER['HTTP_REFERER'] ) ) {
+ unset( $_SERVER['HTTP_REFERER'] );
+ }
+
+ if ( $this->_wp_http_referer ) {
+ $_REQUEST['_wp_http_referer'] = $this->_wp_http_referer;
+ }
+
+ if ( $this->http_referer ) {
+ $_SERVER['HTTP_REFERER'] = $this->http_referer;
+ }
+
+ parent::tearDown();
+ }
+
+ public function test_from__wp_http_referer_fully_qualified_uri() {
+ $home = get_option( 'home' );
+ $_REQUEST['_wp_http_referer'] = trailingslashit( $home ) . 'foo/';
+ $found = bp_get_referer_path();
+ $this->assertSame( '/foo/', bp_get_referer_path() );
+ }
+
+ public function test_from__wp_http_referer_absolute_path() {
+ $_REQUEST['_wp_http_referer'] = '/foo/';
+ $found = bp_get_referer_path();
+ $this->assertSame( '/foo/', bp_get_referer_path() );
+ }
+
+ public function test_from_server_request_uri_fully_qualified_uri() {
+ $home = get_option( 'home' );
+ $_SERVER['HTTP_REFERER'] = trailingslashit( $home ) . 'foo/';
+ $found = bp_get_referer_path();
+ $this->assertSame( '/foo/', bp_get_referer_path() );
+ }
+
+ public function test_from_server_request_uri_absolute_path() {
+ $_SERVER['HTTP_REFERER'] = '/foo/';
+ $found = bp_get_referer_path();
+ $this->assertSame( '/foo/', bp_get_referer_path() );
+ }
+
+ public function test__wp_http_referer_should_take_precedence_over_server_superglobal() {
+ $_SERVER['HTTP_REFERER'] = '/foo/';
+ $_REQUEST['_wp_http_referer'] = '/bar/';
+ $found = bp_get_referer_path();
+ $this->assertSame( '/bar/', bp_get_referer_path() );
+ }
+}
</ins></span></pre>
</div>
</div>
</body>
</html>