Ticket #459: 459.5.diff

src/bbpress.php

@@ -223 +223 @@
 
                 // Post type identifiers
                 $this->forum_post_type   = apply_filters( 'bbp_forum_post_type',  'forum'     );
+                $this->forum_mod_tax_id  = apply_filters( 'bbp_forum_mod_tax_id', 'forum-mod' );
                 $this->topic_post_type   = apply_filters( 'bbp_topic_post_type',  'topic'     );
+                $this->topic_tag_tax_id  = apply_filters( 'bbp_topic_tag_tax_id', 'topic-tag' );
                 $this->reply_post_type   = apply_filters( 'bbp_reply_post_type',  'reply'     );
-                $this->topic_tag_tax_id  = apply_filters( 'bbp_topic_tag_tax_id', 'topic-tag' );
 
                 // Status identifiers
                 $this->spam_status_id    = apply_filters( 'bbp_spam_post_status',    'spam'    );
@@ -647 +648 @@
         }
 
         /**
-         * Register the topic tag taxonomy
+         * Register the topic tag and forum moderator taxonomies
          *
          * @since bbPress (r2464)
          * @uses register_taxonomy() To register the taxonomy
@@ -671 +672 @@
                                 'show_ui'               => bbp_allow_topic_tags() && current_user_can( 'bbp_topic_tags_admin' )
                         )
                 ) );
+
+                // Register the forum-mod taxonomy
+                register_taxonomy(
+                        bbp_get_forum_mod_tax_id(),
+                        bbp_get_forum_post_type(),
+                        apply_filters( 'bbp_register_forum_moderator_taxonomy', array(
+                                'labels'                => bbp_get_forum_mod_tax_labels(),
+                                'capabilities'          => bbp_get_forum_mod_caps(),
+                                'update_count_callback' => '_update_post_term_count',
+                                'query_var'             => false,
+                                'show_tagcloud'         => true,
+                                'hierarchical'          => false,
+                                'show_in_nav_menus'     => false,
+                                'public'                => false,
+                                'show_ui'               => bbp_allow_forum_mods() && current_user_can( 'bbp_forum_mods_admin' )
+                        )
+                ) );
         }
 
         /**

src/includes/admin/forums.php

@@ -58 +58 @@
         private function setup_actions() {
 
                 // Add some general styling to the admin area
-                add_action( 'bbp_admin_head',        array( $this, 'admin_head'       ) );
+                add_action( 'bbp_admin_head',          array( $this, 'admin_head'              ) );
 
                 // Messages
-                add_filter( 'post_updated_messages', array( $this, 'updated_messages' ) );
+                add_filter( 'post_updated_messages',   array( $this, 'updated_messages'        ) );
 
                 // Metabox actions
-                add_action( 'add_meta_boxes',        array( $this, 'attributes_metabox'      ) );
-                add_action( 'save_post',             array( $this, 'attributes_metabox_save' ) );
+                add_action( 'add_meta_boxes',          array( $this, 'attributes_metabox'      ) );
+                add_action( 'save_post',               array( $this, 'attributes_metabox_save' ) );
 
+                // Forum moderators AJAX; run at -1 to preempt built-in tag search
+                add_action( 'wp_ajax_ajax-tag-search', array( $this, 'ajax_tag_search'         ), -1 );
+
                 // Forum Column headers.
                 add_filter( 'manage_' . $this->post_type . '_posts_columns',        array( $this, 'column_headers' )        );
 
@@ -262 +265 @@
         }
 
         /**
+         * Return user nicename suggestions instead of tag suggestions
+         *
+         * @since bbPress (rXXXX)
+         *
+         * @return Return early if not a request for forum moderators tax
+         */
+        public function ajax_tag_search() {
+
+                // Only do AJAX if this is a forum moderators tax search
+                if ( ! isset( $_GET['tax'] ) || ( bbp_get_forum_mod_tax_id() !== $_GET['tax'] ) ) {
+                        return;
+                }
+
+                $taxonomy = sanitize_key( $_GET['tax'] );
+                $tax      = get_taxonomy( $taxonomy );
+                if ( empty( $tax ) ) {
+                        wp_die( 0 );
+                }
+
+                // Check permissions
+                if ( ! current_user_can( $tax->cap->assign_terms ) ) {
+                        wp_die( -1 );
+                }
+
+                $s = stripslashes( $_GET['q'] );
+
+                // Replace tag delimiter with a comma if needed
+                $comma = _x( ',', 'tag delimiter', 'bbpress' );
+                if ( ',' !== $comma ) {
+                        $s = str_replace( $comma, ',', $s );
+                }
+
+                if ( false !== strpos( $s, ',' ) ) {
+                        $s = explode( ',', $s );
+                        $s = $s[ count( $s ) - 1 ];
+                }
+
+                // Search on at least 2 characters
+                $s = trim( $s );
+                if ( strlen( $s ) < 2 ) {
+                        wp_die(); // require 2 chars for matching
+                }
+
+                // Get users
+                $results = array();
+                $users   = get_users( array(
+                        'blog_id'        => 0, // All users
+                        'fields'         => array( 'user_nicename' ),
+                        'search'         => '*' . $s . '*',
+                        'search_columns' => array( 'user_nicename' ),
+                        'orderby'        => 'user_nicename'
+                ) );
+
+                // Format the users into a nice array
+                if ( ! empty( $users ) ) {
+                        foreach( array_values( $users ) as $details ) {
+                                $results[] = $details->user_nicename;
+                        }
+                }
+
+                // Echo results for AJAX
+                echo join( $results, "\n" );
+                wp_die();
+        }
+
+        /**
          * Pass the forum attributes for processing
          *
          * @since bbPress (r2746)

src/includes/core/filters.php

@@ -239 +239 @@
 // Capabilities
 add_filter( 'bbp_map_meta_caps', 'bbp_map_primary_meta_caps',   10, 4 ); // Primary caps
 add_filter( 'bbp_map_meta_caps', 'bbp_map_forum_meta_caps',     10, 4 ); // Forums
+add_filter( 'bbp_map_meta_caps', 'bbp_map_forum_mod_meta_caps', 10, 4 ); // Forum moderator
 add_filter( 'bbp_map_meta_caps', 'bbp_map_topic_meta_caps',     10, 4 ); // Topics
+add_filter( 'bbp_map_meta_caps', 'bbp_map_topic_tag_meta_caps', 10, 4 ); // Topic tags
 add_filter( 'bbp_map_meta_caps', 'bbp_map_reply_meta_caps',     10, 4 ); // Replies
-add_filter( 'bbp_map_meta_caps', 'bbp_map_topic_tag_meta_caps', 10, 4 ); // Topic tags
 
 /** Deprecated ****************************************************************/
 

