diff --git a/lib/class-wp-rest-block-directory-controller.php b/lib/class-wp-rest-block-directory-controller.php index abc7a2c6c9ae7..7ffa52a1fd767 100644 --- a/lib/class-wp-rest-block-directory-controller.php +++ b/lib/class-wp-rest-block-directory-controller.php @@ -1,18 +1,18 @@ WP_REST_Server::READABLE, 'callback' => array( $this, 'get_items' ), - 'permission_callback' => array( $this, 'permissions_check' ), + 'permission_callback' => array( $this, 'get_items_permissions_check' ), + 'args' => $this->get_collection_params(), ), - 'schema' => array( $this, 'get_item_schema' ), + 'schema' => array( $this, 'get_public_item_schema' ), ) ); + register_rest_route( $this->namespace, '/' . $this->rest_base . '/install', array( - array( - 'methods' => WP_REST_Server::CREATABLE, - 'callback' => array( $this, 'install_block' ), - 'permission_callback' => array( $this, 'permissions_check' ), + 'methods' => WP_REST_Server::CREATABLE, + 'callback' => array( $this, 'create_item' ), + 'permission_callback' => array( $this, 'create_item_permissions_check' ), + 'args' => array( + 'slug' => array( + 'required' => true, + ), ), - 'schema' => array( $this, 'get_item_schema' ), ) ); + register_rest_route( $this->namespace, '/' . $this->rest_base . '/uninstall', array( - array( - 'methods' => WP_REST_Server::DELETABLE, - 'callback' => array( $this, 'uninstall_block' ), - 'permission_callback' => array( $this, 'permissions_check' ), + 'methods' => WP_REST_Server::DELETABLE, + 'callback' => array( $this, 'delete_item' ), + 'permission_callback' => array( $this, 'delete_item_permissions_check' ), + 'args' => array( + 'slug' => array( + 'required' => true, + ), ), - 'schema' => array( $this, 'get_item_schema' ), ) ); } @@ -69,15 +76,18 @@ public function register_routes() { /** * Checks whether a given request has permission to install and activate plugins. * - * @since 6.5.0 + * @since 5.5.0 + * + * @param WP_REST_Request $request Full details about the request. * * @return WP_Error|bool True if the request has permission, WP_Error object otherwise. */ - public function permissions_check() { + public function get_items_permissions_check( $request ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable if ( ! current_user_can( 'install_plugins' ) || ! current_user_can( 'activate_plugins' ) ) { return new WP_Error( - 'rest_user_cannot_view', - __( 'Sorry, you are not allowed to install blocks.', 'gutenberg' ) + 'rest_block_directory_cannot_view', + __( 'Sorry, you are not allowed to browse the block directory.', 'gutenberg' ), + array( 'status' => rest_authorization_required_code() ) ); } @@ -85,228 +95,383 @@ public function permissions_check() { } /** - * Installs and activates a plugin + * Search and retrieve blocks metadata * - * @since 6.5.0 + * @since 5.5.0 * * @param WP_REST_Request $request Full details about the request. + * * @return WP_Error|WP_REST_Response Response object on success, or WP_Error object on failure. */ - public function install_block( $request ) { - - include_once( ABSPATH . 'wp-admin/includes/file.php' ); - include_once( ABSPATH . 'wp-admin/includes/plugin.php' ); - include_once( ABSPATH . 'wp-admin/includes/class-wp-upgrader.php' ); - include_once( ABSPATH . 'wp-admin/includes/plugin-install.php' ); + public function get_items( $request ) { + require_once ABSPATH . 'wp-admin/includes/plugin-install.php'; + require_once ABSPATH . 'wp-admin/includes/plugin.php'; - $api = plugins_api( - 'plugin_information', + $response = plugins_api( + 'query_plugins', array( - 'slug' => $request->get_param( 'slug' ), - 'fields' => array( - 'sections' => false, - ), + 'block' => $request['term'], + 'per_page' => $request['per_page'], + 'page' => $request['page'], ) ); - // Check if the plugin is already installed. - $installed_plugins = get_plugins( '/' . $api->slug ); + if ( is_wp_error( $response ) ) { + $response->add_data( array( 'status' => 500 ) ); + + return $response; + } - if ( empty( $installed_plugins ) ) { + $result = array(); - if ( is_wp_error( $api ) ) { - return WP_Error( $api->get_error_code(), $api->get_error_message() ); + foreach ( $response->plugins as $plugin ) { + if ( $this->find_plugin_for_slug( $plugin['slug'] ) ) { + continue; } - $skin = new WP_Ajax_Upgrader_Skin(); - $upgrader = new Plugin_Upgrader( $skin ); + $data = $this->prepare_item_for_response( $plugin, $request ); + $result[] = $this->prepare_response_for_collection( $data ); + } - $filesystem_method = get_filesystem_method(); + return rest_ensure_response( $result ); + } - if ( 'direct' !== $filesystem_method ) { - return WP_Error( null, 'Only direct FS_METHOD is supported.' ); - } + /** + * Checks whether a given request has permission to install and activate plugins. + * + * @since 5.5.0 + * + * @param WP_REST_Request $request Full details about the request. + * + * @return WP_Error|bool True if the request has permission, WP_Error object otherwise. + */ + public function create_item_permissions_check( $request ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable + if ( ! current_user_can( 'install_plugins' ) || ! current_user_can( 'activate_plugins' ) ) { + return new WP_Error( + 'rest_block_directory_cannot_create', + __( 'Sorry, you are not allowed to install blocks.', 'gutenberg' ), + array( 'status' => rest_authorization_required_code() ) + ); + } - $result = $upgrader->install( $api->download_link ); + return true; + } - if ( is_wp_error( $result ) ) { - return WP_Error( $result->get_error_code(), $result->get_error_message() ); - } + /** + * Installs and activates a plugin + * + * @since 5.5.0 + * + * @param WP_REST_Request $request Full details about the request. + * + * @return WP_Error|WP_REST_Response Response object on success, or WP_Error object on failure. + */ + public function create_item( $request ) { + require_once ABSPATH . 'wp-admin/includes/plugin.php'; - if ( is_wp_error( $skin->result ) ) { - return WP_Error( $skin->$result->get_error_code(), $skin->$result->get_error_message() ); - } + $existing = $this->find_plugin_for_slug( $request['slug'] ); - if ( $skin->get_errors()->has_errors() ) { - return WP_Error( $skin->$result->get_error_code(), $skin->$result->get_error_messages() ); - } + if ( $existing ) { + $activate = new WP_REST_Request( 'PUT', '/__experimental/plugins/' . substr( $existing, 0, - 4 ) ); + $activate->set_body_params( array( 'status' => 'active' ) ); - if ( is_null( $result ) ) { - global $wp_filesystem; - // Pass through the error from WP_Filesystem if one was raised. - if ( $wp_filesystem instanceof WP_Filesystem_Base && is_wp_error( $wp_filesystem->errors ) && $wp_filesystem->errors->has_errors() ) { - return WP_Error( 'unable_to_connect_to_filesystem', esc_html( $wp_filesystem->errors->get_error_message() ) ); - } - return WP_Error( 'unable_to_connect_to_filesystem', __( 'Unable to connect to the filesystem. Please confirm your credentials.', 'gutenberg' ) ); - } + return rest_do_request( $activate ); } - $install_status = install_plugin_install_status( $api ); + $inner_request = new WP_REST_Request( 'POST', '/__experimental/plugins' ); + $inner_request->set_body_params( + array( + 'slug' => $request['slug'], + 'status' => 'active', + ) + ); - $activate_result = activate_plugin( $install_status['file'] ); + return rest_do_request( $inner_request ); + } - if ( is_wp_error( $activate_result ) ) { - return WP_Error( $activate_result->get_error_code(), $activate_result->get_error_message() ); + /** + * Checks whether a given request has permission to remove/deactivate plugins. + * + * @since 5.5.0 + * + * @param WP_REST_Request $request Full details about the request. + * + * @return WP_Error|bool True if the request has permission, WP_Error object otherwise. + */ + public function delete_item_permissions_check( $request ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable + if ( ! current_user_can( 'delete_plugins' ) || ! current_user_can( 'deactivate_plugins' ) ) { + return new WP_Error( + 'rest_block_directory_cannot_delete', + __( 'Sorry, you are not allowed to uninstall blocks.', 'gutenberg' ), + array( 'status' => rest_authorization_required_code() ) + ); } - return rest_ensure_response( array( 'success' => true ) ); + return true; } /** * Deactivates and deletes a plugin * - * @since 6.5.0 + * @since 5.5.0 * * @param WP_REST_Request $request Full details about the request. + * * @return WP_Error|WP_REST_Response Response object on success, or WP_Error object on failure. */ - public function uninstall_block( $request ) { - - include_once( ABSPATH . 'wp-admin/includes/file.php' ); - include_once( ABSPATH . 'wp-admin/includes/plugin.php' ); - include_once( ABSPATH . 'wp-admin/includes/class-wp-upgrader.php' ); - include_once( ABSPATH . 'wp-admin/includes/plugin-install.php' ); + public function delete_item( $request ) { + require_once ABSPATH . 'wp-admin/includes/plugin.php'; - $api = plugins_api( - 'plugin_information', - array( - 'slug' => $request->get_param( 'slug' ), - 'fields' => array( - 'sections' => false, - ), - ) - ); + $slug = trim( $request->get_param( 'slug' ) ); - if ( is_wp_error( $api ) ) { - return WP_Error( $api->get_error_code(), $api->get_error_message() ); + if ( ! $slug ) { + return new WP_Error( 'slug_not_provided', 'Valid slug not provided.', array( 'status' => 400 ) ); } - $install_status = install_plugin_install_status( $api ); + $plugin_file = $this->find_plugin_for_slug( $slug ); - $deactivate_result = deactivate_plugins( $install_status['file'] ); - - if ( is_wp_error( $deactivate_result ) ) { - return WP_Error( $deactivate_result->get_error_code(), $deactivate_result->get_error_message() ); + if ( ! $plugin_file ) { + return new WP_Error( 'block_not_found', 'Valid slug not provided.', array( 'status' => 400 ) ); } - $delete_result = delete_plugins( array( $install_status['file'] ) ); + $route = '/__experimental/plugins/' . substr( $plugin_file, 0, - 4 ); + $deactivate = new WP_REST_Request( 'PUT', $route ); + $deactivate->set_body_params( array( 'status' => 'inactive' ) ); + + $deactivated = rest_do_request( $deactivate ); - if ( is_wp_error( $delete_result ) ) { - return WP_Error( $delete_result->get_error_code(), $delete_result->get_error_message() ); + if ( $deactivated->is_error() ) { + return $deactivated->as_error(); } - return rest_ensure_response( true ); + return rest_do_request( new WP_REST_Request( 'DELETE', $route ) ); } /** - * Search and retrieve blocks metadata + * Parse block metadata for a block, and prepare it for an API repsonse. * - * @since 6.5.0 + * @since 5.5.0 + * + * @param array $plugin The plugin metadata. + * @param WP_REST_Request $request Request object. * - * @param WP_REST_Request $request Full details about the request. * @return WP_Error|WP_REST_Response Response object on success, or WP_Error object on failure. */ - public function get_items( $request ) { - - $search_string = $request->get_param( 'term' ); + public function prepare_item_for_response( $plugin, $request ) { + // There might be multiple blocks in a plugin. Only the first block is mapped. + $block_data = reset( $plugin['blocks'] ); + + // A data array containing the properties we'll return. + $block = array( + 'name' => $block_data['name'], + 'title' => ( $block_data['title'] ? $block_data['title'] : $plugin['name'] ), + 'description' => wp_trim_words( $plugin['description'], 30, '...' ), + 'id' => $plugin['slug'], + 'rating' => $plugin['rating'] / 20, + 'rating_count' => intval( $plugin['num_ratings'] ), + 'active_installs' => intval( $plugin['active_installs'] ), + 'author_block_rating' => $plugin['author_block_rating'] / 20, + 'author_block_count' => intval( $plugin['author_block_count'] ), + 'author' => wp_strip_all_tags( $plugin['author'] ), + 'icon' => ( isset( $plugin['icons']['1x'] ) ? $plugin['icons']['1x'] : 'block-default' ), + 'assets' => array(), + 'last_updated' => $plugin['last_updated'], + 'humanized_updated' => sprintf( + /* translators: %s: Human-readable time difference. */ + __( '%s ago', 'gutenberg' ), + human_time_diff( strtotime( $plugin['last_updated'] ) ) + ), + ); - if ( empty( $search_string ) ) { - return rest_ensure_response( array() ); + foreach ( $plugin['block_assets'] as $asset ) { + // TODO: Return from API, not client-set. + $block['assets'][] = 'https://plugins.svn.wordpress.org/' . $plugin['slug'] . $asset; } - include( ABSPATH . WPINC . '/version.php' ); + $this->add_additional_fields_to_object( $block, $request ); - $url = 'http://api.wordpress.org/plugins/info/1.2/'; - $url = add_query_arg( - array( - 'action' => 'query_plugins', - 'request[block]' => $search_string, - 'request[wp_version]' => '5.3', - 'request[per_page]' => '3', - ), - $url - ); - $ssl = wp_http_supports( array( 'ssl' ) ); - if ( $ssl ) { - $url = set_url_scheme( $url, 'https' ); - } + $response = new WP_REST_Response( $block ); + $response->add_links( $this->prepare_links( $plugin ) ); - global $wp_version; - $http_args = array( - 'timeout' => 15, - 'user-agent' => 'WordPress/' . $wp_version . '; ' . home_url( '/' ), + return $response; + } + + /** + * Generates a list of links to include in the response for the plugin. + * + * @since 5.5.0 + * + * @param array $plugin The plugin data from WordPress.org. + * + * @return array + */ + protected function prepare_links( $plugin ) { + $links = array( + 'https://api.w.org/install-plugin' => array( + 'href' => add_query_arg( 'slug', urlencode( $plugin['slug'] ), rest_url( '__experimental/plugins' ) ), + ), ); - $request = wp_remote_get( $url, $http_args ); - $response = json_decode( wp_remote_retrieve_body( $request ), true ); + $plugin_file = $this->find_plugin_for_slug( $plugin['slug'] ); - if ( ! function_exists( 'get_plugins' ) ) { - require_once ABSPATH . 'wp-admin/includes/plugin.php'; + if ( $plugin_file ) { + $links['https://api.w.org/plugin'] = array( + 'href' => rest_url( '__experimental/plugins/' . substr( $plugin_file, 0, - 4 ) ), + 'embeddable' => true, + ); } - $result = array(); + return $links; + } + + /** + * Finds an installed plugin for the given slug. + * + * @since 5.5.0 + * + * @param string $slug The WordPress.org directory slug for a plugin. + * + * @return string The plugin file found matching it. + */ + protected function find_plugin_for_slug( $slug ) { + require_once ABSPATH . 'wp-admin/includes/plugin.php'; + + $plugin_files = get_plugins( '/' . $slug ); - foreach ( $response['plugins'] as $plugin ) { - $result[] = self::parse_block_metadata( $plugin ); + if ( ! $plugin_files ) { + return ''; } - return rest_ensure_response( $result ); + $plugin_files = array_keys( $plugin_files ); + + return $slug . '/' . reset( $plugin_files ); } /** - * Parse block metadata for a block + * Retrieves the theme's schema, conforming to JSON Schema. * - * @since 6.5.0 + * @since 5.5.0 * - * @param WP_Object $plugin The plugin metadata. - * @return WP_Error|WP_REST_Response Response object on success, or WP_Error object on failure. + * @return array Item schema data. */ - private static function parse_block_metadata( $plugin ) { - $block = new stdClass(); - - // There might be multiple blocks in a plugin. Only the first block is mapped. - $block_data = reset( $plugin['blocks'] ); - $block->name = $block_data['name']; - $block->title = $block_data['title']; + public function get_item_schema() { + if ( $this->schema ) { + return $this->add_additional_fields_schema( $this->schema ); + } - // Plugin's description, not description in block.json. - $block->description = wp_trim_words( wp_strip_all_tags( $plugin['description'] ), 30, '...' ); + $this->schema = array( + '$schema' => 'http://json-schema.org/draft-04/schema#', + 'title' => 'block-directory-item', + 'type' => 'object', + 'properties' => array( + 'name' => array( + 'description' => __( 'The block name, in namespace/block-name format.', 'gutenberg' ), + 'type' => 'string', + 'context' => array( 'view' ), + ), + 'title' => array( + 'description' => __( 'The block title, in human readable format.', 'gutenberg' ), + 'type' => 'string', + 'context' => array( 'view' ), + ), + 'description' => array( + 'description' => __( 'A short description of the block, in human readable format.', 'gutenberg' ), + 'type' => 'string', + 'context' => array( 'view' ), + ), + 'id' => array( + 'description' => __( 'The block slug.', 'gutenberg' ), + 'type' => 'string', + 'context' => array( 'view' ), + ), + 'rating' => array( + 'description' => __( 'The star rating of the block.', 'gutenberg' ), + 'type' => 'integer', + 'context' => array( 'view' ), + ), + 'rating_count' => array( + 'description' => __( 'The number of ratings.', 'gutenberg' ), + 'type' => 'integer', + 'context' => array( 'view' ), + ), + 'active_installs' => array( + 'description' => __( 'The number sites that have activated this block.', 'gutenberg' ), + 'type' => 'string', + 'context' => array( 'view' ), + ), + 'author_block_rating' => array( + 'description' => __( 'The average rating of blocks published by the same author.', 'gutenberg' ), + 'type' => 'integer', + 'context' => array( 'view' ), + ), + 'author_block_count' => array( + 'description' => __( 'The number of blocks published by the same author.', 'gutenberg' ), + 'type' => 'integer', + 'context' => array( 'view' ), + ), + 'author' => array( + 'description' => __( 'The WordPress.org username of the block author.', 'gutenberg' ), + 'type' => 'string', + 'context' => array( 'view' ), + ), + 'icon' => array( + 'description' => __( 'The block icon.', 'gutenberg' ), + 'type' => 'string', + 'format' => 'uri', + 'context' => array( 'view' ), + ), + 'humanized_updated' => array( + 'description' => __( 'The date when the block was last updated, in fuzzy human readable format.', 'gutenberg' ), + 'type' => 'string', + 'context' => array( 'view' ), + ), + 'assets' => array( + 'description' => __( 'An object representing the block CSS and JavaScript assets.', 'gutenberg' ), + 'type' => 'array', + 'context' => array( 'view' ), + 'readonly' => true, + 'items' => array( + 'type' => 'string', + 'format' => 'uri', + ), - $block->id = $plugin['slug']; - $block->rating = $plugin['rating'] / 20; - $block->rating_count = $plugin['num_ratings']; - $block->active_installs = $plugin['active_installs']; - $block->author_block_rating = $plugin['author_block_rating'] / 20; - $block->author_block_count = (int) $plugin['author_block_count']; + ), - // Plugin's author, not author in block.json. - $block->author = wp_strip_all_tags( $plugin['author'] ); + ), + ); - // Plugin's icons or icon in block.json. - $block->icon = isset( $plugin['icons']['1x'] ) ? $plugin['icons']['1x'] : 'block-default'; + return $this->add_additional_fields_schema( $this->schema ); + } - $block->assets = array(); + /** + * Retrieves the search params for the blocks collection. + * + * @since 5.5.0 + * + * @return array Collection parameters. + */ + public function get_collection_params() { + $query_params = parent::get_collection_params(); - foreach ( $plugin['block_assets'] as $asset ) { - $block->assets[] = 'https://plugins.svn.wordpress.org/' . $plugin['slug'] . $asset; - } + $query_params['context']['default'] = 'view'; + $query_params['per_page']['default'] = 3; - $block->humanized_updated = sprintf( - /* translators: %s: Human-readable time difference. */ - __( '%s ago', 'gutenberg' ), - human_time_diff( strtotime( $plugin['last_updated'] ), time() ) + $query_params['term'] = array( + 'description' => __( 'Limit result set to blocks matching the search term.', 'gutenberg' ), + 'type' => 'string', + 'required' => true, + 'minLength' => 1, ); - return $block; + unset( $query_params['search'] ); + + /** + * Filter collection parameters for the block directory controller. + * + * @since 5.5.0 + * + * @param array $query_params JSON Schema-formatted collection parameters. + */ + return apply_filters( 'rest_block_directory_collection_params', $query_params ); } } diff --git a/lib/class-wp-rest-plugins-controller.php b/lib/class-wp-rest-plugins-controller.php new file mode 100644 index 0000000000000..492c03a50644f --- /dev/null +++ b/lib/class-wp-rest-plugins-controller.php @@ -0,0 +1,948 @@ +namespace = '__experimental'; + $this->rest_base = 'plugins'; + } + + /** + * Registers the routes for the plugins controller. + * + * @since 5.5.0 + */ + public function register_routes() { + register_rest_route( + $this->namespace, + '/' . $this->rest_base, + array( + array( + 'methods' => WP_REST_Server::READABLE, + 'callback' => array( $this, 'get_items' ), + 'permission_callback' => array( $this, 'get_items_permissions_check' ), + 'args' => $this->get_collection_params(), + ), + array( + 'methods' => WP_REST_Server::CREATABLE, + 'callback' => array( $this, 'create_item' ), + 'permission_callback' => array( $this, 'create_item_permissions_check' ), + 'args' => array( + 'slug' => array( + 'type' => 'string', + 'required' => true, + 'description' => __( 'WordPress.org plugin directory slug.', 'gutenberg' ), + 'pattern' => '[\w\-]+', + ), + 'status' => array( + 'description' => __( 'The plugin activation status.', 'gutenberg' ), + 'type' => 'string', + 'enum' => is_multisite() ? array( 'inactive', 'active', 'network-active' ) : array( 'inactive', 'active' ), + 'default' => 'inactive', + ), + ), + ), + 'schema' => array( $this, 'get_public_item_schema' ), + ) + ); + + register_rest_route( + $this->namespace, + '/' . $this->rest_base . '/(?P' . self::PATTERN . ')', + array( + array( + 'methods' => WP_REST_Server::READABLE, + 'callback' => array( $this, 'get_item' ), + 'permission_callback' => array( $this, 'get_item_permissions_check' ), + ), + array( + 'methods' => WP_REST_Server::EDITABLE, + 'callback' => array( $this, 'update_item' ), + 'permission_callback' => array( $this, 'update_item_permissions_check' ), + 'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ), + ), + array( + 'methods' => WP_REST_Server::DELETABLE, + 'callback' => array( $this, 'delete_item' ), + 'permission_callback' => array( $this, 'delete_item_permissions_check' ), + ), + 'args' => array( + 'context' => $this->get_context_param( array( 'default' => 'view' ) ), + 'plugin' => array( + 'type' => 'string', + 'pattern' => self::PATTERN, + 'validate_callback' => array( $this, 'validate_plugin_param' ), + 'sanitize_callback' => array( $this, 'sanitize_plugin_param' ), + ), + ), + 'schema' => array( $this, 'get_public_item_schema' ), + ) + ); + } + + /** + * Checks if a given request has access to get plugins. + * + * @since 5.5.0 + * + * @param WP_REST_Request $request Full details about the request. + * @return true|WP_Error True if the request has read access, WP_Error object otherwise. + */ + public function get_items_permissions_check( $request ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable + if ( ! current_user_can( 'activate_plugins' ) ) { + return new WP_Error( + 'rest_cannot_view_plugins', + __( 'Sorry, you are not allowed to manage plugins for this site.', 'gutenberg' ), + array( 'status' => rest_authorization_required_code() ) + ); + } + + return true; + } + + /** + * Retrieves a collection of plugins. + * + * @since 5.5.0 + * + * @param WP_REST_Request $request Full details about the request. + * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure. + */ + public function get_items( $request ) { + require_once ABSPATH . 'wp-admin/includes/plugin.php'; + + $plugins = array(); + + foreach ( get_plugins() as $file => $data ) { + if ( is_wp_error( $this->check_read_permission( $file ) ) ) { + continue; + } + + $data['_file'] = $file; + + if ( ! $this->does_plugin_match_request( $request, $data ) ) { + continue; + } + + $plugins[] = $this->prepare_response_for_collection( $this->prepare_item_for_response( $data, $request ) ); + } + + return new WP_REST_Response( $plugins ); + } + + /** + * Checks if a given request has access to get a specific plugin. + * + * @since 5.5.0 + * + * @param WP_REST_Request $request Full details about the request. + * @return true|WP_Error True if the request has read access for the item, WP_Error object otherwise. + */ + public function get_item_permissions_check( $request ) { + if ( ! current_user_can( 'activate_plugins' ) ) { + return new WP_Error( + 'rest_cannot_view_plugin', + __( 'Sorry, you are not allowed to manage plugins for this site.', 'gutenberg' ), + array( 'status' => rest_authorization_required_code() ) + ); + } + + $can_read = $this->check_read_permission( $request['plugin'] ); + + if ( is_wp_error( $can_read ) ) { + return $can_read; + } + + return true; + } + + /** + * Retrieves one plugin from the site. + * + * @since 5.5.0 + * + * @param WP_REST_Request $request Full details about the request. + * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure. + */ + public function get_item( $request ) { + require_once ABSPATH . 'wp-admin/includes/plugin.php'; + + $data = $this->get_plugin_data( $request['plugin'] ); + + if ( is_wp_error( $data ) ) { + return $data; + } + + return $this->prepare_item_for_response( $data, $request ); + } + + /** + * Checks if the given plugin can be viewed by the current user. + * + * On multisite, this hides non-active network only plugins if the user does not have permission + * to manage network plugins. + * + * @since 5.5.0 + * + * @param string $plugin The plugin file to check. + * @return true|WP_Error True if can read, a WP_Error instance otherwise. + */ + protected function check_read_permission( $plugin ) { + if ( ! $this->is_plugin_installed( $plugin ) ) { + return new WP_Error( 'rest_plugin_not_found', __( 'Plugin not found.', 'gutenberg' ), array( 'status' => 404 ) ); + } + + if ( ! is_multisite() ) { + return true; + } + + if ( ! is_network_only_plugin( $plugin ) || is_plugin_active( $plugin ) || current_user_can( 'manage_network_plugins' ) ) { + return true; + } + + return new WP_Error( + 'rest_cannot_view_plugin', + __( 'Sorry, you are not allowed to manage this plugin.', 'gutenberg' ), + array( 'status' => rest_authorization_required_code() ) + ); + } + + /** + * Checks if a given request has access to upload plugins. + * + * @since 5.5.0 + * + * @param WP_REST_Request $request Full details about the request. + * @return true|WP_Error True if the request has access to create items, WP_Error object otherwise. + */ + public function create_item_permissions_check( $request ) { + if ( ! current_user_can( 'install_plugins' ) ) { + return new WP_Error( + 'rest_cannot_install_plugin', + __( 'Sorry, you are not allowed to install plugins on this site.', 'gutenberg' ), + array( 'status' => rest_authorization_required_code() ) + ); + } + + if ( 'inactive' !== $request['status'] && ! current_user_can( 'activate_plugins' ) ) { + return new WP_Error( + 'rest_cannot_activate_plugin', + __( 'Sorry, you are not allowed to activate plugins.', 'gutenberg' ), + array( + 'status' => rest_authorization_required_code(), + ) + ); + } + + return true; + } + + /** + * Uploads a plugin and optionally activates it. + * + * @since 5.5.0 + * + * @param WP_REST_Request $request Full details about the request. + * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure. + */ + public function create_item( $request ) { + require_once ABSPATH . 'wp-admin/includes/file.php'; + require_once ABSPATH . 'wp-admin/includes/plugin.php'; + require_once ABSPATH . 'wp-admin/includes/class-wp-upgrader.php'; + require_once ABSPATH . 'wp-admin/includes/plugin-install.php'; + + $slug = $request['slug']; + + // Verify filesystem is accessible first. + $filesystem_available = $this->is_filesystem_available(); + if ( is_wp_error( $filesystem_available ) ) { + return $filesystem_available; + } + + $api = plugins_api( + 'plugin_information', + array( + 'slug' => $slug, + 'fields' => array( + 'sections' => false, + ), + ) + ); + + if ( is_wp_error( $api ) ) { + if ( false !== strpos( $api->get_error_message(), 'Plugin not found.' ) ) { + $api->add_data( array( 'status' => 404 ) ); + } else { + $api->add_data( array( 'status' => 500 ) ); + } + + return $api; + } + + $skin = new WP_Ajax_Upgrader_Skin(); + $upgrader = new Plugin_Upgrader( $skin ); + + $result = $upgrader->install( $api->download_link ); + + if ( is_wp_error( $result ) ) { + $result->add_data( array( 'status' => 500 ) ); + + return $result; + } + + // This should be the same as $result above. + if ( is_wp_error( $skin->result ) ) { + $skin->result->add_data( array( 'status' => 500 ) ); + + return $skin->result; + } + + if ( $skin->get_errors()->has_errors() ) { + $error = $skin->get_errors(); + $error->add_data( array( 'status' => 500 ) ); + + return $error; + } + + if ( is_null( $result ) ) { + global $wp_filesystem; + // Pass through the error from WP_Filesystem if one was raised. + if ( $wp_filesystem instanceof WP_Filesystem_Base && is_wp_error( $wp_filesystem->errors ) && $wp_filesystem->errors->has_errors() ) { + return new WP_Error( 'unable_to_connect_to_filesystem', $wp_filesystem->errors->get_error_message(), array( 'status' => 500 ) ); + } + + return new WP_Error( 'unable_to_connect_to_filesystem', __( 'Unable to connect to the filesystem. Please confirm your credentials.', 'gutenberg' ), array( 'status' => 500 ) ); + } + + $file = $upgrader->plugin_info(); + + if ( ! $file ) { + return new WP_Error( 'unable_to_determine_installed_plugin', __( 'Unable to determine what plugin was installed.', 'gutenberg' ), array( 'status' => 500 ) ); + } + + if ( 'inactive' !== $request['status'] ) { + $can_change_status = $this->plugin_status_permission_check( $file, $request['status'], 'inactive' ); + + if ( is_wp_error( $can_change_status ) ) { + return $can_change_status; + } + + $changed_status = $this->handle_plugin_status( $file, $request['status'], 'inactive' ); + + if ( is_wp_error( $changed_status ) ) { + return $changed_status; + } + } + + $path = WP_PLUGIN_DIR . '/' . $file; + $data = get_plugin_data( $path, false, false ); + $data['_file'] = $file; + + $response = $this->prepare_item_for_response( $data, $request ); + $response->set_status( 201 ); + $response->header( 'Location', rest_url( sprintf( '%s/%s/%s', $this->namespace, $this->rest_base, substr( $file, 0, - 4 ) ) ) ); + + return $response; + } + + /** + * Checks if a given request has access to update a specific plugin. + * + * @since 5.5.0 + * + * @param WP_REST_Request $request Full details about the request. + * @return true|WP_Error True if the request has access to update the item, WP_Error object otherwise. + */ + public function update_item_permissions_check( $request ) { + require_once ABSPATH . 'wp-admin/includes/plugin.php'; + + if ( ! current_user_can( 'activate_plugins' ) ) { + return new WP_Error( + 'rest_cannot_manage_plugins', + __( 'Sorry, you are not allowed to manage plugins for this site.', 'gutenberg' ), + array( 'status' => rest_authorization_required_code() ) + ); + } + + $can_read = $this->check_read_permission( $request['plugin'] ); + + if ( is_wp_error( $can_read ) ) { + return $can_read; + } + + $status = $this->get_plugin_status( $request['plugin'] ); + + if ( $request['status'] && $status !== $request['status'] ) { + $can_change_status = $this->plugin_status_permission_check( $request['plugin'], $request['status'], $status ); + + if ( is_wp_error( $can_change_status ) ) { + return $can_change_status; + } + } + + return true; + } + + /** + * Updates one plugin. + * + * @since 5.5.0 + * + * @param WP_REST_Request $request Full details about the request. + * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure. + */ + public function update_item( $request ) { + require_once ABSPATH . 'wp-admin/includes/plugin.php'; + + $data = $this->get_plugin_data( $request['plugin'] ); + + if ( is_wp_error( $data ) ) { + return $data; + } + + $status = $this->get_plugin_status( $request['plugin'] ); + + if ( $request['status'] && $status !== $request['status'] ) { + $handled = $this->handle_plugin_status( $request['plugin'], $request['status'], $status ); + + if ( is_wp_error( $handled ) ) { + return $handled; + } + } + + $this->update_additional_fields_for_object( $data, $request ); + + $request['context'] = 'edit'; + + return $this->prepare_item_for_response( $data, $request ); + } + + /** + * Checks if a given request has access to delete a specific plugin. + * + * @since 5.5.0 + * + * @param WP_REST_Request $request Full details about the request. + * @return true|WP_Error True if the request has access to delete the item, WP_Error object otherwise. + */ + public function delete_item_permissions_check( $request ) { + if ( ! current_user_can( 'activate_plugins' ) ) { + return new WP_Error( + 'rest_cannot_manage_plugins', + __( 'Sorry, you are not allowed to manage plugins for this site.', 'gutenberg' ), + array( 'status' => rest_authorization_required_code() ) + ); + } + + if ( ! current_user_can( 'delete_plugins' ) ) { + return new WP_Error( + 'rest_cannot_manage_plugins', + __( 'Sorry, you are not allowed to delete plugins for this site.', 'gutenberg' ), + array( 'status' => rest_authorization_required_code() ) + ); + } + + $can_read = $this->check_read_permission( $request['plugin'] ); + + if ( is_wp_error( $can_read ) ) { + return $can_read; + } + + return true; + } + + /** + * Deletes one plugin from the site. + * + * @since 5.5.0 + * + * @param WP_REST_Request $request Full details about the request. + * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure. + */ + public function delete_item( $request ) { + require_once ABSPATH . 'wp-admin/includes/file.php'; + require_once ABSPATH . 'wp-admin/includes/plugin.php'; + + $data = $this->get_plugin_data( $request['plugin'] ); + + if ( is_wp_error( $data ) ) { + return $data; + } + + if ( is_plugin_active( $request['plugin'] ) ) { + return new WP_Error( + 'rest_cannot_delete_active_plugin', + __( 'Cannot delete an active plugin. Please deactivate it first.', 'gutenberg' ), + array( 'status' => 400 ) + ); + } + + $filesystem_available = $this->is_filesystem_available(); + if ( is_wp_error( $filesystem_available ) ) { + return $filesystem_available; + } + + $prepared = $this->prepare_item_for_response( $data, $request ); + $deleted = delete_plugins( array( $request['plugin'] ) ); + + if ( is_wp_error( $deleted ) ) { + $deleted->add_data( array( 'status' => 500 ) ); + + return $deleted; + } + + return new WP_REST_Response( + array( + 'deleted' => true, + 'previous' => $prepared->get_data(), + ) + ); + } + + /** + * Prepares the plugin for the REST response. + * + * @since 5.5.0 + * + * @param mixed $item Unmarked up and untranslated plugin data from {@see get_plugin_data()}. + * @param WP_REST_Request $request Request object. + * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure. + */ + public function prepare_item_for_response( $item, $request ) { + $item = _get_plugin_data_markup_translate( $item['_file'], $item, false ); + $marked = _get_plugin_data_markup_translate( $item['_file'], $item, true, false ); + + $data = array( + 'plugin' => $item['_file'], + 'status' => $this->get_plugin_status( $item['_file'] ), + 'name' => $item['Name'], + 'plugin_uri' => $item['PluginURI'], + 'author' => $item['Author'], + 'author_uri' => $item['AuthorURI'], + 'description' => array( + 'raw' => $item['Description'], + 'rendered' => $marked['Description'], + ), + 'version' => $item['Version'], + 'network_only' => $item['Network'], + 'requires_wp' => $item['RequiresWP'], + 'requires_php' => $item['RequiresPHP'], + 'text_domain' => $item['TextDomain'], + ); + + $data = $this->add_additional_fields_to_object( $data, $request ); + + $response = new WP_REST_Response( $data ); + $response->add_links( $this->prepare_links( $item ) ); + + /** + * Filters the plugin data for a response. + * + * @since 5.5.0 + * + * @param WP_REST_Response $response The response object. + * @param array $item The plugin item from {@see get_plugin_data()}. + * @param WP_REST_Request $request The request object. + */ + return apply_filters( 'rest_prepare_plugin', $response, $item, $request ); + } + + /** + * Prepares links for the request. + * + * @since 5.5.0 + * + * @param array $item The plugin item. + * @return array[] + */ + protected function prepare_links( $item ) { + return array( + 'self' => array( + 'href' => rest_url( sprintf( '%s/%s/%s', $this->namespace, $this->rest_base, substr( $item['_file'], 0, - 4 ) ) ), + ), + ); + } + + /** + * Gets the plugin header data for a plugin. + * + * @since 5.5.0 + * + * @param string $plugin The plugin file to get data for. + * @return array|WP_Error The plugin data, or a WP_Error if the plugin is not installed. + */ + protected function get_plugin_data( $plugin ) { + $plugins = get_plugins(); + + if ( ! isset( $plugins[ $plugin ] ) ) { + return new WP_Error( 'rest_plugin_not_found', __( 'Plugin not found.', 'gutenberg' ), array( 'status' => 404 ) ); + } + + $data = $plugins[ $plugin ]; + $data['_file'] = $plugin; + + return $data; + } + + /** + * Get's the activation status for a plugin. + * + * @since 5.5.0 + * + * @param string $plugin The plugin file to check. + * @return string Either 'network-active', 'active' or 'inactive'. + */ + protected function get_plugin_status( $plugin ) { + if ( is_plugin_active_for_network( $plugin ) ) { + return 'network-active'; + } + + if ( is_plugin_active( $plugin ) ) { + return 'active'; + } + + return 'inactive'; + } + + /** + * Handle updating a plugin's status. + * + * @since 5.5.0 + * + * @param string $plugin The plugin file to update. + * @param string $new_status The plugin's new status. + * @param string $current_status The plugin's current status. + * + * @return true|WP_Error + */ + protected function plugin_status_permission_check( $plugin, $new_status, $current_status ) { + if ( is_multisite() && ( 'network-active' === $current_status || 'network-active' === $new_status ) && ! current_user_can( 'manage_network_plugins' ) ) { + return new WP_Error( + 'rest_cannot_manage_network_plugins', + __( 'Sorry, you do not have permission to manage network plugins.', 'gutenberg' ), + array( 'status' => rest_authorization_required_code() ) + ); + } + + if ( ( 'active' === $new_status || 'network-active' === $new_status ) && ! current_user_can( 'activate_plugin', $plugin ) ) { + return new WP_Error( + 'rest_cannot_activate_plugin', + __( 'Sorry, you are not allowed to activate this plugin.', 'gutenberg' ), + array( 'status' => rest_authorization_required_code() ) + ); + } + + if ( 'inactive' === $new_status && ! current_user_can( 'deactivate_plugin', $plugin ) ) { + return new WP_Error( + 'rest_cannot_deactivate_plugin', + __( 'Sorry, you are not allowed to deactivate this plugin.', 'gutenberg' ), + array( 'status' => rest_authorization_required_code() ) + ); + } + + return true; + } + + /** + * Handle updating a plugin's status. + * + * @since 5.5.0 + * + * @param string $plugin The plugin file to update. + * @param string $new_status The plugin's new status. + * @param string $current_status The plugin's current status. + * @return true|WP_Error + */ + protected function handle_plugin_status( $plugin, $new_status, $current_status ) { + if ( 'inactive' === $new_status ) { + deactivate_plugins( $plugin, false, 'network-active' === $current_status ); + + return true; + } + + if ( 'active' === $new_status && 'network-active' === $current_status ) { + return true; + } + + $network_activate = 'network-active' === $new_status; + + if ( is_multisite() && ! $network_activate && is_network_only_plugin( $plugin ) ) { + return new WP_Error( + 'rest_network_only_plugin', + __( 'Network only plugin must be network activated.', 'gutenberg' ), + array( 'status' => 400 ) + ); + } + + $activated = activate_plugin( $plugin, '', $network_activate ); + + if ( is_wp_error( $activated ) ) { + $activated->add_data( array( 'status' => 500 ) ); + + return $activated; + } + + return true; + } + + /** + * Checks that the "plugin" parameter is a valid path. + * + * @since 5.5.0 + * + * @param string $file The plugin file parameter. + * @return bool + */ + public function validate_plugin_param( $file ) { + if ( ! is_string( $file ) || ! preg_match( '/' . self::PATTERN . '/u', $file ) ) { + return false; + } + + $validated = validate_file( plugin_basename( $file ) ); + + return 0 === $validated; + } + + /** + * Sanitizes the "plugin" parameter to be a proper plugin file with ".php" appended. + * + * @since 5.5.0 + * + * @param string $file The plugin file parameter. + * @return string + */ + public function sanitize_plugin_param( $file ) { + return plugin_basename( sanitize_text_field( $file . '.php' ) ); + } + + /** + * Checks if the plugin matches the requested parameters. + * + * @since 5.5.0 + * + * @param WP_REST_Request $request The request to require the plugin matches against. + * @param array $item The plugin item. + * + * @return bool + */ + protected function does_plugin_match_request( $request, $item ) { + $search = $request['search']; + + if ( $search ) { + $matched_search = false; + + foreach ( $item as $field ) { + if ( is_string( $field ) && false !== strpos( strip_tags( $field ), $search ) ) { + $matched_search = true; + break; + } + } + + if ( ! $matched_search ) { + return false; + } + } + + $status = $request['status']; + + if ( $status && ! in_array( $this->get_plugin_status( $item['_file'] ), $status, true ) ) { + return false; + } + + return true; + } + + /** + * Checks if the plugin is installed. + * + * @since 5.5.0 + * + * @param string $plugin The plugin file. + * @return bool + */ + protected function is_plugin_installed( $plugin ) { + return file_exists( WP_PLUGIN_DIR . '/' . $plugin ); + } + + /** + * Determine if the endpoints are available. + * + * Only the 'Direct' filesystem transport, and SSH/FTP when credentials are stored are supported at present. + * + * @since 5.5.0 + * + * @return true|WP_Error True if filesystem is available, WP_Error otherwise. + */ + protected function is_filesystem_available() { + $filesystem_method = get_filesystem_method(); + + if ( 'direct' === $filesystem_method ) { + return true; + } + + ob_start(); + $filesystem_credentials_are_stored = request_filesystem_credentials( self_admin_url() ); + ob_end_clean(); + + if ( $filesystem_credentials_are_stored ) { + return true; + } + + return new WP_Error( 'fs_unavailable', __( 'The filesystem is currently unavailable for managing plugins.', 'gutenberg' ), array( 'status' => 500 ) ); + } + + /** + * Retrieves the plugin's schema, conforming to JSON Schema. + * + * @since 4.7.0 + * + * @return array Item schema data. + */ + public function get_item_schema() { + if ( $this->schema ) { + return $this->add_additional_fields_schema( $this->schema ); + } + + $this->schema = array( + '$schema' => 'http://json-schema.org/draft-04/schema#', + 'title' => 'plugin', + 'type' => 'object', + 'properties' => array( + 'plugin' => array( + 'description' => __( 'The plugin file.', 'gutenberg' ), + 'type' => 'string', + 'pattern' => self::PATTERN, + 'readonly' => true, + 'context' => array( 'view', 'edit', 'embed' ), + ), + 'status' => array( + 'description' => __( 'The plugin activation status.', 'gutenberg' ), + 'type' => 'string', + 'enum' => is_multisite() ? array( 'inactive', 'active', 'network-active' ) : array( 'inactive', 'active' ), + 'context' => array( 'view', 'edit', 'embed' ), + ), + 'name' => array( + 'description' => __( 'The plugin name.', 'gutenberg' ), + 'type' => 'string', + 'readonly' => true, + 'context' => array( 'view', 'edit', 'embed' ), + ), + 'plugin_uri' => array( + 'description' => __( 'The plugin\'s website address.', 'gutenberg' ), + 'type' => 'string', + 'format' => 'uri', + 'readonly' => true, + 'context' => array( 'view', 'edit' ), + ), + 'author' => array( + 'description' => __( 'The plugin author.', 'gutenberg' ), + 'type' => 'object', + 'readonly' => true, + 'context' => array( 'view', 'edit' ), + ), + 'author_uri' => array( + 'description' => __( 'Plugin author\'s website address.', 'gutenberg' ), + 'type' => 'string', + 'format' => 'uri', + 'readonly' => true, + 'context' => array( 'view', 'edit' ), + ), + 'description' => array( + 'description' => __( 'The plugin description.', 'gutenberg' ), + 'type' => 'object', + 'readonly' => true, + 'context' => array( 'view', 'edit' ), + 'properties' => array( + 'raw' => array( + 'description' => __( 'The raw plugin description.', 'gutenberg' ), + 'type' => 'string', + ), + 'rendered' => array( + 'description' => __( 'The plugin description formatted for display.', 'gutenberg' ), + 'type' => 'string', + ), + ), + ), + 'version' => array( + 'description' => __( 'The plugin version number.', 'gutenberg' ), + 'type' => 'string', + 'readonly' => true, + 'context' => array( 'view', 'edit' ), + ), + 'network_only' => array( + 'description' => __( 'Whether the plugin can only be activated network-wide.', 'gutenberg' ), + 'type' => 'boolean', + 'readonly' => true, + 'context' => array( 'view', 'edit', 'embed' ), + ), + 'requires_wp' => array( + 'description' => __( 'Minimum required version of WordPress.', 'gutenberg' ), + 'type' => 'string', + 'readonly' => true, + 'context' => array( 'view', 'edit', 'embed' ), + ), + 'requires_php' => array( + 'description' => __( 'Minimum required version of PHP.', 'gutenberg' ), + 'type' => 'string', + 'readonly' => true, + 'context' => array( 'view', 'edit', 'embed' ), + ), + 'text_domain' => array( + 'description' => __( 'The plugin\'s text domain.', 'gutenberg' ), + 'type' => 'string', + 'readonly' => true, + 'context' => array( 'view', 'edit' ), + ), + ), + ); + + return $this->add_additional_fields_schema( $this->schema ); + } + + /** + * Retrieves the query params for the collections. + * + * @since 5.5.0 + * + * @return array Query parameters for the collection. + */ + public function get_collection_params() { + $query_params = parent::get_collection_params(); + + $query_params['context']['default'] = 'view'; + + $query_params['status'] = array( + 'description' => __( 'Limits results to plugins with the given status.', 'gutenberg' ), + 'type' => 'array', + 'items' => array( + 'type' => 'string', + 'enum' => is_multisite() ? array( 'inactive', 'active', 'network-active' ) : array( 'inactive', 'active' ), + ), + ); + + unset( $query_params['page'], $query_params['per_page'] ); + + return $query_params; + } +} diff --git a/lib/load.php b/lib/load.php index a495575668868..f13302e7e5dd8 100644 --- a/lib/load.php +++ b/lib/load.php @@ -57,6 +57,9 @@ function gutenberg_is_experiment_enabled( $name ) { if ( ! class_exists( 'WP_REST_Image_Editor_Controller' ) ) { require dirname( __FILE__ ) . '/class-wp-rest-image-editor-controller.php'; } + if ( ! class_exists( 'WP_REST_Plugins_Controller' ) ) { + require_once dirname( __FILE__ ) . '/class-wp-rest-plugins-controller.php'; + } /** * End: Include for phase 2 */ diff --git a/lib/rest-api.php b/lib/rest-api.php index 0bd60b8583ed2..c0f1c2aa31950 100644 --- a/lib/rest-api.php +++ b/lib/rest-api.php @@ -154,6 +154,20 @@ function gutenberg_register_rest_customizer_nonces() { } add_action( 'rest_api_init', 'gutenberg_register_rest_customizer_nonces' ); + +/** + * Registers the Plugins REST API routes. + */ +function gutenberg_register_plugins_endpoint() { + if ( ! gutenberg_is_experiment_enabled( 'gutenberg-block-directory' ) ) { + return; + } + + $plugins = new WP_REST_Plugins_Controller(); + $plugins->register_routes(); +} +add_action( 'rest_api_init', 'gutenberg_register_plugins_endpoint' ); + /** * Hook in to the nav menu item post type and enable a post type rest endpoint. * diff --git a/package.json b/package.json index 633fffb5ffdd7..fae96c8088f54 100644 --- a/package.json +++ b/package.json @@ -236,8 +236,8 @@ "test-unit:debug": "wp-scripts --inspect-brk test-unit-js --runInBand --no-cache --verbose --config test/unit/jest.config.js ", "test-unit:update": "npm run test-unit -- --updateSnapshot", "test-unit:watch": "npm run test-unit -- --watch", - "test-unit-php": "wp-env run phpunit 'phpunit -c /var/www/html/wp-content/plugins/gutenberg/phpunit.xml.dist'", - "test-unit-php-multisite": "wp-env run phpunit 'WP_MULTISITE=1 phpunit -c /var/www/html/wp-content/plugins/gutenberg/phpunit.xml.dist'", + "test-unit-php": "wp-env run phpunit 'phpunit -c /var/www/html/wp-content/plugins/gutenberg/phpunit.xml.dist --verbose'", + "test-unit-php-multisite": "wp-env run phpunit 'WP_MULTISITE=1 phpunit -c /var/www/html/wp-content/plugins/gutenberg/phpunit/multisite.xml --verbose'", "test-unit:native": "cd test/native/ && cross-env NODE_ENV=test jest --config ./jest.config.js", "test-unit:native:debug": "cd test/native/ && node --inspect-brk ../../node_modules/.bin/jest --runInBand --verbose --config ./jest.config.js", "prestorybook:build": "npm run build:packages", diff --git a/phpunit.xml.dist b/phpunit.xml.dist index e799a44754caf..75b7e4bfeb52e 100644 --- a/phpunit.xml.dist +++ b/phpunit.xml.dist @@ -11,4 +11,9 @@ ./phpunit/ + + + ms-required + + diff --git a/phpunit/bootstrap.php b/phpunit/bootstrap.php index 30cb39dad4fdd..b3f564d120e22 100644 --- a/phpunit/bootstrap.php +++ b/phpunit/bootstrap.php @@ -70,6 +70,12 @@ function fail_if_died( $message ) { } tests_add_filter( 'wp_die_handler', 'fail_if_died' ); +$GLOBALS['wp_tests_options'] = array( + 'gutenberg-experiments' => array( + 'gutenberg-block-directory' => '1', + ), +); + // Start up the WP testing environment. require $_tests_dir . '/includes/bootstrap.php'; diff --git a/phpunit/class-wp-rest-block-directory-controller-test.php b/phpunit/class-wp-rest-block-directory-controller-test.php new file mode 100644 index 0000000000000..1675fac5fa35c --- /dev/null +++ b/phpunit/class-wp-rest-block-directory-controller-test.php @@ -0,0 +1,214 @@ +user->create( + array( + 'role' => 'administrator', + ) + ); + + if ( is_multisite() ) { + grant_super_admin( self::$admin_id ); + } + + if ( ! defined( 'FS_METHOD' ) ) { + define( 'FS_METHOD', 'direct' ); + } + } + + public static function wpTearDownAfterClass() { + self::delete_user( self::$admin_id ); + } + + public function test_register_routes() { + $routes = rest_get_server()->get_routes(); + + $this->assertArrayHasKey( '/__experimental/block-directory/search', $routes ); + $this->assertArrayHasKey( '/__experimental/block-directory/install', $routes ); + $this->assertArrayHasKey( '/__experimental/block-directory/uninstall', $routes ); + } + + public function test_context_param() { + // Collection. + $request = new WP_REST_Request( 'OPTIONS', '/__experimental/block-directory/search' ); + $response = rest_get_server()->dispatch( $request ); + $data = $response->get_data(); + $this->assertEquals( 'view', $data['endpoints'][0]['args']['context']['default'] ); + $this->assertEquals( array( 'view' ), $data['endpoints'][0]['args']['context']['enum'] ); + } + + public function test_get_items() { + wp_set_current_user( self::$admin_id ); + + $request = new WP_REST_Request( 'GET', '/__experimental/block-directory/search' ); + $request->set_query_params( array( 'term' => 'foo' ) ); + + $result = rest_do_request( $request ); + $this->assertNotWPError( $result->as_error() ); + $this->assertEquals( 200, $result->status ); + } + + public function test_get_items_wdotorg_unavailable() { + wp_set_current_user( self::$admin_id ); + + $request = new WP_REST_Request( 'GET', '/__experimental/block-directory/search' ); + $request->set_query_params( array( 'term' => 'foo' ) ); + + $this->prevent_requests_to_host( 'api.wordpress.org' ); + + $this->expectException( 'PHPUnit_Framework_Error_Warning' ); + $response = rest_do_request( $request ); + $this->assertErrorResponse( 'plugins_api_failed', $response, 500 ); + } + + public function test_get_items_logged_out() { + $request = new WP_REST_Request( 'GET', '/__experimental/block-directory/search' ); + $request->set_query_params( array( 'term' => 'foo' ) ); + $response = rest_do_request( $request ); + $this->assertErrorResponse( 'rest_block_directory_cannot_view', $response ); + } + + public function test_get_items_no_results() { + wp_set_current_user( self::$admin_id ); + + $request = new WP_REST_Request( 'GET', '/__experimental/block-directory/search' ); + $request->set_query_params( array( 'term' => '0c4549ee68f24eaaed46a49dc983ecde' ) ); + $response = rest_do_request( $request ); + $data = $response->get_data(); + + // Should produce a 200 status with an empty array. + $this->assertEquals( 200, $response->status ); + $this->assertEquals( array(), $data ); + } + + public function test_get_item() { + $this->markTestSkipped( 'Controller does not have get_item route.' ); + } + + public function test_create_item() { + if ( isset( get_plugins()['hello-dolly/hello.php'] ) ) { + delete_plugins( array( 'hello-dolly/hello.php' ) ); + } + + wp_set_current_user( self::$admin_id ); + + $request = new WP_REST_Request( 'POST', '/__experimental/block-directory/install' ); + $request->set_body_params( array( 'slug' => 'hello-dolly' ) ); + + $response = rest_do_request( $request ); + $this->skip_on_filesystem_error( $response ); + $this->assertNotWPError( $response->as_error() ); + $this->assertEquals( 201, $response->get_status() ); + $this->assertEquals( 'Hello Dolly', $response->get_data()['name'] ); + } + + public function test_update_item() { + $this->markTestSkipped( 'Controller does not have update_item route.' ); + } + + public function test_delete_item() { + $this->markTestSkipped( 'Covered by Plugins controller tests.' ); + } + + public function test_prepare_item() { + wp_set_current_user( self::$admin_id ); + + // This will hit the live API. We're searching for `block` which should definitely return at least one result. + $request = new WP_REST_Request( 'GET', '/__experimental/block-directory/search' ); + $request->set_query_params( array( 'term' => 'block' ) ); + $response = rest_do_request( $request ); + $data = $response->get_data(); + + $this->assertEquals( 200, $response->status ); + // At least one result + $this->assertGreaterThanOrEqual( 1, count( $data ) ); + // Each result should be an object with important attributes set + foreach ( $data as $plugin ) { + $this->assertArrayHasKey( 'name', $plugin ); + $this->assertArrayHasKey( 'title', $plugin ); + $this->assertArrayHasKey( 'id', $plugin ); + $this->assertArrayHasKey( 'author_block_rating', $plugin ); + $this->assertArrayHasKey( 'assets', $plugin ); + $this->assertArrayHasKey( 'humanized_updated', $plugin ); + } + } + + public function test_get_item_schema() { + wp_set_current_user( self::$admin_id ); + + $request = new WP_REST_Request( 'OPTIONS', '/__experimental/block-directory/search' ); + $request->set_query_params( array( 'term' => 'foo' ) ); + $response = rest_do_request( $request ); + $data = $response->get_data(); + + // Check endpoints + $this->assertEquals( [ 'GET' ], $data['endpoints'][0]['methods'] ); + $this->assertTrue( $data['endpoints'][0]['args']['term'][ 'required'] ); + + $properties = $data['schema']['properties']; + + $this->assertCount( 13, $properties ); + $this->assertArrayHasKey( 'name', $properties ); + $this->assertArrayHasKey( 'title', $properties ); + $this->assertArrayHasKey( 'description', $properties ); + $this->assertArrayHasKey( 'id', $properties ); + $this->assertArrayHasKey( 'rating', $properties ); + $this->assertArrayHasKey( 'rating_count', $properties ); + $this->assertArrayHasKey( 'active_installs', $properties ); + $this->assertArrayHasKey( 'author_block_rating', $properties ); + $this->assertArrayHasKey( 'author_block_count', $properties ); + $this->assertArrayHasKey( 'author', $properties ); + $this->assertArrayHasKey( 'icon', $properties ); + $this->assertArrayHasKey( 'humanized_updated', $properties ); + $this->assertArrayHasKey( 'assets', $properties ); + } + + /** + * Skips the test if the response is an error due to the filesystem being unavailable. + * + * @since 5.5.0 + * + * @param WP_REST_Response $response The response object to inspect. + */ + protected function skip_on_filesystem_error( WP_REST_Response $response ) { + if ( ! $response->is_error() ) { + return; + } + + $code = $response->as_error()->get_error_code(); + + if ( 'fs_unavailable' === $code || false !== strpos( $code, 'mkdir_failed' ) ) { + $this->markTestSkipped( 'Filesystem is unavailable.' ); + } + } + + /** + * Simulate a network failure on outbound http requests to a given hostname. + * + * @param string $blocked_host The host to block connections to. + */ + private function prevent_requests_to_host( $blocked_host = 'api.wordpress.org' ) { + add_filter( + 'pre_http_request', + static function ( $return, $args, $url ) use ( $blocked_host ) { + if ( @parse_url( $url, PHP_URL_HOST ) === $blocked_host ) { + return new WP_Error( 'plugins_api_failed', "An expected error occurred connecting to $blocked_host because of a unit test", "cURL error 7: Failed to connect to $blocked_host port 80: Connection refused" ); + + } + + return $return; + }, + 10, + 3 + ); + } +} diff --git a/phpunit/class-wp-rest-plugins-controller-test.php b/phpunit/class-wp-rest-plugins-controller-test.php new file mode 100644 index 0000000000000..f0d3dbeb5064f --- /dev/null +++ b/phpunit/class-wp-rest-plugins-controller-test.php @@ -0,0 +1,1015 @@ +user->create( + array( + 'role' => 'subscriber', + ) + ); + self::$super_admin = $factory->user->create( + array( + 'role' => 'administrator', + ) + ); + self::$admin = $factory->user->create( + array( + 'role' => 'administrator', + ) + ); + + if ( is_multisite() ) { + grant_super_admin( self::$super_admin ); + } + + if ( ! defined( 'FS_METHOD' ) ) { + define( 'FS_METHOD', 'direct' ); + } + } + + /** + * Clean up test fixtures. + * + * @since 5.5.0 + */ + public static function wpTearDownAfterClass() { + self::delete_user( self::$subscriber_id ); + self::delete_user( self::$super_admin ); + } + + public function tearDown() { + parent::tearDown(); + + if ( file_exists( WP_PLUGIN_DIR . '/test-plugin/test-plugin.php' ) ) { + $this->rmdir( WP_PLUGIN_DIR . '/test-plugin' ); + } + } + + public function test_register_routes() { + $routes = rest_get_server()->get_routes(); + $this->assertArrayHasKey( self::BASE, $routes ); + $this->assertArrayHasKey( self::BASE . '/(?P[^.\/]+(?:\/[^.\/]+)?)', $routes ); + } + + public function test_context_param() { + // Collection. + $request = new WP_REST_Request( 'OPTIONS', self::BASE ); + $response = rest_get_server()->dispatch( $request ); + $data = $response->get_data(); + $this->assertEquals( 'view', $data['endpoints'][0]['args']['context']['default'] ); + $this->assertEquals( array( 'view', 'embed', 'edit' ), $data['endpoints'][0]['args']['context']['enum'] ); + // Single. + $request = new WP_REST_Request( 'OPTIONS', self::BASE . '/' . self::PLUGIN ); + $response = rest_get_server()->dispatch( $request ); + $data = $response->get_data(); + $this->assertEquals( 'view', $data['endpoints'][0]['args']['context']['default'] ); + $this->assertEquals( array( 'view', 'embed', 'edit' ), $data['endpoints'][0]['args']['context']['enum'] ); + } + + public function test_get_items() { + $this->create_test_plugin(); + wp_set_current_user( self::$super_admin ); + + $response = rest_do_request( self::BASE ); + $this->assertEquals( 200, $response->get_status() ); + + $items = wp_list_filter( $response->get_data(), array( 'plugin' => self::PLUGIN_FILE ) ); + + $this->assertCount( 1, $items ); + $this->check_get_plugin_data( array_shift( $items ) ); + } + + public function test_get_items_search() { + $this->create_test_plugin(); + wp_set_current_user( self::$super_admin ); + + $request = new WP_REST_Request( 'GET', self::BASE ); + $request->set_query_params( array( 'search' => 'testeroni' ) ); + $response = rest_do_request( $request ); + $this->assertCount( 0, $response->get_data() ); + + $request = new WP_REST_Request( 'GET', self::BASE ); + $request->set_query_params( array( 'search' => 'Cool' ) ); + $response = rest_do_request( $request ); + $this->assertCount( 1, wp_list_filter( $response->get_data(), array( 'plugin' => self::PLUGIN_FILE ) ) ); + } + + public function test_get_items_status() { + $this->create_test_plugin(); + wp_set_current_user( self::$super_admin ); + + $request = new WP_REST_Request( 'GET', self::BASE ); + $request->set_query_params( array( 'status' => 'inactive' ) ); + $response = rest_do_request( $request ); + $this->assertCount( 1, wp_list_filter( $response->get_data(), array( 'plugin' => self::PLUGIN_FILE ) ) ); + + $request = new WP_REST_Request( 'GET', self::BASE ); + $request->set_query_params( array( 'status' => 'active' ) ); + $response = rest_do_request( $request ); + $this->assertCount( 0, wp_list_filter( $response->get_data(), array( 'plugin' => self::PLUGIN_FILE ) ) ); + } + + public function test_get_items_status_multiple() { + $this->create_test_plugin(); + wp_set_current_user( self::$super_admin ); + + $request = new WP_REST_Request( 'GET', self::BASE ); + $request->set_query_params( array( 'status' => array( 'inactive', 'active' ) ) ); + $response = rest_do_request( $request ); + + $this->assertGreaterThan( 1, count( wp_list_filter( $response->get_data(), array( 'plugin' => self::PLUGIN_FILE ), 'NOT' ) ) ); + $this->assertCount( 1, wp_list_filter( $response->get_data(), array( 'plugin' => self::PLUGIN_FILE ) ) ); + } + + /** + * @group ms-required + */ + public function test_get_items_status_network_active() { + $this->create_test_plugin(); + wp_set_current_user( self::$super_admin ); + + $request = new WP_REST_Request( 'GET', self::BASE ); + $request->set_query_params( array( 'status' => 'network-active' ) ); + $response = rest_do_request( $request ); + $this->assertCount( 0, wp_list_filter( $response->get_data(), array( 'plugin' => self::PLUGIN_FILE ) ) ); + + activate_plugin( self::PLUGIN_FILE, '', true ); + $request = new WP_REST_Request( 'GET', self::BASE ); + $request->set_query_params( array( 'status' => 'network-active' ) ); + $response = rest_do_request( $request ); + $this->assertCount( 1, wp_list_filter( $response->get_data(), array( 'plugin' => self::PLUGIN_FILE ) ) ); + } + + public function test_get_items_logged_out() { + $response = rest_do_request( self::BASE ); + $this->assertEquals( 401, $response->get_status() ); + } + + public function test_get_items_insufficient_permissions() { + wp_set_current_user( self::$subscriber_id ); + $response = rest_do_request( self::BASE ); + $this->assertequals( 403, $response->get_status() ); + } + + /** + * @group ms-required + */ + public function test_cannot_get_items_if_plugins_menu_not_available() { + $this->create_test_plugin(); + wp_set_current_user( self::$admin ); + + $request = new WP_REST_Request( 'GET', self::BASE ); + $response = rest_do_request( $request ); + + $this->assertErrorResponse( 'rest_cannot_view_plugins', $response->as_error(), 403 ); + } + + /** + * @group ms-required + */ + public function test_get_items_if_plugins_menu_available() { + $this->create_test_plugin(); + $this->enable_plugins_menu_item(); + wp_set_current_user( self::$admin ); + + $response = rest_do_request( self::BASE ); + $this->assertEquals( 200, $response->get_status() ); + } + + /** + * @group ms-required + */ + public function test_get_items_excludes_network_only_plugin_if_not_active() { + $this->create_test_plugin( true ); + $this->enable_plugins_menu_item(); + wp_set_current_user( self::$admin ); + + $response = rest_do_request( self::BASE ); + $this->assertEquals( 200, $response->get_status() ); + + $items = wp_list_filter( $response->get_data(), array( 'plugin' => self::PLUGIN_FILE ) ); + $this->assertCount( 0, $items ); + } + + /** + * @group ms-excluded + */ + public function test_get_items_does_not_exclude_network_only_plugin_if_not_active_on_single_site() { + $this->create_test_plugin( true ); + wp_set_current_user( self::$admin ); + + $response = rest_do_request( self::BASE ); + $this->assertEquals( 200, $response->get_status() ); + + $items = wp_list_filter( $response->get_data(), array( 'plugin' => self::PLUGIN_FILE ) ); + $this->assertCount( 1, $items ); + $this->check_get_plugin_data( array_shift( $items ), true ); + } + + /** + * @group ms-required + */ + public function test_get_items_does_not_exclude_network_only_plugin_if_not_active_but_has_network_caps() { + $this->create_test_plugin( true ); + $this->enable_plugins_menu_item(); + wp_set_current_user( self::$super_admin ); + + $response = rest_do_request( self::BASE ); + $this->assertEquals( 200, $response->get_status() ); + + $items = wp_list_filter( $response->get_data(), array( 'plugin' => self::PLUGIN_FILE ) ); + $this->assertCount( 1, $items ); + $this->check_get_plugin_data( array_shift( $items ), true ); + } + + public function test_get_item() { + $this->create_test_plugin(); + wp_set_current_user( self::$super_admin ); + + $response = rest_do_request( self::BASE . '/' . self::PLUGIN ); + $this->assertEquals( 200, $response->get_status() ); + $this->check_get_plugin_data( $response->get_data() ); + } + + public function test_get_item_logged_out() { + $response = rest_do_request( self::BASE . '/' . self::PLUGIN ); + $this->assertEquals( 401, $response->get_status() ); + } + + public function test_get_item_insufficient_permissions() { + wp_set_current_user( self::$subscriber_id ); + $response = rest_do_request( self::BASE . '/' . self::PLUGIN ); + $this->assertEquals( 403, $response->get_status() ); + } + + /** + * @group ms-required + */ + public function test_cannot_get_item_if_plugins_menu_not_available() { + $this->create_test_plugin(); + wp_set_current_user( self::$admin ); + + $request = new WP_REST_Request( 'GET', self::BASE . '/' . self::PLUGIN ); + $response = rest_do_request( $request ); + + $this->assertErrorResponse( 'rest_cannot_view_plugin', $response->as_error(), 403 ); + } + + /** + * @group ms-required + */ + public function test_get_item_if_plugins_menu_available() { + $this->create_test_plugin(); + $this->enable_plugins_menu_item(); + wp_set_current_user( self::$admin ); + + $response = rest_do_request( self::BASE . '/' . self::PLUGIN ); + $this->assertEquals( 200, $response->get_status() ); + } + + public function test_get_item_invalid_plugin() { + wp_set_current_user( self::$super_admin ); + $response = rest_do_request( self::BASE . '/' . self::PLUGIN ); + $this->assertEquals( 404, $response->get_status() ); + } + + public function test_create_item() { + if ( isset( get_plugins()['hello-dolly/hello.php'] ) ) { + delete_plugins( array( 'hello-dolly/hello.php' ) ); + } + + wp_set_current_user( self::$super_admin ); + + $request = new WP_REST_Request( 'POST', self::BASE ); + $request->set_body_params( array( 'slug' => 'hello-dolly' ) ); + + $response = rest_do_request( $request ); + $this->skip_on_filesystem_error( $response ); + $this->assertNotWPError( $response->as_error() ); + $this->assertEquals( 201, $response->get_status() ); + $this->assertEquals( 'Hello Dolly', $response->get_data()['name'] ); + } + + public function test_create_item_and_activate() { + if ( isset( get_plugins()['hello-dolly/hello.php'] ) ) { + delete_plugins( array( 'hello-dolly/hello.php' ) ); + } + + wp_set_current_user( self::$super_admin ); + + $request = new WP_REST_Request( 'POST', self::BASE ); + $request->set_body_params( + array( + 'slug' => 'hello-dolly', + 'status' => 'active', + ) + ); + + $response = rest_do_request( $request ); + $this->skip_on_filesystem_error( $response ); + $this->assertNotWPError( $response->as_error() ); + $this->assertEquals( 201, $response->get_status() ); + $this->assertEquals( 'Hello Dolly', $response->get_data()['name'] ); + $this->assertTrue( is_plugin_active( 'hello-dolly/hello.php' ) ); + } + + public function test_create_item_and_activate_errors_if_no_permission_to_activate_plugin() { + if ( isset( get_plugins()['hello-dolly/hello.php'] ) ) { + delete_plugins( array( 'hello-dolly/hello.php' ) ); + } + + wp_set_current_user( self::$super_admin ); + $this->disable_activate_permission( 'hello-dolly/hello.php' ); + + $request = new WP_REST_Request( 'POST', self::BASE ); + $request->set_body_params( + array( + 'slug' => 'hello-dolly', + 'status' => 'active', + ) + ); + + $response = rest_do_request( $request ); + $this->skip_on_filesystem_error( $response ); + $this->assertErrorResponse( 'rest_cannot_activate_plugin', $response ); + $this->assertFalse( is_plugin_active( 'hello-dolly/hello.php' ) ); + } + + /** + * @group ms-excluded + */ + public function test_create_item_and_network_activate_rejected_if_not_multisite() { + if ( isset( get_plugins()['hello-dolly/hello.php'] ) ) { + delete_plugins( array( 'hello-dolly/hello.php' ) ); + } + + wp_set_current_user( self::$super_admin ); + + $request = new WP_REST_Request( 'POST', self::BASE ); + $request->set_body_params( + array( + 'slug' => 'hello-dolly', + 'status' => 'network-active', + ) + ); + + $response = rest_do_request( $request ); + $this->skip_on_filesystem_error( $response ); + $this->assertErrorResponse( 'rest_invalid_param', $response ); + } + + /** + * @group ms-required + */ + public function test_create_item_and_network_activate() { + if ( isset( get_plugins()['hello-dolly/hello.php'] ) ) { + delete_plugins( array( 'hello-dolly/hello.php' ) ); + } + + wp_set_current_user( self::$super_admin ); + + $request = new WP_REST_Request( 'POST', self::BASE ); + $request->set_body_params( + array( + 'slug' => 'hello-dolly', + 'status' => 'network-active', + ) + ); + + $response = rest_do_request( $request ); + $this->skip_on_filesystem_error( $response ); + $this->assertNotWPError( $response->as_error() ); + $this->assertEquals( 201, $response->get_status() ); + $this->assertEquals( 'Hello Dolly', $response->get_data()['name'] ); + $this->assertTrue( is_plugin_active_for_network( 'hello-dolly/hello.php' ) ); + } + + public function test_create_item_logged_out() { + $request = new WP_REST_Request( 'POST', self::BASE ); + $request->set_body_params( array( 'slug' => 'hello-dolly' ) ); + + $response = rest_do_request( $request ); + $this->assertEquals( 401, $response->get_status() ); + } + + public function test_create_item_insufficient_permissions() { + wp_set_current_user( self::$subscriber_id ); + $request = new WP_REST_Request( 'POST', self::BASE ); + $request->set_body_params( array( 'slug' => 'hello-dolly' ) ); + + $response = rest_do_request( $request ); + $this->assertEquals( 403, $response->get_status() ); + } + + /** + * @group ms-required + */ + public function test_cannot_create_item_if_not_super_admin() { + $this->create_test_plugin(); + wp_set_current_user( self::$admin ); + + $request = new WP_REST_Request( 'POST', self::BASE ); + $request->set_body_params( array( 'slug' => 'hello-dolly' ) ); + $response = rest_do_request( $request ); + + $this->assertErrorResponse( 'rest_cannot_install_plugin', $response->as_error(), 403 ); + } + + public function test_create_item_wdotorg_unreachable() { + wp_set_current_user( self::$super_admin ); + + $request = new WP_REST_Request( 'POST', self::BASE ); + $request->set_body_params( array( 'slug' => 'foo' ) ); + + $this->prevent_requests_to_host( 'api.wordpress.org' ); + + $this->expectException( 'PHPUnit_Framework_Error_Warning' ); + $response = rest_do_request( $request ); + $this->skip_on_filesystem_error( $response ); + $this->assertErrorResponse( 'plugins_api_failed', $response, 500 ); + } + + public function test_create_item_unknown_plugin() { + wp_set_current_user( self::$super_admin ); + + // This will hit the live API. + $request = new WP_REST_Request( 'POST', self::BASE ); + $request->set_body_params( array( 'slug' => 'alex-says-this-block-definitely-doesnt-exist' ) ); + $response = rest_do_request( $request ); + + $this->skip_on_filesystem_error( $response ); + // Is this an appropriate status? + $this->assertErrorResponse( 'plugins_api_failed', $response, 404 ); + } + + public function test_update_item() { + $this->create_test_plugin(); + wp_set_current_user( self::$super_admin ); + + $request = new WP_REST_Request( 'PUT', self::BASE . '/' . self::PLUGIN ); + $response = rest_do_request( $request ); + + $this->assertEquals( 200, $response->get_status() ); + } + + public function test_update_item_logged_out() { + $request = new WP_REST_Request( 'PUT', self::BASE . '/' . self::PLUGIN ); + $response = rest_do_request( $request ); + + $this->assertEquals( 401, $response->get_status() ); + } + + public function test_update_item_insufficient_permissions() { + wp_set_current_user( self::$subscriber_id ); + + $request = new WP_REST_Request( 'PUT', self::BASE . '/' . self::PLUGIN ); + $response = rest_do_request( $request ); + + $this->assertEquals( 403, $response->get_status() ); + } + + /** + * @group ms-required + */ + public function test_cannot_update_item_if_plugins_menu_not_available() { + $this->create_test_plugin(); + wp_set_current_user( self::$admin ); + + $request = new WP_REST_Request( 'PUT', self::BASE . '/' . self::PLUGIN ); + $response = rest_do_request( $request ); + + $this->assertErrorResponse( 'rest_cannot_manage_plugins', $response->as_error(), 403 ); + } + + public function test_update_item_activate_plugin() { + $this->create_test_plugin(); + wp_set_current_user( self::$super_admin ); + + $request = new WP_REST_Request( 'PUT', self::BASE . '/' . self::PLUGIN ); + $request->set_body_params( array( 'status' => 'active' ) ); + $response = rest_do_request( $request ); + + $this->assertEquals( 200, $response->get_status() ); + $this->assertTrue( is_plugin_active( self::PLUGIN_FILE ) ); + } + + public function test_update_item_activate_plugin_fails_if_no_activate_cap() { + $this->create_test_plugin(); + wp_set_current_user( self::$super_admin ); + $this->disable_activate_permission( self::PLUGIN_FILE ); + + $request = new WP_REST_Request( 'PUT', self::BASE . '/' . self::PLUGIN ); + $request->set_body_params( array( 'status' => 'active' ) ); + $response = rest_do_request( $request ); + + $this->assertErrorResponse( 'rest_cannot_activate_plugin', $response, 403 ); + } + + /** + * @group ms-excluded + */ + public function test_update_item_network_activate_plugin_rejected_if_not_multisite() { + $this->create_test_plugin(); + wp_set_current_user( self::$super_admin ); + + $request = new WP_REST_Request( 'PUT', self::BASE . '/' . self::PLUGIN ); + $request->set_body_params( array( 'status' => 'network-active' ) ); + $response = rest_do_request( $request ); + + $this->assertErrorResponse( 'rest_invalid_param', $response ); + } + + /** + * @group ms-required + */ + public function test_update_item_network_activate_plugin() { + $this->create_test_plugin(); + wp_set_current_user( self::$super_admin ); + + $request = new WP_REST_Request( 'PUT', self::BASE . '/' . self::PLUGIN ); + $request->set_body_params( array( 'status' => 'network-active' ) ); + $response = rest_do_request( $request ); + + $this->assertEquals( 200, $response->get_status() ); + $this->assertTrue( is_plugin_active_for_network( self::PLUGIN_FILE ) ); + } + + /** + * @group ms-required + */ + public function test_update_item_network_activate_plugin_that_was_active_on_single_site() { + $this->create_test_plugin(); + activate_plugin( self::PLUGIN_FILE ); + wp_set_current_user( self::$super_admin ); + + $request = new WP_REST_Request( 'PUT', self::BASE . '/' . self::PLUGIN ); + $request->set_body_params( array( 'status' => 'network-active' ) ); + $response = rest_do_request( $request ); + + $this->assertEquals( 200, $response->get_status() ); + $this->assertTrue( is_plugin_active_for_network( self::PLUGIN_FILE ) ); + } + + /** + * @group ms-required + */ + public function test_update_item_activate_network_only_plugin() { + $this->create_test_plugin( true ); + wp_set_current_user( self::$super_admin ); + + $request = new WP_REST_Request( 'PUT', self::BASE . '/' . self::PLUGIN ); + $request->set_body_params( array( 'status' => 'active' ) ); + $response = rest_do_request( $request ); + + $this->assertErrorResponse( 'rest_network_only_plugin', $response, 400 ); + } + + /** + * @group ms-required + */ + public function test_update_item_network_activate_network_only_plugin() { + $this->create_test_plugin( true ); + wp_set_current_user( self::$super_admin ); + + $request = new WP_REST_Request( 'PUT', self::BASE . '/' . self::PLUGIN ); + $request->set_body_params( array( 'status' => 'network-active' ) ); + $response = rest_do_request( $request ); + + $this->assertEquals( 200, $response->get_status() ); + $this->assertTrue( is_plugin_active_for_network( self::PLUGIN_FILE ) ); + } + + /** + * @group ms-excluded + */ + public function test_update_item_activate_network_only_plugin_on_non_multisite() { + $this->create_test_plugin( true ); + wp_set_current_user( self::$super_admin ); + + $request = new WP_REST_Request( 'PUT', self::BASE . '/' . self::PLUGIN ); + $request->set_body_params( array( 'status' => 'active' ) ); + $response = rest_do_request( $request ); + + $this->assertEquals( 200, $response->get_status() ); + $this->assertTrue( is_plugin_active( self::PLUGIN_FILE ) ); + } + + /** + * @group ms-required + */ + public function test_update_item_activate_plugin_for_site_if_menu_item_available() { + $this->create_test_plugin(); + $this->enable_plugins_menu_item(); + wp_set_current_user( self::$admin ); + + $request = new WP_REST_Request( 'PUT', self::BASE . '/' . self::PLUGIN ); + $request->set_body_params( array( 'status' => 'active' ) ); + $response = rest_do_request( $request ); + + $this->assertNotWPError( $response->as_error() ); + $this->assertEquals( 200, $response->get_status() ); + $this->assertTrue( is_plugin_active( self::PLUGIN_FILE ) ); + } + + /** + * @group ms-required + */ + public function test_update_item_network_activate_plugin_for_site_if_menu_item_available() { + $this->create_test_plugin(); + $this->enable_plugins_menu_item(); + wp_set_current_user( self::$admin ); + + $request = new WP_REST_Request( 'PUT', self::BASE . '/' . self::PLUGIN ); + $request->set_body_params( array( 'status' => 'network-active' ) ); + $response = rest_do_request( $request ); + + $this->assertErrorResponse( 'rest_cannot_manage_network_plugins', $response, 403 ); + } + + public function test_update_item_deactivate_plugin() { + $this->create_test_plugin(); + activate_plugin( self::PLUGIN_FILE ); + wp_set_current_user( self::$super_admin ); + + $request = new WP_REST_Request( 'PUT', self::BASE . '/' . self::PLUGIN ); + $request->set_body_params( array( 'status' => 'inactive' ) ); + $response = rest_do_request( $request ); + + $this->assertEquals( 200, $response->get_status() ); + $this->assertTrue( is_plugin_inactive( self::PLUGIN_FILE ) ); + } + + public function test_update_item_deactivate_plugin_fails_if_no_deactivate_cap() { + $this->create_test_plugin(); + activate_plugin( self::PLUGIN_FILE ); + wp_set_current_user( self::$super_admin ); + $this->disable_deactivate_permission( self::PLUGIN_FILE ); + + $request = new WP_REST_Request( 'PUT', self::BASE . '/' . self::PLUGIN ); + $request->set_body_params( array( 'status' => 'inactive' ) ); + $response = rest_do_request( $request ); + + $this->assertErrorResponse( 'rest_cannot_deactivate_plugin', $response, 403 ); + } + + /** + * @group ms-required + */ + public function test_update_item_deactivate_network_active_plugin() { + $this->create_test_plugin(); + activate_plugin( self::PLUGIN_FILE, '', true ); + wp_set_current_user( self::$super_admin ); + + $request = new WP_REST_Request( 'PUT', self::BASE . '/' . self::PLUGIN ); + $request->set_body_params( array( 'status' => 'inactive' ) ); + $response = rest_do_request( $request ); + + $this->assertEquals( 200, $response->get_status() ); + $this->assertTrue( is_plugin_inactive( self::PLUGIN_FILE ) ); + } + + /** + * @group ms-required + */ + public function test_update_item_deactivate_network_active_plugin_if_not_super_admin() { + $this->enable_plugins_menu_item(); + $this->create_test_plugin(); + activate_plugin( self::PLUGIN_FILE, '', true ); + wp_set_current_user( self::$admin ); + + $request = new WP_REST_Request( 'PUT', self::BASE . '/' . self::PLUGIN ); + $request->set_body_params( array( 'status' => 'inactive' ) ); + $response = rest_do_request( $request ); + + $this->assertErrorResponse( 'rest_cannot_manage_network_plugins', $response, 403 ); + } + + public function test_delete_item() { + $this->create_test_plugin(); + wp_set_current_user( self::$super_admin ); + + $request = new WP_REST_Request( 'DELETE', self::BASE . '/' . self::PLUGIN ); + $response = rest_do_request( $request ); + + $this->skip_on_filesystem_error( $response ); + $this->assertNotWPError( $response->as_error() ); + $this->assertEquals( 200, $response->get_status() ); + $this->assertTrue( $response->get_data()['deleted'] ); + $this->assertEquals( 'test-plugin/test-plugin.php', $response->get_data()['previous']['plugin'] ); + $this->assertFileNotExists( WP_PLUGIN_DIR . '/' . self::PLUGIN_FILE ); + } + + public function test_delete_item_logged_out() { + $request = new WP_REST_Request( 'DELETE', self::BASE . '/' . self::PLUGIN ); + $response = rest_do_request( $request ); + + $this->assertEquals( 401, $response->get_status() ); + } + + public function test_delete_item_insufficient_permissions() { + wp_set_current_user( self::$subscriber_id ); + + $request = new WP_REST_Request( 'DELETE', self::BASE . '/' . self::PLUGIN ); + $response = rest_do_request( $request ); + + $this->assertEquals( 403, $response->get_status() ); + } + + /** + * @group ms-required + */ + public function test_cannot_delete_item_if_plugins_menu_not_available() { + wp_set_current_user( self::$admin ); + + $request = new WP_REST_Request( 'DELETE', self::BASE . '/' . self::PLUGIN ); + $response = rest_do_request( $request ); + + $this->assertErrorResponse( 'rest_cannot_manage_plugins', $response->as_error(), 403 ); + } + + /** + * @group ms-required + */ + public function test_cannot_delete_item_if_plugins_menu_is_available() { + wp_set_current_user( self::$admin ); + $this->enable_plugins_menu_item(); + + $request = new WP_REST_Request( 'DELETE', self::BASE . '/' . self::PLUGIN ); + $response = rest_do_request( $request ); + + $this->assertErrorResponse( 'rest_cannot_manage_plugins', $response->as_error(), 403 ); + } + + public function test_delete_item_active_plugin() { + $this->create_test_plugin(); + activate_plugin( self::PLUGIN_FILE ); + wp_set_current_user( self::$super_admin ); + + $request = new WP_REST_Request( 'DELETE', self::BASE . '/' . self::PLUGIN ); + $response = rest_do_request( $request ); + + $this->skip_on_filesystem_error( $response ); + $this->assertErrorResponse( 'rest_cannot_delete_active_plugin', $response ); + } + + public function test_prepare_item() { + $this->create_test_plugin(); + + $item = get_plugins()[ self::PLUGIN_FILE ]; + $item['_file'] = self::PLUGIN_FILE; + + $endpoint = new WP_REST_Plugins_Controller(); + $response = $endpoint->prepare_item_for_response( $item, new WP_REST_Request( 'GET', self::BASE . '/' . self::PLUGIN ) ); + + $this->check_get_plugin_data( $response->get_data() ); + $links = $response->get_links(); + $this->assertArrayHasKey( 'self', $links ); + $this->assertEquals( rest_url( self::BASE . '/' . self::PLUGIN ), $links['self'][0]['href'] ); + } + + /** + * @group ms-required + */ + public function test_prepare_item_network_active() { + $this->create_test_plugin(); + activate_plugin( self::PLUGIN_FILE, '', true ); + + $item = get_plugins()[ self::PLUGIN_FILE ]; + $item['_file'] = self::PLUGIN_FILE; + + $endpoint = new WP_REST_Plugins_Controller(); + $response = $endpoint->prepare_item_for_response( $item, new WP_REST_Request( 'GET', self::BASE . '/' . self::PLUGIN ) ); + + $this->assertEquals( 'network-active', $response->get_data()['status'] ); + } + + /** + * @group ms-required + */ + public function test_prepare_item_network_only() { + $this->create_test_plugin( true ); + + $item = get_plugins()[ self::PLUGIN_FILE ]; + $item['_file'] = self::PLUGIN_FILE; + + $endpoint = new WP_REST_Plugins_Controller(); + $response = $endpoint->prepare_item_for_response( $item, new WP_REST_Request( 'GET', self::BASE . '/' . self::PLUGIN ) ); + + $this->check_get_plugin_data( $response->get_data(), true ); + } + + public function test_get_item_schema() { + $request = new WP_REST_Request( 'OPTIONS', self::BASE ); + $response = rest_get_server()->dispatch( $request ); + $data = $response->get_data(); + $properties = $data['schema']['properties']; + + $this->assertCount( 12, $properties ); + $this->assertArrayHasKey( 'plugin', $properties ); + $this->assertArrayHasKey( 'status', $properties ); + $this->assertArrayHasKey( 'name', $properties ); + $this->assertArrayHasKey( 'plugin_uri', $properties ); + $this->assertArrayHasKey( 'description', $properties ); + $this->assertArrayHasKey( 'author', $properties ); + $this->assertArrayHasKey( 'author_uri', $properties ); + $this->assertArrayHasKey( 'version', $properties ); + $this->assertArrayHasKey( 'network_only', $properties ); + $this->assertArrayHasKey( 'requires_wp', $properties ); + $this->assertArrayHasKey( 'requires_php', $properties ); + $this->assertArrayHasKey( 'text_domain', $properties ); + } + + /** + * Checks the response data. + * + * @since 5.5.0 + * + * @param array $data Prepared plugin data. + * @param bool $network_only Whether the plugin is network only. + */ + protected function check_get_plugin_data( $data, $network_only = false ) { + $this->assertEquals( 'test-plugin/test-plugin.php', $data['plugin'] ); + $this->assertEquals( '1.5.4', $data['version'] ); + $this->assertEquals( 'inactive', $data['status'] ); + $this->assertEquals( 'Test Plugin', $data['name'] ); + $this->assertEquals( 'https://wordpress.org/plugins/test-plugin/', $data['plugin_uri'] ); + $this->assertEquals( 'WordPress.org', $data['author'] ); + $this->assertEquals( 'https://wordpress.org/', $data['author_uri'] ); + $this->assertEquals( "My 'Cool' Plugin", $data['description']['raw'] ); + $this->assertEquals( 'My ‘Cool’ Plugin By WordPress.org.', $data['description']['rendered'] ); + $this->assertEquals( $network_only, $data['network_only'] ); + $this->assertEquals( '5.6.0', $data['requires_php'] ); + $this->assertEquals( '5.4.0', $data['requires_wp'] ); + $this->assertEquals( 'test-plugin', $data['text_domain'] ); + } + + /** + * Skips the test if the response is an error due to the filesystem being unavailable. + * + * @since 5.5.0 + * + * @param WP_REST_Response $response The response object to inspect. + */ + protected function skip_on_filesystem_error( WP_REST_Response $response ) { + if ( ! $response->is_error() ) { + return; + } + + $code = $response->as_error()->get_error_code(); + + if ( 'fs_unavailable' === $code || false !== strpos( $code, 'mkdir_failed' ) ) { + $this->markTestSkipped( 'Filesystem is unavailable.' ); + } + } + + /** + * Disables permission for activating a specific plugin. + * + * @param string $plugin The plugin file to disable. + */ + protected function disable_activate_permission( $plugin ) { + add_filter( + 'map_meta_cap', + static function ( $caps, $cap, $user, $args ) use ( $plugin ) { + if ( 'activate_plugin' === $cap && $plugin === $args[0] ) { + $caps = array( 'do_not_allow' ); + } + + return $caps; + }, + 10, + 4 + ); + } + + /** + * Disables permission for deactivating a specific plugin. + * + * @param string $plugin The plugin file to disable. + */ + protected function disable_deactivate_permission( $plugin ) { + add_filter( + 'map_meta_cap', + static function ( $caps, $cap, $user, $args ) use ( $plugin ) { + if ( 'deactivate_plugin' === $cap && $plugin === $args[0] ) { + $caps = array( 'do_not_allow' ); + } + + return $caps; + }, + 10, + 4 + ); + } + + /** + * Enables the "plugins" as an available menu item. + * + * @since 5.5.0 + */ + protected function enable_plugins_menu_item() { + $menu_perms = get_site_option( 'menu_items', array() ); + $menu_perms['plugins'] = true; + update_site_option( 'menu_items', $menu_perms ); + } + + /** + * Creates a test plugin. + * + * @since 5.5.0 + * + * @param bool $network_only Whether to make this a network only plugin. + */ + private function create_test_plugin( $network_only = false ) { + $network = $network_only ? PHP_EOL . ' * Network: true' . PHP_EOL : ''; + + $php = <<markTestSkipped( 'Filesystem is unavailable.' ); + } + + file_put_contents( WP_PLUGIN_DIR . '/test-plugin/test-plugin.php', $php ); + } + + /** + * Simulate a network failure on outbound http requests to a given hostname. + * + * @param string $blocked_host The host to block connections to. + */ + private function prevent_requests_to_host( $blocked_host = 'api.wordpress.org' ) { + add_filter( + 'pre_http_request', + static function ( $return, $args, $url ) use ( $blocked_host ) { + if ( @parse_url( $url, PHP_URL_HOST ) === $blocked_host ) { + return new WP_Error( 'plugins_api_failed', "An expected error occurred connecting to $blocked_host because of a unit test", "cURL error 7: Failed to connect to $blocked_host port 80: Connection refused" ); + + } + + return $return; + }, + 10, + 3 + ); + } +} diff --git a/phpunit/multisite.xml b/phpunit/multisite.xml new file mode 100644 index 0000000000000..168d4cb9e1136 --- /dev/null +++ b/phpunit/multisite.xml @@ -0,0 +1,19 @@ + + + + ./ + + + + + ms-excluded + + +