Changeset 48535

Timestamp:

07/21/2020 03:19:58 PM (4 years ago)

Author:

whyisjake

Message:

Site Health: Include new tests to check for the ability to upload files.

Several new checks:

• max_file_uploads
• file_uploads
• post_max_size
• upload_max_filesize
• upload_max
• max_file_uploads

In addition, new function parse_ini_size() that converts shorthand byte strings to bytes. Useful for size comparisons.

Fixes #50038.
Props dd32, donmhico, JavierCasares, SergeyBiryukov, ayeshrajans, Clorith, ipstenu, sabernhardt, whyisjake.

Location:

trunk/src

Files:

• wp-admin/includes/class-wp-debug-data.php (modified) (1 diff)
• wp-admin/includes/class-wp-site-health.php (modified) (2 diffs)
• wp-includes/functions.php (modified) (1 diff)

trunk/src/wp-admin/includes/class-wp-debug-data.php

@@ -519 +519 @@
             'value' => ( is_array( $imagick_version ) ? $imagick_version['versionString'] : $imagick_version ),
         );
+
+        if ( ! function_exists( 'ini_get' ) ) {
+            $info['wp-media']['fields']['ini_get'] = array(
+                'label' => __( 'File upload 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 {
+            // Get the PHP ini directive values.
+            $post_max_size    = ini_get( 'post_max_size' );
+            $upload_max_size  = ini_get( 'upload_max_filesize' );
+            $max_file_uploads = ini_get( 'max_file_uploads' );
+            $effective        = min( parse_ini_size( $post_max_size ), parse_ini_size( $upload_max_size ) );
+
+            // Add info in Media section.
+            $info['wp-media']['fields']['file_uploads']        = array(
+                'label' => __( 'File uploads' ),
+                'value' => empty( ini_get( 'file_uploads' ) ) ? __( 'Disabled' ) : __( 'Enabled' ),
+                'debug' => 'File uploads is turned off',
+            );
+            $info['wp-media']['fields']['post_max_size']       = array(
+                'label' => __( 'Max size of post data allowed' ),
+                'value' => $post_max_size,
+            );
+            $info['wp-media']['fields']['upload_max_filesize'] = array(
+                'label' => __( 'Max size of an uploaded file' ),
+                'value' => $upload_max_size,
+            );
+            $info['wp-media']['fields']['upload_max']          = array(
+                'label' => __( 'Max effective file size' ),
+                'value' => size_format( $effective ),
+            );
+            $info['wp-media']['fields']['max_file_uploads']    = array(
+                'label' => __( 'Max number of files allowed' ),
+                'value' => number_format( $max_file_uploads ),
+            );
+        }
 
         // If Imagick is used as our editor, provide some more information about its limitations.

trunk/src/wp-admin/includes/class-wp-site-health.php

@@ -1951 +1951 @@
                 );
             }
+        }
+
+        return $result;
+    }
+
+    /**
+     * Test if 'file_uploads' directive in PHP.ini is turned off
+     *
+     * @since 5.5.0
+     *
+     * @return array The test results.
+     */
+    public function get_test_file_uploads() {
+        $result = array(
+            'label'       => __( 'Files can be uploaded.' ),
+            'status'      => 'good',
+            'badge'       => array(
+                'label' => __( 'Performance' ),
+                'color' => 'blue',
+            ),
+            'description' => sprintf(
+                '<p>%s</p>',
+                sprintf(
+                    /* translators: %1$s: file_uploads %2$s: php.ini */
+                    __( 'The %1$s directive in %2$s determines if uploading to is allowed in your WordPress.' ),
+                    '<code>file_uploads</code>',
+                    '<code>php.ini</code>'
+                )
+            ),
+            'actions'     => '',
+            'test'        => 'file_uploads',
+        );
+
+        if ( ! function_exists( 'ini_get' ) ) {
+            $result['status']       = 'critical';
+            $result['description'] .= sprintf(
+                /* translators: %s: ini_get() */
+                __( 'The %s function has been disabled, some media settings are unavailable because of this.' ),
+                '<code>ini_get()</code>'
+            );
+            return $result;
+        }
+
+        if ( empty( ini_get( 'file_uploads' ) ) ) {
+            $result['status']       = 'critical';
+            $result['description'] .= sprintf(
+                '<p>%s</p>',
+                sprintf(
+                    /* translators: %1$s: file_uploads %2$s: 0 */
+                    __( '%1$s is set to %2$s. You won\'t be able to upload files in your WordPress.' ),
+                    '<code>file_uploads</code>',
+                    '<code>0</code>'
+                )
+            );
+            return $result;
+        }
+
+        if ( parse_ini_size( ini_get( 'post_max_size' ) ) !== parse_ini_size( ini_get( 'upload_max_filesize' ) ) ) {
+            $result['label']       = __( 'Mismatched "post_max_size" and "upload_max_filesize" values.' );
+            $result['status']      = 'recommended';
+            $result['description'] = sprintf(
+                '<p>%s</p>',
+                sprintf(
+                    /* translators: %1$s: post_max_size %2$s: upload_max_filesize */
+                    __( 'The settings for %1$s and %2$s are not the same, this could cause some problems when trying to upload files.' ),
+                    '<code>post_max_size</code>',
+                    '<code>upload_max_filesize</code>'
+                )
+            );
+            return $result;
         }
 
@@ -2026 +2096 @@
                     'test'  => 'is_in_debug_mode',
                 ),
+                'file_uploads'         => array(
+                    'label' => __( 'File uploads' ),
+                    'test'  => 'file_uploads',
+                ),
             ),
             'async'  => array(

trunk/src/wp-includes/functions.php

@@ -475 +475 @@
 
     return false;
+}
+
+/**
+ * Converts a shorthand byte string to bytes.
+ *
+ * Useful when needing to compare two byte strings for size differences.
+ *
+ * E.g.
+ *  "1G" (1 Gigabyte) = 1073741824
+ *  "10M" (10 Megabytes) = 10485760
+ *  "1K" (1 Kilobyte) = 1024
+ *
+ * @since 5.5.0
+ *
+ * @param  string $size_string Shorthand byte string
+ * @return int                 $size_string converted to numberic bytes.
+ */
+function parse_ini_size( $size_string ) {
+    $size_string = trim( $size_string );
+    $last        = strtolower( substr( $size_string, - 1 ) );
+    $value       = intval( $size_string );
+
+    switch ( $last ) {
+        case 'g':
+            return (int) $value * GB_IN_BYTES;
+        case 'm':
+            return (int) $value * MB_IN_BYTES;
+        case 'k':
+            return (int) $value * KB_IN_BYTES;
+        default:
+            return (int) $value;
+    }
 }