<!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][5985] trunk/bp-core/bp-core-catchuri.php: Some canonical URL reconfiguration:</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, #logmsg > ol { margin-left: 0; 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">
<dt>Revision</dt> <dd><a href="http://buddypress.trac.wordpress.org/changeset/5985">5985</a></dd>
<dt>Author</dt> <dd>boonebgorges</dd>
<dt>Date</dt> <dd>2012-04-13 14:00:50 +0000 (Fri, 13 Apr 2012)</dd>
</dl>
<h3>Log Message</h3>
<pre>Some canonical URL reconfiguration:
- Introduces bp_get_canonical_url() and bp_get_requested_url(), to abstract some commonly used canonical logic
- Provides an easy way for plugins to access the current canonical URL, using bp_get_canonical_url(). Fixes <a href="http://buddypress.trac.wordpress.org/ticket/4141">#4141</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkbpcorebpcorecatchuriphp">trunk/bp-core/bp-core-catchuri.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkbpcorebpcorecatchuriphp"></a>
<div class="modfile"><h4>Modified: trunk/bp-core/bp-core-catchuri.php (5984 => 5985)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-core/bp-core-catchuri.php 2012-04-13 13:36:25 UTC (rev 5984)
+++ trunk/bp-core/bp-core-catchuri.php 2012-04-13 14:00:50 UTC (rev 5985)
</span><span class="lines">@@ -530,6 +530,8 @@
</span><span class="cx"> * @see BP_Members_Component::setup_globals() where $bp->canonical_stack['base_url'] and
</span><span class="cx"> * ['component'] may be set
</span><span class="cx"> * @see bp_core_new_nav_item() where $bp->canonical_stack['action'] may be set
</span><ins>+ * @uses bp_get_canonical_url()
+ * @uses bp_get_requested_url()
</ins><span class="cx"> */
</span><span class="cx"> function bp_redirect_canonical() {
</span><span class="cx"> global $bp;
</span><span class="lines">@@ -544,38 +546,17 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> // build the URL in the address bar
</span><del>- $requested_url = is_ssl() ? 'https://' : 'http://';
- $requested_url .= $_SERVER['HTTP_HOST'];
- $requested_url .= $_SERVER['REQUEST_URI'];
</del><ins>+ $requested_url = bp_get_requested_url();
</ins><span class="cx">
</span><span class="cx"> // Stash query args
</span><span class="cx"> $url_stack = explode( '?', $requested_url );
</span><span class="cx"> $req_url_clean = $url_stack[0];
</span><ins>+ $query_args = isset( $url_stack[1] ) ? $url_stack[1] : '';
</ins><span class="cx">
</span><del>- // Build the canonical URL out of the redirect stack
- if ( isset( $bp->canonical_stack['base_url'] ) ) {
- $url_stack[0] = $bp->canonical_stack['base_url'];
- }
</del><ins>+ $canonical_url = bp_get_canonical_url();
</ins><span class="cx">
</span><del>- if ( isset( $bp->canonical_stack['component'] ) ) {
- $url_stack[0] = trailingslashit( $url_stack[0] . $bp->canonical_stack['component'] );
- }
-
- if ( isset( $bp->canonical_stack['action'] ) ) {
- $url_stack[0] = trailingslashit( $url_stack[0] . $bp->canonical_stack['action'] );
- }
-
- if ( !empty( $bp->canonical_stack['action_variables'] ) ) {
- foreach( (array) $bp->canonical_stack['action_variables'] as $av ) {
- $url_stack[0] = trailingslashit( $url_stack[0] . $av );
- }
- }
-
- // Add trailing slash
- $url_stack[0] = trailingslashit( $url_stack[0] );
-
</del><span class="cx"> // Only redirect if we've assembled a URL different from the request
</span><del>- if ( $url_stack[0] !== $req_url_clean ) {
</del><ins>+ if ( $canonical_url !== $req_url_clean ) {
</ins><span class="cx">
</span><span class="cx"> // Template messages have been deleted from the cookie by this point, so
</span><span class="cx"> // they must be readded before redirecting
</span><span class="lines">@@ -586,7 +567,11 @@
</span><span class="cx"> bp_core_add_message( $message, $message_type );
</span><span class="cx"> }
</span><span class="cx">
</span><del>- bp_core_redirect( implode( '?', $url_stack ), 301 );
</del><ins>+ if ( !empty( $query_args ) ) {
+ $canonical_url .= '?' . $query_args;
+ }
+
+ bp_core_redirect( $canonical_url, 301 );
</ins><span class="cx"> }
</span><span class="cx"> }
</span><span class="cx"> }
</span><span class="lines">@@ -597,37 +582,91 @@
</span><span class="cx"> * @since 1.6
</span><span class="cx"> */
</span><span class="cx"> function bp_rel_canonical() {
</span><del>- // Build the URL in the address bar
- $requested_url = is_ssl() ? 'https://' : 'http://';
- $requested_url .= $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'];
</del><ins>+ $canonical_url = bp_get_canonical_url();
</ins><span class="cx">
</span><del>- // Stash query args
- $url_stack = explode( '?', $requested_url );
</del><ins>+ // Output rel=canonical tag
+ echo "<link rel='canonical' href='" . esc_attr( $canonical_url ) . "' />\n";
+}
</ins><span class="cx">
</span><del>- // Build the canonical URL out of the redirect stack
- if ( isset( $bp->canonical_stack['base_url'] ) )
- $url_stack[0] = $bp->canonical_stack['base_url'];
</del><ins>+/**
+ * Returns the canonical URL of the current page
+ *
+ * @since BuddyPress (1.6)
+ * @uses apply_filters() Filter bp_get_canonical_url to modify return value
+ * @param array $args
+ * @return string
+ */
+function bp_get_canonical_url( $args = array() ) {
+ global $bp;
</ins><span class="cx">
</span><del>- if ( isset( $bp->canonical_stack['component'] ) )
- $url_stack[0] = trailingslashit( $url_stack[0] . $bp->canonical_stack['component'] );
</del><ins>+ // For non-BP content, return the requested url, and let WP do the work
+ if ( bp_is_blog_page() ) {
+ return bp_get_requested_url();
+ }
</ins><span class="cx">
</span><del>- if ( isset( $bp->canonical_stack['action'] ) )
- $url_stack[0] = trailingslashit( $url_stack[0] . $bp->canonical_stack['action'] );
</del><ins>+ $defaults = array(
+ 'include_query_args' => false // Include URL arguments, eg ?foo=bar&foo2=bar2
+ );
+ $r = wp_parse_args( $args, $defaults );
+ extract( $r );
</ins><span class="cx">
</span><del>- if ( !empty( $bp->canonical_stack['action_variables'] ) ) {
- foreach( (array) $bp->canonical_stack['action_variables'] as $av ) {
- $url_stack[0] = trailingslashit( $url_stack[0] . $av );
</del><ins>+ if ( empty( $bp->canonical_stack['canonical_url'] ) ) {
+ // Build the URL in the address bar
+ $requested_url = bp_get_requested_url();
+
+ // Stash query args
+ $url_stack = explode( '?', $requested_url );
+
+ // Build the canonical URL out of the redirect stack
+ if ( isset( $bp->canonical_stack['base_url'] ) )
+ $url_stack[0] = $bp->canonical_stack['base_url'];
+
+ if ( isset( $bp->canonical_stack['component'] ) )
+ $url_stack[0] = trailingslashit( $url_stack[0] . $bp->canonical_stack['component'] );
+
+ if ( isset( $bp->canonical_stack['action'] ) )
+ $url_stack[0] = trailingslashit( $url_stack[0] . $bp->canonical_stack['action'] );
+
+ if ( !empty( $bp->canonical_stack['action_variables'] ) ) {
+ foreach( (array) $bp->canonical_stack['action_variables'] as $av ) {
+ $url_stack[0] = trailingslashit( $url_stack[0] . $av );
+ }
</ins><span class="cx"> }
</span><ins>+
+ // Add trailing slash
+ $url_stack[0] = trailingslashit( $url_stack[0] );
+
+ // Stash in the $bp global
+ $bp->canonical_stack['canonical_url'] = implode( '?', $url_stack );
</ins><span class="cx"> }
</span><span class="cx">
</span><del>- // Add trailing slash
- $url_stack[0] = trailingslashit( $url_stack[0] );
</del><ins>+ $canonical_url = $bp->canonical_stack['canonical_url'];
</ins><span class="cx">
</span><del>- // Output rel=canonical tag
- echo "<link rel='canonical' href='" . esc_attr( $url_stack[0] ) . "' />\n";
</del><ins>+ if ( !$include_query_args ) {
+ $canonical_url = array_pop( array_reverse( explode( '?', $canonical_url ) ) );
+ }
+
+ return apply_filters( 'bp_get_canonical_url', $canonical_url, $args );
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><ins>+ * Returns the URL as requested on the current page load by the user agent
+ *
+ * @since BuddyPress (1.6)
+ * @return string
+ */
+function bp_get_requested_url() {
+ global $bp;
+
+ if ( empty( $bp->canonical_stack['requested_url'] ) ) {
+ $bp->canonical_stack['requested_url'] = is_ssl() ? 'https://' : 'http://';
+ $bp->canonical_stack['requested_url'] .= $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'];
+ }
+
+ return $bp->canonical_stack['requested_url'];
+}
+
+/**
</ins><span class="cx"> * Remove WordPress's really awesome canonical redirect if we are trying to load
</span><span class="cx"> * BuddyPress specific content. Avoids issues with WordPress thinking that a
</span><span class="cx"> * BuddyPress URL might actually be a blog post or page.
</span></span></pre>
</div>
</div>
</body>
</html>