Skip to content

fix(site): validate the site name and quote remote database check commands #117

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
mrrobot47 merged 3 commits into from
Oct 12, 2026
Merged

fix(site): validate the site name and quote remote database check commands #117

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bb46f2b
fix(site): reject site names that are not valid hostnames
mrrobot47 Oct 12, 2026
de6fff2
fix(site): quote remote database check commands
mrrobot47 Oct 12, 2026
0de0966
fix(site): validate the site name only when site-command provides the…
mrrobot47 Oct 12, 2026
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
69 changes: 21 additions & 48 deletions src/PHP.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -191,6 +191,10 @@ public function create( $args, $assoc_args ) {
$this->logger->debug( 'args:', $args );
$this->logger->debug( 'assoc_args:', empty( $assoc_args ) ? array( 'NULL' ) : $assoc_args );
$this->site_data['site_url'] = strtolower( \EE\Utils\remove_trailing_slash( $args[0] ) );
// site-command's create router validates too; this guard keeps an older site-command working.
if ( function_exists( '\EE\Site\Utils\validate_site_name' ) ) {
\EE\Site\Utils\validate_site_name( $this->site_data['site_url'] );
}

if ( Site::find( $this->site_data['site_url'] ) ) {
\EE::error( sprintf( "Site %1\$s already exists. If you want to re-create it please delete the older one using:\n`ee site delete %1\$s`", $this->site_data['site_url'] ) );
Expand Down Expand Up @@ -704,34 +708,31 @@ private function maybe_verify_remote_db_connection() {

\EE::log( 'Verifying connection to remote database' );

$check_db_connection = sprintf(
"docker exec %s sh -c \"mysql --host='%s' --port='%s' --user='%s' --password='%s' --execute='EXIT'\"",
$container_name,
$db_host,
$this->site_data['db_port'],
$this->site_data['db_user'],
$this->site_data['db_password']
// Each value is quoted for the shell inside the container, then the whole script for the host shell.
$db_args = sprintf(
'--host=%s --port=%s --user=%s --password=%s',
escapeshellarg( $db_host ),
escapeshellarg( $this->site_data['db_port'] ),
escapeshellarg( $this->site_data['db_user'] ),
escapeshellarg( $this->site_data['db_password'] )
);
$db_exec = function ( $shell, $script ) use ( $container_name ) {
return sprintf( 'docker exec %s %s -c %s', $container_name, $shell, escapeshellarg( $script ) );
};
Comment thread
mrrobot47 marked this conversation as resolved.

$check_db_connection = $db_exec( 'sh', "mysql $db_args --execute='EXIT'" );
if ( ! \EE::exec( $check_db_connection ) ) {
\EE::exec( "docker rm -f $container_name" );
throw new \Exception( 'Unable to connect to remote db' );
}
\EE::success( 'Connection to remote db verified' );

$name = str_replace( '_', '\_', $this->site_data['db_name'] );
$check_db_exists = sprintf( "docker exec %s bash -c \"mysqlshow --user='%s' --password='%s' --host='%s' --port='%s' '%s'\"", $container_name, $this->site_data['db_user'], $this->site_data['db_password'], $db_host, $this->site_data['db_port'], $name );
$check_db_exists = $db_exec( 'bash', "mysqlshow $db_args " . escapeshellarg( $name ) );

if ( ! \EE::exec( $check_db_exists ) ) {
\EE::log( sprintf( 'Database `%s` does not exist. Attempting to create it.', $this->site_data['db_name'] ) );
$create_db_command = sprintf(
"docker exec %s bash -c \"mysql --host='%s' --port='%s' --user='%s' --password='%s' --execute='CREATE DATABASE %s;'\"",
$container_name,
$db_host,
$this->site_data['db_port'],
$this->site_data['db_user'],
$this->site_data['db_password'],
$this->site_data['db_name']
);
$create_db_command = $db_exec( 'bash', "mysql $db_args --execute=" . escapeshellarg( 'CREATE DATABASE ' . $this->site_data['db_name'] . ';' ) );
Comment thread
mrrobot47 marked this conversation as resolved.

if ( ! \EE::exec( $create_db_command ) ) {
\EE::exec( "docker rm -f $container_name" );
Expand All @@ -745,38 +746,10 @@ private function maybe_verify_remote_db_connection() {
}
} else {
if ( $this->force ) {
\EE::exec(
sprintf(
"docker exec %s bash -c \"mysql --host='%s' --port='%s' --user='%s' --password='%s' --execute='DROP DATABASE %s;'\"",
$container_name,
$db_host,
$this->site_data['db_port'],
$this->site_data['db_user'],
$this->site_data['db_password'],
$this->site_data['db_name']
)
);
\EE::exec(
sprintf(
"docker exec %s bash -c \"mysql --host='%s' --port='%s' --user='%s' --password='%s' --execute='CREATE DATABASE %s;'\"",
$container_name,
$db_host,
$this->site_data['db_port'],
$this->site_data['db_user'],
$this->site_data['db_password'],
$this->site_data['db_name']
)
);
\EE::exec( $db_exec( 'bash', "mysql $db_args --execute=" . escapeshellarg( 'DROP DATABASE ' . $this->site_data['db_name'] . ';' ) ) );
\EE::exec( $db_exec( 'bash', "mysql $db_args --execute=" . escapeshellarg( 'CREATE DATABASE ' . $this->site_data['db_name'] . ';' ) ) );
}
$check_tables = sprintf(
"docker exec %s bash -c \"mysql --host='%s' --port='%s' --user='%s' --password='%s' --execute='USE %s; show tables;'\"",
$container_name,
$db_host,
$this->site_data['db_port'],
$this->site_data['db_user'],
$this->site_data['db_password'],
$this->site_data['db_name']
);
$check_tables = $db_exec( 'bash', "mysql $db_args --execute=" . escapeshellarg( 'USE ' . $this->site_data['db_name'] . '; show tables;' ) );

$launch = \EE::launch( $check_tables );
if ( ! $launch->return_code ) {
Expand Down
Loading