| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440 |
- <?php
- /**
- * Debug/Status page
- *
- * @package WooCommerce\Admin\System Status
- * @version 2.2.0
- */
- use Automattic\Jetpack\Constants;
- use Automattic\WooCommerce\Utilities\ArrayUtil;
- defined( 'ABSPATH' ) || exit;
- /**
- * WC_Admin_Status Class.
- */
- class WC_Admin_Status {
- /**
- * Handles output of the reports page in admin.
- */
- public static function output() {
- include_once __DIR__ . '/views/html-admin-page-status.php';
- }
- /**
- * Handles output of report.
- */
- public static function status_report() {
- include_once __DIR__ . '/views/html-admin-page-status-report.php';
- }
- /**
- * Handles output of tools.
- */
- public static function status_tools() {
- if ( ! class_exists( 'WC_REST_System_Status_Tools_Controller' ) ) {
- wp_die( 'Cannot load the REST API to access WC_REST_System_Status_Tools_Controller.' );
- }
- $tools = self::get_tools();
- $tool_requires_refresh = false;
- if ( ! empty( $_GET['action'] ) && ! empty( $_REQUEST['_wpnonce'] ) && wp_verify_nonce( wp_unslash( $_REQUEST['_wpnonce'] ), 'debug_action' ) ) { // WPCS: input var ok, sanitization ok.
- $tools_controller = new WC_REST_System_Status_Tools_Controller();
- $action = wc_clean( wp_unslash( $_GET['action'] ) ); // WPCS: input var ok.
- if ( array_key_exists( $action, $tools ) ) {
- $response = $tools_controller->execute_tool( $action );
- $tool = $tools[ $action ];
- $tool_requires_refresh = ArrayUtil::get_value_or_default( $tool, 'requires_refresh', false );
- $tool = array(
- 'id' => $action,
- 'name' => $tool['name'],
- 'action' => $tool['button'],
- 'description' => $tool['desc'],
- 'disabled' => ArrayUtil::get_value_or_default( $tool, 'disabled', false ),
- );
- $tool = array_merge( $tool, $response );
- /**
- * Fires after a WooCommerce system status tool has been executed.
- *
- * @param array $tool Details about the tool that has been executed.
- */
- do_action( 'woocommerce_system_status_tool_executed', $tool );
- } else {
- $response = array(
- 'success' => false,
- 'message' => __( 'Tool does not exist.', 'woocommerce' ),
- );
- }
- if ( $response['success'] ) {
- echo '<div class="updated inline"><p>' . esc_html( $response['message'] ) . '</p></div>';
- } else {
- echo '<div class="error inline"><p>' . esc_html( $response['message'] ) . '</p></div>';
- }
- }
- // Display message if settings settings have been saved.
- if ( isset( $_REQUEST['settings-updated'] ) ) { // WPCS: input var ok.
- echo '<div class="updated inline"><p>' . esc_html__( 'Your changes have been saved.', 'woocommerce' ) . '</p></div>';
- }
- if ( $tool_requires_refresh ) {
- $tools = self::get_tools();
- }
- include_once __DIR__ . '/views/html-admin-page-status-tools.php';
- }
- /**
- * Get tools.
- *
- * @return array of tools
- */
- public static function get_tools() {
- $tools_controller = new WC_REST_System_Status_Tools_Controller();
- return $tools_controller->get_tools();
- }
- /**
- * Show the logs page.
- */
- public static function status_logs() {
- $log_handler = Constants::get_constant( 'WC_LOG_HANDLER' );
- if ( 'WC_Log_Handler_DB' === $log_handler ) {
- self::status_logs_db();
- } else {
- self::status_logs_file();
- }
- }
- /**
- * Show the log page contents for file log handler.
- */
- public static function status_logs_file() {
- $logs = self::scan_log_files();
- if ( ! empty( $_REQUEST['log_file'] ) && isset( $logs[ sanitize_title( wp_unslash( $_REQUEST['log_file'] ) ) ] ) ) { // WPCS: input var ok, CSRF ok.
- $viewed_log = $logs[ sanitize_title( wp_unslash( $_REQUEST['log_file'] ) ) ]; // WPCS: input var ok, CSRF ok.
- } elseif ( ! empty( $logs ) ) {
- $viewed_log = current( $logs );
- }
- $handle = ! empty( $viewed_log ) ? self::get_log_file_handle( $viewed_log ) : '';
- if ( ! empty( $_REQUEST['handle'] ) ) { // WPCS: input var ok, CSRF ok.
- self::remove_log();
- }
- include_once __DIR__ . '/views/html-admin-page-status-logs.php';
- }
- /**
- * Show the log page contents for db log handler.
- */
- public static function status_logs_db() {
- if ( ! empty( $_REQUEST['flush-logs'] ) ) { // WPCS: input var ok, CSRF ok.
- self::flush_db_logs();
- }
- if ( isset( $_REQUEST['action'] ) && isset( $_REQUEST['log'] ) ) { // WPCS: input var ok, CSRF ok.
- self::log_table_bulk_actions();
- }
- $log_table_list = new WC_Admin_Log_Table_List();
- $log_table_list->prepare_items();
- include_once __DIR__ . '/views/html-admin-page-status-logs-db.php';
- }
- /**
- * Retrieve metadata from a file. Based on WP Core's get_file_data function.
- *
- * @since 2.1.1
- * @param string $file Path to the file.
- * @return string
- */
- public static function get_file_version( $file ) {
- // Avoid notices if file does not exist.
- if ( ! file_exists( $file ) ) {
- return '';
- }
- // We don't need to write to the file, so just open for reading.
- $fp = fopen( $file, 'r' ); // @codingStandardsIgnoreLine.
- // Pull only the first 8kiB of the file in.
- $file_data = fread( $fp, 8192 ); // @codingStandardsIgnoreLine.
- // PHP will close file handle, but we are good citizens.
- fclose( $fp ); // @codingStandardsIgnoreLine.
- // Make sure we catch CR-only line endings.
- $file_data = str_replace( "\r", "\n", $file_data );
- $version = '';
- if ( preg_match( '/^[ \t\/*#@]*' . preg_quote( '@version', '/' ) . '(.*)$/mi', $file_data, $match ) && $match[1] ) {
- $version = _cleanup_header_comment( $match[1] );
- }
- return $version;
- }
- /**
- * Return the log file handle.
- *
- * @param string $filename Filename to get the handle for.
- * @return string
- */
- public static function get_log_file_handle( $filename ) {
- return substr( $filename, 0, strlen( $filename ) > 48 ? strlen( $filename ) - 48 : strlen( $filename ) - 4 );
- }
- /**
- * Scan the template files.
- *
- * @param string $template_path Path to the template directory.
- * @return array
- */
- public static function scan_template_files( $template_path ) {
- $files = @scandir( $template_path ); // @codingStandardsIgnoreLine.
- $result = array();
- if ( ! empty( $files ) ) {
- foreach ( $files as $key => $value ) {
- if ( ! in_array( $value, array( '.', '..' ), true ) ) {
- if ( is_dir( $template_path . DIRECTORY_SEPARATOR . $value ) ) {
- $sub_files = self::scan_template_files( $template_path . DIRECTORY_SEPARATOR . $value );
- foreach ( $sub_files as $sub_file ) {
- $result[] = $value . DIRECTORY_SEPARATOR . $sub_file;
- }
- } else {
- $result[] = $value;
- }
- }
- }
- }
- return $result;
- }
- /**
- * Scan the log files.
- *
- * @return array
- */
- public static function scan_log_files() {
- return WC_Log_Handler_File::get_log_files();
- }
- /**
- * Get latest version of a theme by slug.
- *
- * @param object $theme WP_Theme object.
- * @return string Version number if found.
- */
- public static function get_latest_theme_version( $theme ) {
- include_once ABSPATH . 'wp-admin/includes/theme.php';
- $api = themes_api(
- 'theme_information',
- array(
- 'slug' => $theme->get_stylesheet(),
- 'fields' => array(
- 'sections' => false,
- 'tags' => false,
- ),
- )
- );
- $update_theme_version = 0;
- // Check .org for updates.
- if ( is_object( $api ) && ! is_wp_error( $api ) ) {
- $update_theme_version = $api->version;
- } elseif ( strstr( $theme->{'Author URI'}, 'woothemes' ) ) { // Check WooThemes Theme Version.
- $theme_dir = substr( strtolower( str_replace( ' ', '', $theme->Name ) ), 0, 45 ); // @codingStandardsIgnoreLine.
- $theme_version_data = get_transient( $theme_dir . '_version_data' );
- if ( false === $theme_version_data ) {
- $theme_changelog = wp_safe_remote_get( 'http://dzv365zjfbd8v.cloudfront.net/changelogs/' . $theme_dir . '/changelog.txt' );
- $cl_lines = explode( "\n", wp_remote_retrieve_body( $theme_changelog ) );
- if ( ! empty( $cl_lines ) ) {
- foreach ( $cl_lines as $line_num => $cl_line ) {
- if ( preg_match( '/^[0-9]/', $cl_line ) ) {
- $theme_date = str_replace( '.', '-', trim( substr( $cl_line, 0, strpos( $cl_line, '-' ) ) ) );
- $theme_version = preg_replace( '~[^0-9,.]~', '', stristr( $cl_line, 'version' ) );
- $theme_update = trim( str_replace( '*', '', $cl_lines[ $line_num + 1 ] ) );
- $theme_version_data = array(
- 'date' => $theme_date,
- 'version' => $theme_version,
- 'update' => $theme_update,
- 'changelog' => $theme_changelog,
- );
- set_transient( $theme_dir . '_version_data', $theme_version_data, DAY_IN_SECONDS );
- break;
- }
- }
- }
- }
- if ( ! empty( $theme_version_data['version'] ) ) {
- $update_theme_version = $theme_version_data['version'];
- }
- }
- return $update_theme_version;
- }
- /**
- * Remove/delete the chosen file.
- */
- public static function remove_log() {
- if ( empty( $_REQUEST['_wpnonce'] ) || ! wp_verify_nonce( wp_unslash( $_REQUEST['_wpnonce'] ), 'remove_log' ) ) { // WPCS: input var ok, sanitization ok.
- wp_die( esc_html__( 'Action failed. Please refresh the page and retry.', 'woocommerce' ) );
- }
- if ( ! empty( $_REQUEST['handle'] ) ) { // WPCS: input var ok.
- $log_handler = new WC_Log_Handler_File();
- $log_handler->remove( wp_unslash( $_REQUEST['handle'] ) ); // WPCS: input var ok, sanitization ok.
- }
- wp_safe_redirect( esc_url_raw( admin_url( 'admin.php?page=wc-status&tab=logs' ) ) );
- exit();
- }
- /**
- * Clear DB log table.
- *
- * @since 3.0.0
- */
- private static function flush_db_logs() {
- if ( empty( $_REQUEST['_wpnonce'] ) || ! wp_verify_nonce( $_REQUEST['_wpnonce'], 'woocommerce-status-logs' ) ) { // WPCS: input var ok, sanitization ok.
- wp_die( esc_html__( 'Action failed. Please refresh the page and retry.', 'woocommerce' ) );
- }
- WC_Log_Handler_DB::flush();
- wp_safe_redirect( esc_url_raw( admin_url( 'admin.php?page=wc-status&tab=logs' ) ) );
- exit();
- }
- /**
- * Bulk DB log table actions.
- *
- * @since 3.0.0
- */
- private static function log_table_bulk_actions() {
- if ( empty( $_REQUEST['_wpnonce'] ) || ! wp_verify_nonce( $_REQUEST['_wpnonce'], 'woocommerce-status-logs' ) ) { // WPCS: input var ok, sanitization ok.
- wp_die( esc_html__( 'Action failed. Please refresh the page and retry.', 'woocommerce' ) );
- }
- $log_ids = array_map( 'absint', (array) isset( $_REQUEST['log'] ) ? wp_unslash( $_REQUEST['log'] ) : array() ); // WPCS: input var ok, sanitization ok.
- if ( ( isset( $_REQUEST['action'] ) && 'delete' === $_REQUEST['action'] ) || ( isset( $_REQUEST['action2'] ) && 'delete' === $_REQUEST['action2'] ) ) { // WPCS: input var ok, sanitization ok.
- WC_Log_Handler_DB::delete( $log_ids );
- wp_safe_redirect( esc_url_raw( admin_url( 'admin.php?page=wc-status&tab=logs' ) ) );
- exit();
- }
- }
- /**
- * Prints table info if a base table is not present.
- */
- private static function output_tables_info() {
- $missing_tables = WC_Install::verify_base_tables( false );
- if ( 0 === count( $missing_tables ) ) {
- return;
- }
- ?>
- <br>
- <strong style="color:#a00;">
- <span class="dashicons dashicons-warning"></span>
- <?php
- echo esc_html(
- sprintf(
- // translators: Comma seperated list of missing tables.
- __( 'Missing base tables: %s. Some WooCommerce functionality may not work as expected.', 'woocommerce' ),
- implode( ', ', $missing_tables )
- )
- );
- ?>
- </strong>
- <?php
- }
- /**
- * Prints the information about plugins for the system status report.
- * Used for both active and inactive plugins sections.
- *
- * @param array $plugins List of plugins to display.
- * @param array $untested_plugins List of plugins that haven't been tested with the current WooCommerce version.
- * @return void
- */
- private static function output_plugins_info( $plugins, $untested_plugins ) {
- $wc_version = Constants::get_constant( 'WC_VERSION' );
- if ( 'major' === Constants::get_constant( 'WC_SSR_PLUGIN_UPDATE_RELEASE_VERSION_TYPE' ) ) {
- // Since we're only testing against major, we don't need to show minor and patch version.
- $wc_version = $wc_version[0] . '.0';
- }
- foreach ( $plugins as $plugin ) {
- if ( ! empty( $plugin['name'] ) ) {
- // Link the plugin name to the plugin url if available.
- $plugin_name = esc_html( $plugin['name'] );
- if ( ! empty( $plugin['url'] ) ) {
- $plugin_name = '<a href="' . esc_url( $plugin['url'] ) . '" aria-label="' . esc_attr__( 'Visit plugin homepage', 'woocommerce' ) . '" target="_blank">' . $plugin_name . '</a>';
- }
- $has_newer_version = false;
- $version_string = $plugin['version'];
- $network_string = '';
- if ( strstr( $plugin['url'], 'woothemes.com' ) || strstr( $plugin['url'], 'woocommerce.com' ) ) {
- if ( ! empty( $plugin['version_latest'] ) && version_compare( $plugin['version_latest'], $plugin['version'], '>' ) ) {
- /* translators: 1: current version. 2: latest version */
- $version_string = sprintf( __( '%1$s (update to version %2$s is available)', 'woocommerce' ), $plugin['version'], $plugin['version_latest'] );
- }
- if ( false !== $plugin['network_activated'] ) {
- $network_string = ' – <strong style="color: black;">' . esc_html__( 'Network enabled', 'woocommerce' ) . '</strong>';
- }
- }
- $untested_string = '';
- if ( array_key_exists( $plugin['plugin'], $untested_plugins ) ) {
- $untested_string = ' – <strong style="color: #a00;">';
- /* translators: %s: version */
- $untested_string .= esc_html( sprintf( __( 'Installed version not tested with active version of WooCommerce %s', 'woocommerce' ), $wc_version ) );
- $untested_string .= '</strong>';
- }
- ?>
- <tr>
- <td><?php echo wp_kses_post( $plugin_name ); ?></td>
- <td class="help"> </td>
- <td>
- <?php
- /* translators: %s: plugin author */
- printf( esc_html__( 'by %s', 'woocommerce' ), esc_html( $plugin['author_name'] ) );
- echo ' – ' . esc_html( $version_string ) . $untested_string . $network_string; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
- ?>
- </td>
- </tr>
- <?php
- }
- }
- }
- }
|