559 lines
18 KiB
PHP
559 lines
18 KiB
PHP
<?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
|
|
|
|
use Automattic\Jetpack\Constants;
|
|
|
|
new Jetpack_JSON_API_Plugins_Modify_Endpoint(
|
|
array(
|
|
'description' => 'Activate/Deactivate a Plugin on your Jetpack Site, or set automatic updates',
|
|
'min_version' => '1',
|
|
'max_version' => '1.1',
|
|
'method' => 'POST',
|
|
'path' => '/sites/%s/plugins/%s',
|
|
'stat' => 'plugins:1:modify',
|
|
'path_labels' => array(
|
|
'$site' => '(int|string) The site ID, The site domain',
|
|
'$plugin' => '(string) The plugin ID',
|
|
),
|
|
'allow_jetpack_site_auth' => true,
|
|
'request_format' => array(
|
|
'action' => '(string) Possible values are \'update\'',
|
|
'autoupdate' => '(bool) Whether or not to automatically update the plugin',
|
|
'active' => '(bool) Activate or deactivate the plugin',
|
|
'network_wide' => '(bool) Do action network wide (default value: false)',
|
|
'scheduled_update' => '(bool) If the update is happening as a result of a scheduled update event',
|
|
),
|
|
'query_parameters' => array(
|
|
'autoupdate' => '(bool=false) If the update is happening as a result of autoupdate event',
|
|
),
|
|
'response_format' => Jetpack_JSON_API_Plugins_Endpoint::$_response_format,
|
|
'example_request_data' => array(
|
|
'headers' => array(
|
|
'authorization' => 'Bearer YOUR_API_TOKEN',
|
|
),
|
|
'body' => array(
|
|
'action' => 'update',
|
|
),
|
|
),
|
|
'example_request' => 'https://public-api.wordpress.com/rest/v1/sites/example.wordpress.org/plugins/hello-dolly%20hello',
|
|
)
|
|
);
|
|
|
|
new Jetpack_JSON_API_Plugins_Modify_Endpoint(
|
|
array(
|
|
'description' => 'Activate/Deactivate a list of plugins on your Jetpack Site, or set automatic updates',
|
|
'min_version' => '1',
|
|
'max_version' => '1.1',
|
|
'method' => 'POST',
|
|
'path' => '/sites/%s/plugins',
|
|
'stat' => 'plugins:modify',
|
|
'path_labels' => array(
|
|
'$site' => '(int|string) The site ID, The site domain',
|
|
),
|
|
'request_format' => array(
|
|
'action' => '(string) Possible values are \'update\'',
|
|
'autoupdate' => '(bool) Whether or not to automatically update the plugin',
|
|
'active' => '(bool) Activate or deactivate the plugin',
|
|
'network_wide' => '(bool) Do action network wide (default value: false)',
|
|
'plugins' => '(array) A list of plugin ids to modify',
|
|
),
|
|
'allow_jetpack_site_auth' => true,
|
|
'query_parameters' => array(
|
|
'autoupdate' => '(bool=false) If the update is happening as a result of autoupdate event',
|
|
),
|
|
'response_format' => array(
|
|
'plugins' => '(array:plugin) An array of plugin objects.',
|
|
'updated' => '(array) A list of plugin ids that were updated. Only present if action is update.',
|
|
'not_updated' => '(array) A list of plugin ids that were not updated. Only present if action is update.',
|
|
'log' => '(array) Update log. Only present if action is update.',
|
|
),
|
|
'example_request_data' => array(
|
|
'headers' => array(
|
|
'authorization' => 'Bearer YOUR_API_TOKEN',
|
|
),
|
|
'body' => array(
|
|
'active' => true,
|
|
'plugins' => array(
|
|
'jetpack/jetpack',
|
|
'akismet/akismet',
|
|
),
|
|
),
|
|
),
|
|
'example_request' => 'https://public-api.wordpress.com/rest/v1/sites/example.wordpress.org/plugins',
|
|
)
|
|
);
|
|
|
|
new Jetpack_JSON_API_Plugins_Modify_Endpoint(
|
|
array(
|
|
'description' => 'Update a Plugin on your Jetpack Site',
|
|
'min_version' => '1',
|
|
'max_version' => '1.1',
|
|
'method' => 'POST',
|
|
'path' => '/sites/%s/plugins/%s/update/',
|
|
'stat' => 'plugins:1:update',
|
|
'path_labels' => array(
|
|
'$site' => '(int|string) The site ID, The site domain',
|
|
'$plugin' => '(string) The plugin ID',
|
|
),
|
|
'allow_jetpack_site_auth' => true,
|
|
'query_parameters' => array(
|
|
'autoupdate' => '(bool=false) If the update is happening as a result of autoupdate event',
|
|
),
|
|
'response_format' => Jetpack_JSON_API_Plugins_Endpoint::$_response_format,
|
|
'example_request_data' => array(
|
|
'headers' => array(
|
|
'authorization' => 'Bearer YOUR_API_TOKEN',
|
|
),
|
|
),
|
|
'example_request' => 'https://public-api.wordpress.com/rest/v1/sites/example.wordpress.org/plugins/hello-dolly%20hello/update',
|
|
)
|
|
);
|
|
|
|
/**
|
|
* Plugins modify endpoint class.
|
|
*
|
|
* POST /sites/%s/plugins/%s
|
|
* POST /sites/%s/plugins
|
|
*/
|
|
class Jetpack_JSON_API_Plugins_Modify_Endpoint extends Jetpack_JSON_API_Plugins_Endpoint {
|
|
|
|
/**
|
|
* The slug.
|
|
*
|
|
* @var string
|
|
*/
|
|
protected $slug = null;
|
|
|
|
/**
|
|
* Needed capabilities.
|
|
*
|
|
* @var string
|
|
*/
|
|
protected $needed_capabilities = 'activate_plugins';
|
|
|
|
/**
|
|
* Action.
|
|
*
|
|
* @var string
|
|
*/
|
|
protected $action = 'default_action';
|
|
|
|
/**
|
|
* Expected actions.
|
|
*
|
|
* @var array
|
|
*/
|
|
protected $expected_actions = array( 'update', 'install', 'delete', 'update_translations' );
|
|
|
|
/**
|
|
* Callback.
|
|
*
|
|
* @param string $path - the path.
|
|
* @param int $blog_id - the blog ID.
|
|
* @param object $object - the object.
|
|
*
|
|
* @return bool|WP_Error
|
|
*/
|
|
public function callback( $path = '', $blog_id = 0, $object = null ) {
|
|
|
|
Jetpack_JSON_API_Endpoint::validate_input( $object );
|
|
switch ( $this->action ) {
|
|
case 'delete':
|
|
$this->needed_capabilities = 'delete_plugins';
|
|
break;
|
|
case 'update_translations':
|
|
case 'update':
|
|
$this->needed_capabilities = 'update_plugins';
|
|
break;
|
|
case 'install':
|
|
$this->needed_capabilities = 'install_plugins';
|
|
break;
|
|
}
|
|
|
|
$args = $this->input();
|
|
|
|
if ( is_array( $args ) && ( isset( $args['autoupdate'] ) || isset( $args['autoupdate_translations'] ) ) ) {
|
|
$this->needed_capabilities = 'update_plugins';
|
|
}
|
|
|
|
return parent::callback( $path, $blog_id, $object );
|
|
}
|
|
|
|
/**
|
|
* The default action.
|
|
*
|
|
* @return bool|WP_Error
|
|
*/
|
|
public function default_action() {
|
|
$args = $this->input();
|
|
|
|
if ( isset( $args['autoupdate'] ) && is_bool( $args['autoupdate'] ) ) {
|
|
if ( $args['autoupdate'] ) {
|
|
$this->autoupdate_on();
|
|
} else {
|
|
$this->autoupdate_off();
|
|
}
|
|
}
|
|
|
|
if ( isset( $args['active'] ) && is_bool( $args['active'] ) ) {
|
|
if ( $args['active'] ) {
|
|
// We don't have to check for activate_plugins permissions since we assume that the user has those
|
|
// Since we set them via $needed_capabilities.
|
|
return $this->activate();
|
|
} elseif ( $this->current_user_can( 'deactivate_plugins' ) ) {
|
|
return $this->deactivate();
|
|
} else {
|
|
return new WP_Error( 'unauthorized_error', __( 'Plugin deactivation is not allowed', 'jetpack' ), '403' );
|
|
}
|
|
}
|
|
|
|
if ( isset( $args['autoupdate_translations'] ) && is_bool( $args['autoupdate_translations'] ) ) {
|
|
if ( $args['autoupdate_translations'] ) {
|
|
$this->autoupdate_translations_on();
|
|
} else {
|
|
$this->autoupdate_translations_off();
|
|
}
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Turn on autoupdate.
|
|
*/
|
|
protected function autoupdate_on() {
|
|
$autoupdate_plugins = (array) get_site_option( 'auto_update_plugins', array() );
|
|
$autoupdate_plugins = array_unique( array_merge( $autoupdate_plugins, $this->plugins ) );
|
|
update_site_option( 'auto_update_plugins', $autoupdate_plugins );
|
|
}
|
|
|
|
/**
|
|
* Turn off autoupdate.
|
|
*/
|
|
protected function autoupdate_off() {
|
|
$autoupdate_plugins = (array) get_site_option( 'auto_update_plugins', array() );
|
|
$autoupdate_plugins = array_diff( $autoupdate_plugins, $this->plugins );
|
|
update_site_option( 'auto_update_plugins', $autoupdate_plugins );
|
|
}
|
|
|
|
/**
|
|
* Turn autoupdate translations on.
|
|
*/
|
|
protected function autoupdate_translations_on() {
|
|
$autoupdate_plugins = Jetpack_Options::get_option( 'autoupdate_plugins_translations', array() );
|
|
$autoupdate_plugins = array_unique( array_merge( $autoupdate_plugins, $this->plugins ) );
|
|
Jetpack_Options::update_option( 'autoupdate_plugins_translations', $autoupdate_plugins );
|
|
}
|
|
|
|
/**
|
|
* Turn autoupdate translations off.
|
|
*/
|
|
protected function autoupdate_translations_off() {
|
|
$autoupdate_plugins = Jetpack_Options::get_option( 'autoupdate_plugins_translations', array() );
|
|
$autoupdate_plugins = array_diff( $autoupdate_plugins, $this->plugins );
|
|
Jetpack_Options::update_option( 'autoupdate_plugins_translations', $autoupdate_plugins );
|
|
}
|
|
|
|
/**
|
|
* Activate the plugin.
|
|
*
|
|
* @return null|WP_Error null if the activation was successful.
|
|
*/
|
|
protected function activate() {
|
|
$permission_error = false;
|
|
foreach ( $this->plugins as $plugin ) {
|
|
|
|
if ( ! $this->current_user_can( 'activate_plugin', $plugin ) ) {
|
|
$this->log[ $plugin ]['error'] = __( 'Sorry, you are not allowed to activate this plugin.', 'jetpack' );
|
|
$has_errors = true;
|
|
$permission_error = true;
|
|
continue;
|
|
}
|
|
|
|
if ( ( ! $this->network_wide && Jetpack::is_plugin_active( $plugin ) ) || is_plugin_active_for_network( $plugin ) ) {
|
|
$this->log[ $plugin ]['error'] = __( 'The Plugin is already active.', 'jetpack' );
|
|
$has_errors = true;
|
|
continue;
|
|
}
|
|
|
|
if ( ! $this->network_wide && is_network_only_plugin( $plugin ) && is_multisite() ) {
|
|
$this->log[ $plugin ]['error'] = __( 'Plugin can only be Network Activated', 'jetpack' );
|
|
$has_errors = true;
|
|
continue;
|
|
}
|
|
|
|
$result = activate_plugin( $plugin, '', $this->network_wide );
|
|
|
|
if ( is_wp_error( $result ) ) {
|
|
$this->log[ $plugin ]['error'] = $result->get_error_messages();
|
|
$has_errors = true;
|
|
continue;
|
|
}
|
|
|
|
$success = Jetpack::is_plugin_active( $plugin );
|
|
if ( $success && $this->network_wide ) {
|
|
$success &= is_plugin_active_for_network( $plugin );
|
|
}
|
|
|
|
if ( ! $success ) {
|
|
$this->log[ $plugin ]['error'] = $result->get_error_messages;
|
|
$has_errors = true;
|
|
continue;
|
|
}
|
|
$this->log[ $plugin ][] = __( 'Plugin activated.', 'jetpack' );
|
|
}
|
|
|
|
if ( ! $this->bulk && isset( $has_errors ) ) {
|
|
$plugin = $this->plugins[0];
|
|
if ( $permission_error ) {
|
|
return new WP_Error( 'unauthorized_error', $this->log[ $plugin ]['error'], 403 );
|
|
}
|
|
|
|
return new WP_Error( 'activation_error', $this->log[ $plugin ]['error'] );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Check if the current user has capabilities.
|
|
*
|
|
* @param string $capability - the capability we're checking.
|
|
* @param string $plugin - the plugin we're checking.
|
|
*
|
|
* @return bool
|
|
*/
|
|
protected function current_user_can( $capability, $plugin = null ) {
|
|
// If this endpoint accepts site based authentication and a blog token is used, skip capabilities check.
|
|
if ( $this->accepts_site_based_authentication() ) {
|
|
return true;
|
|
}
|
|
if ( $plugin ) {
|
|
return current_user_can( $capability, $plugin );
|
|
}
|
|
|
|
return current_user_can( $capability );
|
|
}
|
|
|
|
/**
|
|
* Deactivate the plugin.
|
|
*
|
|
* @return null|WP_Error null if the deactivation was successful
|
|
*/
|
|
protected function deactivate() {
|
|
$permission_error = false;
|
|
foreach ( $this->plugins as $plugin ) {
|
|
if ( ! $this->current_user_can( 'deactivate_plugin', $plugin ) ) {
|
|
$error = __( 'Sorry, you are not allowed to deactivate this plugin.', 'jetpack' );
|
|
$this->log[ $plugin ]['error'] = $error;
|
|
$permission_error = true;
|
|
continue;
|
|
}
|
|
|
|
if ( ! Jetpack::is_plugin_active( $plugin ) ) {
|
|
$error = __( 'The Plugin is already deactivated.', 'jetpack' );
|
|
$this->log[ $plugin ]['error'] = $error;
|
|
continue;
|
|
}
|
|
|
|
deactivate_plugins( $plugin, false, $this->network_wide );
|
|
|
|
$success = ! Jetpack::is_plugin_active( $plugin );
|
|
if ( $success && $this->network_wide ) {
|
|
$success &= ! is_plugin_active_for_network( $plugin );
|
|
}
|
|
|
|
if ( ! $success ) {
|
|
$error = __( 'There was an error deactivating your plugin', 'jetpack' );
|
|
$this->log[ $plugin ]['error'] = $error;
|
|
continue;
|
|
}
|
|
$this->log[ $plugin ][] = __( 'Plugin deactivated.', 'jetpack' );
|
|
}
|
|
if ( ! $this->bulk && isset( $error ) ) {
|
|
if ( $permission_error ) {
|
|
return new WP_Error( 'unauthorized_error', $error, 403 );
|
|
}
|
|
|
|
return new WP_Error( 'deactivation_error', $error );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Update the plugin.
|
|
*
|
|
* @return bool|WP_Error
|
|
*/
|
|
protected function update() {
|
|
$query_args = $this->query_args();
|
|
|
|
$is_automatic_update = false;
|
|
if ( isset( $query_args['autoupdate'] ) && $query_args['autoupdate'] || $this->scheduled_update ) {
|
|
$is_automatic_update = true;
|
|
}
|
|
|
|
if ( $this->scheduled_update ) {
|
|
Constants::set_constant( 'SCHEDULED_AUTOUPDATE', true );
|
|
}
|
|
wp_clean_plugins_cache( false );
|
|
ob_start();
|
|
wp_update_plugins(); // Check for Plugin updates
|
|
ob_end_clean();
|
|
|
|
$update_plugins = get_site_transient( 'update_plugins' );
|
|
|
|
if ( isset( $update_plugins->response ) ) {
|
|
$plugin_updates_needed = array_keys( $update_plugins->response );
|
|
} else {
|
|
$plugin_updates_needed = array();
|
|
}
|
|
|
|
$update_attempted = false;
|
|
|
|
include_once ABSPATH . 'wp-admin/includes/class-wp-upgrader.php';
|
|
|
|
// unhook this functions that output things before we send our response header.
|
|
remove_action( 'upgrader_process_complete', array( 'Language_Pack_Upgrader', 'async_upgrade' ), 20 );
|
|
remove_action( 'upgrader_process_complete', 'wp_version_check' );
|
|
remove_action( 'upgrader_process_complete', 'wp_update_themes' );
|
|
|
|
// Set the lock timeout to 15 minutes if it's scheduled update, otherwise default to one hour.
|
|
$lock_release_timeout = $this->scheduled_update ? 15 * MINUTE_IN_SECONDS : null;
|
|
|
|
// Early return if unable to obtain auto_updater lock.
|
|
// @see https://github.com/WordPress/wordpress-develop/blob/66469efa99e7978c8824e287834135aa9842e84f/src/wp-admin/includes/class-wp-automatic-updater.php#L453.
|
|
if ( $is_automatic_update && ! WP_Upgrader::create_lock( 'auto_updater', $lock_release_timeout ) ) {
|
|
return new WP_Error( 'update_fail', __( 'Updates are already in progress.', 'jetpack' ), 400 );
|
|
}
|
|
|
|
$result = false;
|
|
|
|
foreach ( $this->plugins as $plugin ) {
|
|
|
|
if ( ! in_array( $plugin, $plugin_updates_needed, true ) ) {
|
|
$this->log[ $plugin ][] = __( 'No update needed', 'jetpack' );
|
|
continue;
|
|
}
|
|
|
|
// Rely on WP_Automatic_Updater class to check if a plugin item should be updated if it is a Jetpack autoupdate request.
|
|
if ( $is_automatic_update && ! ( new WP_Automatic_Updater() )->should_update( 'plugin', $update_plugins->response[ $plugin ], WP_PLUGIN_DIR ) ) {
|
|
continue;
|
|
}
|
|
|
|
// Establish per plugin lock.
|
|
$plugin_slug = Jetpack_Autoupdate::get_plugin_slug( $plugin );
|
|
if ( ! WP_Upgrader::create_lock( 'jetpack_' . $plugin_slug, $lock_release_timeout ) ) {
|
|
continue;
|
|
}
|
|
|
|
/**
|
|
* Pre-upgrade action
|
|
*
|
|
* @since 3.9.3
|
|
*
|
|
* @param array $plugin Plugin data
|
|
* @param array $plugin Array of plugin objects
|
|
* @param bool $updated_attempted false for the first update, true subsequently
|
|
*/
|
|
do_action( 'jetpack_pre_plugin_upgrade', $plugin, $this->plugins, $update_attempted );
|
|
|
|
$update_attempted = true;
|
|
|
|
// Object created inside the for loop to clean the messages for each plugin
|
|
$skin = new WP_Ajax_Upgrader_Skin();
|
|
// The Automatic_Upgrader_Skin skin shouldn't output anything.
|
|
$upgrader = new Plugin_Upgrader( $skin );
|
|
$upgrader->init();
|
|
// This avoids the plugin to be deactivated.
|
|
// Using bulk upgrade puts the site into maintenance mode during the upgrades
|
|
$result = $upgrader->bulk_upgrade( array( $plugin ) );
|
|
$errors = $skin->get_errors();
|
|
$this->log[ $plugin ] = $skin->get_upgrade_messages();
|
|
|
|
// release individual plugin lock.
|
|
WP_Upgrader::release_lock( 'jetpack_' . $plugin_slug );
|
|
|
|
if ( is_wp_error( $errors ) && $errors->get_error_code() ) {
|
|
return $errors;
|
|
}
|
|
}
|
|
|
|
// release auto_udpate lock.
|
|
if ( $is_automatic_update ) {
|
|
WP_Upgrader::release_lock( 'auto_updater' );
|
|
}
|
|
|
|
if ( ! $this->bulk && ! $result && $update_attempted ) {
|
|
return new WP_Error( 'update_fail', __( 'There was an error updating your plugin', 'jetpack' ), 400 );
|
|
}
|
|
|
|
return $this->default_action();
|
|
}
|
|
|
|
/**
|
|
* Update translations.
|
|
*
|
|
* @return bool|WP_Error
|
|
*/
|
|
public function update_translations() {
|
|
include_once ABSPATH . 'wp-admin/includes/class-wp-upgrader.php';
|
|
|
|
// Clear the cache.
|
|
wp_clean_plugins_cache( false );
|
|
ob_start();
|
|
wp_update_plugins(); // Check for Plugin updates
|
|
ob_end_clean();
|
|
|
|
$available_updates = get_site_transient( 'update_plugins' );
|
|
if ( ! isset( $available_updates->translations ) || empty( $available_updates->translations ) ) {
|
|
return new WP_Error( 'nothing_to_translate' );
|
|
}
|
|
|
|
$update_attempted = false;
|
|
$result = false;
|
|
foreach ( $this->plugins as $plugin ) {
|
|
$this->slug = Jetpack_Autoupdate::get_plugin_slug( $plugin );
|
|
$translation = array_filter( $available_updates->translations, array( $this, 'get_translation' ) );
|
|
|
|
if ( empty( $translation ) ) {
|
|
$this->log[ $plugin ][] = __( 'No update needed', 'jetpack' );
|
|
continue;
|
|
}
|
|
|
|
/**
|
|
* Pre-upgrade action
|
|
*
|
|
* @since 4.4.0
|
|
*
|
|
* @param array $plugin Plugin data
|
|
* @param array $plugin Array of plugin objects
|
|
* @param bool $update_attempted false for the first update, true subsequently
|
|
*/
|
|
do_action( 'jetpack_pre_plugin_upgrade_translations', $plugin, $this->plugins, $update_attempted );
|
|
|
|
$update_attempted = true;
|
|
|
|
$skin = new Automatic_Upgrader_Skin();
|
|
$upgrader = new Language_Pack_Upgrader( $skin );
|
|
$upgrader->init();
|
|
|
|
$result = $upgrader->upgrade( (object) $translation[0] );
|
|
|
|
$this->log[ $plugin ] = $upgrader->skin->get_upgrade_messages();
|
|
}
|
|
|
|
if ( ! $this->bulk && ! $result ) {
|
|
return new WP_Error( 'update_fail', __( 'There was an error updating your plugin', 'jetpack' ), 400 );
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Test whether the translation matches `$this->slug`.
|
|
*
|
|
* @param array $translation - the translation.
|
|
*
|
|
* @return bool
|
|
*/
|
|
protected function get_translation( $translation ) {
|
|
return ( $translation['slug'] === $this->slug );
|
|
}
|
|
}
|