Changeset 11923

Timestamp:

04/01/2018 11:30:48 PM (6 years ago)

Author:

r-a-y

Message:

Groups: Conditionally load action and screen functions.

This commit conditionally loads action and screen function code for the
Groups component, utilizing the 'bp_late_include' hook introduced in
r11884.

Previously, we loaded these functions at all times, which is unnecessary
when a user is not on a BuddyPress groups page. Now, we only load this code
when needed.

See #7218.

Location:

trunk

Files:

• src/bp-groups/actions (added)
• src/bp-groups/actions/access.php (added)
• src/bp-groups/actions/create.php (moved) (moved from trunk/src/bp-groups/bp-groups-actions.php) (3 diffs)
• src/bp-groups/actions/feed.php (added)
• src/bp-groups/actions/join.php (added)
• src/bp-groups/actions/leave-group.php (added)
• src/bp-groups/actions/random.php (added)
• src/bp-groups/bp-groups-screens.php (deleted)
• src/bp-groups/classes/class-bp-groups-component.php (modified) (2 diffs)
• src/bp-groups/screens (added)
• src/bp-groups/screens/directory.php (added)
• src/bp-groups/screens/single (added)
• src/bp-groups/screens/single/activity-permalink.php (added)
• src/bp-groups/screens/single/activity.php (added)
• src/bp-groups/screens/single/admin (added)
• src/bp-groups/screens/single/admin.php (added)
• src/bp-groups/screens/single/admin/delete-group.php (added)
• src/bp-groups/screens/single/admin/edit-details.php (added)
• src/bp-groups/screens/single/admin/group-avatar.php (added)
• src/bp-groups/screens/single/admin/group-cover-image.php (added)
• src/bp-groups/screens/single/admin/group-settings.php (added)
• src/bp-groups/screens/single/admin/manage-members.php (added)
• src/bp-groups/screens/single/admin/membership-requests.php (added)
• src/bp-groups/screens/single/home.php (added)
• src/bp-groups/screens/single/invites.php (added)
• src/bp-groups/screens/single/members.php (added)
• src/bp-groups/screens/single/request-membership.php (added)
• src/bp-groups/screens/user (added)
• src/bp-groups/screens/user/invites.php (added)
• src/bp-groups/screens/user/my-groups.php (added)
• src/bp-groups/screens/user/settings-email.php (added)
• tests/phpunit/includes/loader.php (modified) (1 diff)

trunk/src/bp-groups/actions/create.php

@@ -1 +1 @@
 <?php
 /**
- * BuddyPress Groups Actions.
- *
- * Action functions are exactly the same as screen functions, however they do
- * not have a template screen associated with them. Usually they will send the
- * user back to the default screen after execution.
+ * Groups: Create action
  *
  * @package BuddyPress
- * @subpackage GroupsActions
- * @since 1.5.0
+ * @subpackage GroupActions
+ * @since 3.0.0
  */
