Ticket #9757: 9757.1.patch

src/wp-admin/css/themes.css

@@ -1054 +1054 @@
         margin: 30px auto;
         max-width: 380px;
 }
+.upload-plugin .wp-upload-form #existing-plugin-info h3 {
+        margin-top: 8px;
+}
+.upload-plugin .wp-upload-form .plugin-card-top {
+        padding-top: 10px;
+}
+.upload-plugin .wp-upload-form.has-existing-plugin #install-plugin-submit,
+.upload-plugin .wp-upload-form.has-existing-plugin .install-plugin-reset {
+        display: inline-block;
+        margin-top: 20px;
+        margin-right: 10px;
+}
+
 .upload-theme .install-help,
 .upload-plugin .install-help {
         color: #555d66; /* #f1f1f1 background */

src/wp-admin/includes/class-plugin-upgrader.php

@@ -53 +53 @@
                 $this->strings['remove_old_failed'] = __('Could not remove the old plugin.');
                 $this->strings['process_failed'] = __('Plugin update failed.');
                 $this->strings['process_success'] = __('Plugin updated successfully.');
+                $this->strings['overwrite_success'] = __('Plugin replaced successfully.');
                 $this->strings['process_bulk_success'] = __('Plugins updated successfully.');
         }
 
@@ -136 +137 @@
          * @param array  $args {
          *     Optional. Other arguments for upgrading a plugin package. Default empty array.
          *
-         *     @type bool $clear_update_cache Whether to clear the plugin updates cache if successful.
-         *                                    Default true.
+         *     @type bool   $clear_update_cache Whether to clear the plugin updates cache if successful.
+         *                                      Default true.
+         *     @type string $package            Path to the package to replace an existing plugin with.
+         *                                      Default ''.
          * }
          * @return bool|WP_Error True if the upgrade was successful, false or a WP_Error object otherwise.
          */
@@ -145 +148 @@
 
                 $defaults = array(
                         'clear_update_cache' => true,
+                        'package'            => '',
                 );
                 $parsed_args = wp_parse_args( $args, $defaults );
 
                 $this->init();
                 $this->upgrade_strings();
 
-                $current = get_site_transient( 'update_plugins' );
-                if ( !isset( $current->response[ $plugin ] ) ) {
-                        $this->skin->before();
-                        $this->skin->set_result(false);
-                        $this->skin->error('up_to_date');
-                        $this->skin->after();
-                        return false;
-                }
+                $package = $parsed_args['package'];
+                if ( ! $package ) {
+                        $current = get_site_transient( 'update_plugins' );
+                        if ( !isset( $current->response[ $plugin ] ) ) {
+                                $this->skin->before();
+                                $this->skin->set_result(false);
+                                $this->skin->error('up_to_date');
+                                $this->skin->after();
+                                return false;
+                        }
 
-                // Get the URL to the zip file
-                $r = $current->response[ $plugin ];
+                        // Get the URL to the zip file
+                        $r = $current->response[ $plugin ];
+                        $package = $r->package;
+                        $action  = 'update';
+                } else {
+                        $action  = 'overwrite';
+                }
 
                 add_filter('upgrader_pre_install', array($this, 'deactivate_plugin_before_upgrade'), 10, 2);
                 add_filter('upgrader_clear_destination', array($this, 'delete_old_plugin'), 10, 4);
@@ -172 +183 @@
                 }
 
                 $this->run( array(
-                        'package' => $r->package,
+                        'package' => $package,
                         'destination' => WP_PLUGIN_DIR,
                         'clear_destination' => true,
                         'clear_working' => true,
                         'hook_extra' => array(
                                 'plugin' => $plugin,
                                 'type' => 'plugin',
-                                'action' => 'update',
+                                'action' => $action,
                         ),
                 ) );
 

src/wp-admin/includes/class-wp-upgrader.php

@@ -157 +157 @@
 
                 $this->strings['download_failed'] = __('Download failed.');
                 $this->strings['installing_package'] = __('Installing the latest version…');
+                $this->strings['package_overwriting'] = __('Replacing the installed version…');
                 $this->strings['no_files'] = __('The package contains no files.');
                 $this->strings['folder_exists'] = __('Destination folder already exists.');
                 $this->strings['mkdir_failed'] = __('Could not create directory.');
