<?php
/**
* ElasticPress Status Report class
*
* @since 4.4.0
* @package elasticpress
*/
namespace ElasticPress\Screen;
use \ElasticPress\Utils;
defined( 'ABSPATH' ) || exit;
/**
* Status Report class
*
* @package ElasticPress
*/
class StatusReport {
/**
* The formatted/processed reports.
*
* @since 4.5.0
* @var array
*/
protected $formatted_reports = [];
/**
* Initialize class
*/
public function setup() {
add_action( 'admin_enqueue_scripts', [ $this, 'admin_enqueue_scripts' ] );
add_action( 'admin_head', array( $this, 'admin_menu_count' ), 11 );
}
/**
* Enqueue script.
*
* @return void
*/
public function admin_enqueue_scripts() {
if ( 'status-report' !== \ElasticPress\Screen::factory()->get_current_screen() ) {
return;
}
$script_deps = Utils\get_asset_info( 'status-report-script', 'dependencies' );
wp_enqueue_script(
'ep_admin_status_report_scripts',
EP_URL . 'dist/js/status-report-script.js',
array_merge( $script_deps, [ 'clipboard' ] ),
Utils\get_asset_info( 'status-report-script', 'version' ),
true
);
wp_localize_script(
'ep_admin_status_report_scripts',
'epStatusReport',
$this->get_formatted_reports()
);
$style_deps = Utils\get_asset_info( 'status-report-styles', 'dependencies' );
wp_enqueue_style(
'ep_status_report_styles',
EP_URL . 'dist/css/status-report-styles.css',
array_merge( $style_deps, [ 'wp-edit-post' ] ),
Utils\get_asset_info( 'status-report-styles', 'version' )
);
}
/**
* Return all reports available
*
* @return array
*/
public function get_reports() : array {
$reports = [];
/* this filter is documented in elasticpress.php */
$query_logger = apply_filters( 'ep_query_logger', new \ElasticPress\QueryLogger() );
if ( $query_logger ) {
$reports['failed-queries'] = new \ElasticPress\StatusReport\FailedQueries( $query_logger );
}
if ( Utils\is_epio() ) {
$reports['autosuggest'] = new \ElasticPress\StatusReport\ElasticPressIo();
}
$reports['wordpress'] = new \ElasticPress\StatusReport\WordPress();
$reports['indexable'] = new \ElasticPress\StatusReport\IndexableContent();
$reports['elasticpress'] = new \ElasticPress\StatusReport\ElasticPress();
$reports['indices'] = new \ElasticPress\StatusReport\Indices();
$reports['last-sync'] = new \ElasticPress\StatusReport\LastSync();
$reports['features'] = new \ElasticPress\StatusReport\Features();
/**
* Filter the reports executed in the Status Report page.
*
* @since 4.4.0
* @hook ep_status_report_reports
* @param {array<Report>} $reports Array of reports
* @return {array<Report>} New array of reports
*/
$filtered_reports = apply_filters( 'ep_status_report_reports', $reports );
$skipped_reports = ! empty( $_GET['ep-skip-reports'] ) ? (array) $_GET['ep-skip-reports'] : []; // phpcs:ignore WordPress.Security.NonceVerification
$skipped_reports = array_map( 'sanitize_text_field', $skipped_reports );
$filtered_reports = array_filter(
$filtered_reports,
function( $report_slug ) use ( $skipped_reports ) {
return ! in_array( $report_slug, $skipped_reports, true );
},
ARRAY_FILTER_USE_KEY
);
return $filtered_reports;
}
/**
* Render all reports (HTML and Copy & Paste button)
*/
public function render_reports() {
$reports = $this->get_formatted_reports();
$copy_paste_output = [];
foreach ( $reports as $report ) {
$title = $report['title'];
$groups = $report['groups'];
$copy_paste_output[] = $this->render_copy_paste_report( $title, $groups );
}
?>
<p><?php esc_html_e( 'This screen provides a list of information related to ElasticPress and synced content that can be helpful during troubleshooting. This list can also be copy/pasted and shared as needed.', 'elasticpress' ); ?></p>
<p class="ep-copy-button-wrapper">
<a download="elasticpress-report.txt" href="data:text/plain;charset=utf-8,<?php echo rawurlencode( implode( "\n\n", $copy_paste_output ) ); ?>" class="button button-primary" id="ep-download-report">
<?php esc_html_e( 'Download report', 'elasticpress' ); ?>
</a>
<button class="button" data-clipboard-text="<?php echo esc_attr( implode( "\n\n", $copy_paste_output ) ); ?>" id="ep-copy-report" type="button">
<?php esc_html_e( 'Copy status report to clipboard', 'elasticpress' ); ?>
</button>
<span class="ep-copy-button-wrapper__success">
<?php esc_html_e( 'Copied!', 'elasticpress' ); ?>
</span>
</p>
<?php
}
/**
* Process and format the reports, then store them in the `formatted_reports` attribute.
*
* @since 4.5.0
* @return array
*/
protected function get_formatted_reports() : array {
if ( empty( $this->formatted_reports ) ) {
$reports = $this->get_reports();
$this->formatted_reports = array_map(
function( $report ) {
return [
'actions' => $report->get_actions(),
'groups' => $report->get_groups(),
'messages' => $report->get_messages(),
'title' => $report->get_title(),
];
},
$reports
);
}
return $this->formatted_reports;
}
/**
* Render the copy & paste report
*
* @param string $title Report title
* @param array $groups Report groups
* @return string
*/
protected function render_copy_paste_report( string $title, array $groups ) : string {
$output = "## {$title} ##\n\n";
foreach ( $groups as $group ) {
$output .= "### {$group['title']} ###\n";
foreach ( $group['fields'] as $slug => $field ) {
$value = $field['value'] ?? '';
$output .= "{$slug}: ";
$output .= $this->render_value( $value );
$output .= "\n";
}
$output .= "\n";
}
return $output;
}
/**
* Render a value based on its type
*
* @param mixed $value The value
* @return string
*/
protected function render_value( $value ) {
if ( is_array( $value ) || is_object( $value ) ) {
return var_export( $value, true ); // phpcs:ignore WordPress.PHP.DevelopmentFunctions
}
if ( is_bool( $value ) ) {
return $value ? 'true' : 'false';
}
return (string) $value;
}
/**
* Display a badge in the admin menu if there's admin notices from
* ElasticPress.io.
*
* @return void
*/
public function admin_menu_count() {
global $menu, $submenu;
$messages = \ElasticPress\ElasticPressIo::factory()->get_endpoint_messages();
if ( empty( $messages ) ) {
return;
}
$count = count( $messages );
$title = sprintf(
/* translators: %d: Number of messages. */
_n( '%s message from ElasticPress.io', '%s messages from ElasticPress.io', $count, 'elasticpress' ),
$count
);
foreach ( $menu as $key => $value ) {
if ( 'elasticpress' === $value[2] ) {
$menu[ $key ][0] .= sprintf(
' <span class="update-plugins"><span aria-hidden="true">%1$s</span><span class="screen-reader-text">%2$s</span></span>',
esc_html( $count ),
esc_attr( $title )
);
}
}
if ( ! isset( $submenu['elasticpress'] ) ) {
return;
}
foreach ( $submenu['elasticpress'] as $key => $value ) {
if ( 'elasticpress-status-report' === $value[2] ) {
$submenu['elasticpress'][ $key ][0] .= sprintf(
' <span class="menu-counter"><span aria-hidden="true">%1$s</span><span class="screen-reader-text">%2$s</span></span>',
esc_html( $count ),
esc_attr( $title )
);
}
}
}
}