Changeset 4043

Timestamp:

09/13/2016 01:49:12 AM (9 years ago)

Author:

jmdodd

Message:

Support Forums: Allow plugin/theme authors to set topics as sticky on their support forum.

Location:

sites/trunk/wordpress.org/public_html/wp-content/plugins/support-forums/inc

Files:

• class-directory-compat.php (modified) (1 diff)
• class-stickies-compat.php (modified) (4 diffs)

sites/trunk/wordpress.org/public_html/wp-content/plugins/support-forums/inc/class-directory-compat.php

@@ -184 +184 @@
                 if ( class_exists( 'WPORG_Ratings' ) && class_exists( 'WordPressdotorg\Forums\Ratings_Compat' ) ) {
                     $this->ratings = new Ratings_Compat( $this->compat(), $this->slug(), $this->taxonomy(), $this->get_object( $this->slug() ) );
+                }
+
+                // Instantiate WPORG_Stickies mode for topic view.
+                if ( class_exists( 'WordPressdotorg\Forums\Stickies_Compat' ) ) {
+                    $this->stickies = new Stickies_Compat( $this->compat(), $this->slug(), $this->taxonomy(), $this->get_object( $this->slug() ), $this->term, $this->authors );
                 }
 

sites/trunk/wordpress.org/public_html/wp-content/plugins/support-forums/inc/class-stickies-compat.php

@@ -13 +13 @@
     var $term     = null;
 
