Changeset 5985 for trunk/bp-core/bp-core-catchuri.php

Timestamp:

04/13/2012 02:00:50 PM (12 years ago)

Author:

boonebgorges

Message:

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 #4141

File:

• trunk/bp-core/bp-core-catchuri.php (modified) (4 diffs)

trunk/bp-core/bp-core-catchuri.php

@@ -531 +531 @@
  *   ['component'] may be set
  * @see bp_core_new_nav_item() where $bp->canonical_stack['action'] may be set
+ * @uses bp_get_canonical_url()
+ * @uses bp_get_requested_url()
  */
 function bp_redirect_canonical() {
@@ -545 +547 @@
 
         // build the URL in the address bar
-        $requested_url  = is_ssl() ? 'https://' : 'http://';
-        $requested_url .= $_SERVER['HTTP_HOST'];
-        $requested_url .= $_SERVER['REQUEST_URI'];
+        $requested_url  = bp_get_requested_url();
 
         // Stash query args
         $url_stack      = explode( '?', $requested_url );
         $req_url_clean  = $url_stack[0];
-
-        // 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 );
-            }
-        }
-
-        // Add trailing slash
-        $url_stack[0] = trailingslashit( $url_stack[0] );
+        $query_args     = isset( $url_stack[1] ) ? $url_stack[1] : '';
+
+        $canonical_url  = bp_get_canonical_url();
 
         // Only redirect if we've assembled a URL different from the request
-        if ( $url_stack[0] !== $req_url_clean ) {
+        if ( $canonical_url !== $req_url_clean ) {
 
             // Template messages have been deleted from the cookie by this point, so
@@ -587 +568 @@
             }
 
-            bp_core_redirect( implode( '?', $url_stack ), 301 );
+            if ( !empty( $query_args ) ) {
+                $canonical_url .= '?' . $query_args;
+            }
+
+            bp_core_redirect( $canonical_url, 301 );
         }
     }
@@ -598 +583 @@
  */
 function bp_rel_canonical() {
-    // Build the URL in the address bar
-    $requested_url  = is_ssl() ? 'https://' : 'http://';
-    $requested_url .= $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'];
-
-    // 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 );
-        }
-    }
-
-    // Add trailing slash
-    $url_stack[0] = trailingslashit( $url_stack[0] );
+    $canonical_url = bp_get_canonical_url();
 
     // Output rel=canonical tag
-    echo "<link rel='canonical' href='" . esc_attr( $url_stack[0] ) . "' />\n";
+    echo "<link rel='canonical' href='" . esc_attr( $canonical_url ) . "' />\n";
+}
+
+/**
+ * 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;
+
+    // For non-BP content, return the requested url, and let WP do the work
+    if ( bp_is_blog_page() ) {
+        return bp_get_requested_url();
+    }
+
+    $defaults = array(
+        'include_query_args' => false // Include URL arguments, eg ?foo=bar&foo2=bar2
+    );
+    $r = wp_parse_args( $args, $defaults );
+    extract( $r );
+
+    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 );
+            }
+        }
+
+        // Add trailing slash
+        $url_stack[0] = trailingslashit( $url_stack[0] );
+
+        // Stash in the $bp global
+        $bp->canonical_stack['canonical_url'] = implode( '?', $url_stack );
+    }
+
+    $canonical_url = $bp->canonical_stack['canonical_url'];
+
+    if ( !$include_query_args ) {
+        $canonical_url = array_pop( array_reverse( explode( '?', $canonical_url ) ) );
+    }
+
+    return apply_filters( 'bp_get_canonical_url', $canonical_url, $args );
+}
+
+/**
+ * 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'];
 }