Changeset 3757 for trunk/bp-activity/bp-activity-functions.php

Timestamp:

01/20/2011 10:53:49 AM (14 years ago)

Author:

johnjamesjacoby

Message:

Second pass at huge component refactor.

Move component files out of root directory and append '-loader' to the file names. Split those files up into smaller pieces.

Abstract 'settings' component out of 'core' and into its own component for future extension, including new template files in bp-default.

Append '-sa' to bbPress bridge file for 'Stand Alone' compatibility, to make room for bbPress plugin compatibility layer.

Various bug fixes through-out all components. Various code clean-up and documentation through-out all components.

Still more refactoring to do.

File:

• trunk/bp-activity/bp-activity-functions.php (modified) (1 diff)

trunk/bp-activity/bp-activity-functions.php

@@ -1 +1 @@
 <?php
+
+/**
+ * BuddyPress Activity Functions
+ *
+ * Functions for the Activity Streams component
+ *
+ * @package BuddyPress
+ * @subpackage Activity Core
+ */
+
+/**
+ * @todo Figure out if this is still needed
+ *
+ * @global obj $bp
+ */
+function bp_activity_directory_activity_setup() {
+    global $bp;
+
+    if ( bp_is_activity_component() && empty( $bp->current_action ) ) {
+        $bp->is_directory = true;
+
+        do_action( 'bp_activity_directory_activity_setup' );
+
+        bp_core_load_template( apply_filters( 'bp_activity_directory_activity_setup', 'activity/index' ) );
+    }
+}
+add_action( 'wp', 'bp_activity_directory_activity_setup', 2 );
+
+/**
+ * Searches through the content of an activity item to locate usernames, designated by an @ sign
+ *
+ * @package BuddyPress Activity
+ * @since 1.3
+ *
+ * @param $content The content of the activity, usually found in $activity->content
+ * @return array $usernames Array of the found usernames that match existing users
+ */
+function bp_activity_find_mentions( $content ) {
+    $pattern = '/[@]+([A-Za-z0-9-_\.]+)/';
+    preg_match_all( $pattern, $content, $usernames );
+
+    // Make sure there's only one instance of each username
+    if ( !$usernames = array_unique( $usernames[1] ) )
+        return false;
+
+    return $usernames;
+}
+
+/**
+ * Reduces new mention count for mentioned users when activity items are deleted
+ *
+ * @package BuddyPress Activity
+ * @since 1.3
+ *
+ * @param $activity_id The unique id for the activity item
+ */
+function bp_activity_reduce_mention_count( $activity_id ) {
+    $activity = new BP_Activity_Activity( $activity_id );
+
+    if ( $usernames = bp_activity_find_mentions( strip_tags( $activity->content ) ) ) {
+        if ( ! function_exists( 'username_exists' ) )
+            require_once( ABSPATH . WPINC . '/registration.php' );
+
+        foreach( (array)$usernames as $username ) {
+            if ( !$user_id = username_exists( $username ) )
+                continue;
+
+            // Decrease the number of new @ mentions for the user
+            $new_mention_count = (int)get_user_meta( $user_id, 'bp_new_mention_count', true );
+            update_user_meta( $user_id, 'bp_new_mention_count', $new_mention_count - 1 );
+        }
+    }
+}
+add_action( 'bp_activity_action_delete_activity', 'bp_activity_reduce_mention_count' );
+
+/**
+ * Formats notifications related to activity
+ *
+ * @package BuddyPress Activity
+ * @param $action The type of activity item. Just 'new_at_mention' for now
+ * @param $item_id The activity id
+ * @param $secondary_item_id In the case of at-mentions, this is the mentioner's id
+ * @param $total_items The total number of notifications to format
+ */
+function bp_activity_format_notifications( $action, $item_id, $secondary_item_id, $total_items ) {
+    global $bp;
+
+    switch ( $action ) {
+        case 'new_at_mention':
+            $activity_id      = $item_id;
+            $poster_user_id   = $secondary_item_id;
+            $at_mention_link  = $bp->loggedin_user->domain . $bp->activity->slug . '/mentions/';
+            $at_mention_title = sprintf( __( '@%s Mentions', 'buddypress' ), $bp->loggedin_user->userdata->user_nicename );
+
+            if ( (int)$total_items > 1 ) {
+                return apply_filters( 'bp_activity_multiple_at_mentions_notification', '<a href="' . $at_mention_link . '" title="' . $at_mention_title . '">' . sprintf( __( 'You have %1$d new activity mentions', 'buddypress' ), (int)$total_items ) . '</a>', $at_mention_link, $total_items, $activity_id, $poster_user_id );
+            } else {
+                $user_fullname = bp_core_get_user_displayname( $poster_user_id );
+
+                return apply_filters( 'bp_activity_single_at_mentions_notification', '<a href="' . $at_mention_link . '" title="' . $at_mention_title . '">' . sprintf( __( '%1$s mentioned you in an activity update', 'buddypress' ), $user_fullname ) . '</a>', $at_mention_link, $total_items, $activity_id, $poster_user_id );
+            }
+        break;
+    }
+
+    do_action( 'activity_format_notifications', $action, $item_id, $secondary_item_id, $total_items );
+
+    return false;
+}
+
+/** Actions *******************************************************************/
+
+/**
+ * Sets the current action for a given activity stream location
+ *
+ * @global obj $bp
+ * @param str $component_id
+ * @param str $key
+ * @param str $value
+ * @return bool False on error, True on success
+ */
+function bp_activity_set_action( $component_id, $key, $value ) {
+    global $bp;
+
+    // Return false if any of the above values are not set
+    if ( empty( $component_id ) || empty( $key ) || empty( $value ) )
+        return false;
+
+    // Set activity action
+    $bp->activity->actions->{$component_id}->{$key} = apply_filters( 'bp_activity_set_action', array(
+        'key'   => $key,
+        'value' => $value
+    ), $component_id, $key, $value );
+
+    return true;
+}
+
+/**
+ * Retreives the current action from a component and key
+ *
+ * @global obj $bp
+ * @param str $component_id
+ * @param str $key
+ * @return mixed False on error, action on success
+ */
+function bp_activity_get_action( $component_id, $key ) {
+    global $bp;
+
+    // Return false if any of the above values are not set
+    if ( empty( $component_id ) || empty( $key ) )
+        return false;
+
+    return apply_filters( 'bp_activity_get_action', $bp->activity->actions->{$component_id}->{$key}, $component_id, $key );
+}
+
+/** Favorites *****************************************************************/
+
+/**
+ * Get a users favorite activity stream items
+ *
+ * @global obj $bp
+ * @param int $user_id
+ * @return array Array of users favorite activity stream ID's
+ */
+function bp_activity_get_user_favorites( $user_id = 0 ) {
+    global $bp;
+
+    // Fallback to logged in user if no user_id is passed
+    if ( empty( $user_id ) )
+        $user_id = $bp->displayed_user->id;
+
+    // Get favorites for user
+    $favs          = get_user_meta( $user_id, 'bp_favorite_activities', true );
+    $existing_favs = bp_activity_get_specific( array( 'activity_ids' => $favs ) );
+
+    foreach( (array)$existing_favs['activities'] as $fav )
+        $new_favs[] = $fav->id;
+
+    $new_favs = array_unique( (array)$new_favs );
+    update_user_meta( $user_id, 'bp_favorite_activities', $new_favs );
+
+    return apply_filters( 'bp_activity_get_user_favorites', $new_favs );
+}
+
+/**
+ * Add an activity stream item as a favorite for a user
+ *
+ * @global obj $bp
+ * @param int $activity_id
+ * @param int $user_id
+ * @return bool
+ */
+function bp_activity_add_user_favorite( $activity_id, $user_id = 0 ) {
+    global $bp;
+
+    // Favorite activity stream items are for logged in users only
+    if ( !is_user_logged_in() )
+        return false;
+
+    // Fallback to logged in user if no user_id is passed
+    if ( empty( $user_id ) )
+        $user_id = $bp->loggedin_user->id;
+
+    // Update the user's personal favorites
+    $my_favs   = get_user_meta( $bp->loggedin_user->id, 'bp_favorite_activities', true );
+    $my_favs[] = $activity_id;
+
+    // Update the total number of users who have favorited this activity
+    $fav_count = bp_activity_get_meta( $activity_id, 'favorite_count' );
+    $fav_count = !empty( $fav_count ) ? (int)$fav_count + 1 : 1;
+
+    // Update user meta
+    update_user_meta( $bp->loggedin_user->id, 'bp_favorite_activities', $my_favs );
+
+    // Update activity meta counts
+    if ( true === bp_activity_update_meta( $activity_id, 'favorite_count', $fav_count ) ) {
+
+        // Execute additional code
+        do_action( 'bp_activity_add_user_favorite', $activity_id, $user_id );
+
+        // Success
+        return true;
+
+    // Saving meta was unsuccessful for an unknown reason
+    } else {
+        // Execute additional code
+        do_action( 'bp_activity_add_user_favorite_fail', $activity_id, $user_id );
+
+        return false;
+    }
+}
+
+function bp_activity_remove_user_favorite( $activity_id, $user_id = 0 ) {
+    global $bp;
+
+    // Favorite activity stream items are for logged in users only
+    if ( !is_user_logged_in() )
+        return false;
+
+    // Fallback to logged in user if no user_id is passed
+    if ( empty( $user_id ) )
+        $user_id = $bp->loggedin_user->id;
+
+    // Remove the fav from the user's favs
+    $my_favs = get_user_meta( $user_id, 'bp_favorite_activities', true );
+    $my_favs = array_flip( (array) $my_favs );
+    unset( $my_favs[$activity_id] );
+    $my_favs = array_unique( array_flip( $my_favs ) );
+
+    // Update the total number of users who have favorited this activity
+    if ( $fav_count = bp_activity_get_meta( $activity_id, 'favorite_count' ) ) {
+
+        // Deduct from total favorites
+        if ( bp_activity_update_meta( $activity_id, 'favorite_count', (int)$fav_count - 1 ) ) {
+
+            // Update users favorites
+            if ( update_user_meta( $user_id, 'bp_favorite_activities', $my_favs ) ) {
+
+                // Execute additional code
+                do_action( 'bp_activity_remove_user_favorite', $activity_id, $user_id );
+
+                // Success
+                return true;
+
+            // Error updating
+            } else {
+                return false;
+            }
+
+        // Error updating favorite count
+        } else {
+            return false;
+        }
+
+    // Error getting favorite count
+    } else {
+        return false;
+    }
+}
+
+/**
+ * Check if activity exists by scanning content
+ *
+ * @param str $content
+ * @return bool
+ */
+function bp_activity_check_exists_by_content( $content ) {
+    return apply_filters( 'bp_activity_check_exists_by_content', BP_Activity_Activity::check_exists_by_content( $content ) );
+}
+
+/**
+ * Retreive the last time activity was updated
+ *
+ * @return str
+ */
+function bp_activity_get_last_updated() {
+    return apply_filters( 'bp_activity_get_last_updated', BP_Activity_Activity::get_last_updated() );
+}
+
+/**
+ * Retreive the number of favorite activity stream items a user has
+ *
+ * @global obj $bp
+ * @param int $user_id
+ * @return int
+ */
+function bp_activity_total_favorites_for_user( $user_id = 0 ) {
+    global $bp;
+
+    // Fallback on displayed user, and then logged in user
+    if ( empty( $user_id ) )
+        $user_id = ( $bp->displayed_user->id ) ? $bp->displayed_user->id : $bp->loggedin_user->id;
+
+    return BP_Activity_Activity::total_favorite_count( $user_id );
+}
+
+/** Meta **********************************************************************/
+
+/**
+ * Delete a meta entry from the DB for an activity stream item
+ *
+ * @global DB $wpdb
+ * @global obj $bp
+ * @param int $activity_id
+ * @param str $meta_key
+ * @param str $meta_value
+ * @return bool
+ */
+function bp_activity_delete_meta( $activity_id, $meta_key = '', $meta_value = '' ) {
+    global $wpdb, $bp;
+
+    // Return false if any of the above values are not set
+    if ( !is_numeric( $activity_id ) )
+        return false;
+
+    // Sanitize key
+    $meta_key = preg_replace( '|[^a-z0-9_]|i', '', $meta_key );
+
+    if ( is_array( $meta_value ) || is_object( $meta_value ) )
+        $meta_value = serialize( $meta_value );
+
+    // Trim off whitespace
+    $meta_value = trim( $meta_value );
+
+    // Delete all for activity_id
+    if ( empty( $meta_key ) )
+        $retval = $wpdb->query( $wpdb->prepare( "DELETE FROM {$bp->activity->table_name_meta} WHERE activity_id = %d", $activity_id ) );
+
+    // Delete only when all match
+    else if ( $meta_value )
+        $retval = $wpdb->query( $wpdb->prepare( "DELETE FROM {$bp->activity->table_name_meta} WHERE activity_id = %d AND meta_key = %s AND meta_value = %s", $activity_id, $meta_key, $meta_value ) );
+
+    // Delete only when activity_id and meta_key match
+    else
+        $retval = $wpdb->query( $wpdb->prepare( "DELETE FROM {$bp->activity->table_name_meta} WHERE activity_id = %d AND meta_key = %s", $activity_id, $meta_key ) );
+
+    // Delete cache entry
+    wp_cache_delete( 'bp_activity_meta_' . $meta_key . '_' . $activity_id, 'bp' );
+
+    // Success
+    if ( !is_wp_error( $retval ) )
+        return true;
+
+    // Fail
+    else
+        return false;
+}
+
+/**
+ * Get activity meta
+ *
+ * @global DB $wpdb
+ * @global obj $bp
+ * @param int $activity_id
+ * @param str $meta_key
+ * @return bool
+ */
+function bp_activity_get_meta( $activity_id = 0, $meta_key = '' ) {
+    global $wpdb, $bp;
+
+    // Make sure activity_id is valid
+    if ( empty( $activity_id ) || !is_numeric( $activity_id ) )
+        return false;
+
+    // We have a key to look for
+    if ( !empty( $meta_key ) ) {
+
+        // Sanitize key
+        $meta_key = preg_replace( '|[^a-z0-9_]|i', '', $meta_key );
+
+        // Check cache
+        if ( !$metas = wp_cache_get( 'bp_activity_meta_' . $meta_key . '_' . $activity_id, 'bp' ) ) {
+
+            // No cache so hit the DB
+            $metas = $wpdb->get_col( $wpdb->prepare("SELECT meta_value FROM {$bp->activity->table_name_meta} WHERE activity_id = %d AND meta_key = %s", $activity_id, $meta_key ) );
+
+            // Set cache
+            wp_cache_set( 'bp_activity_meta_' . $meta_key . '_' . $activity_id, $metas, 'bp' );
+        }
+
+    // No key so get all for activity_id
+    } else {
+        $metas = $wpdb->get_col( $wpdb->prepare( "SELECT meta_value FROM {$bp->activity->table_name_meta} WHERE activity_id = %d", $activity_id ) );
+    }
+
+    // No result so return false
+    if ( empty( $metas ) )
+        return false;
+
+    // Maybe, just maybe... unserialize
+    $metas = array_map( 'maybe_unserialize', (array)$metas );
+
+    // Return first item in array if only 1, else return all metas found
+    $retval = ( 1 == count( $metas ) ? $metas[0] : $metas );
+
+    // Filter result before returning
+    return apply_filters( 'bp_activity_get_meta', $retval, $activity_id, $meta_key );
+}
+
+/**
+ * Update activity meta
+ *
+ * @global DB $wpdb
+ * @global obj $bp
+ * @param int $activity_id
+ * @param str $meta_key
+ * @param str $meta_value
+ * @return bool
+ */
+function bp_activity_update_meta( $activity_id, $meta_key, $meta_value ) {
+    global $wpdb, $bp;
+
+    // Make sure activity_id is valid
+    if ( !is_numeric( $activity_id ) )
+        return false;
+
+    // Sanitize key
+    $meta_key = preg_replace( '|[^a-z0-9_]|i', '', $meta_key );
+
+    // Sanitize value
+    if ( is_string( $meta_value ) )
+        $meta_value = stripslashes( $wpdb->escape( $meta_value ) );
+
+    // Maybe, just maybe... serialize
+    $meta_value = maybe_serialize( $meta_value );
+
+    // If value is empty, delete the meta key
+    if ( empty( $meta_value ) )
+        return bp_activity_delete_meta( $activity_id, $meta_key );
+
+    // See if meta key exists for activity_id
+    $cur = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM {$bp->activity->table_name_meta} WHERE activity_id = %d AND meta_key = %s", $activity_id, $meta_key ) );
+
+    // Meta key does not exist so INSERT
+    if ( empty( $cur ) )
+        $wpdb->query( $wpdb->prepare( "INSERT INTO {$bp->activity->table_name_meta} ( activity_id, meta_key, meta_value ) VALUES ( %d, %s, %s )", $activity_id, $meta_key, $meta_value ) );
+
+    // Meta key exists, so UPDATE
+    else if ( $cur->meta_value != $meta_value )
+        $wpdb->query( $wpdb->prepare( "UPDATE {$bp->activity->table_name_meta} SET meta_value = %s WHERE activity_id = %d AND meta_key = %s", $meta_value, $activity_id, $meta_key ) );
+
+    // Weirdness, so return false
+    else
+        return false;
+
+    // Set cache
+    wp_cache_set( 'bp_activity_meta_' . $meta_key . '_' . $activity_id, $meta_value, 'bp' );
+
+    // Victory is ours!
+    return true;
+}
+
+/** Clean up ******************************************************************/
+
+/**
+ * Completely remove
+ * @param int $user_id
+ */
+function bp_activity_remove_all_user_data( $user_id = 0 ) {
+
+    // Do not delete user data unless a logged in user says so
+    if ( empty( $user_id ) || !is_user_logged_in() )
+        return false;
+
+    // Clear the user's activity from the sitewide stream and clear their activity tables
+    bp_activity_delete( array( 'user_id' => $user_id ) );
+
+    // Remove any usermeta
+    delete_user_meta( $user_id, 'bp_latest_update' );
+    delete_user_meta( $user_id, 'bp_favorite_activities' );
+
+    // Execute additional code
+    do_action( 'bp_activity_remove_data', $user_id ); // Deprecated! Do not use!
+
+    // Use this going forward
+    do_action( 'bp_activity_remove_all_user_data', $user_id );
+}
+add_action( 'wpmu_delete_user',  'bp_activity_remove_all_user_data' );
+add_action( 'delete_user',       'bp_activity_remove_all_user_data' );
+add_action( 'bp_make_spam_user', 'bp_activity_remove_all_user_data' );
+
+/**
+ * Register the activity stream actions for updates
+ *
+ * @global obj $bp
+ */
+function updates_register_activity_actions() {
+    global $bp;
+
+    bp_activity_set_action( $bp->activity->id, 'activity_update', __( 'Posted an update', 'buddypress' ) );
+
+    do_action( 'updates_register_activity_actions' );
+}
+add_action( 'bp_register_activity_actions', 'updates_register_activity_actions' );
 
 /*******************************************************************************