-
-// Exit if accessed directly.
-defined( 'ABSPATH' ) || exit;
-
-/**
- * Protect access to single groups.
- *
- * @since 2.1.0
- */
-function bp_groups_group_access_protection() {
-    if ( ! bp_is_group() ) {
-        return;
-    }
-
-    $current_group   = groups_get_current_group();
-    $user_has_access = $current_group->user_has_access;
-    $is_visible      = $current_group->is_visible;
-    $no_access_args  = array();
-
-    // The user can know about the group but doesn't have full access.
-    if ( ! $user_has_access && $is_visible ) {
-        // Always allow access to home and request-membership.
-        if ( bp_is_current_action( 'home' ) || bp_is_current_action( 'request-membership' ) ) {
-            $user_has_access = true;
-
-        // User doesn't have access, so set up redirect args.
-        } elseif ( is_user_logged_in() ) {
-            $no_access_args = array(
-                'message'  => __( 'You do not have access to this group.', 'buddypress' ),
-                'root'     => bp_get_group_permalink( $current_group ) . 'home/',
-                'redirect' => false
-            );
-        }
-    }
-
-    // Protect the admin tab from non-admins.
-    if ( bp_is_current_action( 'admin' ) && ! bp_is_item_admin() ) {
-        $user_has_access = false;
-        $no_access_args  = array(
-            'message'  => __( 'You are not an admin of this group.', 'buddypress' ),
-            'root'     => bp_get_group_permalink( $current_group ),
-            'redirect' => false
-        );
-    }
-
-    /**
-     * Allow plugins to filter whether the current user has access to this group content.
-     *
-     * Note that if a plugin sets $user_has_access to false, it may also
-     * want to change the $no_access_args, to avoid problems such as
-     * logged-in users being redirected to wp-login.php.
-     *
-     * @since 2.1.0
-     *
-     * @param bool  $user_has_access True if the user has access to the
-     *                               content, otherwise false.
-     * @param array $no_access_args  Arguments to be passed to bp_core_no_access() in case
-     *                               of no access. Note that this value is passed by reference,
-     *                               so it can be modified by the filter callback.
-     */
-    $user_has_access = apply_filters_ref_array( 'bp_group_user_has_access', array( $user_has_access, &$no_access_args ) );
-
-    // If user has access, we return rather than redirect.
-    if ( $user_has_access ) {
-        return;
-    }
-
-    // Groups that the user cannot know about should return a 404 for non-members.
-    // Unset the current group so that you're not redirected
-    // to the default group tab.
-    if ( ! $is_visible ) {
-        buddypress()->groups->current_group = 0;
-        buddypress()->is_single_item        = false;
-        bp_do_404();
-        return;
-    } else {
-        bp_core_no_access( $no_access_args );
-    }
-
-}
-add_action( 'bp_actions', 'bp_groups_group_access_protection' );
 
 /**
@@ -385 +300 @@
 
 /**
- * Catch and process "Join Group" button clicks.
- *
- * @since 1.0.0
- *
- * @return bool
- */
-function groups_action_join_group() {
-
-    if ( !bp_is_single_item() || !bp_is_groups_component() || !bp_is_current_action( 'join' ) )
-        return false;
-
-    // Nonce check.
-    if ( !check_admin_referer( 'groups_join_group' ) )
-        return false;
-
-    $bp = buddypress();
-
-    // Skip if banned or already a member.
-    if ( !groups_is_user_member( bp_loggedin_user_id(), $bp->groups->current_group->id ) && !groups_is_user_banned( bp_loggedin_user_id(), $bp->groups->current_group->id ) ) {
-
-        // User wants to join a group that is not public.
-        if ( bp_current_user_can( 'groups_join_group', array( 'group_id' => $bp->groups->current_group->id ) ) ) {
-            if ( !groups_check_user_has_invite( bp_loggedin_user_id(), $bp->groups->current_group->id ) ) {
-                bp_core_add_message( __( 'There was an error joining the group.', 'buddypress' ), 'error' );
-                bp_core_redirect( bp_get_group_permalink( $bp->groups->current_group ) );
-            }
-        }
-
-        // User wants to join any group.
-        if ( !groups_join_group( $bp->groups->current_group->id ) )
-            bp_core_add_message( __( 'There was an error joining the group.', 'buddypress' ), 'error' );
-        else
-            bp_core_add_message( __( 'You joined the group!', 'buddypress' ) );
-
-        bp_core_redirect( bp_get_group_permalink( $bp->groups->current_group ) );
-    }
-
-    /**
-     * Filters the template to load for the single group screen.
-     *
-     * @since 1.0.0
-     *
-     * @param string $value Path to the single group template to load.
-     */
-    bp_core_load_template( apply_filters( 'groups_template_group_home', 'groups/single/home' ) );
-}
-add_action( 'bp_actions', 'groups_action_join_group' );
-
-/**
- * Catch and process "Leave Group" button clicks.
- *
- * When a group member clicks on the "Leave Group" button from a group's page,
- * this function is run.
- *
- * Note: When leaving a group from the group directory, AJAX is used and
- * another function handles this. See {@link bp_legacy_theme_ajax_joinleave_group()}.
- *
- * @since 1.2.4
- *
- * @return bool
- */
-function groups_action_leave_group() {
-    if ( ! bp_is_single_item() || ! bp_is_groups_component() || ! bp_is_current_action( 'leave-group' ) ) {
-        return false;
-    }
-
-    // Nonce check.
-    if ( ! check_admin_referer( 'groups_leave_group' ) ) {
-        return false;
-    }
-
-    // User wants to leave any group.
-    if ( groups_is_user_member( bp_loggedin_user_id(), bp_get_current_group_id() ) ) {
-        $bp = buddypress();
-
-        // Stop sole admins from abandoning their group.
-        $group_admins = groups_get_group_admins( bp_get_current_group_id() );
-
-        if ( 1 == count( $group_admins ) && $group_admins[0]->user_id == bp_loggedin_user_id() ) {
-            bp_core_add_message( __( 'This group must have at least one admin', 'buddypress' ), 'error' );
-        } elseif ( ! groups_leave_group( $bp->groups->current_group->id ) ) {
-            bp_core_add_message( __( 'There was an error leaving the group.', 'buddypress' ), 'error' );
-        } else {
-            bp_core_add_message( __( 'You successfully left the group.', 'buddypress' ) );
-        }
-
-        $group = groups_get_current_group();
-        $redirect = bp_get_group_permalink( $group );
-
-        if ( ! $group->is_visible ) {
-            $redirect = trailingslashit( bp_loggedin_user_domain() . bp_get_groups_slug() );
-        }
-
-        bp_core_redirect( $redirect );
-    }
-
-    /** This filter is documented in bp-groups/bp-groups-actions.php */
-    bp_core_load_template( apply_filters( 'groups_template_group_home', 'groups/single/home' ) );
-}
-add_action( 'bp_actions', 'groups_action_leave_group' );
-
-/**
  * Sort the group creation steps.
  *
@@ -524 +337 @@
     do_action( 'groups_action_sort_creation_steps' );
 }
-
-/**
- * Catch requests for a random group page (example.com/groups/?random-group) and redirect.
- *
- * @since 1.2.0
- */
-function groups_action_redirect_to_random_group() {
-
-    if ( bp_is_groups_component() && isset( $_GET['random-group'] ) ) {
-        $group = BP_Groups_Group::get_random( 1, 1 );
-
-        bp_core_redirect( trailingslashit( bp_get_groups_directory_permalink() . $group['groups'][0]->slug ) );
-    }
-}
-add_action( 'bp_actions', 'groups_action_redirect_to_random_group' );
-
-/**
- * Load the activity feed for the current group.
- *
- * @since 1.2.0
- *
- * @return false|null False on failure.
- */
-function groups_action_group_feed() {
-
-    // Get current group.
-    $group = groups_get_current_group();
-
-    if ( ! bp_is_active( 'activity' ) || ! bp_is_groups_component() || ! $group || ! bp_is_current_action( 'feed' ) )
-        return false;
-
-    // If group isn't public or if logged-in user is not a member of the group, do
-    // not output the group activity feed.
-    if ( ! bp_group_is_visible( $group ) ) {
-        return false;
-    }
-
-    // Set up the feed.
-    buddypress()->activity->feed = new BP_Activity_Feed( array(
-        'id'            => 'group',
-
-        /* translators: Group activity RSS title - "[Site Name] | [Group Name] | Activity" */
-        'title'         => sprintf( __( '%1$s | %2$s | Activity', 'buddypress' ), bp_get_site_name(), bp_get_current_group_name() ),
-
-        'link'          => bp_get_group_permalink( $group ),
-        'description'   => sprintf( __( "Activity feed for the group, %s.", 'buddypress' ), bp_get_current_group_name() ),
-        'activity_args' => array(
-            'object'           => buddypress()->groups->id,
-            'primary_id'       => bp_get_current_group_id(),
-            'display_comments' => 'threaded'
-        )
-    ) );
-}
-add_action( 'bp_actions', 'groups_action_group_feed' );

