Repository navigation
fix(ssl): keep the WordPress URLs on http while the site is served over HTTP #247
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.
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
Changes from all commits
400e0f3
9e4da51
a5c9cf3
8e27c66
dcc3d64
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -1004,7 +1004,7 @@ private function create_site( $assoc_args ) { | |
| if ( 'custom' === $this->site_data['site_ssl'] ) { | ||
| $this->custom_site_ssl(); | ||
| } | ||
| $this->www_ssl_wrapper( [ 'nginx' ] ); | ||
| $this->run_ssl_step(); | ||
| } catch ( \Exception $e ) { | ||
| $this->catch_clean( $e ); | ||
| } | ||
|
|
@@ -1051,6 +1051,21 @@ private function create_site( $assoc_args ) { | |
| $this->info( [ $this->site_data['site_url'] ], [] ); | ||
| } | ||
|
|
||
| /** | ||
| * Runs the certificate step and switches the URLs back to http when the site isn't served over HTTPS afterwards. | ||
| */ | ||
| private function run_ssl_step() { | ||
|
|
||
| // install_wp() used https:// URLs for any SSL type. | ||
| $installed_with_https = ! $this->skip_install && ! empty( $this->site_data['site_ssl'] ); | ||
|
|
||
| $this->www_ssl_wrapper( [ 'nginx' ] ); | ||
|
|
||
| if ( $installed_with_https && ! $this->serves_https() ) { | ||
| $this->replace_url_scheme( 'https', 'http', false ); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Download WordPress core into the site, retrying transient failures. | ||
| * | ||
|
|
@@ -1462,38 +1477,127 @@ private function create_site_db_entry() { | |
| protected function update_ssl( $assoc_args ) { | ||
|
|
||
| parent::update_ssl( $assoc_args ); | ||
|
|
||
| $ssl = get_flag_value( $assoc_args, 'ssl' ); | ||
| // A manual DNS-01 challenge keeps the site on HTTP; site_scheme_changed() switches the URLs once ssl-verify succeeds. | ||
| if ( 'off' !== $ssl && ! $this->serves_https() ) { | ||
| return; | ||
| } | ||
|
|
||
| $this->replace_url_scheme( 'off' === $ssl ? 'https' : 'http', 'off' === $ssl ? 'http' : 'https' ); | ||
| } | ||
|
|
||
| /** | ||
| * Switches the WordPress URLs when site-command changes the site's scheme outside `ee site update --ssl`. | ||
| * | ||
| * @param string $scheme The scheme the site is served over now: http or https. | ||
| */ | ||
| protected function site_scheme_changed( $scheme ) { | ||
|
|
||
| chdir( $this->site_data['site_fs_path'] ); | ||
| // A site created with --skip-install has no URLs to switch yet. | ||
| if ( ! EE::exec( \EE_DOCKER::docker_compose_with_custom() . ' exec php wp core is-installed' ) ) { | ||
| return; | ||
| } | ||
|
|
||
| EE::log( 'Running search-replace.' ); | ||
| EE::log( 'Taking database backup before search-replace.' ); | ||
| EE::exec( sprintf( \EE_DOCKER::docker_compose_with_custom() . ' exec php wp db export --skip-ssl %s.db', $this->site_data['site_url'] ) ); | ||
| $this->replace_url_scheme( 'https' === $scheme ? 'http' : 'https', $scheme ); | ||
| } | ||
|
|
||
| $db_file = $this->site_data['site_fs_path'] . '/app/htdocs/' . $this->site_data['site_url'] . '.db'; | ||
| /** | ||
| * Whether the site is served over HTTPS. site-command keeps it on HTTP when its certificate could not be issued (it | ||
| * clears site_ssl) and while a manual DNS-01 challenge waits for `ee site ssl-verify`. | ||
| * | ||
| * @return bool | ||
| */ | ||
| private function serves_https() { | ||
|
|
||
| if ( empty( $this->site_data['site_ssl'] ) ) { | ||
| return false; | ||
| } | ||
|
|
||
| // Older site-command versions have no pending state. | ||
| return ! function_exists( '\EE\Site\Utils\is_le_ssl_pending' ) || ! \EE\Site\Utils\is_le_ssl_pending( $this->site_data['site_url'], $this->site_data['site_ssl'] ); | ||
| } | ||
|
|
||
| /** | ||
| * Rewrites the site's URLs in its database from one scheme to the other. | ||
| * | ||
| * @param string $from Scheme of the URLs now. | ||
| * @param string $to Scheme to switch them to. | ||
| * @param bool $backup Whether to export the database first. | ||
| */ | ||
| private function replace_url_scheme( $from, $to, $backup = true ) { | ||
|
|
||
| chdir( $this->site_data['site_fs_path'] ); | ||
|
|
||
| EE::log( 'Running search-replace.' ); | ||
| $backup_success = false; | ||
| $backup_location = EE_BACKUP_DIR . '/' . $this->site_data['site_url'] . '/' . $this->site_data['site_url'] . '.db'; | ||
| $this->fs->mkdir( dirname( $backup_location ) ); | ||
| if ( $backup ) { | ||
| EE::log( 'Taking database backup before search-replace.' ); | ||
| EE::exec( sprintf( \EE_DOCKER::docker_compose_with_custom() . ' exec php wp db export --skip-ssl %s.db', $this->site_data['site_url'] ) ); | ||
|
|
||
| $db_file = $this->site_data['site_fs_path'] . '/app/htdocs/' . $this->site_data['site_url'] . '.db'; | ||
| $this->fs->mkdir( dirname( $backup_location ) ); | ||
|
|
||
| $backup_success = false; | ||
| if ( $this->fs->exists( $db_file ) ) { | ||
| $this->fs->remove( $backup_location ); | ||
| $this->fs->rename( $db_file, $backup_location ); | ||
| $backup_success = true; | ||
| if ( $this->fs->exists( $db_file ) ) { | ||
| $this->fs->remove( $backup_location ); | ||
| $this->fs->rename( $db_file, $backup_location ); | ||
| $backup_success = true; | ||
| } | ||
| } | ||
|
|
||
| $extra_flags = '--precise'; | ||
| $extra_flags .= ( 'wp' === $this->site_data['app_sub_type'] ) ? '' : ' --network'; | ||
|
|
||
| $ssl = get_flag_value( $assoc_args, 'ssl' ); | ||
| $from = $ssl === 'off' ? 'https' : 'http'; | ||
| $to = $ssl === 'off' ? 'http' : 'https'; | ||
| $search_replace = sprintf( 'wp search-replace %2$s://%1$s %3$s://%1$s %4$s', $this->site_data['site_url'], $from, $to, $extra_flags ); | ||
|
coderabbitai[bot] marked this conversation as resolved.
Resolved
|
||
| if ( EE::exec( \EE_DOCKER::docker_compose_with_custom() . ' exec php ' . $search_replace, true, true ) ) { | ||
| EE::success( 'Successfully completed search-replace.' ); | ||
| } else { | ||
| EE::warning( sprintf( 'The site URLs could not be switched to %1$s. Run `ee shell %2$s --command=\'%3$s\'` to switch them.', $to, $this->site_data['site_url'], $search_replace ) ); | ||
| } | ||
|
|
||
| EE::exec( sprintf( \EE_DOCKER::docker_compose_with_custom() . ' exec php wp search-replace %2$s://%1$s %3$s://%1$s %4$s', $this->site_data['site_url'], $from, $to, $extra_flags ), true, true ); | ||
| EE::success( 'Successfully completed search-replace.' ); | ||
| if ( 'subdom' === $this->site_data['app_sub_type'] ) { | ||
| $this->replace_subsite_url_scheme( $from, $to ); | ||
| } | ||
|
|
||
| if ( $backup_success ) { | ||
| EE::log( "In case something is not working as intended, you can restore your DB from backup file generated before search-replace located at:\n `$backup_location`\nand proceed with search-replace according to your needs." ); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Switches the scheme of the subdomain subsites, whose origins the network-wide search for the site's own origin doesn't match. | ||
| * | ||
| * @param string $from Scheme of the URLs now. | ||
| * @param string $to Scheme to switch them to. | ||
| */ | ||
| private function replace_subsite_url_scheme( $from, $to ) { | ||
|
|
||
| $compose = \EE_DOCKER::docker_compose_with_custom(); | ||
| $sites = EE::launch( $compose . ' exec -T php wp site list --field=url' ); | ||
| if ( $sites->return_code ) { | ||
| EE::warning( 'Could not list the subsites, so their URLs were not switched to ' . $to . '.' ); | ||
|
|
||
| return; | ||
| } | ||
|
|
||
| $suffix = '.' . $this->site_data['site_url']; | ||
| foreach ( preg_split( '/\R/', trim( $sites->stdout ) ) as $url ) { | ||
| $host = (string) parse_url( trim( $url ), PHP_URL_HOST ); | ||
| // Only subdomains of the site are covered by its certificate; mapped domains keep their scheme. | ||
| // The host goes into a shell command unquoted, so accept plain hostnames only. | ||
| if ( parse_url( trim( $url ), PHP_URL_SCHEME ) !== $from || substr( $host, -strlen( $suffix ) ) !== $suffix || ! preg_match( '/^[a-z0-9.-]+$/i', $host ) ) { | ||
| continue; | ||
| } | ||
|
|
||
| $search_replace = sprintf( 'wp search-replace %2$s://%1$s %3$s://%1$s --precise --network', $host, $from, $to ); | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Match the complete host before replacing its scheme. If the network contains
|
||
| if ( ! EE::exec( $compose . ' exec php ' . $search_replace, true, true ) ) { | ||
| EE::warning( sprintf( 'The URLs of %1$s could not be switched to %2$s. Run `ee shell %3$s --command=\'%4$s\'` to switch them.', $host, $to, $this->site_data['site_url'], $search_replace ) ); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Restarts containers associated with site. | ||
| * When no service(--nginx etc.) is specified, all site containers will be restarted. | ||
|
|
||
Uh oh!
There was an error while loading. Please reload this page.