src/includes/core/options.php

@@ -235 +235 @@
 }
 
 /**
+ * Are per-forum moderators allowed
+ *
+ * @since bbPress (rXXXX)
+ * @param $default bool Optional. Default value true
+ * @uses get_option() To get the allow tags
+ * @return bool Are per-forum moderators allowed?
+ */
+function bbp_allow_forum_mods( $default = 1 ) {
+        return (bool) apply_filters( 'bbp_allow_forum_mods', (bool) get_option( '_bbp_allow_forum_mods', $default ) );
+}
+
+/**
  * Is forum-wide searching allowed
  *
  * @since bbPress (r4970)

src/includes/forums/capabilities.php

@@ -179 +179 @@
 
                 /** Admin *************************************************************/
 
+                // Forum admin area
                 case 'bbp_forums_admin' :
                         $caps = array( 'keep_gate' );
                         break;
+
+                // Forum moderator admin area
+                case 'bbp_forum_mods_admin' :
+                        $caps = array( 'keep_gate' );
+                        break;
         }
 
         return apply_filters( 'bbp_map_forum_meta_caps', $caps, $cap, $user_id, $args );
 }
+
+/**
+ * Return forum moderator capabilities
+ *
+ * @since bbPress (rXXXX)
+ *
+ * @uses apply_filters() Calls 'bbp_get_forum_mod_caps' with the capabilities
+ * @return array Forum mod capabilities
+ */
+function bbp_get_forum_mod_caps() {
+        return apply_filters( 'bbp_get_forum_mod_caps', array(
+                'manage_terms' => 'keep_gate',
+                'edit_terms'   => 'keep_gate',
+                'delete_terms' => 'keep_gate',
+                'assign_terms' => 'keep_gate'
+        ) );
+}
+
+/**
+ * Maps forum moderator capabilities
+ *
+ * @since bbPress (rXXXX)
+ *
+ * @param array $caps Capabilities for meta capability
+ * @param string $cap Capability name
+ * @param int $user_id User id
+ * @param mixed $args Arguments
+ * @uses apply_filters() Filter capabilities map results
+ * @return array Actual capabilities for meta capability
+ */
+function bbp_map_forum_mod_meta_caps( $caps, $cap, $user_id, $args ) {
+
+        // What capability is being checked?
+        switch( $cap ) {
+                case 'manage_forum_mods'    :
+                case 'edit_forum_mods'      :
+                case 'delete_forum_mods'    :
+                case 'assign_forum_mods'    :
+                case 'bbp_forum_mods_admin' :
+
+                        // Key Masters can always edit
+                        if ( user_can( $user_id, 'keep_gate' ) ) {
+                                $caps = array( 'keep_gate' );
+                        }
+        }
+
+        return apply_filters( 'bbp_map_forum_mod_meta_caps', $caps, $cap, $user_id, $args );
+}
+
+/**
+ * Get moderators of a forum
+ *
+ * @since bbPress (rXXXX)
+ *
+ * @param $forum_id Forum id
+ * @uses bbp_is_forum() To make sure it is a forum
+ * @uses bbp_get_forum_mod_tax_id() To get the forum moderator taxonomy
+ * @uses wp_get_object_terms() To get the forum's moderator terms
+ * @uses is_wp_error() To check for errors
+ * @uses bbp_get_term_taxonomy_user_id() To convert terms to user ids
+ * @return boolean Return false early, or if no moderator terms set, or
+ * @return array User ids
+ */
+function bbp_get_forum_mod_ids( $forum_id = 0 ) {
+
+        // Bail if no forum ID
+        $forum_id = bbp_get_forum_id( $forum_id );
+        if ( empty( $forum_id ) ) {
+                return false;
+        }
+
+        // Bail if forum does not exist
+        if ( ! bbp_is_forum( $forum_id ) ) {
+                return false;
+        }
+
+        // Get forum taxonomy terms
+        $taxonomy = bbp_get_forum_mod_tax_id();
+        $terms    = wp_get_object_terms( $forum_id, $taxonomy, array(
+                'fields' => 'ids'
+        ) );
+
+        // Bail if no terms found
+        if ( empty( $terms ) || is_wp_error( $terms ) ) {
+                return false;
+        }
+
+        $moderators = array();
+
+        // Convert term ids to user ids
+        foreach ( $terms as $term ) {
+                $user_id = bbp_get_term_taxonomy_user_id( $term, $taxonomy );
+                if ( !empty( $user_id ) ) {
+                        $moderators[] = $user_id;
+                }
+        }
+
+        // Moderators found
+        if ( !empty( $moderators ) ) {
+                return $moderators;
+        }
+
+        return false;
+}
+
+/**
+ * Get forums of a moderator
+ *
+ * @since bbPress (rXXXX)
+ *
+ * @param $user_id User id
+ * @uses get_userdata() To get the user object
+ * @uses bbp_get_forum_mod_tax_id() To get the forum moderator taxonomy
+ * @uses get_term_by() To get the term id
+ * @uses get_objects_in_term() Get the forums the user moderates
+ * @uses is_wp_error() To check for errors
+ * @uses bbp_is_forum() To make sure the objects are forums
+ * @return boolean Return false early, or if user has no forums, or
+ * @return array Forum ids
+ */
+function bbp_get_moderator_forum_ids( $user_id = 0 ) {
+
+        // Bail if no user ID
+        if ( empty( $user_id ) ) {
+                return false;
+        }
+
+        // Bail if user does not eist
+        $user = get_userdata( $user_id );
+        if ( empty( $user ) ) {
+                return false;
+        }
+
+        // Convert user id to term id
+        $taxonomy = bbp_get_forum_mod_tax_id();
+        $term_id  = bbp_get_user_taxonomy_term_id( $user_id, $taxonomy );
+
+        // Get moderator forums
+        $forums = get_objects_in_term( $term_id, $taxonomy );
+
+        // Forums found
+        if ( empty( $forums ) || is_wp_error( $forums ) ) {
+                return false;
+        }
+
+        // Make sure the ids returned are forums
+        $forum_ids = array();
+        foreach ( $forums as $forum_id ) {
+                if ( bbp_is_forum( $forum_id ) ) {
+                        $forum_ids[] = $forum_id;
+                }
+        }
+
+        return $forum_ids;
+}
+
+/**
+ * Can a user moderate a forum?
+ *
+ * @since bbPress (rXXXX)
+ *
+ * @param int $user_id
+ * @param int $forum_id
+ * @return bool
+ */
+function bbp_is_user_forum_mod( $user_id = 0, $forum_id = 0 ) {
+
+        // Assume user cannot moderate the forum
+        $retval    = false;
+
+        // Validate user ID - fallback to current user if no ID passed
+        $user_id   = bbp_get_user_id( $user_id, false, ! empty( $user_id ) );
+        $forum_id  = bbp_get_forum_id( $forum_id );
+
+        // Get forums the user can moderate
+        $forum_ids = bbp_get_moderator_forum_ids( $user_id );
+
+        // Is this forum ID in the users array of forum IDs?
+        if ( ! empty( $forum_ids ) ) {
+                $retval = in_array( $forum_id, $forum_ids );
+        }
+
+        return (bool) apply_filters( 'bbp_is_user_forum_mod', $retval, $user_id, $forum_id, $forum_ids );
+}
+ No newline at end of file

