Changeset 2659

Timestamp:

03/01/2016 07:59:36 PM (9 years ago)

Author:

obenland

Message:

Plugin Directory: Add support for internal notes.

Needs some more permission checks.

See #1570.

Location:

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

Files:

• admin/class-customizations.php (modified) (4 diffs)
• admin/metabox/class-controls.php (modified) (5 diffs)
• admin/metabox/class-notes.php (added)
• css/edit-form.css (modified) (3 diffs)
• js/edit-form.js (modified) (1 diff)

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

@@ -27 +27 @@
 
         add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_assets' ) );
+        add_action( 'wp_ajax_save-note', array( $this, 'save_note' ) );
     }
 
@@ -55 +56 @@
         if ( 'post.php' == $hook_suffix && 'plugin' == $post_type ) {
             wp_enqueue_style( 'plugin-admin-edit-css', plugins_url( 'css/edit-form.css', Plugin_Directory\PLUGIN_FILE ), array( 'edit' ), 1 );
-            wp_enqueue_script( 'plugin-admin-edit-js', plugins_url( 'js/edit-form.js', Plugin_Directory\PLUGIN_FILE ), array(), 1 );
+            wp_enqueue_script( 'plugin-admin-edit-js', plugins_url( 'js/edit-form.js', Plugin_Directory\PLUGIN_FILE ), array( 'wp-util' ), 1 );
         }
     }
@@ -75 +76 @@
             array( __NAMESPACE__ . '\Metabox\Committers', 'display' ),
             'plugin', 'side'
+        );
+
+        add_meta_box(
+            'plugin-notes',
+            __( 'Internal Notes', 'wporg-plugins' ),
+            array( __NAMESPACE__ . '\Metabox\Notes', 'display' ),
+            'plugin', 'normal', 'high'
         );
 
@@ -118 +126 @@
     }
 
