Changeset 13533

Timestamp:

07/28/2023 04:15:24 PM (2 months ago)

Author:

dcavins

Message:

Introduce basic community visibility feature.

Site admins now have the option to restrict access to the
community portion of a BuddyPress site. If the site admin
chooses "members only," then, when a non-logged-in
user attempts to visit a BuddyPress screen, she will
be shown an access error message and a log-in form.

Props imath, sbrajesh, jjj, shawfactor.

Fixes #8734.

Location:

trunk

Files:

• src/bp-core/admin/bp-core-admin-settings.php (modified) (1 diff)
• src/bp-core/bp-core-functions.php (modified) (1 diff)
• src/bp-core/bp-core-options.php (modified) (1 diff)
• src/bp-core/bp-core-update.php (modified) (1 diff)
• src/bp-core/classes/class-bp-admin.php (modified) (1 diff)
• src/bp-core/classes/class-bp-component.php (modified) (2 diffs)
• src/bp-templates/bp-legacy/buddypress/assets/utils (added)
• src/bp-templates/bp-legacy/buddypress/assets/utils/restricted-access-message.php (added)
• src/bp-templates/bp-nouveau/buddypress/assets/utils (added)
• src/bp-templates/bp-nouveau/buddypress/assets/utils/restricted-access-message.php (added)
• tests/phpunit/testcases/core/community-visibility.php (added)

trunk/src/bp-core/admin/bp-core-admin-settings.php

@@ -46 +46 @@
 
 <?php
+}
+
+/**
+ * Choose whether the community is visible to anyone or only to members.
+ *
+ * @since 12.0.0
+ */
+function bp_admin_setting_callback_community_visibility() {
+    $visibility = bp_get_community_visibility( 'all' );
+?>
+    <select name="_bp_community_visibility[global]" id="_bp_community_visibility-global" aria-describedby="_bp_community_visibility_description" autocomplete="off">
+        <option value="anyone" <?php echo selected( $visibility['global'], 'anyone' ); ?>><?php esc_html_e( 'Anyone', 'buddypress' ); ?></option>
+        <option value="members" <?php echo selected( $visibility['global'], 'members' ); ?>><?php esc_html_e( 'Members Only', 'buddypress' ); ?></option>
+    </select>
+
+    <p id="_bp_community_visibility_description" class="description"><?php esc_html_e( 'Choose "Anyone" to allow any visitor access to your community area. Choose "Members Only" to restrict access to your community area to logged-in members only.', 'buddypress' ); ?></p>
+<?php
+}
+
+/**
+ * Sanitize the visibility setting when it is saved.
+ *
+ * @since 12.0.0
+ *
+ * @param mixed $saved_value The value passed to the save function.
+ */
+function bp_admin_sanitize_callback_community_visibility( $saved_value ) {
+    $retval = array();
+
+    // Use the global setting, if it has been passed.
+    $retval['global'] = isset( $saved_value['global'] ) ? $saved_value['global'] : 'anyone';
+    // Ensure the global value is a valid option. Else, assume that the site is open.
+    if ( ! in_array( $retval['global'], array( 'anyone', 'members' ), true ) ) {
+        $retval['global'] = 'anyone';
+    }
+
+    // Keys must be either 'global' or a component ID, but not register or activate.
+    $directory_pages = bp_core_get_directory_pages();
+    foreach ( $directory_pages as $component_id => $component_page ) {
+        if ( in_array( $component_id, array( 'register', 'activate' ), true ) ) {
+            continue;
+        }
+
+        // Use the global value if a specific value hasn't been set.
+        $component_value = isset( $saved_value[ $component_id ] ) ? $saved_value[ $component_id ] : $retval['global'];
+
+        // Valid values are 'anyone' or 'memebers'.
+        if ( ! in_array( $component_value, array( 'anyone', 'members' ), true ) ) {
+            $component_value = $retval['global'];
+        }
+        $retval[ $component_id ] = $component_value;
+    }
+
+    return $retval;
 }
 

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

