Changeset 5834 for trunk/src/includes/users/capabilities.php

Timestamp:

07/15/2015 03:59:23 PM (11 years ago)

Author:

johnjamesjacoby

Message:

Moderators: First pass at per-forum moderators.

This commit introduces a powerful feature commonly found in other popular forum software that has been on our wishlist for nearly 9 years. It includes the following changes:

• Custom forum-mod taxonomy for assigning user nicenames to forum IDs
• Associated functions for defining capabilities, labels, etc...
• New capability filters for ensuring forum moderators have the ability to moderate forums even without the moderator role assignment
• New option for toggling the entire feature on/off (on by default)

Props jmdodd, netweb. See #459.

File:

• trunk/src/includes/users/capabilities.php (modified) (5 diffs)

trunk/src/includes/users/capabilities.php

@@ -15 +15 @@
  * @since bbPress (r4242)
  *
- * @param array $caps Capabilities for meta capability
- * @param string $cap Capability name
- * @param int $user_id User id
- * @param array $args Arguments
+ * @param array  $caps Capabilities for meta capability.
+ * @param string $cap Capability name.
+ * @param int    $user_id User id.
+ * @param array  $args Arguments.
+ * @uses bbp_is_user_inactive() To check if user is spammer or deleted
+ * @uses get_post() To get the post
+ * @uses bbp_get_forum_post_type() To get the forum post type
+ * @uses bbp_get_topic_post_type() To get the topic post type
+ * @uses bbp_get_topic_forum_id() To get the topic forum id
+ * @uses bbp_get_reply_post_type() To get the reply post type
+ * @uses bbp_get_reply_forum_id() To get the reply forum id
+ * @uses bbp_is_user_forum_mod() To check if the user is a forum moderator
  * @uses apply_filters() Filter mapped results
+ *
  * @return array Actual capabilities for meta capability
  */
@@ -26 +35 @@
         // What capability is being checked?
         switch ( $cap ) {
-                case 'spectate'    :
-                case 'participate' :
-                case 'moderate'    :
-
-                        // Do not allow inactive users
+                case 'spectate' :
+
+                        // Do not allow inactive users.
                         if ( bbp_is_user_inactive( $user_id ) ) {
                                 $caps = array( 'do_not_allow' );
 
-                        // Moderators are always participants
+                        // Default to the current cap.
                         } else {
                                 $caps = array( $cap );
+                        }
+                        break;
+
+                case 'participate' :
+
+                        // Do not allow inactive users.
+                        if ( bbp_is_user_inactive( $user_id ) ) {
+                                $caps = array( 'do_not_allow' );
+
+                        // Default to the current cap.
+                        } else {
+                                $caps = array( $cap );
+                        }
+                        break;
+
+                case 'moderate' :
+
+                        // Do not allow inactive users.
+                        if ( bbp_is_user_inactive( $user_id ) ) {
+                                $caps = array( 'do_not_allow' );
+
+                        // Default to the current cap.
+                        } else {
+                                $caps = array( $cap );
+
+                                // Bail if no post to check.
+                                if ( empty( $args[0] ) ) {
+                                        break;
+                                }
+
+                                // Get the post.
+                                $_post = get_post( $args[0] );
+                                if ( empty( $_post ) ) {
+                                        break;
+                                }
+
+                                // Get forum ID for specific type of post.
+                                switch ( $_post->post_type ) {
+
+                                        // Forum.
+                                        case bbp_get_forum_post_type() :
+                                                $forum_id = $_post->ID;
+                                                break;
+
+                                        // Topic.
+                                        case bbp_get_topic_post_type() :
+                                                $forum_id = bbp_get_topic_forum_id( $_post->ID );
+                                                break;
+
+                                        // Reply.
+                                        case bbp_get_reply_post_type() :
+                                                $forum_id = bbp_get_reply_forum_id( $_post->ID );
+                                                break;
+
+                                        // Any other post type defaults to 0.
+                                        default :
+                                                $forum_id = 0;
+                                                break;
+                                }
+
+                                // Bail if no forum ID.
+                                if ( empty( $forum_id ) ) {
+                                        break;
+                                }
+
+                                // If user is a per-forum moderator, make sure they can spectate.
+                                if ( bbp_is_user_forum_mod( $user_id, $forum_id ) ) {
+                                        $caps = array( 'spectate' );
+                                }
                         }
 
@@ -212 +288 @@
                 return;
         }
-        
+
         // Bail if current user cannot promote the passing user
         if ( ! current_user_can( 'promote_user', $user_id ) ) {
@@ -308 +384 @@
 
         // Don't add the user, but still give them the correct caps dynamically
-        } else {                
+        } else {
                 $bbp->current_user->caps[$new_role] = true;
                 $bbp->current_user->get_role_caps();
@@ -671 +747 @@
  * @since bbPress (r4783)
  *
- * @param int $user_id 
+ * @param int $user_id
  * @return bool True if keymaster, false if not
  */