trunk/src/bp-groups/classes/class-bp-groups-component.php

@@ -124 +124 @@
         $includes = array(
             'cache',
-            'actions',
             'filters',
-            'screens',
             'widgets',
             'activity',
@@ -140 +138 @@
 
         parent::includes( $includes );
+    }
+
+    /**
+     * Late includes method.
+     *
+     * Only load up certain code when on specific pages.
+     *
+     * @since 3.0.0
+     */
+    public function late_includes() {
+        // Bail if PHPUnit is running.
+        if ( defined( 'BP_TESTS_DIR' ) ) {
+            return;
+        }
+
+        if ( bp_is_groups_component() ) {
+            // Authenticated actions.
+            if ( is_user_logged_in() &&
+                in_array( bp_current_action(), array( 'create', 'join', 'leave-group' ), true )
+            ) {
+                require $this->path . 'bp-groups/actions/' . bp_current_action() . '.php';
+            }
+
+            // Actions - RSS feed handler.
+            if ( bp_is_active( 'activity' ) && bp_is_current_action( 'feed' ) ) {
+                require $this->path . 'bp-groups/actions/feed.php';
+            }
+
+            // Actions - Random group handler.
+            if ( isset( $_GET['random-group'] ) ) {
+                require $this->path . 'bp-groups/actions/random.php';
+            }
+
+            // Screens - Directory.
+            if ( bp_is_groups_directory() ) {
+                require $this->path . 'bp-groups/screens/directory.php';
+            }
+
+            // Screens - User profile integration.
+            if ( bp_is_user() ) {
+                require $this->path . 'bp-groups/screens/user/my-groups.php';
+
+                if ( bp_is_current_action( 'invites' ) ) {
+                    require $this->path . 'bp-groups/screens/user/invites.php';
+                }
+            }
+
+            // Single group.
+            if ( bp_is_group() ) {
+                // Actions - Access protection.
+                require $this->path . 'bp-groups/actions/access.php';
+
+                // Public nav items.
+                if ( in_array( bp_current_action(), array( 'home', 'request-membership', 'activity', 'members', 'send-invites' ), true ) ) {
+                    require $this->path . 'bp-groups/screens/single/' . bp_current_action() . '.php';
+                }
+
+                // Admin nav items.
+                if ( bp_is_item_admin() && is_user_logged_in() ) {
+                    require $this->path . 'bp-groups/screens/single/admin.php';
+
+                    if ( in_array( bp_get_group_current_admin_tab(), array( 'edit-details', 'group-settings', 'group-avatar', 'group-cover-image', 'manage-members', 'membership-requests', 'delete-group' ), true ) ) {
+                        require $this->path . 'bp-groups/screens/single/admin/' . bp_get_group_current_admin_tab() . '.php';
+                    }
+                }
+            }
+
+            // Theme compatibility.
+            new BP_Groups_Theme_Compat();
+        }
+
+        // Groups notifications HTML table.
+        if ( bp_is_user_settings_notifications() ) {
+            require $this->path . 'bp-groups/screens/user/settings-email.php';
+        }
     }
 

trunk/tests/phpunit/includes/loader.php

@@ -19 +19 @@
 
 /**
- * Load up activity action and screen code.
+ * Load up component action and screen code.
  *
  * In BuddyPress, this is loaded conditionally, but PHPUnit needs all files
  * loaded at the same time to prevent weird load order issues.
  */
-add_action( 'bp_activity_includes', function() {
-    $dirs = array(
-        buddypress()->plugin_dir . 'bp-activity/actions/',
-        buddypress()->plugin_dir . 'bp-activity/screens/',
-    );
+$components = array( 'activity', 'groups' );
+foreach ( $components as $component ) {
+    add_action( "bp_{$component}_includes", function() use ( $component ) {
+        $dirs = array(
+            buddypress()->plugin_dir . 'bp-' . $component . '/actions/',
+            buddypress()->plugin_dir . 'bp-' . $component . '/screens/',
+        );
 
-    foreach ( $dirs as $dir ) {
-        foreach ( glob( $dir . "*.php" ) as $file ) {
-            require $file;
+        foreach ( $dirs as $dir ) {
+            foreach ( glob( $dir . "*.php" ) as $file ) {
+                require $file;
+            }
         }
-    }
-} );
+    } );
+}