<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[3797] sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-bbp-topic-resolution: Support: Allow front-end updating of topic resolution.</title>
</head>
<body>

<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt;  }
#msg dl a { font-weight: bold}
#msg dl a:link    { color:#fc3; }
#msg dl a:active  { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff  {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="http://meta.trac.wordpress.org/changeset/3797">3797</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://meta.trac.wordpress.org/changeset/3797","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>jmdodd</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2016-08-10 17:06:22 +0000 (Wed, 10 Aug 2016)</dd>
</dl>

<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Support: Allow front-end updating of topic resolution.

Lets moderators and topic authors change the topic resolution status.

See <a href="http://meta.trac.wordpress.org/ticket/1544">#1544</a>, <a href="http://meta.trac.wordpress.org/ticket/1873">#1873</a>.</pre>

<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginswporgbbptopicresolutionincclasspluginphp">sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-bbp-topic-resolution/inc/class-plugin.php</a></li>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginswporgbbptopicresolutionwporgbbptopicresolutionphp">sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-bbp-topic-resolution/wporg-bbp-topic-resolution.php</a></li>
</ul>

</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginswporgbbptopicresolutionincclasspluginphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-bbp-topic-resolution/inc/class-plugin.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-bbp-topic-resolution/inc/class-plugin.php  2016-08-09 22:52:06 UTC (rev 3796)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-bbp-topic-resolution/inc/class-plugin.php    2016-08-10 17:06:22 UTC (rev 3797)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -5,11 +5,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> class Plugin {
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><span class="cx" style="display: block; padding: 0 10px">        /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-         * @todo Edit enabled forums - will need to be updateable from the admin interface for administrators during forum setup
-        * Decisions: default topic resolution is 'no'
-        */
-
-       /**
</del><span class="cx" style="display: block; padding: 0 10px">          * @var Plugin The singleton instance.
</span><span class="cx" style="display: block; padding: 0 10px">         */
</span><span class="cx" style="display: block; padding: 0 10px">        private static $instance;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -42,7 +37,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">                // Change the topic title when resolved.
</span><span class="cx" style="display: block; padding: 0 10px">                add_filter( 'bbp_get_topic_title', array( $this, 'get_topic_title' ), 10, 2 );
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-                // Display the form for new/edited topics.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+         // Display the form for new/edit topics.
</ins><span class="cx" style="display: block; padding: 0 10px">                 add_action( 'bbp_theme_before_topic_form_content', array( $this, 'form_topic_resolution_dropdown' ) );
</span><span class="cx" style="display: block; padding: 0 10px">                add_action( 'bbp_theme_before_topic_form_subscriptions', array( $this, 'form_topic_resolution_checkbox' ) );
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -50,6 +45,10 @@
</span><span class="cx" style="display: block; padding: 0 10px">                add_action( 'bbp_new_topic_post_extras', array( $this, 'topic_post_extras' ) );
</span><span class="cx" style="display: block; padding: 0 10px">                add_action( 'bbp_edit_topic_post_extras', array( $this, 'topic_post_extras' ) );
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+                // Add form for moderator/user topic resolution update.
+               // @todo Add AJAX processing to front-end topic resolution updates.
+               add_action( 'bbp_post_request', array( $this, 'topic_resolution_handler' ) );
+
</ins><span class="cx" style="display: block; padding: 0 10px">                 // Register views.
</span><span class="cx" style="display: block; padding: 0 10px">                add_action( 'bbp_register_views', array( $this, 'register_views' ) );
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -57,7 +56,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">                add_filter( 'manage_forum_posts_columns', array( $this, 'add_forum_topic_resolution_column' ), 11 );
</span><span class="cx" style="display: block; padding: 0 10px">                add_action( 'manage_forum_posts_custom_column', array( $this, 'add_forum_topic_resolution_value' ), 10, 2 );
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-                // Process field submission
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+         // Process changes to a forums support status.
</ins><span class="cx" style="display: block; padding: 0 10px">                 // @todo Bulk actions aren't filterable, so this might be hacky.
</span><span class="cx" style="display: block; padding: 0 10px">        }
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -81,7 +80,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">                        return;
</span><span class="cx" style="display: block; padding: 0 10px">                }
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-                // Only display on topic edits
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+         // Only display on topic edit.
</ins><span class="cx" style="display: block; padding: 0 10px">                 if ( ! bbp_is_topic_edit() ) {
</span><span class="cx" style="display: block; padding: 0 10px">                        return;
</span><span class="cx" style="display: block; padding: 0 10px">                }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -154,6 +153,119 @@
</span><span class="cx" style="display: block; padding: 0 10px">        }
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><span class="cx" style="display: block; padding: 0 10px">        /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+         * Output topic resolution as a string or a selection dropdown.
+        */
+       public function get_topic_resolution_form() {
+               // Only display on forums where this is enabled
+               if ( ! $this->is_enabled_on_forum() ) {
+                       return;
+               }
+
+               // Only display on single topic.
+               if ( ! bbp_is_single_topic() && ! bbp_is_topic_edit() ) {
+                       return;
+               }
+
+               // Get topic and user data.
+               $topic_id = intval( bbp_get_topic_id() );
+               $topic = bbp_get_topic( $topic_id );
+               if ( ! $topic_id || ! $topic ) {
+                       return;
+               }
+
+               // Get the current resolution of this topic.
+               $resolution = $this->get_topic_resolution( array( 'id' => bbp_get_topic_id() ) );
+               if ( empty( $resolution ) ) {
+                       $resolution = $this->get_default_topic_resolution();
+               }
+               $resolutions = $this->get_topic_resolutions();
+
+               // Display the current topic resolution if the user can't update it.
+               $user_id = get_current_user_id();
+               if ( bbp_is_topic_edit() || ! $this->user_can_resolve( $user_id, $topic_id ) ) {
+                       printf( esc_html__( 'Status: %s', 'wporg-forums' ), $resolutions[ $resolution ] );
+
+               // Display the form to update the topic resolution.
+               } else {
+                       ?>
+                       <form method="POST">
+                       <input type="hidden" name="action" value="wporg_bbp_topic_resolution" />
+                       <input type="hidden" name="topic_id" value="<?php echo esc_attr( $topic->ID ); ?>" />
+                       <?php wp_nonce_field( 'toggle-topic-resolution_' . $topic->ID ); ?>
+                       <label for="topic-resolved"><?php esc_html_e( 'Status:', 'wporg-forums' ); ?></label>
+
+                       <select name="<?php echo esc_attr( self::META_KEY ); ?>" id="topic-resolved">
+
+                       <?php foreach ( $resolutions as $key => $label ) : ?>
+
+                               <option value="<?php echo esc_attr( $key ); ?>" <?php selected( $key, $resolution ); ?>><?php echo esc_html( $label ); ?></option>
+
+                       <?php endforeach; ?>
+
+                       </select>
+                       <input type="submit" name="submit" value="<?php esc_attr_e( 'Update', 'wporg-forums' ); ?>" />
+                       </form></span>
+                       <?php
+               }
+       }
+
+       /**
+        * Handle a user setting the topic resolution on a given topic.
+        *
+        * @param string $action The requested action to compare this function to
+        */
+       public function topic_resolution_handler( $action = '' ) {
+               if ( ! $this->is_enabled_on_forum() ) {
+                       return false;
+               }
+
+               // Bail if the action isn't meant for this function.
+               if ( $action != 'wporg_bbp_topic_resolution' ) {
+                       return;
+               }
+
+               // Bail if no topic id or resolution is passed.
+               if ( empty( $_POST['topic_id'] ) || empty( $_POST[ self::META_KEY ] ) ) {
+                       return;
+               }
+
+               // Get required data.
+               $topic_id   = intval( $_POST['topic_id'] );
+               $topic      = bbp_get_topic( $topic_id );
+               $user_id    = get_current_user_id();
+               $resolution = $_POST[ self::META_KEY ];
+
+               // Check for empty topic id.
+               if ( empty( $topic_id ) || ! $topic ) {
+                       bbp_add_error( 'wporg_bbp_topic_resolution_topic_id', __( '<strong>ERROR</strong>: No topic was found!', 'wporg-forums' ) );
+
+               // Check valid resolution.
+               } elseif ( ! $this->is_valid_topic_resolution( $resolution ) ) {
+                       bbp_add_error( 'wporg_bbp_topic_resolution_invalid', __( '<strong>ERROR</srong>: That is not a valid topic resolution!', 'wporg-forums' ) );
+
+               // Check user permissions.
+               } elseif ( ! $this->user_can_resolve( $user_id, $topic->ID ) ) {
+                       bbp_add_error( 'wporg_bbp_topic_resolution_permissions', __( '<strong>ERROR</strong>: You don\t have permission to do this!', 'wporg-forums' ) );
+
+               // Check nonce.
+               } elseif ( ! bbp_verify_nonce_request( 'toggle-topic-resolution_' . $topic->ID ) ) {
+                       bbp_add_error( 'wporg_bbp_topic_resolution_nonce', __( '<strong>ERROR</strong>: Are you sure you wanted to do that?', 'wporg-forums' ) );
+               }
+
+               if ( bbp_has_errors() ) {
+                       return;
+               }
+
+               // Update the topic resolution.
+               $this->set_topic_resolution( array(
+                       'id'         => $topic->ID,
+                       'resolution' => $resolution,
+               ) );
+
+               bbp_redirect( get_permalink( $topic->ID ) );
+       }
+
+       /**
</ins><span class="cx" style="display: block; padding: 0 10px">          * Register resolution state views.
</span><span class="cx" style="display: block; padding: 0 10px">         */
</span><span class="cx" style="display: block; padding: 0 10px">        public function register_views() {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -307,12 +419,24 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><span class="cx" style="display: block; padding: 0 10px">        public function get_topic_resolutions() {
</span><span class="cx" style="display: block; padding: 0 10px">                return apply_filters( 'wporg_bbp_get_topic_resolutions', array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-                                'no'  => __( 'not resolved', 'wporg-forums' ),
-                               'yes' => __( 'resolved', 'wporg-forums' ),
-                               'mu'  => __( 'not a support question', 'wporg-forums' ),
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+                 'no'  => __( 'not resolved', 'wporg-forums' ),
+                       'yes' => __( 'resolved', 'wporg-forums' ),
+                       'mu'  => __( 'not a support question', 'wporg-forums' ),
</ins><span class="cx" style="display: block; padding: 0 10px">                 ) );
</span><span class="cx" style="display: block; padding: 0 10px">        }
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+        /**
+        * Is a topic resolution string in the array of possible resolutions?
+        *
+        * @param string $resolution The resolution to check
+        * @return bool True if in the array, false if not
+        */
+       public function is_valid_topic_resolution( $resolution ) {
+               $resolutions = $this->get_topic_resolutions();
+               $retval = in_array( $resolution, array_keys( $resolutions ) );
+               return apply_filters( 'wporg_bbp_is_valid_topic_resolution', $retval, $resolution );
+       }
+
</ins><span class="cx" style="display: block; padding: 0 10px">         public function get_default_topic_resolution() {
</span><span class="cx" style="display: block; padding: 0 10px">                $retval = get_option( '_bbp_default_topic_resolution' );
</span><span class="cx" style="display: block; padding: 0 10px">                if ( false == $retval ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -329,4 +453,25 @@
</span><span class="cx" style="display: block; padding: 0 10px">                }
</span><span class="cx" style="display: block; padding: 0 10px">                return apply_filters( 'wporg_bbp_sanitize_topic_resolution', $retval );
</span><span class="cx" style="display: block; padding: 0 10px">        }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+       /**
+        * Is a given user is allowed to update the resolution of a topic?
+        *
+        * @param int $user_id The user id
+        * @param int $topic_id The topic id
+        * @return bool True if allowed, false if not
+        */
+       public function user_can_resolve( $user_id, $topic_id ) {
+               $topic_id = bbp_get_topic_id();
+               if ( $topic_id ) {
+                       $post = get_post( $topic_id );
+               }
+
+               if ( $user_id && $post && ( user_can( $user_id, 'moderate' ) || $user_id == $post->post_author ) ) {
+                       $retval = true;
+               } else {
+                       $retval = false;
+               }
+               return apply_filters( 'wporg_bbp_user_can_resolve', $retval, $user_id, $topic_id );
+       }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginswporgbbptopicresolutionwporgbbptopicresolutionphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-bbp-topic-resolution/wporg-bbp-topic-resolution.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-bbp-topic-resolution/wporg-bbp-topic-resolution.php        2016-08-09 22:52:06 UTC (rev 3796)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-bbp-topic-resolution/wporg-bbp-topic-resolution.php  2016-08-10 17:06:22 UTC (rev 3797)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -26,6 +26,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> Plugin::get_instance();
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><span class="cx" style="display: block; padding: 0 10px"> // Easy access for templates
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function get_topic_resolution( $topic_id ) {
-       return Plugin::get_topic_resolution( array( 'id' => $topic_id ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function get_topic_resolution_form( $topic_id ) {
+       return Plugin::get_instance()->get_topic_resolution_form( array( 'id' => $topic_id ) );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>

</body>
</html>