@@ -4972 +4972 @@
     return $navigations;
 }
+
+/**
+ * Get the community visibility value calculated from the
+ * saved visibility setting.
+ *
+ * @since 12.0.0
+ *
+ * @param string $component Whether we want the visibility for a single component
+ *                          or for all components.
+ *
+ * @return arrary|string $retval The calculated visbility settings for the site.
+ */
+function bp_get_community_visibility( $component = 'global' ) {
+    $retval = ( 'all' === $component ) ? array( 'global' => 'anyone' ) : 'anyone';
+    if ( 'rewrites' !== bp_core_get_query_parser() ) {
+        return $retval;
+    }
+
+    $saved_value = (array) bp_get_option( '_bp_community_visibility', array() );
+
+    // If the global value has not been set, we assume that the site is open.
+    if ( ! isset( $saved_value['global'] ) ) {
+        $saved_value['global'] = 'anyone';
+    }
+
+    if ( 'all' === $component ) {
+        // Build the component list.
+        $retval = array(
+            'global' => $saved_value['global']
+        );
+        $directory_pages = bp_core_get_directory_pages();
+        foreach ( $directory_pages as $component_id => $component_page ) {
+            if ( in_array( $component_id, array( 'register', 'activate' ), true ) ) {
+                continue;
+            }
+            $retval[ $component_id ] = isset( $saved_value[ $component_id ] ) ? $saved_value[ $component_id ] : $saved_value['global'];
+        }
+    } else {
+        // We are checking a particular component.
+        // Fall back to the global value if not set.
+        $retval = isset( $saved_value[ $component ] ) ? $saved_value[ $component ] : $saved_value['global'];
+    }
+
+    /**
+     * Filter the community visibility value calculated from the
+     * saved visibility setting.
+     *
+     * @since 12.0.0
+     *
+     * @param arrary|string $retval    The calculated visbility settings for the site.
+     * @param string        $component The component value to get the visibility for.
+     */
+    return apply_filters( 'bp_get_community_visibility', $retval, $component );
+}

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

@@ -74 +74 @@
         // Email unsubscribe salt.
         'bp-emails-unsubscribe-salt'           => '',
+
+        // Community visibility.
+        '_bp_community_visibility'             => array( 'global' => 'anyone' ),
 
         /* Groups ************************************************************/

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

@@ -861 +861 @@
         }
 
-        /* Widgets **************************************************/
-        $widget_options = array(
-            'widget_bp_core_login_widget',
-            'widget_bp_core_members_widget',
-            'widget_bp_core_whos_online_widget',
-            'widget_bp_core_recently_active_widget',
-            'widget_bp_groups_widget',
-            'widget_bp_messages_sitewide_notices_widget',
-        );
-
-        foreach ( $widget_options as $widget_option ) {
-            bp_delete_option( $widget_option );
-        }
-
         // Finally make sure to rebuilt permalinks at next page load.
         bp_delete_rewrite_rules();
     }
+
+    // Widgets.
+    $widget_options = array(
+        'widget_bp_core_login_widget',
+        'widget_bp_core_members_widget',
+        'widget_bp_core_whos_online_widget',
+        'widget_bp_core_recently_active_widget',
+        'widget_bp_groups_widget',
+        'widget_bp_messages_sitewide_notices_widget',
+    );
+
+    foreach ( $widget_options as $widget_option ) {
+        bp_delete_option( $widget_option );
+    }
+
+    // Community visibility.
+    bp_update_option( '_bp_community_visibility', array( 'global' => 'anyone' ) );
 }
 

trunk/src/bp-core/classes/class-bp-admin.php

@@ -476 +476 @@
         add_settings_field( 'bp-disable-account-deletion', __( 'Account Deletion', 'buddypress' ), 'bp_admin_setting_callback_account_deletion', 'buddypress', 'bp_main' );
         register_setting( 'buddypress', 'bp-disable-account-deletion', 'intval' );
