<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* REST API Onboarding Profile Controller

[2] Fix | Delete

*

[3] Fix | Delete

* Handles requests to /onboarding/profile

[4] Fix | Delete

*/

[5] Fix | Delete

[6] Fix | Delete

namespace Automattic\WooCommerce\Admin\API;

[7] Fix | Delete

[8] Fix | Delete

defined( 'ABSPATH' ) || exit;

[9] Fix | Delete

use Automattic\WooCommerce\Admin\PluginsHelper;

[10] Fix | Delete

use Automattic\WooCommerce\Internal\Jetpack\JetpackConnection;

[11] Fix | Delete

use WC_REST_Data_Controller;

[12] Fix | Delete

use WP_Error;

[13] Fix | Delete

use WP_REST_Request;

[14] Fix | Delete

use WP_REST_Response;

[15] Fix | Delete

[16] Fix | Delete

/**

[17] Fix | Delete

* Onboarding Plugins controller.

[18] Fix | Delete

*

[19] Fix | Delete

* @internal

[20] Fix | Delete

* @extends WC_REST_Data_Controller

[21] Fix | Delete

*/

[22] Fix | Delete

class OnboardingPlugins extends WC_REST_Data_Controller {

[23] Fix | Delete

/**

[24] Fix | Delete

* Endpoint namespace.

[25] Fix | Delete

*

[26] Fix | Delete

* @var string

[27] Fix | Delete

*/

[28] Fix | Delete

protected $namespace = 'wc-admin';

[29] Fix | Delete

[30] Fix | Delete

/**

[31] Fix | Delete

* Route base.

[32] Fix | Delete

*

[33] Fix | Delete

* @var string

[34] Fix | Delete

*/

[35] Fix | Delete

protected $rest_base = 'onboarding/plugins';

[36] Fix | Delete

[37] Fix | Delete

/**

[38] Fix | Delete

* Register routes.

[39] Fix | Delete

*/

[40] Fix | Delete

public function register_routes() {

[41] Fix | Delete

register_rest_route(

[42] Fix | Delete

$this->namespace,

[43] Fix | Delete

'/' . $this->rest_base . '/install-and-activate-async',

[44] Fix | Delete

array(

[45] Fix | Delete

array(

[46] Fix | Delete

'methods' => 'POST',

[47] Fix | Delete

'callback' => array( $this, 'install_and_activate_async' ),

[48] Fix | Delete

'permission_callback' => array( $this, 'can_install_and_activate_plugins' ),

[49] Fix | Delete

'args' => array(

[50] Fix | Delete

'plugins' => array(

[51] Fix | Delete

'description' => 'A list of plugins to install',

[52] Fix | Delete

'type' => 'array',

[53] Fix | Delete

'items' => 'string',

[54] Fix | Delete

'sanitize_callback' => function ( $value ) {

[55] Fix | Delete

return array_map(

[56] Fix | Delete

function ( $value ) {

[57] Fix | Delete

return sanitize_text_field( $value );

[58] Fix | Delete

},

[59] Fix | Delete

$value

[60] Fix | Delete

);

[61] Fix | Delete

},

[62] Fix | Delete

'required' => true,

[63] Fix | Delete

),

[64] Fix | Delete

'source' => array(

[65] Fix | Delete

'description' => 'The source of the request',

[66] Fix | Delete

'type' => 'string',

[67] Fix | Delete

'sanitize_callback' => 'sanitize_text_field',

[68] Fix | Delete

'required' => false,

[69] Fix | Delete

),

[70] Fix | Delete

),

[71] Fix | Delete

),

[72] Fix | Delete

'schema' => array( $this, 'get_install_async_schema' ),

[73] Fix | Delete

)

[74] Fix | Delete

);

[75] Fix | Delete

register_rest_route(

[76] Fix | Delete

$this->namespace,

[77] Fix | Delete

'/' . $this->rest_base . '/install-and-activate',

[78] Fix | Delete

array(

[79] Fix | Delete

array(

[80] Fix | Delete

'methods' => 'POST',

[81] Fix | Delete

'callback' => array( $this, 'install_and_activate' ),

[82] Fix | Delete

'permission_callback' => array( $this, 'can_install_and_activate_plugins' ),

[83] Fix | Delete

[84] Fix | Delete

),

[85] Fix | Delete

'schema' => array( $this, 'get_install_activate_schema' ),

[86] Fix | Delete

)

[87] Fix | Delete

);

[88] Fix | Delete

register_rest_route(

[89] Fix | Delete

$this->namespace,

[90] Fix | Delete

'/' . $this->rest_base . '/scheduled-installs/(?P<job_id>\w+)',

[91] Fix | Delete

array(

[92] Fix | Delete

array(

[93] Fix | Delete

'methods' => 'GET',

[94] Fix | Delete

'callback' => array( $this, 'get_scheduled_installs' ),

[95] Fix | Delete

'permission_callback' => array( $this, 'can_install_plugins' ),

[96] Fix | Delete

),

[97] Fix | Delete

'schema' => array( $this, 'get_install_async_schema' ),

[98] Fix | Delete

)

[99] Fix | Delete

);

[100] Fix | Delete

[101] Fix | Delete

// This is an experimental endpoint and is subject to change in the future.

[102] Fix | Delete

register_rest_route(

[103] Fix | Delete

$this->namespace,

[104] Fix | Delete

'/' . $this->rest_base . '/jetpack-authorization-url',

[105] Fix | Delete

array(

[106] Fix | Delete

array(

[107] Fix | Delete

'methods' => 'GET',

[108] Fix | Delete

'callback' => array( $this, 'get_jetpack_authorization_url' ),

[109] Fix | Delete

'permission_callback' => array( $this, 'can_install_plugins' ),

[110] Fix | Delete

'args' => array(

[111] Fix | Delete

'redirect_url' => array(

[112] Fix | Delete

'description' => 'The URL to redirect to after authorization',

[113] Fix | Delete

'type' => 'string',

[114] Fix | Delete

'sanitize_callback' => 'sanitize_text_field',

[115] Fix | Delete

'required' => true,

[116] Fix | Delete

),

[117] Fix | Delete

'from' => array(

[118] Fix | Delete

'description' => 'from value for the jetpack authorization page',

[119] Fix | Delete

'type' => 'string',

[120] Fix | Delete

'sanitize_callback' => 'sanitize_text_field',

[121] Fix | Delete

'required' => false,

[122] Fix | Delete

'default' => 'woocommerce-onboarding',

[123] Fix | Delete

),

[124] Fix | Delete

),

[125] Fix | Delete

),

[126] Fix | Delete

)

[127] Fix | Delete

);

[128] Fix | Delete

add_action( 'woocommerce_plugins_install_error', array( $this, 'log_plugins_install_error' ), 10, 4 );

[129] Fix | Delete

add_action( 'woocommerce_plugins_install_api_error', array( $this, 'log_plugins_install_api_error' ), 10, 2 );

[130] Fix | Delete

}

[131] Fix | Delete

[132] Fix | Delete

/**

[133] Fix | Delete

* Install and activate a plugin.

[134] Fix | Delete

*

[135] Fix | Delete

* @param WP_REST_Request $request WP Request object.

[136] Fix | Delete

*

[137] Fix | Delete

* @return WP_REST_Response

[138] Fix | Delete

*/

[139] Fix | Delete

public function install_and_activate( WP_REST_Request $request ) {

[140] Fix | Delete

$response = array();

[141] Fix | Delete

$response['install'] = PluginsHelper::install_plugins( $request->get_param( 'plugins' ) );

[142] Fix | Delete

$response['activate'] = PluginsHelper::activate_plugins( $response['install']['installed'] );

[143] Fix | Delete

[144] Fix | Delete

return new WP_REST_Response( $response );

[145] Fix | Delete

}

[146] Fix | Delete

[147] Fix | Delete

/**

[148] Fix | Delete

* Queue plugin install request.

[149] Fix | Delete

*

[150] Fix | Delete

* @param WP_REST_Request $request WP_REST_Request object.

[151] Fix | Delete

*

[152] Fix | Delete

* @return array

[153] Fix | Delete

*/

[154] Fix | Delete

public function install_and_activate_async( WP_REST_Request $request ) {

[155] Fix | Delete

$plugins = $request->get_param( 'plugins' );

[156] Fix | Delete

$source = $request->get_param( 'source' );

[157] Fix | Delete

$job_id = uniqid();

[158] Fix | Delete

[159] Fix | Delete

WC()->queue()->add( 'woocommerce_plugins_install_and_activate_async_callback', array( $plugins, $job_id, $source ) );

[160] Fix | Delete

[161] Fix | Delete

$plugin_status = array();

[162] Fix | Delete

foreach ( $plugins as $plugin ) {

[163] Fix | Delete

$plugin_status[ $plugin ] = array(

[164] Fix | Delete

'status' => 'pending',

[165] Fix | Delete

'errors' => array(),

[166] Fix | Delete

);

[167] Fix | Delete

}

[168] Fix | Delete

[169] Fix | Delete

return array(

[170] Fix | Delete

'job_id' => $job_id,

[171] Fix | Delete

'status' => 'pending',

[172] Fix | Delete

'plugins' => $plugin_status,

[173] Fix | Delete

);

[174] Fix | Delete

}

[175] Fix | Delete

[176] Fix | Delete

/**

[177] Fix | Delete

* Returns current status of given job.

[178] Fix | Delete

*

[179] Fix | Delete

* @param WP_REST_Request $request WP_REST_Request object.

[180] Fix | Delete

*

[181] Fix | Delete

* @return array|WP_REST_Response

[182] Fix | Delete

*/

[183] Fix | Delete

public function get_scheduled_installs( WP_REST_Request $request ) {

[184] Fix | Delete

$job_id = $request->get_param( 'job_id' );

[185] Fix | Delete

[186] Fix | Delete

$actions = WC()->queue()->search(

[187] Fix | Delete

array(

[188] Fix | Delete

'hook' => 'woocommerce_plugins_install_and_activate_async_callback',

[189] Fix | Delete

'search' => $job_id,

[190] Fix | Delete

'orderby' => 'date',

[191] Fix | Delete

'order' => 'DESC',

[192] Fix | Delete

)

[193] Fix | Delete

);

[194] Fix | Delete

[195] Fix | Delete

$actions = array_filter(

[196] Fix | Delete

PluginsHelper::get_action_data( $actions ),

[197] Fix | Delete

function ( $action ) use ( $job_id ) {

[198] Fix | Delete

return $action['job_id'] === $job_id;

[199] Fix | Delete

}

[200] Fix | Delete

);

[201] Fix | Delete

[202] Fix | Delete

if ( empty( $actions ) ) {

[203] Fix | Delete

return new WP_REST_Response( null, 404 );

[204] Fix | Delete

}

[205] Fix | Delete

[206] Fix | Delete

$response = array(

[207] Fix | Delete

'job_id' => $actions[0]['job_id'],

[208] Fix | Delete

'status' => $actions[0]['status'],

[209] Fix | Delete

);

[210] Fix | Delete

[211] Fix | Delete

$option = get_option( 'woocommerce_onboarding_plugins_install_and_activate_async_' . $job_id );

[212] Fix | Delete

if ( isset( $option['plugins'] ) ) {

[213] Fix | Delete

$response['plugins'] = $option['plugins'];

[214] Fix | Delete

}

[215] Fix | Delete

[216] Fix | Delete

return $response;

[217] Fix | Delete

}

[218] Fix | Delete

[219] Fix | Delete

/**

[220] Fix | Delete

* Return Jetpack authorization URL.

[221] Fix | Delete

*

[222] Fix | Delete

* @param WP_REST_Request $request WP_REST_Request object.

[223] Fix | Delete

*

[224] Fix | Delete

* @return array

[225] Fix | Delete

*/

[226] Fix | Delete

public function get_jetpack_authorization_url( WP_REST_Request $request ) {

[227] Fix | Delete

return JetpackConnection::get_authorization_url(

[228] Fix | Delete

$request->get_param( 'redirect_url' ),

[229] Fix | Delete

$request->get_param( 'from' )

[230] Fix | Delete

);

[231] Fix | Delete

}

[232] Fix | Delete

[233] Fix | Delete

/**

[234] Fix | Delete

* Check whether the current user has permission to install plugins

[235] Fix | Delete

*

[236] Fix | Delete

* @return WP_Error|boolean

[237] Fix | Delete

*/

[238] Fix | Delete

public function can_install_plugins() {

[239] Fix | Delete

if ( ! current_user_can( 'install_plugins' ) ) {

[240] Fix | Delete

return new WP_Error(

[241] Fix | Delete

'woocommerce_rest_cannot_update',

[242] Fix | Delete

__( 'Sorry, you cannot manage plugins.', 'woocommerce' ),

[243] Fix | Delete

array( 'status' => rest_authorization_required_code() )

[244] Fix | Delete

);

[245] Fix | Delete

}

[246] Fix | Delete

[247] Fix | Delete

return true;

[248] Fix | Delete

}

[249] Fix | Delete

[250] Fix | Delete

/**

[251] Fix | Delete

* Check whether the current user has permission to install and activate plugins

[252] Fix | Delete

*

[253] Fix | Delete

* @return WP_Error|boolean

[254] Fix | Delete

*/

[255] Fix | Delete

public function can_install_and_activate_plugins() {

[256] Fix | Delete

if ( ! current_user_can( 'install_plugins' ) || ! current_user_can( 'activate_plugins' ) ) {

[257] Fix | Delete

return new WP_Error(

[258] Fix | Delete

'woocommerce_rest_cannot_update',

[259] Fix | Delete

__( 'Sorry, you cannot manage plugins.', 'woocommerce' ),

[260] Fix | Delete

array( 'status' => rest_authorization_required_code() )

[261] Fix | Delete

);

[262] Fix | Delete

}

[263] Fix | Delete

[264] Fix | Delete

return true;

[265] Fix | Delete

}

[266] Fix | Delete

[267] Fix | Delete

/**

[268] Fix | Delete

* JSON Schema for both install-async and scheduled-installs endpoints.

[269] Fix | Delete

*

[270] Fix | Delete

* @return array

[271] Fix | Delete

*/

[272] Fix | Delete

public function get_install_async_schema() {

[273] Fix | Delete

return array(

[274] Fix | Delete

'$schema' => 'http://json-schema.org/draft-04/schema#',

[275] Fix | Delete

'title' => 'Install Async Schema',

[276] Fix | Delete

'type' => 'object',

[277] Fix | Delete

'properties' => array(

[278] Fix | Delete

'type' => 'object',

[279] Fix | Delete

'properties' => array(

[280] Fix | Delete

'job_id' => 'integer',

[281] Fix | Delete

'status' => array(

[282] Fix | Delete

'type' => 'string',

[283] Fix | Delete

'enum' => array( 'pending', 'complete', 'failed' ),

[284] Fix | Delete

),

[285] Fix | Delete

),

[286] Fix | Delete

),

[287] Fix | Delete

);

[288] Fix | Delete

}

[289] Fix | Delete

[290] Fix | Delete

/**

[291] Fix | Delete

* JSON Schema for install-and-activate endpoint.

[292] Fix | Delete

*

[293] Fix | Delete

* @return array

[294] Fix | Delete

*/

[295] Fix | Delete

public function get_install_activate_schema() {

[296] Fix | Delete

$error_schema = array(

[297] Fix | Delete

'type' => 'object',

[298] Fix | Delete

'patternProperties' => array(

[299] Fix | Delete

'^.*$' => array(

[300] Fix | Delete

'type' => 'string',

[301] Fix | Delete

),

[302] Fix | Delete

),

[303] Fix | Delete

'items' => array(

[304] Fix | Delete

'type' => 'string',

[305] Fix | Delete

),

[306] Fix | Delete

);

[307] Fix | Delete

[308] Fix | Delete

$install_schema = array(

[309] Fix | Delete

'type' => 'object',

[310] Fix | Delete

'properties' => array(

[311] Fix | Delete

'installed' => array(

[312] Fix | Delete

'type' => 'array',

[313] Fix | Delete

'items' => array(

[314] Fix | Delete

'type' => 'string',

[315] Fix | Delete

),

[316] Fix | Delete

),

[317] Fix | Delete

'results' => array(

[318] Fix | Delete

'type' => 'array',

[319] Fix | Delete

'items' => array(

[320] Fix | Delete

'type' => 'string',

[321] Fix | Delete

),

[322] Fix | Delete

),

[323] Fix | Delete

'errors' => array(

[324] Fix | Delete

'type' => 'object',

[325] Fix | Delete

'properties' => array(

[326] Fix | Delete

'errors' => $error_schema,

[327] Fix | Delete

'error_data' => $error_schema,

[328] Fix | Delete

),

[329] Fix | Delete

),

[330] Fix | Delete

),

[331] Fix | Delete

);

[332] Fix | Delete

[333] Fix | Delete

$activate_schema = array(

[334] Fix | Delete

'type' => 'object',

[335] Fix | Delete

'properties' => array(

[336] Fix | Delete

'activated' => array(

[337] Fix | Delete

'type' => 'array',

[338] Fix | Delete

'items' => array(

[339] Fix | Delete

'type' => 'string',

[340] Fix | Delete

),

[341] Fix | Delete

),

[342] Fix | Delete

'active' => array(

[343] Fix | Delete

'type' => 'array',

[344] Fix | Delete

'items' => array(

[345] Fix | Delete

'type' => 'string',

[346] Fix | Delete

),

[347] Fix | Delete

),

[348] Fix | Delete

'errors' => array(

[349] Fix | Delete

'type' => 'object',

[350] Fix | Delete

'properties' => array(

[351] Fix | Delete

'errors' => $error_schema,

[352] Fix | Delete

'error_data' => $error_schema,

[353] Fix | Delete

),

[354] Fix | Delete

),

[355] Fix | Delete

),

[356] Fix | Delete

);

[357] Fix | Delete

[358] Fix | Delete

return array(

[359] Fix | Delete

'$schema' => 'http://json-schema.org/draft-04/schema#',

[360] Fix | Delete

'title' => 'Install and Activate Schema',

[361] Fix | Delete

'type' => 'object',

[362] Fix | Delete

'properties' => array(

[363] Fix | Delete

'type' => 'object',

[364] Fix | Delete

'properties' => array(

[365] Fix | Delete

'install' => $install_schema,

[366] Fix | Delete

'activate' => $activate_schema,

[367] Fix | Delete

),

[368] Fix | Delete

),

[369] Fix | Delete

);

[370] Fix | Delete

}

[371] Fix | Delete

[372] Fix | Delete

public function log_plugins_install_error( $slug, $api, $result, $upgrader ) {

[373] Fix | Delete

$properties = array(

[374] Fix | Delete

'error_message' => sprintf(

[375] Fix | Delete

/* translators: %s: plugin slug (example: woocommerce-services) */

[376] Fix | Delete

__(

[377] Fix | Delete

'The requested plugin `%s` could not be installed.',

[378] Fix | Delete

'woocommerce'

[379] Fix | Delete

),

[380] Fix | Delete

$slug

[381] Fix | Delete

),

[382] Fix | Delete

'type' => 'plugin_info_api_error',

[383] Fix | Delete

'slug' => $slug,

[384] Fix | Delete

'api_version' => $api->version,

[385] Fix | Delete

'api_download_link' => $api->download_link,

[386] Fix | Delete

'upgrader_skin_message' => implode( ',', $upgrader->skin->get_upgrade_messages() ),

[387] Fix | Delete

'result' => is_wp_error( $result ) ? $result->get_error_message() : 'null',

[388] Fix | Delete

);

[389] Fix | Delete

wc_admin_record_tracks_event( 'coreprofiler_install_plugin_error', $properties );

[390] Fix | Delete

}

[391] Fix | Delete

[392] Fix | Delete

public function log_plugins_install_api_error( $slug, $api ) {

[393] Fix | Delete

$properties = array(

[394] Fix | Delete

'error_message' => sprintf(

[395] Fix | Delete

// translators: %s: plugin slug (example: woocommerce-services).

[396] Fix | Delete

__(

[397] Fix | Delete

'The requested plugin `%s` could not be installed. Plugin API call failed.',

[398] Fix | Delete

'woocommerce'

[399] Fix | Delete

),

[400] Fix | Delete

$slug

[401] Fix | Delete

),

[402] Fix | Delete

'type' => 'plugin_install_error',

[403] Fix | Delete

'api_error_message' => $api->get_error_message(),

[404] Fix | Delete

'slug' => $slug,

[405] Fix | Delete

);

[406] Fix | Delete

wc_admin_record_tracks_event( 'coreprofiler_install_plugin_error', $properties );

[407] Fix | Delete

}

[408] Fix | Delete

}

[409] Fix | Delete

[410] Fix | Delete