Changeset 12604

Timestamp:

03/29/2020 04:27:09 PM (6 years ago)

Author:

imath

Message:

Make sure activities requiring content are not inserted empty into db

The activity type activity_update requires a content. If it is not set (eg: this can happen after sanitization), the activity won't be inserted into the database. Plugin developers can use the bp_activity_type_requires_content filter to force the activity type their plugin generated to also require content.

Props oztaser

Fixes #8236

Location:

trunk

Files:

• src/bp-activity/classes/class-bp-activity-activity.php (modified) (1 diff)
• tests/phpunit/testcases/activity/class.BP_Activity_Activity.php (modified) (1 diff)

trunk/src/bp-activity/classes/class-bp-activity-activity.php

@@ -269 +269 @@
             } else {
                 if ( empty( $this->component ) ) {
-                    $this->errors->add( 'bp_activity_missing_component' );
+                    $this->errors->add( 'bp_activity_missing_component', __( 'You need to define a component parameter to insert activity.', 'buddypress' ) );
                 } else {
-                    $this->errors->add( 'bp_activity_missing_type' );
+                    $this->errors->add( 'bp_activity_missing_type', __( 'You need to define a type parameter to insert activity.', 'buddypress' ) );
                 }
+
+                return $this->errors;
+            }
+        }
+
+        /**
+         * Use this filter to make the content of your activity required.
+         *
+         * @since 6.0.0
+         *
+         * @param bool   $value True if the content of the activity type is required.
+         *                      False otherwise.
+         * @param string $type  The type of the activity we are about to insert.
+         */
+        $type_requires_content = (bool) apply_filters( 'bp_activity_type_requires_content', $this->type === 'activity_update', $this->type );
+        if ( $type_requires_content && ! $this->content ) {
+            if ( 'bool' === $this->error_type ) {
+                return false;
+            } else {
+                $this->errors->add( 'bp_activity_missing_content', __( 'Please enter some content to post.', 'buddypress' ) );
 
                 return $this->errors;

trunk/tests/phpunit/testcases/activity/class.BP_Activity_Activity.php

@@ -786 +786 @@
         return 'Woo Hoo!';
     }
+
+    /**
+     * @ticket BP8236
+     */
+    public function test_save_activity_requires_component() {
+        $a = bp_activity_add(
+            array(
+                'component'  => '',
+                'content'    => 'Activity without component content %s',
+                'type'       => 'activity_update',
+                'error_type' => 'wp_error',
+            )
+        );
+
+        $this->assertInstanceOf( 'WP_Error', $a );
+        $this->assertEquals( 'bp_activity_missing_component', $a->get_error_code() );
+    }
+
+    /**
+     * @ticket BP8236
+     */
+    public function test_save_activity_requires_type() {
+        $a = bp_activity_add(
+            array(
+                'component'  => 'foobar',
+                'content'    => 'Activity without type content %s',
+                'type'       => '',
+                'error_type' => 'wp_error',
+            )
+        );
+
+        $this->assertInstanceOf( 'WP_Error', $a );
+        $this->assertEquals( 'bp_activity_missing_type', $a->get_error_code() );
+    }
+
+    /**
+     * @ticket BP8236
+     */
+    public function test_save_activity_requires_content() {
+        $a = bp_activity_add(
+            array(
+                'component'  => buddypress()->activity->id,
+                'content'    => '',
+                'type'       => 'activity_update',
+                'error_type' => 'wp_error',
+            )
+        );
+
+        $this->assertInstanceOf( 'WP_Error', $a );
+        $this->assertEquals( 'bp_activity_missing_content', $a->get_error_code() );
+    }
+
+    /**
+     * @ticket BP8236
+     */
+    public function test_save_activity_does_not_require_content() {
+        $a = bp_activity_add(
+            array(
+                'component'  => buddypress()->members->id,
+                'content'    => '',
+                'type'       => 'new_member',
+                'error_type' => 'wp_error',
+            )
+        );
+
+        $this->assertFalse( is_wp_error( $a ) );
+    }
+
+    /**
+     * @ticket BP8236
+     */
+    public function test_save_activity_custom_type_requires_content() {
+        add_filter( 'bp_activity_type_requires_content', '__return_true' );
+
+        $a = bp_activity_add(
+            array(
+                'component'  => 'foo',
+                'content'    => '',
+                'type'       => 'bar',
+                'error_type' => 'wp_error',
+            )
+        );
+
+        remove_filter( 'bp_activity_type_requires_content', '__return_true' );
+
+        $this->assertInstanceOf( 'WP_Error', $a );
+        $this->assertEquals( 'bp_activity_missing_content', $a->get_error_code() );
+    }
 }