Changeset 5309

Timestamp:

03/05/2014 06:41:02 PM (11 years ago)

Author:

johnjamesjacoby

Message:

Introduce topic & reply counts for users:

• New functions for updating user options.
• New action hooks for bumping existing counts on CRUD actions.
• Uses existing _raw functions when no counts are previously found to incrementally update missing meta values.
• Tool for updating topic & reply counts already exists.
• Props netweb, MZAWeb, anointed.
• Fixes #1694.

Location:

trunk/src/includes

Files:

• core/actions.php (modified) (1 diff)
• users/functions.php (modified) (2 diffs)
• users/options.php (modified) (10 diffs)

trunk/src/includes/core/actions.php

@@ -248 +248 @@
 add_action( 'bbp_unspammed_reply', 'bbp_update_reply_walker' );
 
+// Users topic & reply counts
+add_action( 'bbp_new_topic',     'bbp_increase_user_topic_count' );
+add_action( 'bbp_new_reply',     'bbp_increase_user_reply_count' );
+add_action( 'bbp_untrash_topic', 'bbp_increase_user_topic_count' );
+add_action( 'bbp_untrash_reply', 'bbp_increase_user_reply_count' );
+add_action( 'bbp_unspam_topic',  'bbp_increase_user_topic_count' );
+add_action( 'bbp_unspam_reply',  'bbp_increase_user_reply_count' );
+add_action( 'bbp_trash_topic',   'bbp_decrease_user_topic_count' );
+add_action( 'bbp_trash_reply',   'bbp_decrease_user_reply_count' );
+add_action( 'bbp_spam_topic',    'bbp_decrease_user_topic_count' );
+add_action( 'bbp_spam_reply',    'bbp_decrease_user_reply_count' );
+
 // User status
 // @todo make these sub-actions

trunk/src/includes/users/functions.php

@@ -156 +156 @@
 
     return apply_filters( 'bbp_current_author_ua', $retval );
-}
-
-/** Post Counts ***************************************************************/
-
-/**
- * Return the raw database count of topics by a user
- *
- * @since bbPress (r3633)
- * @global WPDB $wpdb
- * @uses bbp_get_user_id()
- * @uses get_posts_by_author_sql()
- * @uses bbp_get_topic_post_type()
- * @uses apply_filters()
- * @return int Raw DB count of topics
- */
-function bbp_get_user_topic_count_raw( $user_id = 0 ) {
-    $user_id = bbp_get_user_id( $user_id );
-    if ( empty( $user_id ) )
-        return false;
-
-    global $wpdb;
-
-    $where = get_posts_by_author_sql( bbp_get_topic_post_type(), true, $user_id );
-    $count = (int) $wpdb->get_var( "SELECT COUNT(*) FROM {$wpdb->posts} {$where}" );
-
-    return (int) apply_filters( 'bbp_get_user_topic_count_raw', $count, $user_id );
-}
-
-/**
- * Return the raw database count of replies by a user
- *
- * @since bbPress (r3633)
- * @global WPDB $wpdb
- * @uses bbp_get_user_id()
- * @uses get_posts_by_author_sql()
- * @uses bbp_get_reply_post_type()
- * @uses apply_filters()
- * @return int Raw DB count of replies
- */
-function bbp_get_user_reply_count_raw( $user_id = 0 ) {
-    $user_id = bbp_get_user_id( $user_id );
-    if ( empty( $user_id ) )
-        return false;
-
-    global $wpdb;
-
-    $where = get_posts_by_author_sql( bbp_get_reply_post_type(), true, $user_id );
-    $count = (int) $wpdb->get_var( "SELECT COUNT(*) FROM {$wpdb->posts} {$where}" );
-
-    return (int) apply_filters( 'bbp_get_user_reply_count_raw', $count, $user_id );
 }
 
@@ -1533 +1483 @@
 }
 
