Changeset 2735

Timestamp:

03/11/2016 06:04:19 PM (9 years ago)

Author:

obenland

Message:

Plugin Directory: Use a custom comment type for internal notes.

See #1570, #1603.

Location:

sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory

Files:

• admin/class-customizations.php (modified) (7 diffs)
• admin/class-plugin-comments-list-table.php (added)
• admin/metabox/class-internal-notes.php (moved) (moved from sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/admin/metabox/class-notes.php) (2 diffs)
• class-plugin-directory.php (modified) (1 diff)
• css/edit-form.css (modified) (1 diff)
• js/edit-form.js (modified) (3 diffs)

sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/admin/class-customizations.php

@@ -11 +11 @@
 
     /**
-     * Fetch the instance of the Admin Customizations class.
+     * Fetch the instance of the Customizations class.
      */
     public static function instance() {
@@ -19 +19 @@
     }
 
+    /**
+     * Constructor.
+     */
     private function __construct() {
         // Admin Metaboxes
@@ -27 +30 @@
 
         add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_assets' ) );
-        add_action( 'wp_ajax_save-note', array( $this, 'save_note' ) );
+        add_action( 'wp_ajax_replyto-comment', array( $this, 'save_custom_comment' ), 0 );
+
+        add_filter( 'postbox_classes_plugin_internal-notes', array( $this, 'postbox_classes' ) );
     }
 
@@ -33 +38 @@
      * Adds the plugin name into the post editing title.
      *
-     * @global $title The wp-admin title variable.
+     * @global string $title The wp-admin title variable.
      *
      * @param string $post_type The post type of the current page