@@ -451 +452 @@
                 if ( empty( $source ) || empty( $destination ) ) {
                         return new WP_Error( 'bad_request', $this->strings['bad_request'] );
                 }
-                $this->skin->feedback( 'installing_package' );
+
+                if ( isset( $args['hook_extra']['action'] ) && 'overwrite' === $args['hook_extra']['action'] ) {
+                        // Overwriting the existing plugin
+                        $this->skin->feedback( 'package_overwriting' );
+                } else {
+                        $this->skin->feedback( 'installing_package' );
+                }
 
                 /**
                  * Filters the install response before the installation has started.
@@ -751 +758 @@
                         $this->skin->error($result);
                         $this->skin->feedback('process_failed');
                 } else {
-                        // Installation succeeded.
-                        $this->skin->feedback('process_success');
+
+                        if ( isset( $options['hook_extra']['action'] ) && 'overwrite' === $options['hook_extra']['action'] ) {
+                                // Overwrite succeeded.
+                                $this->skin->feedback( 'overwrite_success' );
+                        } else {
+                                // Installation succeeded.
+                                $this->skin->feedback('process_success');
+                        }
                 }
 
                 $this->skin->after();

src/wp-admin/includes/plugin-install.php

@@ -310 +310 @@
                 <?php submit_button( __( 'Install Now' ), '', 'install-plugin-submit', false ); ?>
         </form>
 </div>
+<script type="text/html" id="tmpl-existing-plugin-data">
+        <div id="existing-plugin-info">
+                <p class="attention">{{{data.warnOverwrite}}}</p>
+                <div class="plugin-card-top">
+                        <h3>{{data.pluginDetailsIntro}}</h3>
+                        <div class="desc">
+                                <h4>{{data.name}} {{data.version}}</h4>
+                                <p class="description">{{{data.description}}}</p>
+                        </div>
+                </div>
+                <input type="hidden" name="overwrite" value="{{data.id}}"/>
+        </div>
+</script>
 <?php
 }
 

src/wp-admin/js/common.js

@@ -687 +687 @@
                         e.target.scrollIntoView(false);
         });
 
-        // Disable upload buttons until files are selected
-        (function(){
-                var button, input, form = $('form.wp-upload-form');
-                if ( ! form.length )
-                        return;
-                button = form.find('input[type="submit"]');
-                input = form.find('input[type="file"]');
-
-                function toggleUploadButton() {
-                        button.prop('disabled', '' === input.map( function() {
-                                return $(this).val();
-                        }).get().join(''));
-                }
-                toggleUploadButton();
-                input.on('change', toggleUploadButton);
-        })();
-
         function pinMenu( event ) {
                 var windowPos = $window.scrollTop(),
                         resizing = ! event || event.type !== 'scroll';

src/wp-admin/js/plugin-install.js

@@ -12 +12 @@
                 $firstTabbable,
                 $lastTabbable,
                 $focusedBefore = $(),
-                $uploadViewToggle = $( '.upload-view-toggle' ),
-                $wrap = $ ( '.wrap' ),
                 $body = $( document.body );
 
         tb_position = function() {
@@ -191 +189 @@
                 $( '#section-holder div.section' ).hide(); // Hide 'em all.
                 $( '#section-' + tab ).show();
         });
-
-        /*
-         * When a user presses the "Upload Plugin" button, show the upload form in place
-         * rather than sending them to the devoted upload plugin page.
-         * The `?tab=upload` page still exists for no-js support and for plugins that
-         * might access it directly. When we're in this page, let the link behave
-         * like a link. Otherwise we're in the normal plugin installer pages and the
-         * link should behave like a toggle button.
-         */
-        if ( ! $wrap.hasClass( 'plugin-install-tab-upload' ) ) {
-                $uploadViewToggle
-                        .attr({
-                                role: 'button',
-                                'aria-expanded': 'false'
-                        })
-                        .on( 'click', function( event ) {
-                                event.preventDefault();
-                                $body.toggleClass( 'show-upload-view' );
-                                $uploadViewToggle.attr( 'aria-expanded', $body.hasClass( 'show-upload-view' ) );
-                        });
-        }
 });