+    /**
+     * 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'] ) ),
+        ) );
+    }
 }

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

@@ -22 +22 @@
                 }
             echo '</div>';
-    
+
             echo '<div id="major-publishing-actions"><div id="publishing-action">';
                 echo '<span class="spinner"></span>';
@@ -41 +41 @@
         <div class="misc-pub-section misc-pub-plugin-status">
             <label for="post_status"><?php _e( 'Status:', 'wporg-plugins' ); ?></label>
-            <span id="plugin-status-display"><?php echo esc_html( get_post_status_object( $post->post_status )->label ); ?></span>
-            <a href="#plugin_status" class="edit-plugin-status hide-if-no-js"><span aria-hidden="true">Edit</span> <span class="screen-reader-text">Edit status</span></a>
-        
-            <div id="plugin-status-select" class="hide-if-js">
-                <input type="hidden" name="hidden_post_status" id="hidden_post_status" value="<?php echo esc_attr( $post->post_status ); ?>">
-                <select name="post_status" id="plugin_status">
+            <strong id="plugin-status-display"><?php echo esc_html( get_post_status_object( $post->post_status )->label ); ?></strong>
+            <button type="button" class="button-link edit-plugin-status hide-if-no-js">
+                <span aria-hidden="true"><?php _e( 'Edit', 'wporg-plugins' ); ?></span>
+                <span class="screen-reader-text"><?php _e( 'Edit plugin status', 'wporg-plugins' ); ?></span>
+            </button>
+
+            <div id="plugin-status-select" class="plugin-control-select hide-if-js">
+                <input type="hidden" name="hidden_post_status" id="hidden-post-status" value="<?php echo esc_attr( $post->post_status ); ?>">
+                <select name="post_status" id="plugin-status">
                     <?php
                     foreach ( $statuses as $statii ) {
                         $status_object = get_post_status_object( $statii );
-                        $selected = selected( $post->post_status, $statii, false );
                         printf(
                             '<option value="%s" %s>%s</option>',
                             esc_attr( $statii ),
-                            $selected,
+                            selected( $post->post_status, $statii, false ),
                             esc_html( $status_object->label )
                         );
@@ -60 +62 @@
                     ?>
                 </select>
-                <a href="#plugin_status" class="save-plugin-status hide-if-no-js button">OK</a>
-                <a href="#plugin_status" class="cancel-plugin-status hide-if-no-js button-cancel">Cancel</a>
+                <button type="button" class="save-plugin-status hide-if-no-js button"><?php _e( 'OK', 'wporg-plugins' ); ?></button>
+                <button type="button" class="cancel-plugin-status hide-if-no-js button-link"><?php _e( 'Cancel', 'wporg-plugins' ); ?></button>
             </div>
-        
+
         </div><!-- .misc-pub-section --><?php
     }
@@ -71 +73 @@
      */
     protected static function display_tested_up_to() {
-        $post = get_post();
-        $tested_up_to = (string) get_post_meta( $post->ID, 'tested', true );
-        $versions = self::get_tested_up_to_versions( $tested_up_to );
-        $tested_up_to = $versions['tested_up_to'];
+        $post           = get_post();
+        $tested_up_to   = (string) get_post_meta( $post->ID, 'tested', true );
+        $versions       = self::get_tested_up_to_versions( $tested_up_to );
+        $tested_up_to   = $versions['tested_up_to'];
         $unknown_string = _x( 'Unknown', 'unknown version', 'wporg-plugins' );
         ?>
         <div class="misc-pub-section misc-pub-tested">
             <label for="tested_with"><?php _e( 'Tested With:', 'wporg-plugins' ); ?></label>
-            <span id="tested-with-display"><?php echo ( $tested_up_to ? sprintf( 'WordPress %s', $tested_up_to ) : $unknown_string ); ?></span>
-            <a href="#tested_with" class="edit-tested-with hide-if-no-js"><span aria-hidden="true">Edit</span> <span class="screen-reader-text">Edit status</span></a>
-        
-            <div id="tested-with-select" class="hide-if-js">
-                <input type="hidden" name="hidden_tested_with" id="hidden_tested_with" value="<?php echo esc_attr( $tested_up_to ); ?>">
-                <select name="tested_with" id="tested_with">
+            <strong id="tested-with-display"><?php echo ( $tested_up_to ? sprintf( 'WordPress %s', $tested_up_to ) : $unknown_string ); ?></strong>
+            <button type="button" class="button-link edit-tested-with hide-if-no-js">
+                <span aria-hidden="true"><?php _e( 'Edit', 'wporg-plugins' ); ?></span>
+                <span class="screen-reader-text"><?php _e( 'Edit tested with version', 'wporg-plugins' ); ?></span>
+            </button>
+
+            <div id="tested-with-select" class="plugin-control-select hide-if-js">
+                <input type="hidden" name="hidden_tested_with" id="hidden-tested-with" value="<?php echo esc_attr( $tested_up_to ); ?>">
+                <select name="tested_with" id="tested-with">
                     <?php
                     foreach ( $versions['versions'] as $ver ) {
@@ -96 +101 @@
                     ?>
                 </select>
-                <a href="#tested_with" class="save-tested-with hide-if-no-js button">OK</a>
-                <a href="#tested_with" class="cancel-tested-with hide-if-no-js button-cancel">Cancel</a>
+                <button type="button" class="save-tested-with hide-if-no-js button"><?php _e( 'OK', 'wporg-plugins' ); ?></button>
+                <button type="button" class="cancel-tested-with hide-if-no-js button-link"><?php _e( 'Cancel', 'wporg-plugins' ); ?></button>
             </div>
-        
+
         </div><!-- .misc-pub-section --><?php
     }

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

@@ -2 +2 @@
  * CSS Rules for the Plugin Admin screen
  */
-#misc-publishing-actions label::before {
+.misc-pub-section label::before {
     font: normal 20px/1 dashicons;
     speak: none;
@@ -17 +17 @@
 }
 
-#misc-publishing-actions label[for="post_status"]::before {
+.misc-pub-section label[for="post_status"]::before {
     content: "\f173";
 }
-#misc-publishing-actions label[for="tested_with"]::before {
+.misc-pub-section label[for="tested_with"]::before {
     content: "\f177";
 }
 
-#misc-publishing-actions span#plugin-status-display,
-#misc-publishing-actions span#tested-with-display {
-    font-weight: bold;
-}
-
-.inside-submitbox #plugin-status,
-.inside-submitbox #tested-with {
-    margin: 2px 0 2px -2px;
-}
-
-#plugin-status-select,
-#tested-with-select {
+.plugin-control-select {
     margin-top: 3px;
 }
