From 3293d9ba899e473e7c757f56464196f4b0c062fa Mon Sep 17 00:00:00 2001 From: dmsnell Date: Tue, 10 Sep 2024 00:04:19 +0000 Subject: [PATCH] WP_Debug_Data: Extract `wp-server` data into separate method. This is the part four in a larger modularization of the data in `WP_Debug_Data`. Previously this was a single massive method drawing in debug data from various groups of related data, where the groups were independent from each other. This patch separates the fourth of twelve groups, the `wp-server` info, into a separate method focused on that data. This work precedes changes to make the `WP_Debug_Data` class more extensible for better use by plugin and theme code. Developed in https://github.com/wordpress/wordpress-develop/7283 Discussed in https://core.trac.wordpress.org/ticket/61648 Props apermo, costdev, dmsnell, kebbet, mukesh27. See #61648. Built from https://develop.svn.wordpress.org/trunk@59002 git-svn-id: http://core.svn.wordpress.org/trunk@58398 1a063a9b-81f0-0310-95a4-ce76da25c4cd --- wp-admin/includes/class-wp-debug-data.php | 385 +++++++++++----------- wp-includes/version.php | 2 +- 2 files changed, 199 insertions(+), 188 deletions(-) diff --git a/wp-admin/includes/class-wp-debug-data.php b/wp-admin/includes/class-wp-debug-data.php index 766253b1ea..3bb2980a25 100644 --- a/wp-admin/includes/class-wp-debug-data.php +++ b/wp-admin/includes/class-wp-debug-data.php @@ -85,12 +85,17 @@ class WP_Debug_Data { 'wp-plugins-active' => array(), 'wp-plugins-inactive' => array(), 'wp-media' => array(), - 'wp-server' => array(), + 'wp-server' => self::get_wp_server(), 'wp-database' => self::get_wp_database(), 'wp-constants' => self::get_wp_constants(), 'wp-filesystem' => self::get_wp_filesystem(), ); + // Remove debug data which is only relevant on single-site installs. + if ( is_multisite() ) { + unset( $info['wp-paths-sizes'] ); + } + $info['wp-core'] = array( 'label' => __( 'WordPress' ), 'fields' => array( @@ -217,17 +222,6 @@ class WP_Debug_Data { 'fields' => array(), ); - $info['wp-server'] = array( - 'label' => __( 'Server' ), - 'description' => __( 'The options shown below relate to your server setup. If changes are required, you may need your web host’s assistance.' ), - 'fields' => array(), - ); - - $info['wp-database'] = array( - 'label' => __( 'Database' ), - 'fields' => array(), - ); - // Conditionally add debug information for multisite setups. if ( is_multisite() ) { $site_id = get_current_blog_id(); @@ -546,181 +540,6 @@ class WP_Debug_Data { 'debug' => $gs_debug, ); - // Populate the server debug fields. - if ( function_exists( 'php_uname' ) ) { - $server_architecture = sprintf( '%s %s %s', php_uname( 's' ), php_uname( 'r' ), php_uname( 'm' ) ); - } else { - $server_architecture = 'unknown'; - } - - $php_version_debug = PHP_VERSION; - // Whether PHP supports 64-bit. - $php64bit = ( PHP_INT_SIZE * 8 === 64 ); - - $php_version = sprintf( - '%s %s', - $php_version_debug, - ( $php64bit ? __( '(Supports 64bit values)' ) : __( '(Does not support 64bit values)' ) ) - ); - - if ( $php64bit ) { - $php_version_debug .= ' 64bit'; - } - - $info['wp-server']['fields']['server_architecture'] = array( - 'label' => __( 'Server architecture' ), - 'value' => ( 'unknown' !== $server_architecture ? $server_architecture : __( 'Unable to determine server architecture' ) ), - 'debug' => $server_architecture, - ); - $info['wp-server']['fields']['httpd_software'] = array( - 'label' => __( 'Web server' ), - 'value' => ( isset( $_SERVER['SERVER_SOFTWARE'] ) ? $_SERVER['SERVER_SOFTWARE'] : __( 'Unable to determine what web server software is used' ) ), - 'debug' => ( isset( $_SERVER['SERVER_SOFTWARE'] ) ? $_SERVER['SERVER_SOFTWARE'] : 'unknown' ), - ); - $info['wp-server']['fields']['php_version'] = array( - 'label' => __( 'PHP version' ), - 'value' => $php_version, - 'debug' => $php_version_debug, - ); - $info['wp-server']['fields']['php_sapi'] = array( - 'label' => __( 'PHP SAPI' ), - 'value' => PHP_SAPI, - 'debug' => PHP_SAPI, - ); - - // Some servers disable `ini_set()` and `ini_get()`, we check this before trying to get configuration values. - if ( ! function_exists( 'ini_get' ) ) { - $info['wp-server']['fields']['ini_get'] = array( - 'label' => __( 'Server settings' ), - 'value' => sprintf( - /* translators: %s: ini_get() */ - __( 'Unable to determine some settings, as the %s function has been disabled.' ), - 'ini_get()' - ), - 'debug' => 'ini_get() is disabled', - ); - } else { - $info['wp-server']['fields']['max_input_variables'] = array( - 'label' => __( 'PHP max input variables' ), - 'value' => ini_get( 'max_input_vars' ), - ); - $info['wp-server']['fields']['time_limit'] = array( - 'label' => __( 'PHP time limit' ), - 'value' => ini_get( 'max_execution_time' ), - ); - - if ( WP_Site_Health::get_instance()->php_memory_limit !== ini_get( 'memory_limit' ) ) { - $info['wp-server']['fields']['memory_limit'] = array( - 'label' => __( 'PHP memory limit' ), - 'value' => WP_Site_Health::get_instance()->php_memory_limit, - ); - $info['wp-server']['fields']['admin_memory_limit'] = array( - 'label' => __( 'PHP memory limit (only for admin screens)' ), - 'value' => ini_get( 'memory_limit' ), - ); - } else { - $info['wp-server']['fields']['memory_limit'] = array( - 'label' => __( 'PHP memory limit' ), - 'value' => ini_get( 'memory_limit' ), - ); - } - - $info['wp-server']['fields']['max_input_time'] = array( - 'label' => __( 'Max input time' ), - 'value' => ini_get( 'max_input_time' ), - ); - $info['wp-server']['fields']['upload_max_filesize'] = array( - 'label' => __( 'Upload max filesize' ), - 'value' => ini_get( 'upload_max_filesize' ), - ); - $info['wp-server']['fields']['php_post_max_size'] = array( - 'label' => __( 'PHP post max size' ), - 'value' => ini_get( 'post_max_size' ), - ); - } - - if ( function_exists( 'curl_version' ) ) { - $curl = curl_version(); - - $info['wp-server']['fields']['curl_version'] = array( - 'label' => __( 'cURL version' ), - 'value' => sprintf( '%s %s', $curl['version'], $curl['ssl_version'] ), - ); - } else { - $info['wp-server']['fields']['curl_version'] = array( - 'label' => __( 'cURL version' ), - 'value' => $not_available, - 'debug' => 'not available', - ); - } - - // SUHOSIN. - $suhosin_loaded = ( extension_loaded( 'suhosin' ) || ( defined( 'SUHOSIN_PATCH' ) && constant( 'SUHOSIN_PATCH' ) ) ); - - $info['wp-server']['fields']['suhosin'] = array( - 'label' => __( 'Is SUHOSIN installed?' ), - 'value' => ( $suhosin_loaded ? __( 'Yes' ) : __( 'No' ) ), - 'debug' => $suhosin_loaded, - ); - - // Imagick. - $imagick_loaded = extension_loaded( 'imagick' ); - - $info['wp-server']['fields']['imagick_availability'] = array( - 'label' => __( 'Is the Imagick library available?' ), - 'value' => ( $imagick_loaded ? __( 'Yes' ) : __( 'No' ) ), - 'debug' => $imagick_loaded, - ); - - // Pretty permalinks. - $pretty_permalinks_supported = got_url_rewrite(); - - $info['wp-server']['fields']['pretty_permalinks'] = array( - 'label' => __( 'Are pretty permalinks supported?' ), - 'value' => ( $pretty_permalinks_supported ? __( 'Yes' ) : __( 'No' ) ), - 'debug' => $pretty_permalinks_supported, - ); - - // Check if a .htaccess file exists. - if ( is_file( ABSPATH . '.htaccess' ) ) { - // If the file exists, grab the content of it. - $htaccess_content = file_get_contents( ABSPATH . '.htaccess' ); - - // Filter away the core WordPress rules. - $filtered_htaccess_content = trim( preg_replace( '/\# BEGIN WordPress[\s\S]+?# END WordPress/si', '', $htaccess_content ) ); - $filtered_htaccess_content = ! empty( $filtered_htaccess_content ); - - if ( $filtered_htaccess_content ) { - /* translators: %s: .htaccess */ - $htaccess_rules_string = sprintf( __( 'Custom rules have been added to your %s file.' ), '.htaccess' ); - } else { - /* translators: %s: .htaccess */ - $htaccess_rules_string = sprintf( __( 'Your %s file contains only core WordPress features.' ), '.htaccess' ); - } - - $info['wp-server']['fields']['htaccess_extra_rules'] = array( - 'label' => __( '.htaccess rules' ), - 'value' => $htaccess_rules_string, - 'debug' => $filtered_htaccess_content, - ); - } - - // Server time. - $date = new DateTime( 'now', new DateTimeZone( 'UTC' ) ); - - $info['wp-server']['fields']['current'] = array( - 'label' => __( 'Current time' ), - 'value' => $date->format( DateTime::ATOM ), - ); - $info['wp-server']['fields']['utc-time'] = array( - 'label' => __( 'Current UTC time' ), - 'value' => $date->format( DateTime::RFC850 ), - ); - $info['wp-server']['fields']['server-time'] = array( - 'label' => __( 'Current Server time' ), - 'value' => wp_date( 'c', $_SERVER['REQUEST_TIME'] ), - ); - // List must use plugins if there are any. $mu_plugins = get_mu_plugins(); @@ -1246,6 +1065,198 @@ class WP_Debug_Data { return $info; } + /** + * Gets the WordPress server section of the debug data. + * + * @since 6.7.0 + * + * @return array + */ + public static function get_wp_server(): array { + // Populate the server debug fields. + if ( function_exists( 'php_uname' ) ) { + $server_architecture = sprintf( '%s %s %s', php_uname( 's' ), php_uname( 'r' ), php_uname( 'm' ) ); + } else { + $server_architecture = 'unknown'; + } + + $php_version_debug = PHP_VERSION; + // Whether PHP supports 64-bit. + $php64bit = ( PHP_INT_SIZE * 8 === 64 ); + + $php_version = sprintf( + '%s %s', + $php_version_debug, + ( $php64bit ? __( '(Supports 64bit values)' ) : __( '(Does not support 64bit values)' ) ) + ); + + if ( $php64bit ) { + $php_version_debug .= ' 64bit'; + } + + $fields = array(); + + $fields['server_architecture'] = array( + 'label' => __( 'Server architecture' ), + 'value' => ( 'unknown' !== $server_architecture ? $server_architecture : __( 'Unable to determine server architecture' ) ), + 'debug' => $server_architecture, + ); + $fields['httpd_software'] = array( + 'label' => __( 'Web server' ), + 'value' => ( isset( $_SERVER['SERVER_SOFTWARE'] ) ? $_SERVER['SERVER_SOFTWARE'] : __( 'Unable to determine what web server software is used' ) ), + 'debug' => ( isset( $_SERVER['SERVER_SOFTWARE'] ) ? $_SERVER['SERVER_SOFTWARE'] : 'unknown' ), + ); + $fields['php_version'] = array( + 'label' => __( 'PHP version' ), + 'value' => $php_version, + 'debug' => $php_version_debug, + ); + $fields['php_sapi'] = array( + 'label' => __( 'PHP SAPI' ), + 'value' => PHP_SAPI, + 'debug' => PHP_SAPI, + ); + + // Some servers disable `ini_set()` and `ini_get()`, we check this before trying to get configuration values. + if ( ! function_exists( 'ini_get' ) ) { + $fields['ini_get'] = array( + 'label' => __( 'Server settings' ), + 'value' => sprintf( + /* translators: %s: ini_get() */ + __( 'Unable to determine some settings, as the %s function has been disabled.' ), + 'ini_get()' + ), + 'debug' => 'ini_get() is disabled', + ); + } else { + $fields['max_input_variables'] = array( + 'label' => __( 'PHP max input variables' ), + 'value' => ini_get( 'max_input_vars' ), + ); + $fields['time_limit'] = array( + 'label' => __( 'PHP time limit' ), + 'value' => ini_get( 'max_execution_time' ), + ); + + if ( WP_Site_Health::get_instance()->php_memory_limit !== ini_get( 'memory_limit' ) ) { + $fields['memory_limit'] = array( + 'label' => __( 'PHP memory limit' ), + 'value' => WP_Site_Health::get_instance()->php_memory_limit, + ); + $fields['admin_memory_limit'] = array( + 'label' => __( 'PHP memory limit (only for admin screens)' ), + 'value' => ini_get( 'memory_limit' ), + ); + } else { + $fields['memory_limit'] = array( + 'label' => __( 'PHP memory limit' ), + 'value' => ini_get( 'memory_limit' ), + ); + } + + $fields['max_input_time'] = array( + 'label' => __( 'Max input time' ), + 'value' => ini_get( 'max_input_time' ), + ); + $fields['upload_max_filesize'] = array( + 'label' => __( 'Upload max filesize' ), + 'value' => ini_get( 'upload_max_filesize' ), + ); + $fields['php_post_max_size'] = array( + 'label' => __( 'PHP post max size' ), + 'value' => ini_get( 'post_max_size' ), + ); + } + + if ( function_exists( 'curl_version' ) ) { + $curl = curl_version(); + + $fields['curl_version'] = array( + 'label' => __( 'cURL version' ), + 'value' => sprintf( '%s %s', $curl['version'], $curl['ssl_version'] ), + ); + } else { + $fields['curl_version'] = array( + 'label' => __( 'cURL version' ), + 'value' => __( 'Not available' ), + 'debug' => 'not available', + ); + } + + // SUHOSIN. + $suhosin_loaded = ( extension_loaded( 'suhosin' ) || ( defined( 'SUHOSIN_PATCH' ) && constant( 'SUHOSIN_PATCH' ) ) ); + + $fields['suhosin'] = array( + 'label' => __( 'Is SUHOSIN installed?' ), + 'value' => ( $suhosin_loaded ? __( 'Yes' ) : __( 'No' ) ), + 'debug' => $suhosin_loaded, + ); + + // Imagick. + $imagick_loaded = extension_loaded( 'imagick' ); + + $fields['imagick_availability'] = array( + 'label' => __( 'Is the Imagick library available?' ), + 'value' => ( $imagick_loaded ? __( 'Yes' ) : __( 'No' ) ), + 'debug' => $imagick_loaded, + ); + + // Pretty permalinks. + $pretty_permalinks_supported = got_url_rewrite(); + + $fields['pretty_permalinks'] = array( + 'label' => __( 'Are pretty permalinks supported?' ), + 'value' => ( $pretty_permalinks_supported ? __( 'Yes' ) : __( 'No' ) ), + 'debug' => $pretty_permalinks_supported, + ); + + // Check if a .htaccess file exists. + if ( is_file( ABSPATH . '.htaccess' ) ) { + // If the file exists, grab the content of it. + $htaccess_content = file_get_contents( ABSPATH . '.htaccess' ); + + // Filter away the core WordPress rules. + $filtered_htaccess_content = trim( preg_replace( '/\# BEGIN WordPress[\s\S]+?# END WordPress/si', '', $htaccess_content ) ); + $filtered_htaccess_content = ! empty( $filtered_htaccess_content ); + + if ( $filtered_htaccess_content ) { + /* translators: %s: .htaccess */ + $htaccess_rules_string = sprintf( __( 'Custom rules have been added to your %s file.' ), '.htaccess' ); + } else { + /* translators: %s: .htaccess */ + $htaccess_rules_string = sprintf( __( 'Your %s file contains only core WordPress features.' ), '.htaccess' ); + } + + $fields['htaccess_extra_rules'] = array( + 'label' => __( '.htaccess rules' ), + 'value' => $htaccess_rules_string, + 'debug' => $filtered_htaccess_content, + ); + } + + // Server time. + $date = new DateTime( 'now', new DateTimeZone( 'UTC' ) ); + + $fields['current'] = array( + 'label' => __( 'Current time' ), + 'value' => $date->format( DateTime::ATOM ), + ); + $fields['utc-time'] = array( + 'label' => __( 'Current UTC time' ), + 'value' => $date->format( DateTime::RFC850 ), + ); + $fields['server-time'] = array( + 'label' => __( 'Current Server time' ), + 'value' => wp_date( 'c', $_SERVER['REQUEST_TIME'] ), + ); + + return array( + 'label' => __( 'Server' ), + 'description' => __( 'The options shown below relate to your server setup. If changes are required, you may need your web host’s assistance.' ), + 'fields' => $fields, + ); + } + /** * Gets the WordPress constants section of the debug data. * diff --git a/wp-includes/version.php b/wp-includes/version.php index dab06f6b22..e58d8e951b 100644 --- a/wp-includes/version.php +++ b/wp-includes/version.php @@ -16,7 +16,7 @@ * * @global string $wp_version */ -$wp_version = '6.7-alpha-59001'; +$wp_version = '6.7-alpha-59002'; /** * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.