src/wp-admin/js/plugin-upload.js

@@ +1 @@
+window.wp = window.wp || {};
+
+( function( $, _, wp ){
+
+        window.toggleUploadButton = function() {
+                var button, input, form = $('form.wp-upload-form');
+
+                if ( ! form.length ) {
+                        return;
+                }
+
+                button = form.find('input[type="submit"]');
+                input  = form.find('input[type="file"]');
+
+                button.prop('disabled', '' === input.map( function() {
+                        return $(this).val();
+                } ).get().join( '' ) );
+        }
+        toggleUploadButton();
+
+        $( 'form.wp-upload-form' ).on( 'change', 'input[type="file"]', function( event ) {
+                if ( ! event.currentTarget.files || 'undefined' === typeof pluginUploadL10n ) {
+                        toggleUploadButton();
+                        return event;
+                }
+
+                var file     = _.first( event.currentTarget.files ), form = $( event.delegateTarget )
+                    template = wp.template( 'existing-plugin-data' ), pluginData = {};
+
+                if ( file.name ) {
+                        // Checks if there is an existing plugin.
+                        wp.apiRequest( {
+                                path: 'wp/v2/plugins/' + file.name.replace( '.zip', '' ),
+                                type: 'GET',
+                                dataType: 'json'
+                        } ).done( function( response ) {
+                                // The plugin exists, display a warning and informations about the Plugin.
+                                if ( response && response.id ) {
+                                        form.addClass( 'has-existing-plugin' );
+                                        window.toggleUploadButton();
+
+                                        $( '#install-plugin-submit' ).after(
+                                                $( '<input></input' )
+                                                        .prop( 'type', 'reset' )
+                                                        .val( pluginUploadL10n.cancel )
+                                                        .addClass( 'button button-secondary install-plugin-reset' )
+                                        );
+
+                                        pluginData = _.extend( response, _.pick( pluginUploadL10n, [ 'warnOverwrite','pluginDetailsIntro' ] ) );
+
+                                        $( '#pluginzip' ).after( template( pluginData ) );
+                                }
+
+                        // The plugin is not installed yet.
+                        } ).fail( function() {
+                                window.toggleUploadButton();
+                        } );
+                }
+        } );
+
+        // Resets the Upload form when 'Cancel' is clicked.
+        $( 'form.wp-upload-form' ).on( 'reset', function( event ) {
+                $( '#existing-plugin-info' ).remove();
+                $( event.currentTarget ).removeClass( 'has-existing-plugin' );
+                $( event.currentTarget ).find( 'input[type="file"]' ).val( '' );
+                $( event.currentTarget ).find( '.install-plugin-reset' ).remove();
+                window.toggleUploadButton();
+        } );
+
+        /*
+         * When a user presses the "Upload Plugin" button, show the upload form in place
+         * rather than sending them to the devoted upload plugin page.
+         * The `?tab=upload` page still exists for no-js support and for plugins that
+         * might access it directly. When we're in this page, let the link behave
+         * like a link. Otherwise we're in the normal plugin installer pages and the
+         * link should behave like a toggle button.
+         */
+        if ( ! $( '.wrap' ).hasClass( 'plugin-install-tab-upload' ) ) {
+                $( '.upload-view-toggle' )
+                        .attr({
+                                role: 'button',
+                                'aria-expanded': 'false'
+                        } )
+                        .on( 'click', function( event ) {
+                                var $body = $( document.body ), $uploadViewToggle = $( event.currentTarget );
+                                event.preventDefault();
+                                $body.toggleClass( 'show-upload-view' );
+                                $uploadViewToggle.attr( 'aria-expanded', $body.hasClass( 'show-upload-view' ) );
+                        } );
+        }
+
+}( jQuery, _, window.wp ) );

src/wp-admin/plugin-install.php

@@ -55 +55 @@
 $body_id = $tab;
 
 wp_enqueue_script( 'updates' );