@@ -43 +32 @@
     display: none;
 }
+
+.misc-pub-section .button-link {
+    color: #0073aa;
+    -webkit-transition-property: border, background, color;
+    transition-property: border, background, color;
+    -webkit-transition-duration: .05s;
+    transition-duration: .05s;
+    -webkit-transition-timing-function: ease-in-out;
+    transition-timing-function: ease-in-out;
+    text-decoration: underline;
+}
+
+.misc-pub-section .button-link:hover,
+.misc-pub-section .button-link:active {
+    color: #00a0d2;
+}
+
+.misc-pub-section .button-link:focus {
+    color: #124964;
+    -webkit-box-shadow:
+        0 0 0 1px #5b9dd9,
+        0 0 2px 1px rgba(30, 140, 190, .8);
+    box-shadow:
+        0 0 0 1px #5b9dd9,
+        0 0 2px 1px rgba(30, 140, 190, .8);
+}

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

@@ -3 +3 @@
  */
 
-jQuery(document).ready( function($) {
+( function( $, wp ) {
 
-    var updateText,
-        $testedWithSelect = $('#tested-with-select'),
-        $pluginStatusSelect = $('#plugin-status-select');
+    var PluginEdit = {
+        $notesBox: {},
+        $testedWith: {},
+        $pluginStatus: {},
 
-    // submitdiv
-    if ( $('#submitdiv').length ) {
+        ready: function() {
+            PluginEdit.$notesBox     = $( '#plugin-notes' );
+            PluginEdit.$testedWith   = $( '#tested-with-select' );
+            PluginEdit.$pluginStatus = $( '#plugin-status-select' );
 
-        updateText = function() {
-            $('#plugin-status-display').html( $('option:selected', $pluginStatusSelect).text() );
-            $('#tested-with-display').html( $('option:selected', $testedWithSelect).text() );
-            return true;
-        };
+            $( '#submitdiv' )
+                .on( 'click', '.edit-tested-with',     PluginEdit.editTestedWith )
+                .on( 'click', '.edit-plugin-status',   PluginEdit.editPluginStatus )
+                .on( 'click', '.save-tested-with',     PluginEdit.updateTestedWith )
+                .on( 'click', '.save-plugin-status',   PluginEdit.updatePluginStatus )
+                .on( 'click', '.cancel-tested-with',   PluginEdit.cancelTestedWith )
+                .on( 'click', '.cancel-plugin-status', PluginEdit.cancelPluginStatus );
 
-        // Plugin Status / post_status
-        $pluginStatusSelect.siblings('a.edit-plugin-status').click( function( event ) {
-            if ( $pluginStatusSelect.is( ':hidden' ) ) {
-                $pluginStatusSelect.slideDown( 'fast', function() {
-                    $pluginStatusSelect.find('select').focus();
+            PluginEdit.$notesBox
+                .on( 'click', '.cancel-note', PluginEdit.showNote )
+                .on( 'click', '.view-note',   PluginEdit.editNote )
+                .on( 'click', '.save-note',   PluginEdit.saveNote );
+        },
+
+        editTestedWith: function() {
+            if ( PluginEdit.$testedWith.is( ':hidden' ) ) {
+                PluginEdit.$testedWith.slideDown( 'fast', function() {
+                    $( 'select', PluginEdit.$testedWith ).focus();
                 } );
-                $(this).hide();
+                $( this ).hide();
             }
-            event.preventDefault();
-        });
+        },
 
-        $pluginStatusSelect.find('.save-plugin-status').click( function( event ) {
-            $pluginStatusSelect.slideUp( 'fast' ).siblings( 'a.edit-plugin-status' ).show().focus();
-            updateText();
-            event.preventDefault();
-        });
+        editPluginStatus: function() {
+            if ( PluginEdit.$pluginStatus.is( ':hidden' ) ) {
+                PluginEdit.$pluginStatus.slideDown( 'fast', function() {
+                    $( 'select', PluginEdit.$pluginStatus ).focus();
+                } );
+                $( this ).hide();
+            }
+        },
 
-        $pluginStatusSelect.find('.cancel-plugin-status').click( function( event ) {
-            $pluginStatusSelect.slideUp( 'fast' ).siblings( 'a.edit-plugin-status' ).show().focus();
-            $('#post_status').val( $('#hidden_post_status').val() );
-            updateText();
-            event.preventDefault();
-        });
+        updateTestedWith: function() {
+            PluginEdit.$testedWith.slideUp( 'fast' ).siblings( 'button.edit-tested-with' ).show().focus();
+            $( '#tested-with-display' ).text( $( 'option:selected', PluginEdit.$testedWith ).text() );
+        },
 
-        // Tested With
-        $testedWithSelect.siblings('a.edit-tested-with').click( function( event ) {
-            if ( $testedWithSelect.is( ':hidden' ) ) {
-                $testedWithSelect.slideDown( 'fast', function() {
-                    $testedWithSelect.find('select').focus();
+        updatePluginStatus: function() {
+            PluginEdit.$pluginStatus.slideUp( 'fast' ).siblings( 'button.edit-plugin-status' ).show().focus();
+            $( '#plugin-status-display' ).text( $( 'option:selected', PluginEdit.$pluginStatus ).text() );
+        },
+
+        cancelTestedWith: function() {
+            $( '#tested-with' ).val( $( '#hidden-tested-with' ).val() );
+            PluginEdit.updateTestedWith();
+        },
+
+        cancelPluginStatus: function() {
+            $( '#post-status' ).val( $( '#hidden-post-status' ).val() );
+            PluginEdit.updatePluginStatus( event );
+        },
+
+        showNote: function() {
+            $( '.view-note', PluginEdit.$notesBox ).show();
+            $( '.edit-note', PluginEdit.$notesBox ).hide();
+        },
+
+        editNote: function() {
+            var $textarea = $( '.note-content', PluginEdit.$notesBox );
+
+            $( '.view-note', PluginEdit.$notesBox ).hide();
+            $( '.edit-note', PluginEdit.$notesBox ).show();
+            $textarea.text( $textarea.val() ).focus();
+        },
+
+        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();
                 } );
-                $(this).hide();
-            }
-            event.preventDefault();
-        });
+        }
+    };
 
-        $testedWithSelect.find('.save-tested-with').click( function( event ) {
-            $testedWithSelect.slideUp( 'fast' ).siblings( 'a.edit-tested-with' ).show().focus();
-            updateText();
-            event.preventDefault();
-        });
-
-        $testedWithSelect.find('.cancel-tested-with').click( function( event ) {
-            $testedWithSelect.slideUp( 'fast' ).siblings( 'a.edit-tested-with' ).show().focus();
-            $('#tested_with').val( $('#hidden_tested_with').val() );
-            updateText();
-            event.preventDefault();
-        });
-    } // end submitdiv
-
-} );
+    $( PluginEdit.ready );
+} )( window.jQuery, window.wp );