-/** Premissions ***************************************************************/
+/** Post Counts ***************************************************************/
+
+/**
+ * Return the raw database count of topics by a user
+ *
+ * @since bbPress (r3633)
+ * @global WPDB $wpdb
+ * @uses bbp_get_user_id()
+ * @uses get_posts_by_author_sql()
+ * @uses bbp_get_topic_post_type()
+ * @uses apply_filters()
+ * @return int Raw DB count of topics
+ */
+function bbp_get_user_topic_count_raw( $user_id = 0 ) {
+    $user_id = bbp_get_user_id( $user_id );
+    if ( empty( $user_id ) ) {
+        return false;
+    }
+
+    global $wpdb;
+
+    $where = get_posts_by_author_sql( bbp_get_topic_post_type(), true, $user_id );
+    $count = (int) $wpdb->get_var( "SELECT COUNT(*) FROM {$wpdb->posts} {$where}" );
+
+    return (int) apply_filters( 'bbp_get_user_topic_count_raw', $count, $user_id );
+}
+
+/**
+ * Return the raw database count of replies by a user
+ *
+ * @since bbPress (r3633)
+ * @global WPDB $wpdb
+ * @uses bbp_get_user_id()
+ * @uses get_posts_by_author_sql()
+ * @uses bbp_get_reply_post_type()
+ * @uses apply_filters()
+ * @return int Raw DB count of replies
+ */
+function bbp_get_user_reply_count_raw( $user_id = 0 ) {
+    $user_id = bbp_get_user_id( $user_id );
+    if ( empty( $user_id ) ) {
+        return false;
+    }
+
+    global $wpdb;
+
+    $where = get_posts_by_author_sql( bbp_get_reply_post_type(), true, $user_id );
+    $count = (int) $wpdb->get_var( "SELECT COUNT(*) FROM {$wpdb->posts} {$where}" );
+
+    return (int) apply_filters( 'bbp_get_user_reply_count_raw', $count, $user_id );
+}
+
+/**
+ * Bump the topic count for a user by a certain amount.
+ *
+ * @since bbPress (r5309)
+ *
+ * @param int $user_id
+ * @param int $difference
+ * @uses bbp_get_user_topic_count() To get the users current topic count
+ * @uses bbp_set_user_topic_count() To set the users new topic count
+ */
+function bbp_bump_user_topic_count( $user_id = 0, $difference = 1 ) {
+
+    // Validate user ID
+    $user_id = bbp_get_user_id( $user_id );
+    if ( empty( $user_id ) ) {
+        return false;
+    }
+
+    // Check meta for count, or query directly if not found
+    $count = bbp_get_user_topic_count( $user_id, true );
+    if ( empty( $count ) ) {
+        $count = bbp_get_user_topic_count_raw( $user_id );
+    }
+
+    // Add them up and filter them
+    $new_count = apply_filters( 'bbp_bump_user_topic_count', ( (int) $count + (int) $difference ), $user_id, $difference, $count );
+
+    return bbp_update_user_topic_count( $user_id, $new_count );
+}
+
+/**
+ * Bump the reply count for a user by a certain amount.
+ *
+ * @since bbPress (r5309)
+ *
+ * @param int $user_id
+ * @param int $difference
+ * @uses bbp_get_user_reply_count() To get the users current reply count
+ * @uses bbp_set_user_reply_count() To set the users new reply count
+ */
+function bbp_bump_user_reply_count( $user_id = 0, $difference = 1 ) {
+
+    // Validate user ID
+    $user_id = bbp_get_user_id( $user_id );
+    if ( empty( $user_id ) ) {
+        return false;
+    }
+
+    // Check meta for count, or query directly if not found
+    $count = bbp_get_user_reply_count( $user_id, true );
+    if ( empty( $count ) ) {
+        $count = bbp_get_user_reply_count_raw( $user_id );
+    }
+
+    // Add them up and filter them
+    $new_count = apply_filters( 'bbp_bump_user_reply_count', ( (int) $count + (int) $difference ), $user_id, $difference, $count );
+
+    return bbp_update_user_reply_count( $user_id, $new_count );
+}
+
+/**
+ * Helper function used to increase (by one) the count of topics for a user when
+ * a topic is published.
+ *
+ * @since bbPress (r5309)
+ *
+ * @access
+ * @param $topic_id
+ * @param $forum_id
+ * @param $anonymous_data
+ * @param $topic_author
+ */
+function bbp_increase_user_topic_count( $topic_id = 0 ) {
+    $user_id = bbp_get_topic_author_id( $topic_id );
+    return bbp_bump_user_topic_count( $user_id, 1 );
+}
+
+/**
+ * Helper function used to increase (by one) the count of replies for a user when
+ * a reply is published.
+ *
+ * This is a helper function, hooked to `bbp_new_reply`
+ *
+ * @since bbPress (r5309)
+ *
+ * @param $topic_id
+ * @param $forum_id
+ * @param $anonymous_data
+ * @param $topic_author
+ */
+function bbp_increase_user_reply_count( $reply_id = 0 ) {
+    $user_id = bbp_get_reply_author_id( $reply_id );
+    return bbp_bump_user_reply_count( $user_id, 1 );
+}
+
+/**
+ * Helper function used to decrease (by one) the count of topics for a user when
+ * a topic is unpublished.
+ *
+ * @since bbPress (r5309)
+ *
+ * @param $topic_id
+ */
+function bbp_decrease_user_topic_count( $topic_id = 0 ) {
+    $user_id = bbp_get_topic_author_id( $topic_id );
+    return bbp_bump_user_topic_count( $user_id, -1 );
+}
+
+/**
+ * Helper function used to increase (by one) the count of replies for a user when
+ * a topic is unpublished.
+ *
+ * @since bbPress (r5309)
+ *
+ * @param $reply_id
+ */
+function bbp_decrease_user_reply_count( $reply_id = 0 ) {
+    $user_id = bbp_get_reply_author_id( $reply_id );
+    return bbp_bump_user_reply_count( $user_id, -1 );
+}
+
+/** Permissions ***************************************************************/
 
 /**

trunk/src/includes/users/options.php

@@ -43 +43 @@
     // Validate user id
     $user_id = bbp_get_user_id( $user_id );
-    if ( empty( $user_id ) )
+    if ( empty( $user_id ) ) {
         return;
+    }
 
     // Add default options
-    foreach ( bbp_get_default_user_options() as $key => $value )
+    foreach ( bbp_get_default_user_options() as $key => $value ) {
         update_user_option( $user_id, $key, $value );
+    }
 
     // Allow previously activated plugins to append their own user options.
@@ -69 +71 @@
     // Validate user id
     $user_id = bbp_get_user_id( $user_id );
-    if ( empty( $user_id ) )
+    if ( empty( $user_id ) ) {
         return;
+    }
 
     // Add default options
-    foreach ( array_keys( bbp_get_default_user_options() ) as $key )
+    foreach ( array_keys( bbp_get_default_user_options() ) as $key ) {
         delete_user_option( $user_id, $key );
+    }
 
     // Allow previously activated plugins to append their own options.
@@ -92 +96 @@
 
     // Add filters to each bbPress option
-    foreach ( array_keys( bbp_get_default_user_options() ) as $key )
+    foreach ( array_keys( bbp_get_default_user_options() ) as $key ) {
         add_filter( 'get_user_option_' . $key, 'bbp_filter_get_user_option', 10, 3 );
+    }
 
     // Allow previously activated plugins to append their own options.
@@ -111 +116 @@
 
     // Check the options global for preset value
-    if ( isset( $user->ID ) && isset( $bbp->user_options[$user->ID] ) && !empty( $bbp->user_options[$user->ID][$option] ) )
+    if ( isset( $user->ID ) && isset( $bbp->user_options[$user->ID] ) && !empty( $bbp->user_options[$user->ID][$option] ) ) {
         $value = $bbp->user_options[$user->ID][$option];
+    }
 
     // Always return a value, even if false
@@ -119 +125 @@
 
 /** Post Counts ***************************************************************/
