Changeset 5412

Timestamp:

11/29/2011 08:58:28 PM (13 years ago)

Author:

boonebgorges

Message:

Refactors URL canonicalization logic, moving it into the single bp_redirect_canonical() which is loaded from bp_core_load_template() instead of redirecting during the nav setup routine. See #1741. Combines all canonicalization into a single redirect. Fixes #3771. Ensures that query strings are preserved on redirects. Fixes #3777.

Location:

trunk

Files:

• bp-core/bp-core-buddybar.php (modified) (2 diffs)
• bp-core/bp-core-catchuri.php (modified) (2 diffs)
• bp-core/bp-core-functions.php (modified) (1 diff)
• bp-groups/bp-groups-loader.php (modified) (1 diff)
• bp-members/bp-members-loader.php (modified) (1 diff)

trunk/bp-core/bp-core-buddybar.php

@@ -71 +71 @@
 
         if ( !empty( $default_subnav_slug ) ) {
-            /**
-             * BuddyPress will attempt to resolve to the most specific URL possible,
-             * to avoid search-engine-unfriendly content reduplication. Filter
-             * bp_guarantee_unique_uris (and return false) to avoid this behavior
-             */
-            if ( apply_filters( 'bp_guarantee_unique_uris', true ) ) {
-                bp_core_redirect( bp_displayed_user_domain() . $slug . '/' . apply_filters( 'bp_default_component_subnav', $default_subnav_slug, $r ) );
-            } else {
-                 $bp->current_action = apply_filters( 'bp_default_component_subnav', $default_subnav_slug, $r );
-            }
+            $bp->current_action           = apply_filters( 'bp_default_component_subnav', $default_subnav_slug, $r );
+            $bp->redirect_stack['action'] = $bp->current_action;
         }
 
@@ -91 +83 @@
 
         if ( !empty( $default_subnav_slug ) ) {
-            /**
-             * BuddyPress will attempt to resolve to the most specific URL possible,
-             * to avoid search-engine-unfriendly content reduplication. Filter
-             * bp_guarantee_unique_uris (and return false) to avoid this behavior
-             */
-            if ( apply_filters( 'bp_guarantee_unique_uris', true ) ) {
-                bp_core_redirect( bp_get_root_domain() . '/' . bp_get_root_slug( bp_current_component() ) . '/' . $slug . '/' . apply_filters( 'bp_default_component_subnav', $default_subnav_slug, $r ) );
-            } else {
-                $bp->current_action = apply_filters( 'bp_default_component_subnav', $default_subnav_slug, $r );
-            }
+            $bp->current_action           = apply_filters( 'bp_default_component_subnav', $default_subnav_slug, $r );
+            $bp->redirect_stack['action'] = $bp->current_action;
         }
     }

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

@@ -368 +368 @@
         $post                        = $wp_query->queried_object;
     }
-
+    
     // Define local variables
     $located_template   = false;
@@ -386 +386 @@
         $wp_query->is_404  = false;
 
+        do_action( 'bp_core_pre_load_template', $located_template );
+
         load_template( apply_filters( 'bp_load_template', $located_template ) );
+    
+        do_action( 'bp_core_post_load_template', $located_template );
     }
 

trunk/bp-core/bp-core-functions.php

@@ -1601 +1601 @@
         remove_action( 'template_redirect', 'redirect_canonical' );
 }
+
+/**
+ * Canonicalizes BuddyPress URLs
+ *
+ * This function ensures that requests for BuddyPress content are always redirected to their
+ * most specific, trailingslashed versions.
+ *
+ * @since 1.6
+ * @see BP_Members_Component::setup_globals() where $bp->redirect_stack['base_url'] and
+ *   ['component'] may be set
+ * @see bp_core_new_nav_item() where $bp->redirect_stack['action'] may be set
+ */
+function bp_redirect_canonical() {
+    global $bp;
+    
+    if ( !bp_is_blog_page() && apply_filters( 'bp_do_redirect_canonical', true ) ) {
+        // build the URL in the address bar
+        $requested_url  = is_ssl() ? 'https://' : 'http://';
+        $requested_url .= $_SERVER['HTTP_HOST'];
+        $requested_url .= $_SERVER['REQUEST_URI'];
+        
+        // Stash query args
+        $url_stack      = explode( '?', $requested_url );
+        $req_url_clean  = $url_stack[0];
+        
+        // Process the redirect stack
+        if ( isset( $bp->redirect_stack['base_url'] ) ) {
+            $url_stack[0] = $bp->redirect_stack['base_url'];
+        }
+                
+        if ( isset( $bp->redirect_stack['component'] ) ) {
+            $url_stack[0] = trailingslashit( $url_stack[0] . $bp->redirect_stack['component'] );
+        }
+                
+        if ( isset( $bp->redirect_stack['action'] ) ) {
+            $url_stack[0] = trailingslashit( $url_stack[0] . $bp->redirect_stack['action'] );
+        }
+                    
+        if ( !empty( $bp->redirect_stack['action_variables'] ) ) {
+            foreach( (array)$bp->redirect_stack['action_variables'] as $av ) {
+                $url_stack[0] = trailingslashit( $url_stack[0] . $av ); 
+            }
+        }
+        
+        // Add trailing slash
+        $url_stack[0] = trailingslashit( $url_stack[0] );
+        
+        // Only redirect if we've assembled a URL different from the request
+        if ( $url_stack[0] !== $req_url_clean ) {
+            bp_core_redirect( implode( '?', $url_stack ) );
+        }
+    }
+}
+add_action( 'bp_core_pre_load_template', 'bp_redirect_canonical' );
 ?>

trunk/bp-groups/bp-groups-loader.php

@@ -165 +165 @@
         
         if ( bp_is_groups_component() && !empty( $this->current_group ) && !bp_current_action() ) {
-            $bp->current_action = apply_filters( 'bp_groups_default_extension', defined( 'BP_GROUPS_DEFAULT_EXTENSION' ) ? BP_GROUPS_DEFAULT_EXTENSION : 'home' );
+            $bp->current_action              = apply_filters( 'bp_groups_default_extension', defined( 'BP_GROUPS_DEFAULT_EXTENSION' ) ? BP_GROUPS_DEFAULT_EXTENSION : 'home' );
+            
+            // Prepare for a redirect to the canonical URL
+            $bp->redirect_stack['base_url']  = bp_get_group_permalink( $this->current_group );
+            $bp->redirect_stack['action']    = $bp->current_action;
         }
 

trunk/bp-members/bp-members-loader.php

@@ -116 +116 @@
 
         if ( !bp_current_component() && bp_displayed_user_id() ) {
-            /**
-             * BuddyPress will attempt to resolve to the most specific URL possible,
-             * to avoid search-engine-unfriendly content reduplication. Filter
-             * bp_guarantee_unique_uris (and return false) to avoid this behavior
-             */
-            if ( apply_filters( 'bp_guarantee_unique_uris', true ) ) {
-                bp_core_redirect( bp_displayed_user_domain() . $bp->default_component );
-            } else {
-                $bp->current_component = $bp->default_component;
-            }
+            $bp->current_component       = $bp->default_component;
+            
+            // Prepare for a redirect to the canonical URL
+            $bp->redirect_stack['base_url']  = bp_displayed_user_domain();
+            $bp->redirect_stack['component'] = $bp->default_component;
         }
     }