Changeset 12482

Timestamp:

10/27/2019 04:10:39 AM (5 years ago)

Author:

imath

Message:

Only load BP REST API Avatar Controllers when avatar uploads are on

• Move the loading of the BP_REST_Attachments_Member_Avatar_Endpoint controller into the xProfile component's class. User Avatar is an xProfile feature.
• Make sure to check the community administrator allowed member avatar uploads before loading this controller.
• Make sure to check the community administrator allowed group avatar uploads before loading BP_REST_Attachments_Group_Avatar_Endpoint.

See #8151 (Trunk)

Location:

trunk

Files:

• src/bp-groups/classes/class-bp-groups-component.php (modified) (1 diff)
• src/bp-members/classes/class-bp-members-component.php (modified) (1 diff)
• src/bp-xprofile/classes/class-bp-xprofile-component.php (modified) (1 diff)
• tests/phpunit/assets/bp-rest-api-controllers.php (modified) (2 diffs)
• tests/phpunit/testcases/core/class-bp-component.php (modified) (3 diffs)

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

@@ -933 +933 @@
      */
     public function rest_api_init( $controllers = array() ) {
-        parent::rest_api_init( array(
+        $controllers = array(
             'BP_REST_Groups_Endpoint',
             'BP_REST_Group_Membership_Endpoint',
             'BP_REST_Group_Invites_Endpoint',
             'BP_REST_Group_Membership_Request_Endpoint',
-            'BP_REST_Attachments_Group_Avatar_Endpoint',
-        ) );
+        );
+
+        // Only Load the Group's Avatar controller if Group Avatar uploads are allowed.
+        if ( ! bp_disable_group_avatar_uploads() ) {
+            $controllers[] = 'BP_REST_Attachments_Group_Avatar_Endpoint';
+        }
+
+        parent::rest_api_init( $controllers );
     }
 }

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

@@ -474 +474 @@
             'BP_REST_Components_Endpoint',
             'BP_REST_Members_Endpoint',
-            'BP_REST_Attachments_Member_Avatar_Endpoint',
         ) );
     }

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

@@ -500 +500 @@
      */
     public function rest_api_init( $controllers = array() ) {
-        parent::rest_api_init( array(
+        $controllers = array(
             'BP_REST_XProfile_Fields_Endpoint',
             'BP_REST_XProfile_Field_Groups_Endpoint',
             'BP_REST_XProfile_Data_Endpoint',
-        ) );
+        );
+
+        // Only Load the Member's Avatar controller if Avatar uploads are allowed.
+        if ( ! bp_disable_avatar_uploads() ) {
+            $controllers[] = 'BP_REST_Attachments_Member_Avatar_Endpoint';
+        }
+
+        parent::rest_api_init( $controllers );
     }
 }

trunk/tests/phpunit/assets/bp-rest-api-controllers.php

@@ -18 +18 @@
     public function __construct() {
         $this->namespace = bp_rest_namespace() . '/' . bp_rest_version();
-        $this->rest_base = 'members';
+        $this->rest_base = 'xprofile';
     }
 
@@ -53 +53 @@
     }
 }
+
+/**
+ * BP xProfiles Data REST Controller's mock.
+ */
+class BP_REST_XProfile_Data_Endpoint extends BP_REST_Mock_Class {
+    public function __construct() {
+        $this->namespace = bp_rest_namespace() . '/' . bp_rest_version();
+        $this->rest_base = 'xprofile';
+    }
+
+    public function register_routes( $controller = '' ) {
+        parent::register_routes( 'BP_REST_XProfile_Data_Endpoint' );
+    }
+}
+
+/**
+ * BP xProfiles Field Groups REST Controller's mock.
+ */
+class BP_REST_XProfile_Field_Groups_Endpoint extends BP_REST_Mock_Class {
+    public function __construct() {
+        $this->namespace = bp_rest_namespace() . '/' . bp_rest_version();
+        $this->rest_base = 'xprofile/groups';
+    }
+
+    public function register_routes( $controller = '' ) {
+        parent::register_routes( 'BP_REST_XProfile_Field_Groups_Endpoint' );
+    }
+}
+
+/**
+ * BP xProfiles Fields REST Controller's mock.
+ */
+class BP_REST_XProfile_Fields_Endpoint extends BP_REST_Mock_Class {
+    public function __construct() {
+        $this->namespace = bp_rest_namespace() . '/' . bp_rest_version();
+        $this->rest_base = 'xprofile/fields';
+    }
+
+    public function register_routes( $controller = '' ) {
+        parent::register_routes( 'BP_REST_XProfile_Fields_Endpoint' );
+    }
+}

trunk/tests/phpunit/testcases/core/class-bp-component.php

@@ -33 +33 @@
             'BP_REST_Components_Endpoint',
             'BP_REST_Members_Endpoint',
-            'BP_REST_Attachments_Member_Avatar_Endpoint',
         ) );
     }
@@ -49 +48 @@
         $this->assertSame( $bp->unit_test_rest->controllers, array(
             'BP_REST_Components_Endpoint',
-            'BP_REST_Attachments_Member_Avatar_Endpoint',
         ) );
     }
@@ -66 +64 @@
             'BP_REST_Components_Endpoint',
             'BP_REST_Members_Endpoint',
+        ) );
+    }
+
+    public function test_rest_api_init_for_xprofile_component() {
+        $bp_xprofile = new BP_XProfile_Component();
+        $bp          = buddypress();
+
+        $bp_xprofile->rest_api_init();
+
+        $this->assertSame( $bp->unit_test_rest->controllers, array(
+            'BP_REST_XProfile_Fields_Endpoint',
+            'BP_REST_XProfile_Field_Groups_Endpoint',
+            'BP_REST_XProfile_Data_Endpoint',
             'BP_REST_Attachments_Member_Avatar_Endpoint',
         ) );
     }
+
+    public function test_rest_api_init_for_xprofile_component_without_avatar_enabled() {
+        add_filter( 'bp_disable_avatar_uploads', '__return_true' );
+
+        $bp_xprofile = new BP_XProfile_Component();
+        $bp          = buddypress();
+
+        $bp_xprofile->rest_api_init();
+
+        remove_filter( 'bp_disable_avatar_uploads', '__return_true' );
+
+        $this->assertSame( $bp->unit_test_rest->controllers, array(
+            'BP_REST_XProfile_Fields_Endpoint',
+            'BP_REST_XProfile_Field_Groups_Endpoint',
+            'BP_REST_XProfile_Data_Endpoint',
+        ) );
+    }
 }