+
+        // Community Visibility
+        if ( 'rewrites' === bp_core_get_query_parser() ) {
+            add_settings_field( '_bp_community_visibility', __( 'Community Visibility', 'buddypress' ), 'bp_admin_setting_callback_community_visibility', 'buddypress', 'bp_main' );
+            register_setting( 'buddypress', '_bp_community_visibility', 'bp_admin_sanitize_callback_community_visibility' );
+        }
 
         // Template pack picker.

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

@@ -1258 +1258 @@
      * @since 12.0.0
      *
-     * @param  null     $retval A null value to use the regular WP Query.
-     * @param  WP_Query $query  The WP Query object.
+     * @param  null     $posts A null value to use the regular WP Query.
+     * @param  WP_Query $query The WP Query object.
      * @return null|array Null if not displaying a BuddyPress page.
-     *                    An array containing the BuddyPress directory post otherwise.
-     */
-    public function pre_query( $retval = null, $query = null ) {
+     *                    An array containing the BuddyPress directory page otherwise.
+     */
+    public function pre_query( $posts = null, $query = null ) {
         remove_filter( 'posts_pre_query', array( $this, 'pre_query' ), 10 );
 
@@ -1269 +1269 @@
 
         if ( $queried_object instanceof WP_Post && 'buddypress' === get_post_type( $queried_object ) ) {
-            // Only include the queried directory post into returned posts.
-            $retval = array( $queried_object );
-
-            // Reset some query flags.
-            $query->is_home       = false;
-            $query->is_front_page = false;
-            $query->is_page       = false;
-            $query->is_archive    = false;
-            $query->is_tax        = false;
-
-            if ( ! is_embed() ) {
-                $query->is_single = true;
-            }
-        }
-
-        return $retval;
+            $component = bp_core_get_component_from_directory_page_id( $queried_object->ID );
+            if ( bp_current_user_can( 'bp_view', array( 'bp_component' => $component ) ) ) {
+                // Only include the queried directory post into returned posts.
+                $posts = array( $queried_object );
+
+                // Reset some query flags.
+                $query->is_home       = false;
+                $query->is_front_page = false;
+                $query->is_page       = false;
+                $query->is_archive    = false;
+                $query->is_tax        = false;
+
+                if ( ! is_embed() ) {
+                    $query->is_single = true;
+                }
+            } else {
+                // The current user may not access the directory page.
+                $bp                    = buddypress();
+                $bp->current_component = 'core';
+
+                // Unset other BuddyPress URI globals.
+                foreach ( array( 'current_item', 'current_action', 'action_variables', 'displayed_user' ) as $global ) {
+                    if ( 'action_variables' === $global ) {
+                        $bp->{$global} = array();
+                    } elseif ( 'displayed_user' === $global ) {
+                        $bp->{$global} = new \stdClass();
+                    } else {
+                        $bp->{$global} = '';
+                    }
+                }
+
+                // Reset the post.
+                $post = (object) array(
+                    'ID'             => 0,
+                    'post_type'      => 'buddypress',
+                    'post_name'      => 'restricted',
+                    'post_title'     => __( 'Members-only area', 'buddypress' ),
+                    'post_content'   => bp_buffer_template_part( 'assets/utils/restricted-access-message', null, false ),
+                    'comment_status' => 'closed',
+                    'comment_count'  => 0,
+                );
+
+                // Reset the queried object.
+                $query->queried_object    = get_post( $post );
+                $query->queried_object_id = $query->queried_object->ID;
+
+                // Reset the posts.
+                $posts = array( $query->queried_object );
+
+                // Reset some WP Query properties.
+                $query->found_posts   = 1;
+                $query->max_num_pages = 1;
+                $query->posts         = $posts;
+                $query->post          = $post;
+                $query->post_count    = 1;
+                $query->is_home       = false;
+                $query->is_front_page = false;
+                $query->is_page       = true;
+                $query->is_archive    = false;
+                $query->is_tax        = false;
+
+                // Make sure no comments are displayed for this page.
+                add_filter( 'comments_pre_query', 'bp_comments_pre_query', 10, 2 );
+            }
+
+            return $posts;
+        }
     }