+wp_enqueue_script( 'plugin-upload' );
 
 /**
  * Fires before each tab on the Install Plugins screen is loaded.

src/wp-admin/update.php

@@ -159 +159 @@
                 $type = 'upload'; //Install plugin type, From Web or an Upload.
 
                 $upgrader = new Plugin_Upgrader( new Plugin_Installer_Skin( compact('type', 'title', 'nonce', 'url') ) );
-                $result = $upgrader->install( $file_upload->package );
+
+                // Overwrite an existing plugin.
+                if ( isset( $_POST['overwrite'] ) && $_POST['overwrite'] ) {
+                        $result = $upgrader->upgrade( wp_unslash( $_POST['overwrite'] ), array( 'package' => $file_upload->package ) );
+
+                // Install a new plugin.
+                } else {
+                        $result = $upgrader->install( $file_upload->package );
+                }
 
                 if ( $result || is_wp_error($result) )
                         $file_upload->cleanup();

src/wp-includes/rest-api.php

@@ -233 +233 @@
         // Settings.
         $controller = new WP_REST_Settings_Controller;
         $controller->register_routes();
+
+        // Plugins.
+        $controller = new WP_REST_Plugins_Controller;
+        $controller->register_routes();
 }
 
 /**

src/wp-includes/rest-api/endpoints/class-wp-rest-plugins-controller.php

@@ +1 @@
+<?php
+/**
+ * REST API: WP_REST_Plugins_Controller class
+ *
+ * @package WordPress
+ * @subpackage REST_API
+ * @since 5.0.0
+ */
+
+/**
+ * Core class used to get a site's plugins via the REST API.
+ *
+ * @since 5.0.0
+ *
+ * @see WP_REST_Controller
+ */
+class WP_REST_Plugins_Controller extends WP_REST_Controller {
+        /**
+         * List of installed plugins.
+         *
+         * @var array
+         */
+        protected $plugins;
+
+        /**
+         * Constructor.
+         *
+         * @since 5.0.0
+         */
+        public function __construct() {
+                $this->namespace = 'wp/v2';
+                $this->rest_base = 'plugins';
+        }
+
+        /**
+         * Registers the routes for the objects of the controller.
+         *
+         * @since 5.0.0
+         *
+         * @see register_rest_route()
+         */
+        public function register_routes() {
+
+                register_rest_route( $this->namespace, '/' . $this->rest_base, array(
+                        array(
+                                'methods'             => WP_REST_Server::READABLE,
+                                'callback'            => array( $this, 'get_items' ),
+                                'args'                => array(),
+                                'permission_callback' => array( $this, 'get_items_permissions_check' ),
+                        ),
+                        'schema' => array( $this, 'get_public_item_schema' ),
+                ) );
+
+                register_rest_route( $this->namespace, '/' . $this->rest_base . '/(?P<slug>[\w-]+)', array(
+                        'args' => array(
+                                'slug' => array(
+                                        'description' => __( 'An alphanumeric identifier for the slug of the plugin.' ),
+                                        'type'        => 'string',
+                                ),
+                        ),
+                        array(
+                                'methods'             => WP_REST_Server::READABLE,
+                                'callback'            => array( $this, 'get_item' ),
+                                'permission_callback' => array( $this, 'get_item_permissions_check' ),
+                                'args'                => array(
+                                        'context' => $this->get_context_param( array( 'default' => 'view' ) ),
+                                ),
+                        ),
+                        'schema' => array( $this, 'get_public_item_schema' ),
+                ) );
+        }
+
+        /**
+         * Checks if a given request has access to read plugins.
+         *
+         * @since 5.0.0
+         *
+         * @param WP_REST_Request $request Full details about the request.
+         * @return bool True if the request has read access for the item, otherwise false.
+         */
+        public function get_items_permissions_check( $request ) {
+                return current_user_can( 'update_plugins' );
+        }
+
+        /**
+         * Retrieves the collection of plugins.
+         *
+         * @since 5.0.0
+         *
+         * @param WP_REST_Request $request Full details about the request.
+         * @return WP_REST_Response Response object.
+         */
+        public function get_items( $request ) {
+                $plugins  = $this->get_installed_plugins();
+                $response = array();
+
+                foreach ( $plugins as $id => $plugin ) {
+                        $response[]  = $this->prepare_item_for_response( $plugin, $request );
+                }
+
+                return rest_ensure_response( $response );
+        }
+
+        /**
+         * Checks if a given request has access to read the plugin.
+         *
+         * @since 5.0.0
+         *
+         * @param WP_REST_Request $request Full details about the request.
+         * @return bool True if the request has read access for the item, otherwise false.
+         */
+        public function get_item_permissions_check( $request ) {
+                return current_user_can( 'update_plugins' );
+        }
+
+        /**
+         * Retrieves the requested plugin.
+         *
+         * @since 5.0.0
+         *
+         * @param WP_REST_Request $request Full details about the request.
+         * @return array|WP_Error Array on success, or WP_Error object on failure.
+         * @return WP_REST_Response Response object.
+         */
+        public function get_item( $request ) {
+                $plugins = $this->get_installed_plugins();
+                $error   = new WP_Error( 'rest_plugin_not_found', __( 'The plugin is not installed' ), array( 'status' => 404 ) );
+
+                $slug = $request->get_param( 'slug' );
+
+                if ( ! $slug ) {
+                        return $error;
+                }
+
+                $plugin = wp_list_filter( $plugins, array( 'slug' => $slug ) );
+
+                if ( ! $plugin ) {
+                        return $error;
+                }
+
+                $response = $this->prepare_item_for_response( $plugin, $request );
+
+                return rest_ensure_response( $response );
+        }
+
+        /**
+         * Prepares a single plugin output for response.
+         *
+         * @since 5.0.0
+         *
+         * @param array           $plugin  Array of Plugin header tags.
+         * @param WP_REST_Request $request Request object.
+         * @return array Array of plugin header tags.
+         */
+        public function prepare_item_for_response( $plugin, $request ) {
+                if ( ! is_array( $plugin ) ) {
+                        return array();
+                }
+
+                if ( 'id' !== key( $plugin ) ) {
+                        $plugin = reset( $plugin );
+                }
+
+                $schema     = $this->get_item_schema();
+                $properties = wp_list_filter( $schema['properties'], array( 'type' => 'string' ) );
+                $data       = array();
+                $attributes = array();
+
+                // Set plugin data to translate.
+                foreach ( $properties as $property => $params ) {
+                        if ( 'id' === $property || 'slug' === $property ) {
+                                continue;
+                        }
+
+                        $data[ $params['description'] ] = $plugin[ $property ];
+                        $attributes[ $property ]        = $params['description'];
+                }
+
+                $data = _get_plugin_data_markup_translate( $plugin['id'], $data, false, true );
+                $data = array_map( 'strip_tags', $data );
+
+                // Update plugin with translated attributes
+                foreach ( $attributes as $p => $t ) {
+                        if ( ! isset( $data[ $t ] ) ) {
+                                continue;
+                        }
+
+                        $plugin[ $p ] = $data[ $t ];
+                }
+
+                $context = ! empty( $request['context'] ) ? $request['context'] : 'view';
+                $plugin = $this->filter_response_by_context( $plugin, $context );
+
+                return $plugin;
+        }
+
+        /**
+         * Retrieves all of the installed plugins or the Rest additionnal shema.
+         *
+         * @since 5.0.0
+         *
+         * @param  boolean $schema True to get the additionnal schema.
+         * @return array Array of registered options.
+         */
+        protected function get_installed_plugins( $schema = false ) {
+                $rest_plugins = array();
+
+                if ( ! $this->plugins ) {
+                        require_once ABSPATH . 'wp-admin/includes/plugin.php';
+
+                        $this->plugins = get_plugins();
+                }
+
+                foreach ( $this->plugins as $id => $args ) {
+                        if ( $schema ) {
+                                $rest_args = array();
+
+                                $default_schema = array(
+                                        'type'        => 'string',
+                                        'description' => '',
+                                        'context'     => array( 'view', 'edit', 'embed' ),
+                                );
+
+                        } else {
+                                $rest_args = array( 'id' => $id );
+                                $slug      = dirname( $id );
+
+                                if ( ! $slug ) {
+                                        continue;
+                                }
+
+                                if ( '.' === $slug ) {
+                                        $slug = wp_basename( $id, '.php' );
+                                }
+
+                                $rest_args['slug'] = $slug;
+                        }
+
+                        $header_keys = array_keys( $args );
+
+                        foreach ( array_map( 'sanitize_key', $header_keys ) as $tag_id => $header_tag ) {
+                                if ( $schema && ! isset( $rest_plugins[ $header_tag ] ) ) {
+                                        $rest_args['id']     = $header_tag;
+                                        $rest_args['schema'] = wp_parse_args( array(
+                                                'description' => $header_keys[ $tag_id ],
+                                                'type'        => is_bool( $args[ $header_keys[ $tag_id ] ] ) ? 'boolean' : 'string',
+                                        ), $default_schema );
+
+                                        $rest_plugins[ $rest_args['id'] ] = $rest_args;
+
+                                } else {
+                                        $rest_args[ $header_tag ] = $args[ $header_keys[ $tag_id ] ];
+                                }
+                        }
+
+                        if ( ! $schema ) {
+                                $rest_plugins[ $rest_args['id'] ] = $rest_args;
+                        }
+                }
+
+                return $rest_plugins;
+        }
+
+        /**
+         * Retrieves the plugins schema, conforming to JSON Schema.
+         *
+         * @since 5.0.0
+         *
+         * @return array Item schema data.
+         */
+        public function get_item_schema() {
+                $plugins = $this->get_installed_plugins( true );
+
+                $schema = array(
+                        '$schema'    => 'http://json-schema.org/draft-04/schema#',
+                        'title'      => 'plugins',
+                        'type'       => 'object',
+                        'properties' => array(
+                                'id'            => array(
+                                        'description' => __( 'An alphanumeric identifier for the object unique to its directory and main php file.' ),
+                                        'type'        => 'string',
+                                        'context'     => array( 'view', 'edit', 'embed' ),
+                                ),
+                                'slug'            => array(
+                                        'description' => __( 'An alphanumeric identifier for the object unique to its slug.' ),
+                                        'type'        => 'string',
+                                        'context'     => array( 'view', 'edit', 'embed' ),
+                                ),
+                        ),
+                );
+
+                foreach ( $plugins as $property_name => $property ) {
+                        $schema['properties'][ $property_name ] = $property['schema'];
+                }
+
+                return $this->add_additional_fields_schema( $schema );
+        }
+}