@@ -40 +45 @@
     public function replace_title_global( $post_type ) {
         global $title;
+
         if ( 'plugin' === $post_type ) {
             $title = sprintf( $title, get_the_title() ); // esc_html() on output
@@ -79 +85 @@
 
         add_meta_box(
-            'plugin-notes',
+            'internal-notes',
             __( 'Internal Notes', 'wporg-plugins' ),
-            array( __NAMESPACE__ . '\Metabox\Notes', 'display' ),
+            array( __NAMESPACE__ . '\Metabox\Internal_Notes', 'display' ),
             'plugin', 'normal', 'high'
         );
@@ -127 +133 @@
 
     /**
-     * Saves a plugin note.
-     */
-    public function save_note() {
-        check_admin_referer( 'save-note', 'notce' );
-
-        if ( empty( $_POST['id'] ) ) {
-            wp_send_json_error( array( 'errorCode' => 'no_post_specified' ) );
-        }
-
-        if ( ! current_user_can( 'review_plugin', absint( $_POST['id'] ) ) ) {
-            wp_send_json_error( array(
-                'error' => __( 'You do not have sufficient permissions to edit notes on this site.' ),
-            ) );
-        }
-
-        update_post_meta( absint( $_POST['id'] ), 'note', wp_kses_post( $_POST['note'] ) );
-
-        wp_send_json_success( array(
-            'note' => wpautop( wp_kses_post( $_POST['note'] ) ),
-        ) );
+     * Filters the postbox classes for custom comment meta boxes.
+     *
+     * @param array $classes An array of postbox classes.
+     * @return array
+     */
+    public function postbox_classes( $classes ) {
+        $classes[] = 'comments-meta-box';
+
+        return array_filter( $classes );
+    }
+
+    /**
+     * Saves a comment that is not built-in.
+     *
+     * We pretty much have to replicate all of `wp_ajax_replyto_comment()` to be able to comment on draft posts.
+     */
+    public function save_custom_comment() {
+        $comment_post_ID = (int) $_POST['comment_post_ID'];
+        $post            = get_post( $comment_post_ID );
+
+        if ( 'plugin' !== $post->post_type ) {
+            return;
+        }
+        remove_action( 'wp_ajax_replyto-comment', 'wp_ajax_replyto_comment', 1 );
+
+        global $wp_list_table;
+        if ( empty( $action ) ) {
+            $action = 'replyto-comment';
+        }
+
+        check_ajax_referer( $action, '_ajax_nonce-replyto-comment' );
+
+        if ( ! $post ) {
+            wp_die( - 1 );
+        }
+
+        if ( ! current_user_can( 'edit_post', $comment_post_ID ) ) {
+            wp_die( - 1 );
+        }
+
+        if ( empty( $post->post_status ) ) {
+            wp_die( 1 );
+        }
+
+        $user = wp_get_current_user();
+        if ( ! $user->exists() ) {
+            wp_die( __( 'Sorry, you must be logged in to reply to a comment.' ) );
+        }
+
+        $user_ID              = $user->ID;
+        $comment_author       = wp_slash( $user->display_name );
+        $comment_author_email = wp_slash( $user->user_email );
+        $comment_author_url   = wp_slash( $user->user_url );
+        $comment_content      = trim( $_POST['content'] );
+        $comment_type         = isset( $_POST['comment_type'] ) ? trim( $_POST['comment_type'] ) : '';
+
+        if ( current_user_can( 'unfiltered_html' ) ) {
+            if ( ! isset( $_POST['_wp_unfiltered_html_comment'] ) ) {
+                $_POST['_wp_unfiltered_html_comment'] = '';
+            }
+
+            if ( wp_create_nonce( 'unfiltered-html-comment' ) != $_POST['_wp_unfiltered_html_comment'] ) {
+                kses_remove_filters(); // start with a clean slate
+                kses_init_filters(); // set up the filters
+            }
+        }
+
+        if ( '' == $comment_content ) {
+            wp_die( __( 'ERROR: please type a comment.' ) );
+        }
+
+        $comment_parent = 0;
+        if ( isset( $_POST['comment_ID'] ) ) {
+            $comment_parent = absint( $_POST['comment_ID'] );
+        }
+        $comment_auto_approved = false;
+        $comment_data          = compact( 'comment_post_ID', 'comment_author', 'comment_author_email', 'comment_author_url', 'comment_content', 'comment_type', 'comment_parent', 'user_ID' );
+
+        // Automatically approve parent comment.
+        if ( ! empty( $_POST['approve_parent'] ) ) {
+            $parent = get_comment( $comment_parent );
+
+            if ( $parent && $parent->comment_approved === '0' && $parent->comment_post_ID == $comment_post_ID ) {
+                if ( ! current_user_can( 'edit_comment', $parent->comment_ID ) ) {
+                    wp_die( - 1 );
+                }
+
+                if ( wp_set_comment_status( $parent, 'approve' ) ) {
+                    $comment_auto_approved = true;
+                }
+            }
+        }
+
+        $comment_id = wp_new_comment( $comment_data );
+        $comment    = get_comment( $comment_id );
+        if ( ! $comment ) {
+            wp_die( 1 );
+        }
+
+        $position = ( isset( $_POST['position'] ) && (int) $_POST['position'] ) ? (int) $_POST['position'] : '-1';
+
+        ob_start();
+        if ( isset( $_REQUEST['mode'] ) && 'dashboard' == $_REQUEST['mode'] ) {
+            require_once( ABSPATH . 'wp-admin/includes/dashboard.php' );
+            _wp_dashboard_recent_comments_row( $comment );
+        } else {
+            if ( isset( $_REQUEST['mode'] ) && 'single' == $_REQUEST['mode'] ) {
+                $wp_list_table = _get_list_table( 'WP_Post_Comments_List_Table', array( 'screen' => 'edit-comments' ) );
+            } else {
+                $wp_list_table = _get_list_table( 'WP_Comments_List_Table', array( 'screen' => 'edit-comments' ) );
+            }
+            $wp_list_table->single_row( $comment );
+        }
+        $comment_list_item = ob_get_clean();
+
+        $response = array(
+            'what'     => 'comment',
+            'id'       => $comment->comment_ID,
+            'data'     => $comment_list_item,
+            'position' => $position
+        );
+
+        $counts                   = wp_count_comments();
+        $response['supplemental'] = array(
+            'in_moderation'        => $counts->moderated,
+            'i18n_comments_text'   => sprintf(
+                _n( '%s Comment', '%s Comments', $counts->approved ),
+                number_format_i18n( $counts->approved )
+            ),
+            'i18n_moderation_text' => sprintf(
+                _nx( '%s in moderation', '%s in moderation', $counts->moderated, 'comments' ),
+                number_format_i18n( $counts->moderated )
+            )
+        );
+
+        if ( $comment_auto_approved ) {
+            $response['supplemental']['parent_approved'] = $parent->comment_ID;
+            $response['supplemental']['parent_post_id']  = $parent->comment_post_ID;
+        }
+
+        $x = new \WP_Ajax_Response();
+        $x->add( $response );
+        $x->send();
     }
 }

sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/admin/metabox/class-internal-notes.php

@@ -1 +1 @@
 <?php
 namespace WordPressdotorg\Plugin_Directory\Admin\Metabox;
-use WordPressdotorg\Plugin_Directory\Tools;
+use WordPressdotorg\Plugin_Directory\Admin\Plugin_Comments_List_Table;
 
 /**
@@ -8 +8 @@
  * @package WordPressdotorg\Plugin_Directory\Admin\Metabox
  */
-class Notes {
+class Internal_Notes {
 
     /**
-     *
+     * Displays comment box for internal notes.
      */
-    static function display( $post ) {
-        $note = (string) get_post_meta( $post->ID, 'note', true );
-
+    static function display() {
+        $wp_list_table = new Plugin_Comments_List_Table( array(
+            'comment_type' => 'internal-note',
+        ) );
+        wp_nonce_field( 'get-comments', 'add_comment_nonce', false );
         ?>
-        <div class="view-note hide-if-no-js">
-            <?php echo empty( $note ) ? __( 'Add note', 'wporg-plugins' ) : wpautop( $note ); ?>
-        </div>
-        <div class="edit-note show-if-no-js" style="display: none;">
-            <?php wp_nonce_field( 'save-note', 'notce' ); ?>
-            <textarea class="note-content" rows="5" style="width: 100%;"><?php echo $note; ?></textarea>
-            <p>
-                <button type="button" class="button button-primary save-note"><?php _e( 'Save', 'wporg-plugins' ); ?></button>
-                <button type="reset" class="button button-secondary cancel-note"><?php _e( 'Cancel', 'wporg-plugins' ); ?></button>
-            </p>
-        </div>
+        <p class="hide-if-no-js" id="add-new-comment">
+            <a class="button" href="#commentstatusdiv"><?php _e( 'Add note', 'wporg-plugins' ); ?></a>
+        </p>
         <?php
+        $wp_list_table->display( true );
+        wp_comment_trashnotice();
     }
 }

sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/class-plugin-directory.php

@@ -54 +54 @@
             ),
             'description'     => __( 'A Repo Plugin', 'wporg-plugins' ),
-            'supports'        => false,
+            'supports'        => array( 'comments' ),
             'public'          => true,
             'show_ui'         => true,

sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/css/edit-form.css

@@ -58 +58 @@
         0 0 2px 1px rgba(30, 140, 190, .8);
 }
+
+/* Comment meta boxes */
+.comments-meta-box #edithead .inside {
+    float: left;
+    padding: 3px 0 2px 5px;
+    margin: 0;
+    text-align: center;
+}
+
+.comments-meta-box.postbox .inside,
+.comments-meta-box .column-comment p {
+    margin: 0;
+    padding: 0;
+}
+
+.comments-meta-box .inside .row-actions {
+    line-height:18px;
+}
+
+.comments-meta-box .inside .column-author *:not(strong) {
+    display: none;
+}
+
+.comments-meta-box #replyrow td {
+    padding: 0;
+}
+
+.comments-meta-box p {
+    padding: 8px 10px;
+    margin: 0;
+}
+
+.comments-meta-box .comments-box {
+    border: 0 none;
+}
+
+.comments-meta-box .comments-box thead th,
+.comments-meta-box .comments-box thead td {
+    background: transparent;
+    padding: 0 7px 4px;
+    font-style: italic;
+}
+
+.comments-meta-box .comments-box tr:last-child td {
+    border-bottom: 0 none;
+}
+
+.comments-meta-box #edithead .inside input {
+    width: 160px;
+}
+
+@media screen and ( max-width: 782px ) {
+    .comments-meta-box .fixed .column-author {
+        display: none !important;
+    }
+
+    .comments-meta-box #edithead .inside {
+        float: none;
+        text-align: left;
+        padding: 3px 5px;
+    }
+
+    .comments-meta-box #edithead .inside input {
+        width: 100%;
+    }
+}

sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/js/edit-form.js

@@ -4 +4 @@
 
 ( function( $, wp ) {
-
     var PluginEdit = {
-        $notesBox: {},
         $testedWith: {},
         $pluginStatus: {},
 
         ready: function() {
-            PluginEdit.$notesBox     = $( '#plugin-notes' );
             PluginEdit.$testedWith   = $( '#tested-with-select' );
             PluginEdit.$pluginStatus = $( '#plugin-status-select' );
@@ -23 +20 @@
                 .on( 'click', '.cancel-plugin-status', PluginEdit.cancelPluginStatus );
 
-            PluginEdit.$notesBox
-                .on( 'click', '.cancel-note', PluginEdit.showNote )
-                .on( 'click', '.view-note',   PluginEdit.editNote )
-                .on( 'click', '.save-note',   PluginEdit.saveNote );
+            _.each( $( '#post-body' ).find( '.comments-box' ), PluginEdit.loadComments );
+
+            $( '#add-new-comment' ).on( 'click', 'a.button', function( event ) {
+                event.preventDefault();
+
+                window.commentReply && commentReply.addcomment( $( '#post_ID' ).val() );
+
+                $( '#replyrow' ).find( '.comment-reply' ).append( $( '<input/>' ).attr({
+                    type: 'hidden',
+                    name: 'comment_type',
+                    value: $( '.comments-box' ).data( 'comment-type' )
+                }) );
+            } );
         },
 
@@ -67 +73 @@
         },
 
-        showNote: function() {
-            $( '.view-note', PluginEdit.$notesBox ).show();
-            $( '.edit-note', PluginEdit.$notesBox ).hide();
-        },
+        loadComments: function ( element ) {
+            var $commentsList = $( element ),
+                data = {
+                    _ajax_nonce:  $( '#add_comment_nonce' ).val(),
+                    p:            $( '#post_ID' ).val(),
+                    mode:         'single',
+                    start:        0,
+                    number:       20,
+                    comment_type: $commentsList.data( 'comment-type' )
+                };
 
-        editNote: function() {
-            var $textarea = $( '.note-content', PluginEdit.$notesBox );
+            wp.ajax.post( 'get-comments', data ).always( function( response ) {
+                response = wpAjax.parseAjaxResponse( response );
 
-            $( '.view-note', PluginEdit.$notesBox ).hide();
-            $( '.edit-note', PluginEdit.$notesBox ).show();
-            $textarea.text( $textarea.val() ).focus();
-        },
+                if ( 'object' == typeof response && response.responses[0] ) {
+                    $commentsList.append( response.responses[0].data ).show();
 
-        saveNote: function() {
-            wp.ajax.post( 'save-note', {
-                id: $( '#post_ID' ).val(),
-                note: $( '.note-content', PluginEdit.$notesBox ).val(),
-                notce: $( '#notce' ).val()
-            } )
-                .done( function( response ) {
-                    var note = response.note ? response.note : 'Add note';
-
-                    $( '.view-note', PluginEdit.$notesBox ).html( note );
-                    PluginEdit.showNote();
-                } );
+                    $( 'a[className*=\':\']' ).unbind();
+                }
+            } );
         }
     };