src/includes/forums/template.php

@@ -2160 +2160 @@
                 return apply_filters( 'bbp_get_single_forum_description', $retstr, $r );
         }
 
+/** Moderators ****************************************************************/
+
+/**
+ * Output the unique id of the forum moderators taxonomy
+ *
+ * @since bbPress (rXXXX)
+ *
+ * @uses bbp_get_forum_mod_tax_id() To get the forum modorator taxonomy ID
+ */
+function bbp_forum_mod_tax_id() {
+        echo bbp_get_forum_mod_tax_id();
+}
+        /**
+         * Return the unique id of the forum moderators taxonomy
+         *
+         * @since bbPress (rXXXX)
+         *
+         * @uses apply_filters() Calls 'bbp_get_forum_mod_tax_id' with the forum
+         *                        moderator taxonomy id
+         * @return string The unique forum moderators taxonomy
+         */
+        function bbp_get_forum_mod_tax_id() {
+                return apply_filters( 'bbp_get_forum_mod_tax_id', bbpress()->forum_mod_tax_id );
+        }
+
+/**
+ * Return array of labels used by the forum-mod taxonomy
+ *
+ * @since bbPress (rXXXX)
+ *
+ * @return array
+ */
+function bbp_get_forum_mod_tax_labels() {
+        return apply_filters( 'bbp_get_topic_tag_tax_labels', array(
+                'name'                       => __( 'Forum Moderators',     'bbpress' ),
+                'singular_name'              => __( 'Forum Moderator',      'bbpress' ),
+                'search_items'               => __( 'Search Moderators',    'bbpress' ),
+                'popular_items'              => __( 'Popular Moderators',   'bbpress' ),
+                'all_items'                  => __( 'All Moderators',       'bbpress' ),
+                'edit_item'                  => __( 'Edit Moderator',       'bbpress' ),
+                'update_item'                => __( 'Update Moderator',     'bbpress' ),
+                'add_new_item'               => __( 'Add New Moderator',    'bbpress' ),
+                'new_item_name'              => __( 'New Moderator Name',   'bbpress' ),
+                'view_item'                  => __( 'View Forum Moderator', 'bbpress' ),
+                'separate_items_with_commas' => __( 'Separate moderator names with commas', 'bbpress' )
+        ) );
+}
+
 /** Forms *********************************************************************/
 
 /**

src/includes/replies/capabilities.php

@@ -131 +131 @@
 
                                 // Unknown, so map to edit_others_posts
                                 } else {
-                                        $caps[] = $post_type->cap->edit_others_posts;
+
+                                        // If user is a per-forum moderator, make sure they can spectate
+                                        if ( bbp_is_user_forum_mod( $user_id, bbp_get_reply_forum_id( $_post->ID ) ) ) {
+                                                $caps = array( 'spectate' );
+
+                                        // Fallback to edit_others_posts
+                                        } else {
+                                                $caps[] = $post_type->cap->edit_others_posts;
+                                        }
                                 }
                         }
 

src/includes/topics/capabilities.php

@@ -149 +149 @@
 
                                 // Unknown, so map to edit_others_posts
                                 } else {
-                                        $caps[] = $post_type->cap->edit_others_posts;
+
+                                        // If user is a per-forum moderator, make sure they can spectate
+                                        if ( bbp_is_user_forum_mod( $user_id, bbp_get_topic_forum_id( $_post->ID ) ) ) {
+                                                $caps = array( 'spectate' );
+
+                                        // Fallback to edit_others_posts
+                                        } else {
+                                                $caps[] = $post_type->cap->edit_others_posts;
+                                        }
                                 }
                         }
 

src/includes/users/capabilities.php

@@ -35 +35 @@
 
                         // Moderators are always participants
                         } else {
+
+                                // Default to the current cap
                                 $caps = array( $cap );
+
+                                // Bail if no post to check
+                                if ( ( 'moderate' !== $cap ) || 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' );
+                                }
                         }
 
                         break;

src/includes/users/functions.php

@@ -1681 +1681 @@
         return bbp_bump_user_reply_count( $user_id, -1 );
 }
 
+/** User Nicename Taxonomies **************************************************/
+
+/**
+ * Return the term id for a given user id and taxonomy
+ *
+ * @since bbPress (rXXXX)
+ *
+ * @param int $user_id User id
+ * @param string $taxonomy Taxonomy
+ * @uses get_userdata() To get the user data
+ * @uses taxonomy_exists() To make sure the taxonomy exists
+ * @uses get_term_by() To get the term by name
+ *
+ * @return boolean Return false early, or if not found, or
+ * @return int Term id
+ */
+function bbp_get_user_taxonomy_term_id( $user_id = 0, $taxonomy = '' ) {
+
+        // Bail if no user ID
+        if ( empty( $user_id ) ) {
+                return false;
+        }
+
+        // Bail if user does not exist
+        $user = get_userdata( $user_id );
+        if ( empty( $user ) ) {
+                return false;
+        }
+
+        // Bail if no taxonomy
+        if ( empty( $taxonomy ) || ! taxonomy_exists( $taxonomy ) ) {
+                return false;
+        }
+
+        // Get the term id
+        $term = get_term_by( 'name', $user->user_nicename, $taxonomy );
+        if ( ! empty( $term ) ) {
+                return $term->term_id;
+        }
+
+        return false;
+}
+
+/**
+ * Return the user id for a given term id and taxonomy
+ *
+ * @since bbPress (rXXXX)
+ *
+ * @param int $term_id Term id
+ * @param string $taxonomy
+ * @uses taxonomy_exists() To make sure the taxonomy exists
+ * @uses get_term() To get the term by term id
+ * @uses get_user_by() To get the user by nicename
+ *
+ * @return boolean Return false early, or if not found, or
+ * @return int User id
+ */
+function bbp_get_term_taxonomy_user_id( $term_id = 0, $taxonomy = '' ) {
+
+        // Bail if no user ID
+        if ( empty( $term_id ) ) {
+                return false;
+        }
+
+        // Bail if no taxonomy
+        if ( empty( $taxonomy ) || ! taxonomy_exists( $taxonomy ) ) {
+                return false;
+        }
+
+        // Bail if no term exists
+        $term = get_term( $term_id, $taxonomy );
+        if ( empty( $term ) ) {
+                return false;
+        }
+
+        // Get the user by nicename
+        $nicename = $term->name;
+        $user     = get_user_by( 'slug', $nicename );
+        if ( !empty( $user ) ) {
+                return $user->ID;
+        }
+
+        return false;
+}
+
 /** Permissions ***************************************************************/
 
 /**