src/wp-includes/script-loader.php

@@ -832 +832 @@
                         ),
                 ) );
 
+                $scripts->add( 'plugin-upload', "/wp-admin/js/plugin-upload$suffix.js", array( 'wp-util', 'wp-api-request' ), false, 1 );
+                did_action( 'init' ) && $scripts->localize( 'plugin-upload', 'pluginUploadL10n', array(
+                        'warnOverwrite'      => __( "You are about to replace an existing plugin.\nThis action cannot be undone.\nPress 'Cancel' to stop or 'Install' to confirm." ),
+                        'cancel'             => __( 'Cancel' ),
+                        'pluginDetailsIntro' => __( 'About the existing plugin:' ),
+                ) );
+
                 $scripts->add( 'farbtastic', '/wp-admin/js/farbtastic.js', array('jquery'), '1.2' );
 
                 $scripts->add( 'iris', '/wp-admin/js/iris.min.js', array( 'jquery-ui-draggable', 'jquery-ui-slider', 'jquery-touch-punch' ), '1.0.7', 1 );

src/wp-settings.php

@@ -234 +234 @@
 require( ABSPATH . WPINC . '/rest-api/endpoints/class-wp-rest-users-controller.php' );
 require( ABSPATH . WPINC . '/rest-api/endpoints/class-wp-rest-comments-controller.php' );
 require( ABSPATH . WPINC . '/rest-api/endpoints/class-wp-rest-settings-controller.php' );
+require( ABSPATH . WPINC . '/rest-api/endpoints/class-wp-rest-plugins-controller.php' );
 require( ABSPATH . WPINC . '/rest-api/fields/class-wp-rest-meta-fields.php' );
 require( ABSPATH . WPINC . '/rest-api/fields/class-wp-rest-comment-meta-fields.php' );
 require( ABSPATH . WPINC . '/rest-api/fields/class-wp-rest-post-meta-fields.php' );