Changeset 7998

Timestamp:

02/27/2014 07:51:28 PM (11 years ago)

Author:

boonebgorges

Message:

Reinstate updated_profile activity item

Once upon a time, a user's activity stream was updated when that user updated
his/her profile. This changeset reintroduces (and rethinks) that functionality.

• New phrasing is "Boone's profile was updated", to avoid gendered pronouns in English
• updated_profile items are limited to one per user per two-hour period
• Activity items are posted only when at least one publicly-visible xprofile field has been changed

Fixes #4636

Props ericlewis, boonebgorges

Location:

trunk

Files:

• bp-xprofile/bp-xprofile-activity.php (modified) (1 diff)
• bp-xprofile/bp-xprofile-screens.php (modified) (2 diffs)
• tests/testcases/xprofile/activity.php (added)

trunk/bp-xprofile/bp-xprofile-activity.php

@@ -133 +133 @@
 }
 add_action( 'xprofile_avatar_uploaded', 'bp_xprofile_new_avatar_activity' );
+
+/**
+ * Add an activity item when a user has updated his profile.
+ *
+ * @since BuddyPress (2.0.0)
+ *
+ * @param int $user_id ID of the user who has updated his profile.
+ * @param array $field_ids IDs of the fields submitted.
+ * @param bool $errors True if validation or saving errors occurred, otherwise
+ *        false.
+ * @param array $old_values Pre-save xprofile field values and visibility
+ *        levels.
+ * @param array $new_values Post-save xprofile field values and visibility
+ *        levels.
+ * @return bool True on success, false on failure.
+ */
+function bp_xprofile_updated_profile_activity( $user_id, $field_ids, $errors, $old_values = array(), $new_values = array() ) {
+    // If there were errors, don't post
+    if ( ! empty( $errors ) ) {
+        return false;
+    }
+
+    // Don't post if there have been no changes, or if the changes are
+    // related solely to non-public fields
+    $public_changes = false;
+    foreach ( $new_values as $field_id => $new_value ) {
+        $old_value            = isset( $old_values[ $field_id ] ) ? $old_values[ $field_id ] : '';
+        $old_value_value      = isset( $old_value['value'] ) ? $old_value['value'] : '';
+        $old_value_visibility = isset( $old_value['visibility'] ) ? $old_value['visibility'] : '';
+
+        // Don't register changes to private fields
+        if ( 'public' !== $new_value['visibility'] ) {
+            continue;
+        }
+
+        // Don't register if there have been no changes
+        if ( $new_value === $old_value ) {
+            continue;
+        }
+
+        // Looks like we have public changes - no need to keep checking
+        $public_changes = true;
+        break;
+    }
+
+    if ( ! $public_changes ) {
+        return false;
+    }
+
+    // Throttle to one activity of this type per 2 hours
+    $existing = bp_activity_get( array(
+        'max' => 1,
+        'filter' => array(
+            'user_id' => $user_id,
+            'object'  => buddypress()->profile->id,
+            'action'  => 'updated_profile',
+        ),
+    ) );
+
+    if ( empty( $existing['activities'] ) ) {
+        $throttle = false;
+    } else {
+        // Default throttle time is 2 hours. Filter to change (in seconds)
+        $throttle_period = apply_filters( 'bp_xprofile_updated_profile_activity_throttle_time', 60 * 60 * 2 );
+        $then = strtotime( $existing['activities'][0]->date_recorded );
+        $now  = strtotime( bp_core_current_time() );
+
+        $throttle = ( $now - $then ) < $throttle_period;
+    }
+
+    if ( $throttle ) {
+        return false;
+    }
+
+    // If we've reached this point, assemble and post the activity item
+
+    // Note for translators: The natural phrasing in English, "Joe updated
+    // his profile", requires that we know Joe's gender, which we don't. If
+    // your language doesn't have this restriction, feel free to use a more
+    // natural translation.
+    $profile_link = trailingslashit( bp_core_get_user_domain( $user_id ) . buddypress()->profile->slug );
+    $action = sprintf( __( '%1$s&#8217;s profile was updated', 'buddypress' ), '<a href="' . $profile_link . '">' . bp_core_get_user_displayname( $user_id ) . '</a>' );
+
+    $retval = xprofile_record_activity( array(
+        'user_id'      => $user_id,
+        'action'       => $action,
+        'primary_link' => $profile_link,
+        'component'    => buddypress()->profile->id,
+        'type'         => 'updated_profile',
+    ) );
+
+    return (bool) $retval;
+}
+add_action( 'xprofile_updated_profile', 'bp_xprofile_updated_profile_activity', 10, 5 );
+
+/**
+ * Add filters for xprofile activity types to Show dropdowns.
+ *
+ * @since BuddyPress (2.0.0)
+ */
+function xprofile_activity_filter_options() {
+    ?>
+
+    <option value="updated_profile"><?php _e( 'Profile Updates', 'buddypress' ) ?></option>
+
+    <?php
+}
+add_action( 'bp_activity_filter_options', 'xprofile_activity_filter_options' );

trunk/bp-xprofile/bp-xprofile-screens.php

@@ -103 +103 @@
 
             // Now we've checked for required fields, lets save the values.
+            $old_values = $new_values = array();
             foreach ( (array) $posted_field_ids as $field_id ) {
 
@@ -121 +122 @@
                 $visibility_level = !empty( $_POST['field_' . $field_id . '_visibility'] ) ? $_POST['field_' . $field_id . '_visibility'] : 'public';
                 xprofile_set_field_visibility_level( $field_id, bp_displayed_user_id(), $visibility_level );
-            }
-
-            do_action( 'xprofile_updated_profile', bp_displayed_user_id(), $posted_field_ids, $errors );
+
+                // Save the old and new values. They will be
+                // passed to the filter and used to determine
+                // whether an activity item should be posted
+                $old_values[ $field_id ] = array(
+                    'value'      => xprofile_get_field_data( $field_id, bp_displayed_user_id() ),
+                    'visibility' => xprofile_get_field_visibility_level( $field_id, bp_displayed_user_id() ),
+                );
+                $new_values[ $field_id ] = array(
+                    'value'      => $value,
+                    'visibility' => $visibility_level,
+                );
+            }
+
+            do_action( 'xprofile_updated_profile', bp_displayed_user_id(), $posted_field_ids, $errors, $old_values, $new_values );
 
             // Set the feedback messages