Skip to content
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

Refactor config create command #181

Merged
merged 3 commits into from
Jul 22, 2024
Merged

Refactor config create command #181

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f2f5fc0
Refactor config create command
UmeshSingla May 17, 2024
420118c
Handle extra-php input
UmeshSingla May 18, 2024
0601669
Added functional test for DB_PASSWORD
UmeshSingla May 20, 2024
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
9 changes: 9 additions & 0 deletions features/config-create.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -293,3 +293,12 @@ Feature: Create a wp-config file
PasswordWith'SingleQuotes'
"""

Scenario: Correct config file is generated when database password has double quote in it
Given an empty directory
And WP files

When I run `wp config create --skip-check --dbname=somedb --dbuser=someuser --dbpass='p@(ss){w0r?d><}"!With"DoubleQuotes'`
Then the wp-config.php file should contain:
"""
define( 'DB_PASSWORD', 'p@(ss){w0r?d><}"!With"DoubleQuotes' )
"""
140 changes: 102 additions & 38 deletions src/Config_Command.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -193,16 +193,6 @@ public function create( $_, $assoc_args ) {
}
}

$defaults = [
'dbhost' => 'localhost',
'dbpass' => '',
'dbprefix' => 'wp_',
'dbcharset' => 'utf8',
'dbcollate' => '',
'locale' => self::get_initial_locale(),
'config-file' => rtrim( ABSPATH, '/\\' ) . '/wp-config.php',
];
$assoc_args = array_merge( $defaults, $assoc_args );
if ( empty( $assoc_args['dbprefix'] ) ) {
WP_CLI::error( '--dbprefix cannot be empty' );
}
Expand Down Expand Up @@ -239,52 +229,126 @@ public function create( $_, $assoc_args ) {
// phpcs:enable WordPress.DB.RestrictedFunctions
}

$defaults = [
'dbhost' => 'localhost',
'dbpass' => '',
'dbprefix' => 'wp_',
'dbcharset' => 'utf8',
'dbcollate' => '',
'locale' => self::get_initial_locale(),
'config-file' => rtrim( ABSPATH, '/\\' ) . '/wp-config.php',
];

if ( Utils\wp_version_compare( '4.0', '<' ) ) {
$defaults['add-wplang'] = true;
} else {
$defaults['add-wplang'] = false;
}

if ( ! Utils\get_flag_value( $assoc_args, 'skip-salts' ) ) {
try {
$assoc_args['keys-and-salts'] = true;
$assoc_args['auth-key'] = self::unique_key();
$assoc_args['secure-auth-key'] = self::unique_key();
$assoc_args['logged-in-key'] = self::unique_key();
$assoc_args['nonce-key'] = self::unique_key();
$assoc_args['auth-salt'] = self::unique_key();
$assoc_args['secure-auth-salt'] = self::unique_key();
$assoc_args['logged-in-salt'] = self::unique_key();
$assoc_args['nonce-salt'] = self::unique_key();
$assoc_args['wp-cache-key-salt'] = self::unique_key();
$defaults['keys-and-salts'] = true;
$defaults['auth-key'] = self::unique_key();
$defaults['secure-auth-key'] = self::unique_key();
$defaults['logged-in-key'] = self::unique_key();
$defaults['nonce-key'] = self::unique_key();
$defaults['auth-salt'] = self::unique_key();
$defaults['secure-auth-salt'] = self::unique_key();
$defaults['logged-in-salt'] = self::unique_key();
$defaults['nonce-salt'] = self::unique_key();
$defaults['wp-cache-key-salt'] = self::unique_key();
} catch ( Exception $e ) {
$assoc_args['keys-and-salts'] = false;
$assoc_args['keys-and-salts-alt'] = self::fetch_remote_salts(
$defaults['keys-and-salts'] = false;
$defaults['keys-and-salts-alt'] = self::fetch_remote_salts(
(bool) Utils\get_flag_value( $assoc_args, 'insecure', false )
);
}
}

if ( Utils\wp_version_compare( '4.0', '<' ) ) {
$assoc_args['add-wplang'] = true;
} else {
$assoc_args['add-wplang'] = false;
}

foreach ( $assoc_args as $key => $value ) {
$assoc_args[ $key ] = $this->escape_config_value( $key, $value );
$path = $defaults['config-file'];
if ( ! empty( $assoc_args['config-file'] ) ) {
$path = $assoc_args['config-file'];
}

// 'extra-php' from STDIN is retrieved after escaping to avoid breaking
// the PHP code.
if ( Utils\get_flag_value( $assoc_args, 'extra-php' ) === true ) {
$assoc_args['extra-php'] = file_get_contents( 'php://stdin' );
// 'extra-php' from STDIN is retrieved.
$defaults['extra-php'] = file_get_contents( 'php://stdin' );
}

$command_root = Utils\phar_safe_path( dirname( __DIR__ ) );
$out = Utils\mustache_render( "{$command_root}/templates/wp-config.mustache", $assoc_args );
$out = Utils\mustache_render( "{$command_root}/templates/wp-config.mustache", $defaults );

// Output the default config file at path specified in assoc args.
$wp_config_file_name = basename( $path );
$bytes_written = file_put_contents( $path, $out );

$wp_config_file_name = basename( $assoc_args['config-file'] );
$bytes_written = file_put_contents( $assoc_args['config-file'], $out );
if ( ! $bytes_written ) {
WP_CLI::error( "Could not create new '{$wp_config_file_name}' file." );
} else {
WP_CLI::success( "Generated '{$wp_config_file_name}' file." );
}

$assoc_args = array_merge( $defaults, $assoc_args );

$options = [
'raw' => false,
'add' => true,
'normalize' => true,
];

$config_keys = [
'dbhost' => array(
'name' => 'DB_HOST',
'type' => 'constant',
),
'dbpass' => array(
'name' => 'DB_PASSWORD',
'type' => 'constant',
),
'dbprefix' => array(
'name' => 'table_prefix',
'type' => 'variable',
),
'dbcharset' => array(
'name' => 'DB_CHARSET',
'type' => 'constant',
),
'dbcollate' => array(
'name' => 'DB_COLLATE',
'type' => 'constant',
),
'locale' => array(
'name' => 'WPLANG',
'type' => 'constant',
),
'dbname' => array(
'name' => 'DB_NAME',
'type' => 'constant',
),
'dbuser' => array(
'name' => 'DB_USER',
'type' => 'constant',
),
];

try {
$config_transformer = new WPConfigTransformer( $path );

foreach ( $config_keys as $key => $const ) {

$value = $assoc_args[ $key ];
if ( ! empty( $value ) ) {
$config_transformer->update( $const['type'], $const['name'], $value, $options );
}
}
} catch ( Exception $exception ) {
// Remove the default moustache wp-config.php template file.
if ( file_exists( $assoc_args['config-file'] ) ) {
unlink( $path );
}

WP_CLI::error( "Could not create new '{$wp_config_file_name}' file.\nReason: {$exception->getMessage()}" );
}

WP_CLI::success( "Generated '{$wp_config_file_name}' file." );
}

/**
Expand Down