Changeset 13461 for trunk/src/bp-core/bp-core-catchuri.php

Timestamp:

04/24/2023 02:32:27 AM (3 years ago)

Author:

imath

Message:

Make canonical redirection & Ajax requesting BP Rewrites ready

• Introduces bp_core_setup_query_parser() to decide when to postpone some key hooks firing to bp_parse_query.
• Introduces bp_core_get_query_parser() to get the query parser in use. It contains a filter BP Classic will be able to use to force the Legacy URL parser. So far it uses legacy for pretty links and rewrites for plain links.
• Edit bp_redirect_canonical() & bp_get_canonical_url() so that they use the BP Rewrites API.
• Introduces bp_core_set_ajax_uri_globals() to set the BuddyPress URI globales using the BP Rewrites API inside the Ajax context thanks to the updated bp_reset_query() function.
• To avoid using WP() at each Ajax call, introduces a simple Ajax actions registration process thanks to the new bp_ajax_register_action().
• Update Legacy & Nouveau template packs so that they use this logic. As BP Default will require the legacy URL parser and will be moved inside BP Classic, the theme can stay the way it is.
• Improve the bp_rewrites_pre_get_slug filter logic making it depends on the bp_core_get_query_parser() function.
• Make sure to reset the Members navigation to a new BP_Core_Nav based on the displayed user once the user is available in the component's parse_query() method.

Props r-a-y, johnjamesjacoby, boonebgorges

Closes ​https://github.com/buddypress/buddypress/pull/91
See #4954

File:

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

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

@@ -386 +386 @@
         // Reset the keys by merging with an empty array.
         $bp->action_variables = array_merge( array(), $bp->action_variables );
+}
+
+/**
+ * Sets BuddyPress globals for Ajax requests using the BP Rewrites API.
+ *
+ * @since 12.0.0
+ */
+function bp_core_set_ajax_uri_globals() {
+        if ( ! wp_doing_ajax() || 'rewrites' !== bp_core_get_query_parser() ) {
+                return;
+        }
+
+        $action = '';
+        if ( isset( $_REQUEST['action'] ) ) {
+                $action = wp_unslash( sanitize_text_field( $_REQUEST['action'] ) );
+        }
+
+        // Only set BuddyPress URI globals for registered Ajax actions.
+        if ( ! bp_ajax_action_is_registered( $action ) ) {
+                return;
+        }
+
+        bp_reset_query( bp_get_referer_path(), $GLOBALS['wp_query'] );
 }
 
@@ -808 +831 @@
          * @param bool $value Whether or not to do canonical redirects. Default true.
          */
