<?php
namespace WPMailSMTP;
use WPMailSMTP\Admin\Area;
use WPMailSMTP\Admin\DomainChecker;
/**
* Class SiteHealth adds the plugin status and information to the WP Site Health admin page.
*
* @since 1.9.0
*/
class SiteHealth {
/**
* String of a badge color.
* Options: blue, green, red, orange, purple and gray.
*
* @see https://make.wordpress.org/core/2019/04/25/site-health-check-in-5-2/
*
* @since 1.9.0
*/
const BADGE_COLOR = 'blue';
/**
* Debug info plugin slug.
* This should be a plugin unique string, which will be used in the WP Site Health page,
* for the "info" tab and will present the plugin info section.
*
* @since 1.9.0
*/
const DEBUG_INFO_SLUG = 'wp_mail_smtp';
/**
* Translatable string for the plugin label.
*
* @since 1.9.0
*
* @return string
*/
public function get_label() {
return esc_html__( 'WP Mail SMTP', 'wp-mail-smtp' );
}
/**
* Initialize the site heath functionality.
*
* @since 1.9.0
*/
public function init() {
// Enqueue site health page scripts and styles.
add_action( 'admin_enqueue_scripts', [ $this, 'enqueue_assets' ] );
add_filter( 'site_status_tests', array( $this, 'register_site_status_tests' ) );
add_filter( 'debug_information', array( $this, 'register_debug_information' ) );
// Register async test hooks.
add_action( 'wp_ajax_health-check-email-domain_check_test', array( $this, 'email_domain_check_test' ) );
}
/**
* Enqueue site health page scripts and styles.
*
* @since 2.8.0
*
* @param string $hook Current hook.
*/
public function enqueue_assets( $hook ) {
if ( $hook !== 'site-health.php' ) {
return;
}
wp_enqueue_style(
'wp-mail-smtp-site-health',
\wp_mail_smtp()->assets_url . '/css/admin-site-health.min.css',
false,
WPMS_PLUGIN_VER
);
}
/**
* Register plugin WP site health tests.
* This will be displayed in the "Status" tab of the WP Site Health page.
*
* @since 1.9.0
*
* @param array $tests The array with all WP site health tests.
*
* @return array
*/
public function register_site_status_tests( $tests ) {
$tests['direct']['wp_mail_smtp_mailer_setup_complete'] = array(
'label' => esc_html__( 'Is WP Mail SMTP mailer setup complete?', 'wp-mail-smtp' ),
'test' => array( $this, 'mailer_setup_complete_test' ),
);
$tests['direct']['wp_mail_smtp_db_tables_exist'] = array(
'label' => esc_html__( 'Do WP Mail SMTP DB tables exist?', 'wp-mail-smtp' ),
'test' => [ $this, 'db_tables_test' ],
);
$tests['async']['wp_mail_smtp_email_domain_check'] = array(
'label' => esc_html__( 'Is email domain configured properly?', 'wp-mail-smtp' ),
'test' => 'email_domain_check_test',
);
return $tests;
}
/**
* Register plugin WP Site Health debug information.
* This will be displayed in the "Info" tab of the WP Site Health page.
*
* @since 1.9.0
*
* @param array $debug_info Array of existing debug information.
*
* @return array
*/
public function register_debug_information( $debug_info ) {
$debug_notices = Debug::get();
$db_tables = $this->get_db_tables( 'existing' );
$debug_info[ self::DEBUG_INFO_SLUG ] = [
'label' => $this->get_label(),
'fields' => [
'version' => [
'label' => esc_html__( 'Version', 'wp-mail-smtp' ),
'value' => WPMS_PLUGIN_VER,
],
'license_key_type' => [
'label' => esc_html__( 'License key type', 'wp-mail-smtp' ),
'value' => wp_mail_smtp()->get_license_type(),
],
'debug' => [
'label' => esc_html__( 'Debug', 'wp-mail-smtp' ),
'value' => ! empty( $debug_notices ) ? implode( '; ', $debug_notices ) : esc_html__( 'No debug notices found.', 'wp-mail-smtp' ),
],
'db_tables' => [
'label' => esc_html__( 'DB tables', 'wp-mail-smtp' ),
'value' => ! empty( $db_tables ) ?
implode( ', ', $db_tables ) : esc_html__( 'No DB tables found.', 'wp-mail-smtp' ),
'private' => true,
],
],
];
// Install date.
$activated = get_option( 'wp_mail_smtp_activated', [] );
if ( ! empty( $activated['lite'] ) ) {
$date = $activated['lite'] + ( get_option( 'gmt_offset' ) * 3600 );
$debug_info[ self::DEBUG_INFO_SLUG ]['fields']['lite_install_date'] = [
'label' => esc_html__( 'Lite install date', 'wp-mail-smtp' ),
'value' => date_i18n( esc_html__( 'M j, Y @ g:ia' ), $date ),
];
}
return $debug_info;
}
/**
* Perform the WP site health test for checking, if the mailer setup is complete.
*
* @since 1.9.0
*/
public function mailer_setup_complete_test() {
$mailer = Options::init()->get( 'mail', 'mailer' );
$mailer_complete = false;
$mailer_title = esc_html__( 'None selected', 'wp-mail-smtp' );
if ( ! empty( $mailer ) ) {
$mailer_object = wp_mail_smtp()
->get_providers()
->get_mailer(
$mailer,
wp_mail_smtp()->get_processor()->get_phpmailer()
);
$mailer_complete = ! empty( $mailer_object ) ? $mailer_object->is_mailer_complete() : false;
$mailer_title = wp_mail_smtp()->get_providers()->get_options( $mailer )->get_title();
}
// The default mailer should be considered as a non-complete mailer.
if ( $mailer === 'mail' ) {
$mailer_complete = false;
}
$mailer_text = sprintf(
'%s: <strong>%s</strong>',
esc_html__( 'Current mailer', 'wp-mail-smtp' ),
esc_html( $mailer_title )
);
$result = array(
'label' => esc_html__( 'WP Mail SMTP mailer setup is complete', 'wp-mail-smtp' ),
'status' => 'good',
'badge' => array(
'label' => $this->get_label(),
'color' => self::BADGE_COLOR,
),
'description' => sprintf(
'<p>%s</p><p>%s</p>',
$mailer_text,
esc_html__( 'The WP Mail SMTP plugin mailer setup is complete. You can send a test email, to make sure it\'s working properly.', 'wp-mail-smtp' )
),
'actions' => sprintf(
'<p><a href="%s">%s</a></p>',
esc_url( add_query_arg( 'tab', 'test', wp_mail_smtp()->get_admin()->get_admin_page_url( Area::SLUG . '-tools' ) ) ),
esc_html__( 'Test email sending', 'wp-mail-smtp' )
),
'test' => 'wp_mail_smtp_mailer_setup_complete',
);
if ( $mailer === 'mail' ) {
$mailer_text .= sprintf( /* translators: %s - explanation why default mailer is not a valid mailer option. */
'<p>%s</p>',
esc_html__( 'You currently have the default mailer selected, which means that you haven’t set up SMTP yet.', 'wp-mail-smtp' )
);
}
if ( $mailer_complete === false ) {
$result['label'] = esc_html__( 'WP Mail SMTP mailer setup is incomplete', 'wp-mail-smtp' );
$result['status'] = 'recommended';
$result['badge']['color'] = 'orange';
$result['description'] = sprintf(
'<p>%s</p><p>%s</p>',
$mailer_text,
esc_html__( 'The WP Mail SMTP plugin mailer setup is incomplete. Please click on the link below to access plugin settings and configure the mailer.', 'wp-mail-smtp' )
);
$result['actions'] = sprintf(
'<p><a href="%s">%s</a></p>',
esc_url( wp_mail_smtp()->get_admin()->get_admin_page_url() ),
esc_html__( 'Configure mailer', 'wp-mail-smtp' )
);
}
return $result;
}
/**
* Perform the test for checking if all custom plugin DB tables exist.
*
* @since 2.1.2
*
* @return array
*/
public function db_tables_test() {
$result = array(
'label' => esc_html__( 'WP Mail SMTP DB tables are created', 'wp-mail-smtp' ),
'status' => 'good',
'badge' => array(
'label' => $this->get_label(),
'color' => self::BADGE_COLOR,
),
'description' => esc_html__( 'WP Mail SMTP is using custom database tables for some of its features. In order to work properly, the custom tables should be created, and it looks like they exist in your database.', 'wp-mail-smtp' ),
'actions' => '',
'test' => 'wp_mail_smtp_db_tables_exist',
);
$missing_tables = $this->get_db_tables( 'missing' );
if ( ! empty( $missing_tables ) ) {
$missing_tables_create_link = wp_nonce_url(
add_query_arg(
[
'create-missing-db-tables' => 1,
],
wp_mail_smtp()->get_admin()->get_admin_page_url( Area::SLUG )
),
Area::SLUG . '-create-missing-db-tables'
);
$result['label'] = esc_html__( 'WP Mail SMTP DB tables check has failed', 'wp-mail-smtp' );
$result['status'] = 'critical';
$result['badge']['color'] = 'red';
$result['description'] = sprintf(
'<p>%s</p><p>%s</p>',
sprintf( /* translators: %s - the list of missing tables separated by comma. */
esc_html( _n( 'Missing table: %s', 'Missing tables: %s', count( $missing_tables ), 'wp-mail-smtp' ) ),
esc_html( implode( ', ', $missing_tables ) )
),
wp_kses(
sprintf( /* translators: %1$s - Settings Page URL; %2$s - The aria label; %3$s - The text that will appear on the link. */
__( 'WP Mail SMTP is using custom database tables for some of its features. In order to work properly, the custom tables should be created, and it seems they are missing. Please try to <a href="%1$s" target="_self" aria-label="%2$s" rel="noopener noreferrer">%3$s</a>. If this issue persists, please contact our support.', 'wp-mail-smtp' ),
esc_url( $missing_tables_create_link ),
esc_attr__( 'Go to WP Mail SMTP settings page.', 'wp-mail-smtp' ),
esc_attr__( 'create the missing DB tables by clicking on this link', 'wp-mail-smtp' )
),
[
'a' => [
'href' => [],
'rel' => [],
'target' => [],
'aria-label' => [],
],
]
)
);
}
return $result;
}
/**
* Perform the test (async) for checking if email domain configured properly.
*
* @since 2.8.0
*/
public function email_domain_check_test() {
check_ajax_referer( 'health-check-site-status' );
if ( ! current_user_can( 'view_site_health_checks' ) ) {
wp_send_json_error();
}
$options = Options::init();
$mailer = $options->get( 'mail', 'mailer' );
$email = $options->get( 'mail', 'from_email' );
$domain = '';
$email_domain_text = sprintf(
'%1$s: <strong>%2$s</strong>',
esc_html__( 'Current from email domain', 'wp-mail-smtp' ),
esc_html( WP::get_email_domain( $email ) )
);
$result = array(
'label' => esc_html__( 'Email domain is configured correctly', 'wp-mail-smtp' ),
'status' => 'good',
'badge' => array(
'label' => $this->get_label(),
'color' => self::BADGE_COLOR,
),
'description' => sprintf(
'<p>%1$s</p><p>%2$s</p>',
$email_domain_text,
esc_html__( 'All checks for your email domain were successful. It looks like everything is configured correctly.', 'wp-mail-smtp' )
),
'actions' => sprintf(
'<p><a href="%1$s">%2$s</a></p>',
esc_url( add_query_arg( 'tab', 'test', wp_mail_smtp()->get_admin()->get_admin_page_url( Area::SLUG . '-tools' ) ) ),
esc_html__( 'Send a Test Email', 'wp-mail-smtp' )
),
'test' => 'wp_mail_smtp_email_domain_check',
);
// Add the optional sending domain parameter.
if ( in_array( $mailer, [ 'mailgun', 'sendinblue', 'sendgrid' ], true ) ) {
$domain = $options->get( $mailer, 'domain' );
}
$domain_checker = new DomainChecker( $mailer, $email, $domain );
if ( ! $domain_checker->no_issues() ) {
$result['label'] = esc_html__( 'Email domain issues detected', 'wp-mail-smtp' );
$result['status'] = 'recommended';
$result['description'] = sprintf(
'<p>%1$s</p> %2$s',
$email_domain_text,
$domain_checker->get_results_html()
);
$result['actions'] = sprintf(
'<p><a href="%1$s">%2$s</a></p>',
esc_url( wp_mail_smtp()->get_admin()->get_admin_page_url() ),
esc_html__( 'Configure mailer', 'wp-mail-smtp' )
);
}
wp_send_json_success( $result );
}
/**
* Get the missing tables from the database.
*
* @since 3.6.0
*
* @return array
*/
public function get_missing_db_tables() {
return $this->get_db_tables( 'missing' );
}
/**
* Check DB:
* - if any required plugin DB table is missing,
* - which of the required plugin DB tables exist.
*
* @since 2.1.2
*
* @param string $check Which type of tables to return: 'missing' or 'existing'.
*
* @return array Missing or existing tables.
*/
private function get_db_tables( $check = 'missing' ) {
global $wpdb;
$tables = wp_mail_smtp()->get_custom_db_tables();
$missing_tables = [];
$existing_tables = [];
foreach ( $tables as $table ) {
// phpcs:ignore WordPress.DB.DirectDatabaseQuery.NoCaching
$db_result = $wpdb->get_var( $wpdb->prepare( 'SHOW TABLES LIKE %s', $table ) );
if ( is_null( $db_result ) || strtolower( $db_result ) !== strtolower( $table ) ) {
$missing_tables[] = $table;
} else {
$existing_tables[] = $table;
}
}
return ( $check === 'existing' ) ? $existing_tables : $missing_tables;
}
}