-    public function __construct( $compat, $slug, $taxonomy, $object, $term ) {
+    public function __construct( $compat, $slug, $taxonomy, $object, $term, $authors = array() ) {
         if ( empty( $compat ) || empty( $slug ) || empty( $taxonomy ) || empty( $object ) || empty( $term ) ) {
             return;
@@ -23 +23 @@
         $this->object   = $object;
         $this->term     = $term;
-
+        $this->authors  = $authors;
+
+        // Add compat stickies to sticky array.
         add_filter( 'bbp_get_stickies', array( $this, 'get_compat_stickies' ), 10, 2 );
+
+        // Add topic toggle for compat authors.
+        add_action( 'bbp_get_request', array( $this, 'sticky_handler' ) );
+
+        // Add link to topic admin.
+        add_filter( 'bbp_topic_admin_links', array( $this, 'admin_links' ), 10, 2 );
     }
 
@@ -42 +50 @@
 
     /**
+     */
+    public function sticky_handler( $action = '' ) {
+        // Bail if the action isn't meant for this function.
+        if ( ! in_array( $action, array(
+            'wporg_bbp_stick_topic',
+            'wporg_bbp_unstick_topic',
+        ) ) ) {
+            return;
+        }
+
+        // Bail if no topic id or term id are passed.
+        if ( empty( $_GET['topic_id'] ) || empty( $_GET['term_id'] ) ) {
+            return;
+        }
+
+        // Get required data.
+        $topic   = get_post( absint( $_GET['topic_id'] ) );
+        $term    = get_term( absint( $_GET['term_id'] ) );
+        $user_id = get_current_user_id();
+
+        // Check for empty topic or term id.
+        if ( ! $topic || ! $term ) {
+            bbp_add_error( 'wporg_bbp_sticky_topic_id', __( '<strong>ERROR</strong>: No topic was found! Which topic are you sticking?', 'wporg-forums' ) );
+
+        // Check user.
+        } elseif ( ! $this->user_can_stick( $user_id, $term->term_id, $topic->ID ) ) {
+            bbp_add_error( 'wporg_bbp_sticky_logged_in', __( '<strong>ERROR</strong>: You do not have permission to do this!', 'wporg-forums' ) );
+
+        // Check nonce.
+        } elseif( ! bbp_verify_nonce_request( 'toggle-topic-sticky_' . $topic->ID . '_' . $term->term_id ) ) {
+            bbp_add_error( 'wporg_bbp_sticky_nonce', __( '<strong>ERROR</strong>: Are you sure you wanted to do that?', 'wporg-forums' ) );
+        }
+
+        if ( bbp_has_errors() ) {
+            return;
+        }
+
+        $is_sticky = self::is_sticky( $term->term_id, $topic->ID );
+        $success = false;
+
+        // Stick/unstick the topic.
+        if ( 'wporg_bbp_stick_topic' == $action ) {
+            $success = self::add_sticky( $term->term_id, $topic->ID );
+        } elseif ( 'wporg_bbp_unstick_topic' == $action ) {
+            $success = self::remove_sticky( $term->term_id, $topic->ID );
+        }
+
+        $permalink = get_permalink( $topic->ID );
+
+        if ( $success && ! is_wp_error( $success ) ) {
+            bbp_redirect( $permalink );
+        } elseif ( true === $is_sticky && 'wporg_bbp_stick_topic' == $action ) {
+            bbp_add_error( 'wporg_bbp_stick_topic', __( '<strong>ERROR<strong>: There was a problem sticking that topic!', 'wporg-forums' ) );
+        } elseif ( false === $is_sticky && 'wporg_bbp_unstick_topic' == $action ) {
+            bbp_add_error( 'wporg_bbp_unstick_topic', __( '<strong>ERROR</strong>: There was a problem unsticking that topic!', 'wporg-forums' ) );
+        }
+    }
+
+    /**
+     * Replace the bbPress stick link with the custom stick link in compat topics.
+     *
+     * @param array $r The array of admin links
+     * @param int $topic_id The topic id
+     * @return array The filtered array of admin links
+     */
+    public function admin_links( $r, $topic_id ) {
+        if ( ! bbp_is_single_topic() ) {
+            return $r;
+        }
+        $user_id = get_current_user_id();
+        if ( $this->user_can_stick( $user_id, $this->term->term_id, $topic_id ) ) {
+            $r['stick'] = self::get_stick_link( array( 'topic_id' => $topic_id, 'term_id' => $this->term->term_id ) );
+        } else {
+            unset( $r['stick'] );
+        }
+        return $r;
+    }
+
+    /**
+     * Get the link to stick/unstick a compat topic.
+     *
+     * @param array $args The link arguments
+     * @return string The linked URL
+     */
+    public static function get_stick_link( $args = array() ) {
+        $user_id = get_current_user_id();
+
+        $r = bbp_parse_args( $args, array(
+            'topic_id' => get_the_ID(),
+            'term_id'  => 0,
+            'stick'    => esc_html__( 'Stick', 'wporg-forums' ),
+            'unstick'  => esc_html__( 'Unstick', 'wporg-forums' ),
+        ), 'get_topic_stick_link' );
+        if ( empty( $r['topic_id'] ) || empty( $r['term_id'] ) ) {
+            return false;
+        }
+
+        $topic = get_post( $r['topic_id'] );
+        $term  = get_term( $r['term_id'] );
+        if ( ! $topic || ! $term ) {
+            return false;
+        }
+
+        if ( self::is_sticky( $term->term_id, $topic->ID ) ) {
+            $text = $r['unstick'];
+            $query_args = array( 'action' => 'wporg_bbp_unstick_topic', 'topic_id' => $topic->ID, 'term_id' => $term->term_id );
+        } else {
+            $text = $r['stick'];
+            $query_args = array( 'action' => 'wporg_bbp_stick_topic', 'topic_id' => $topic->ID, 'term_id' => $term->term_id );
+        }
+
+        $permalink = get_permalink( $topic->ID );
+        $url = esc_url( wp_nonce_url( add_query_arg( $query_args, $permalink ), 'toggle-topic-sticky_' . $topic->ID . '_' . $term->term_id ) );
+        return sprintf( "<a href='%s'>%s</a>", $url, esc_html( $text ) );
+    }
+
+    /**
+     * Is a given user allowed to stick/unstick a topic?
+     *
+     * @param int $user_id The user id
+     * @param int $term_id The term id
+     * @param int $topic_id The topic id
+     * @return bool True if allowed, false if not
+     */
+    public function user_can_stick( $user_id = 0, $term_id = 0, $topic_id = 0 ) {
+        $retval = $topic = $term = false;
+
+        if ( empty( $user_id ) ) {
+            $user_id = get_current_user_id();
+        }
+
+        if ( $topic_id ) {
+            $topic = get_post( $topic_id );
+        }
+        if ( $term_id ) {
+            $term = get_term( $term_id );
+        }
+
+        if ( $user_id && $topic && $term ) {
+            // Moderators.
+            if ( user_can( $user_id, 'moderate' ) ) {
+                $retval = true;
+            }
+
+            // Compat authors.
+            if ( $this->authors && in_array( $user_id, $this->authors ) ) {
+                $retval = true;
+            }
+        }
+        return $retval;
+    }
+
+    /**
+     * Is a topic sticky for this term?
+     *
+     * @param int $term_id The term id
+     * @param int $topic_id The topic id
+     * @return bool True if sticky, false if not
+     */
+    public static function is_sticky( $term_id, $topic_id ) {
+        $stickies = self::get_stickies( $term_id );
+        return in_array( $topic_id, $stickies );
+    }
+
+    /**
+     * Add a topic id to a term's list of sticky topic ids.
+     *
+     * @param int $term_id The term id
+     * @param int $topic_id The topic id
+     */
+    public static function add_sticky( $term_id, $topic_id ) {
+        $stickies = self::get_stickies( $term_id );
+        if ( ! in_array( $topic_id, $stickies ) ) {
+            $stickies[] = $topic_id;
+        }
+        return self::set_stickies( $term_id, $stickies );
+    }
+
+    /**
+     * Remove a topic id from a term's list of sticky topic ids.
+     *
+     * @param int $topic_id The topic id
+     * @param int $term_id The term id
+     */
+    public static function remove_sticky( $term_id, $topic_id ) {
+        $stickies = self::get_stickies( $term_id );
+        if ( ( $key = array_search( $topic_id, $stickies ) ) !== false ) {
+            unset( $stickies[ $key ] );
+        }
+        return self::set_stickies( $term_id, $stickies );
+    }
+
+    /**
      * Return an array of topic sticky ids for a given term.
      *
@@ -56 +257 @@
         return $retval;
     }
+
+    /**
+     * Set the topic sticky ids for a given term.
+     *
+     * @param int $term_id The term id
+     * @param array $stickies The sticky topic ids
+     */
+    public static function set_stickies( $term_id, $stickies = array() ) {
+        return update_term_meta( $term_id, self::META, implode( ',', $stickies ) );
+    }
 }