-        if ( !bp_is_blog_page() && apply_filters( 'bp_do_redirect_canonical', true ) ) {
+        if ( ! bp_is_blog_page() && apply_filters( 'bp_do_redirect_canonical', true ) ) {
                 // If this is a POST request, don't do a canonical redirect.
                 // This is for backward compatibility with plugins that submit form requests to
                 // non-canonical URLs. Plugin authors should do their best to use canonical URLs in
                 // their form actions.
-                if ( !empty( $_POST ) ) {
+                if ( ! empty( $_POST ) ) {
                         return;
                 }
@@ -819 +842 @@
                 // Build the URL in the address bar.
                 $requested_url  = bp_get_requested_url();
+                $query_args     = '';
 
                 // Stash query args.
-                $url_stack      = explode( '?', $requested_url );
-                $req_url_clean  = $url_stack[0];
-                $query_args     = isset( $url_stack[1] ) ? $url_stack[1] : '';
-
-                $canonical_url  = bp_get_canonical_url();
+                if ( bp_has_pretty_urls() ) {
+                        $query_args    = wp_parse_url( $requested_url, PHP_URL_QUERY );
+                        $req_url_clean = str_replace( '?' . $query_args, '', $requested_url );
+                } else {
+                        $req_url_clean = $requested_url;
+                }
+
+                $canonical_url = bp_get_canonical_url();
 
                 // Only redirect if we've assembled a URL different from the request.
-                if ( $canonical_url !== $req_url_clean ) {
-
+                if ( esc_url( $canonical_url ) !== esc_url( $req_url_clean ) ) {
                         $bp = buddypress();
 
@@ -841 +867 @@
                         }
 
-                        if ( !empty( $query_args ) ) {
+                        if ( ! empty( $query_args ) ) {
                                 $canonical_url .= '?' . $query_args;
                         }
@@ -891 +917 @@
                 $defaults
         );
-
-        extract( $r );
 
         // Special case: when a BuddyPress directory (eg example.com/members)
@@ -929 +953 @@
                 // Build the URL in the address bar.
                 $requested_url  = bp_get_requested_url();
-
-                // Stash query args.
-                $url_stack      = explode( '?', $requested_url );
+                $base_url       = '';
+                $path_chunks    = array();
+                $component_id   = '';
+
+                // Get query args.
+                $query_string = wp_parse_url( $requested_url, PHP_URL_QUERY );
+                $query_args   = wp_parse_args( $query_string, array() );
 
                 // 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 );
+                if ( isset( $bp->canonical_stack['base_url'] ) ) {
+                        $base_url = $bp->canonical_stack['base_url'];
+                } else {
+                        $base_url = $requested_url;
+
+                        if ( bp_has_pretty_urls() ) {
+                                $base_url = str_replace( '?' . $query_string, '', $requested_url );
+                        }
+                }
+
+                // This is a BP Members URL.
+                if ( isset( $bp->canonical_stack['component'] ) ) {
+                        $component_id  = 'members';
+                        $path_chunks[] = $bp->canonical_stack['component'];
+
+                        if ( $query_args ) {
+                                $query_args = array_diff_key(
+                                        $query_args,
+                                        array_fill_keys(
+                                                array( 'bp_members', 'bp_member', 'bp_member_component' ),
+                                                true
+                                        )
+                                );
+                        }
+                } else {
+                        $component_id = 'groups';
+                }
+
+                if ( isset( $bp->canonical_stack['action'] ) ) {
+                        $path_chunks[]        = $bp->canonical_stack['action'];
+                        $action_key           = 'bp_member_action';
+                        $action_variables_key = 'bp_member_action_variables';
+
+                        if ( 'groups' === $component_id ) {
+                                $action_key           = 'bp_group_action';
+                                $action_variables_key = 'bp_group_action_variables';
+                        }
+
+                        if ( ! empty( $bp->canonical_stack['action_variables'] ) ) {
+                                $path_chunks = array_merge( $path_chunks, (array) $bp->canonical_stack['action_variables'] );
+                        } elseif ( isset( $query_args[ $action_variables_key ] ) ) {
+                                unset( $query_args[ $action_variables_key ] );
+                        }
+
+                        if ( $query_args ) {
+                                $query_args = array_diff_key(
+                                        $query_args,
+                                        array_fill_keys(
+                                                array( $action_key, $action_variables_key ),
+                                                true
+                                        )
+                                );
+                        }
+                } elseif ( isset( $query_args['bp_member_action'] ) && 'members' === $component_id ) {
+                        unset( $query_args['bp_member_action'] );
+                } elseif( isset( $query_args['bp_group_action'] ) && 'groups' === $component_id ) {
+                        unset( $query_args['bp_group_action'] );
+                }
+
+                if ( $path_chunks ) {
+                        if ( 'groups' === $component_id ) {
+                                $bp->canonical_stack['canonical_url'] = bp_get_group_url(
+                                        groups_get_current_group(),
+                                        bp_groups_get_path_chunks( $path_chunks )
+                                );
+                        } else {
+                                $bp->canonical_stack['canonical_url'] = bp_displayed_user_url( bp_members_get_path_chunks( $path_chunks ) );
+                        }
+                } else {
+                        $bp->canonical_stack['canonical_url'] = $base_url;
+                }
         }
 
         $canonical_url = $bp->canonical_stack['canonical_url'];
 
-        if ( !$include_query_args ) {
-                $canonical_url = array_reverse( explode( '?', $canonical_url ) );
-                $canonical_url = array_pop( $canonical_url );
+        if ( $r['include_query_args'] && $query_args ) {
+                $canonical_url = add_query_arg( $query_args, $canonical_url );
         }
 
@@ -1014 +1092 @@
                 remove_action( 'template_redirect', 'redirect_canonical' );
 }
-add_action( 'bp_init', '_bp_maybe_remove_redirect_canonical' );
 
 /**