+
+/**
+ * Update the topic count for a user
+ *
+ * @since bbPress (r5309)
+ *
+ * @param int $user_id
+ * @param mixed $count
+ * @return boolean
+ */
+function bbp_update_user_topic_count( $user_id = 0, $count = false ) {
+
+    // Validate user id
+    $user_id = bbp_get_user_id( $user_id );
+    if ( empty( $user_id ) ) {
+        return false;
+    }
+
+    // Just in time filtering of the user's topic count
+    $count = apply_filters( 'bbp_update_user_topic_count', $count, $user_id );
+
+    // Bail if no count was passed
+    if ( false === $count ) {
+        return false;
+    }
+
+    // Return the updated user option
+    return update_user_option( $user_id, '_bbp_topic_count', $count );
+}
+
+/**
+ * Update the reply count for a user
+ *
+ * @since bbPress (r5309)
+ *
+ * @param int $user_id
+ * @param mixed $count
+ * @return boolean
+ */
+function bbp_update_user_reply_count( $user_id = 0, $count = false ) {
+
+    // Validate user id
+    $user_id = bbp_get_user_id( $user_id );
+    if ( empty( $user_id ) ) {
+        return false;
+    }
+
+    // Just in time filtering of the user's reply count
+    $count = apply_filters( 'bbp_update_user_reply_count', $count, $user_id );
+
+    // Bail if no count was passed
+    if ( false === $count ) {
+        return false;
+    }
+
+    // Return the updated user option
+    return update_user_option( $user_id, '_bbp_reply_count', $count );
+}
 
 /**
@@ -146 +210 @@
      */
     function bbp_get_user_topic_count( $user_id = 0, $integer = false ) {
-
+ 
         // Validate user id
         $user_id = bbp_get_user_id( $user_id );
-        if ( empty( $user_id ) )
+        if ( empty( $user_id ) ) {
             return false;
+        }
 
         $count  = (int) get_user_option( '_bbp_topic_count', $user_id );
@@ -187 +252 @@
         // Validate user id
         $user_id = bbp_get_user_id( $user_id );
-        if ( empty( $user_id ) )
+        if ( empty( $user_id ) ) {
             return false;
+        }
 
         $count  = (int) get_user_option( '_bbp_reply_count', $user_id );
-        $filter = ( true === $integer ) ? 'bbp_get_user_topic_count_int' : 'bbp_get_user_topic_count';
+        $filter = ( true === $integer ) ? 'bbp_get_user_reply_count_int' : 'bbp_get_user_reply_count';
 
         return apply_filters( $filter, $count, $user_id );
@@ -225 +291 @@
         // Validate user id
         $user_id = bbp_get_user_id( $user_id );
-        if ( empty( $user_id ) )
+        if ( empty( $user_id ) ) {
             return false;
+        }
 
         $topics  = bbp_get_user_topic_count( $user_id, true );
@@ -250 +317 @@
     // Validate user id
     $user_id = bbp_get_user_id( $user_id );
-    if ( empty( $user_id ) )
-        return false;
+    if ( empty( $user_id ) ) {
+        return false;
+    }
 
     // Set time to now if nothing is passed
-    if ( empty( $time ) )
+    if ( empty( $time ) ) {
         $time = time();
+    }
 
     return update_user_option( $user_id, '_bbp_last_posted', $time );
@@ -282 +351 @@
         // Validate user id
         $user_id = bbp_get_user_id( $user_id );
-        if ( empty( $user_id ) )
+        if ( empty( $user_id ) ) {
             return false;
+        }
 
         $time = get_user_option( '_bbp_last_posted', $user_id );