Skip to content

Add --insecure flag to plugin|theme install & plugin\theme update commands #287

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
schlessera merged 2 commits into from
May 10, 2021
Merged

Add --insecure flag to plugin|theme install & plugin\theme update commands #287

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e57258e
Add --insecure flag to plugin|theme install & plugin\theme update com…
schlessera May 7, 2021
062a77f
Use WpOrgApi abstraction
schlessera May 10, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions src/Plugin_Command.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -593,6 +593,9 @@ protected function install_from_repo( $slug, $assoc_args ) {
* [--dry-run]
* : Preview which plugins would be updated.
*
* [--insecure]
* : Retry downloads without certificate validation if TLS handshake fails. Note: This makes the request vulnerable to a MITM attack.
*
* ## EXAMPLES
*
* $ wp plugin update bbpress --version=dev
Expand Down Expand Up @@ -737,6 +740,9 @@ protected function filter_item_list( $items, $args ) {
* [--activate-network]
* : If set, the plugin will be network activated immediately after install
*
* [--insecure]
* : Retry downloads without certificate validation if TLS handshake fails. Note: This makes the request vulnerable to a MITM attack.
*
* ## EXAMPLES
*
* # Install the latest version from wordpress.org and activate
Expand Down
6 changes: 6 additions & 0 deletions src/Theme_Command.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -457,6 +457,9 @@ protected function filter_item_list( $items, $args ) {
* [--activate]
* : If set, the theme will be activated immediately after install.
*
* [--insecure]
* : Retry downloads without certificate validation if TLS handshake fails. Note: This makes the request vulnerable to a MITM attack.
*
* ## EXAMPLES
*
* # Install the latest version from wordpress.org and activate
Expand Down Expand Up @@ -596,6 +599,9 @@ public function get( $args, $assoc_args ) {
* [--dry-run]
* : Preview which themes would be updated.
*
* [--insecure]
* : Retry downloads without certificate validation if TLS handshake fails. Note: This makes the request vulnerable to a MITM attack.
*
* ## EXAMPLES
*
* # Update multiple themes
Expand Down
88 changes: 49 additions & 39 deletions src/WP_CLI/CommandWithUpgrade.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,12 @@
namespace WP_CLI;

use Composer\Semver\Comparator;
use Exception;
use WP_CLI;
use WP_CLI\Fetchers;
use WP_CLI\Loggers;
use WP_CLI\Utils;
use WP_Error;

abstract class CommandWithUpgrade extends \WP_CLI_Command {

Expand Down Expand Up @@ -38,7 +42,7 @@ function () {
999
);

$this->fetcher = new WP_CLI\Fetchers\Plugin();
$this->fetcher = new Fetchers\Plugin();
}

abstract protected function get_upgrader_class( $force );
Expand Down Expand Up @@ -95,10 +99,10 @@ private function status_all() {
$line .= ' ' . $details['version'];
}

\WP_CLI::line( \WP_CLI::colorize( $line ) );
WP_CLI::line( WP_CLI::colorize( $line ) );
}

\WP_CLI::line();
WP_CLI::line();

$this->show_legend( $items );
}
Expand Down Expand Up @@ -135,7 +139,7 @@ private function show_legend( $items ) {
$legend_line[] = '%yU = Update Available%n';
}

\WP_CLI::line( 'Legend: ' . \WP_CLI::colorize( implode( ', ', $legend_line ) ) );
WP_CLI::line( 'Legend: ' . WP_CLI::colorize( implode( ', ', $legend_line ) ) );
}

public function install( $args, $assoc_args ) {
Expand Down Expand Up @@ -185,7 +189,7 @@ public function install( $args, $assoc_args ) {
return $new_path;
}

return new \WP_Error( 'wpcli_install_github', "Couldn't move Github-based project to appropriate directory." );
return new WP_Error( 'wpcli_install_github', "Couldn't move Github-based project to appropriate directory." );
};
add_filter( 'upgrader_source_selection', $filter, 10, 3 );
}
Expand Down Expand Up @@ -213,7 +217,7 @@ public function install( $args, $assoc_args ) {
WP_CLI::warning( "Couldn't find '$slug' in the WordPress.org {$this->item_type} directory." );
$errors++;
} else {
\WP_CLI::warning( "$slug: " . $result->get_error_message() );
WP_CLI::warning( "$slug: " . $result->get_error_message() );
if ( 'already_installed' !== $key ) {
$errors++;
}
Expand All @@ -237,12 +241,12 @@ public function install( $args, $assoc_args ) {
if ( true === $allow_activation && count( $extension ) > 0 ) {
$this->chained_command = true;
if ( Utils\get_flag_value( $assoc_args, 'activate-network' ) ) {
\WP_CLI::log( "Network-activating '$slug'..." );
WP_CLI::log( "Network-activating '$slug'..." );
$this->activate( array( $slug ), array( 'network' => true ) );
}

if ( Utils\get_flag_value( $assoc_args, 'activate' ) ) {
\WP_CLI::log( "Activating '$slug'..." );
WP_CLI::log( "Activating '$slug'..." );
$this->activate( array( $slug ) );
}
$this->chained_command = false;
Expand Down Expand Up @@ -306,20 +310,22 @@ protected static function alter_api_response( $response, $version ) {
}

protected function get_upgrader( $assoc_args ) {
$upgrader_class = $this->get_upgrader_class( Utils\get_flag_value( $assoc_args, 'force' ) );
return Utils\get_upgrader( $upgrader_class );
$force = (bool) Utils\get_flag_value( $assoc_args, 'force', false );
$insecure = (bool) Utils\get_flag_value( $assoc_args, 'insecure', false );
$upgrader_class = $this->get_upgrader_class( $force );
return Utils\get_upgrader( $upgrader_class, $insecure );
}

protected function update_many( $args, $assoc_args ) {
call_user_func( $this->upgrade_refresh );

if ( ! empty( $assoc_args['format'] ) && in_array( $assoc_args['format'], [ 'json', 'csv' ], true ) ) {
$logger = new \WP_CLI\Loggers\Quiet();
$logger = new Loggers\Quiet();
WP_CLI::set_logger( $logger );
}

if ( ! Utils\get_flag_value( $assoc_args, 'all' ) && empty( $args ) ) {
\WP_CLI::error( "Please specify one or more {$this->item_type}s, or use --all." );
WP_CLI::error( "Please specify one or more {$this->item_type}s, or use --all." );
}

if ( Utils\get_flag_value( $assoc_args, 'minor' ) && Utils\get_flag_value( $assoc_args, 'patch' ) ) {
Expand All @@ -336,14 +342,18 @@ protected function update_many( $args, $assoc_args ) {

$items_to_update = wp_list_filter( $items, [ 'update' => true ] );

$minor = (bool) Utils\get_flag_value( $assoc_args, 'minor', false );
$patch = (bool) Utils\get_flag_value( $assoc_args, 'patch', false );

if ( 'plugin' === $this->item_type
&& ( Utils\get_flag_value( $assoc_args, 'minor' )
|| Utils\get_flag_value( $assoc_args, 'patch' ) ) ) {
$type = Utils\get_flag_value( $assoc_args, 'minor' ) ? 'minor' : 'patch';
$items_to_update = self::get_minor_or_patch_updates( $items_to_update, $type );
&& ( $minor || $patch ) ) {
$type = $minor ? 'minor' : 'patch';
$insecure = (bool) Utils\get_flag_value( $assoc_args, 'insecure', false );

$items_to_update = self::get_minor_or_patch_updates( $items_to_update, $type, $insecure );
}

$exclude = WP_CLI\Utils\get_flag_value( $assoc_args, 'exclude' );
$exclude = Utils\get_flag_value( $assoc_args, 'exclude' );
if ( isset( $exclude ) ) {
$exclude_items = explode( ',', trim( $assoc_args['exclude'], ',' ) );
unset( $assoc_args['exclude'] );
Expand All @@ -369,29 +379,29 @@ protected function update_many( $args, $assoc_args ) {

if ( Utils\get_flag_value( $assoc_args, 'dry-run' ) ) {
if ( empty( $items_to_update ) ) {
\WP_CLI::log( "No {$this->item_type} updates available." );
WP_CLI::log( "No {$this->item_type} updates available." );

if ( null !== $exclude ) {
\WP_CLI::log( "Skipped updates for: $exclude" );
WP_CLI::log( "Skipped updates for: $exclude" );
}

return;
}

if ( ! empty( $assoc_args['format'] ) && in_array( $assoc_args['format'], [ 'json', 'csv' ], true ) ) {
WP_CLI\Utils\format_items( $assoc_args['format'], $items_to_update, [ 'name', 'status', 'version', 'update_version' ] );
Utils\format_items( $assoc_args['format'], $items_to_update, [ 'name', 'status', 'version', 'update_version' ] );
} elseif ( ! empty( $assoc_args['format'] ) && 'summary' === $assoc_args['format'] ) {
\WP_CLI::log( "Available {$this->item_type} updates:" );
WP_CLI::log( "Available {$this->item_type} updates:" );
foreach ( $items_to_update as $item_to_update => $info ) {
\WP_CLI::log( "{$info['title']} update from version {$info['version']} to version {$info['update_version']}" );
WP_CLI::log( "{$info['title']} update from version {$info['version']} to version {$info['update_version']}" );
}
} else {
\WP_CLI::log( "Available {$this->item_type} updates:" );
WP_CLI::log( "Available {$this->item_type} updates:" );
Utils\format_items( 'table', $items_to_update, [ 'name', 'status', 'version', 'update_version' ] );
}

if ( null !== $exclude ) {
\WP_CLI::log( "Skipped updates for: $exclude" );
WP_CLI::log( "Skipped updates for: $exclude" );
}

return;
Expand All @@ -401,7 +411,7 @@ protected function update_many( $args, $assoc_args ) {

// Only attempt to update if there is something to update.
if ( ! empty( $items_to_update ) ) {
$cache_manager = \WP_CLI::get_http_cache_manager();
$cache_manager = WP_CLI::get_http_cache_manager();
foreach ( $items_to_update as $item ) {
$cache_manager->whitelist_package( $item['update_package'], $this->item_type, $item['name'], $item['update_version'] );
}
Expand Down Expand Up @@ -429,7 +439,7 @@ protected function update_many( $args, $assoc_args ) {
if ( ! empty( $assoc_args['format'] ) && 'summary' === $assoc_args['format'] ) {
foreach ( $items_to_update as $item_to_update => $info ) {
$message = null !== $result[ $info['update_id'] ] ? 'updated successfully' : 'did not update';
\WP_CLI::log( "{$info['title']} {$message} from version {$info['version']} to version {$info['update_version']}" );
WP_CLI::log( "{$info['title']} {$message} from version {$info['version']} to version {$info['update_version']}" );
}
} else {
$status = array();
Expand Down Expand Up @@ -457,7 +467,7 @@ protected function update_many( $args, $assoc_args ) {
$total_updated = Utils\get_flag_value( $assoc_args, 'all' ) ? $num_to_update : count( $args );
Utils\report_batch_operation_results( $this->item_type, 'update', $total_updated, $num_updated, $errors );
if ( null !== $exclude ) {
\WP_CLI::log( "Skipped updates for: $exclude" );
WP_CLI::log( "Skipped updates for: $exclude" );
}
}

Expand All @@ -469,7 +479,7 @@ protected function _list( $_, $assoc_args ) {
$all_items = $this->get_all_items();

if ( ! is_array( $all_items ) ) {
\WP_CLI::error( "No {$this->item_type}s found." );
WP_CLI::error( "No {$this->item_type}s found." );
}

foreach ( $all_items as $key => &$item ) {
Expand Down Expand Up @@ -568,20 +578,20 @@ private function get_color( $status ) {
/**
* Get the minor or patch version for plugins with available updates
*
* @param array $items Plugins with updates.
* @param string $type Either 'minor' or 'patch'
* @param array $items Plugins with updates.
* @param string $type Either 'minor' or 'patch'.
* @param bool $insecure Whether to retry without certificate validation on TLS handshake failure.
* @return array
*/
private function get_minor_or_patch_updates( $items, $type ) {
private function get_minor_or_patch_updates( $items, $type, $insecure ) {
$wp_org_api = new WpOrgApi( [ 'insecure' => $insecure ] );
foreach ( $items as $i => $item ) {
$wporg_url = sprintf( 'https://api.wordpress.org/plugins/info/1.0/%s.json', $item['name'] );
$response = Utils\http_request( 'GET', $wporg_url );
// Must not be hosted on wp.org
if ( 20 !== absint( substr( $response->status_code, 0, 2 ) ) ) {
try {
$data = $wp_org_api->get_plugin_info( $item['name'] );
} catch ( Exception $exception ) {
unset( $items[ $i ] );
continue;
}
$data = json_decode( $response->body, true );
// No minor or patch versions to access.
if ( empty( $data['versions'] ) ) {
unset( $items[ $i ] );
Expand Down Expand Up @@ -658,13 +668,13 @@ protected function _search( $args, $assoc_args ) {
}

if ( is_wp_error( $api ) ) {
\WP_CLI::error( $api->get_error_message() . __( ' Try again' ) );
WP_CLI::error( $api->get_error_message() . __( ' Try again' ) );
}

$plural = $this->item_type . 's';

if ( ! isset( $api->$plural ) ) {
\WP_CLI::error( __( 'API error. Try Again.' ) );
WP_CLI::error( __( 'API error. Try Again.' ) );
}

$items = $api->$plural;
Expand All @@ -678,7 +688,7 @@ protected function _search( $args, $assoc_args ) {

if ( 'table' === $format ) {
$count = Utils\get_flag_value( $api->info, 'results', 'unknown' );
\WP_CLI::success( sprintf( 'Showing %s of %s %s.', count( $items ), $count, $plural ) );
WP_CLI::success( sprintf( 'Showing %s of %s %s.', count( $items ), $count, $plural ) );
}

$formatter->display_items( $items );
Expand Down