Changeset 45220

Timestamp:

04/16/2019 11:01:45 PM (5 years ago)

Author:

azaozz

Message:

Site health, info tab:

• Change recurse_dirsize() to accept an array of excluded paths.
• Change so we don't calculate the sizes of dirs in wp-content twice.
• Add the size in bytes to the "debug" into.
• Add a custom DOM event after the dir sizes request is done. Can be used by plugins to "daisy chain" more requests.
• Move "WordPress directory location" and "WordPress directory size" to the top in the "Directories and Sizes" section.
• Move "Theme directory location" to the "Active Theme" section.
• Fix labels capitalization.

Props xkon, afercia, Clorith, azaozz.
Fixes #46707.

Location:

trunk/src

Files:

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

trunk/src/js/_enqueues/admin/site-health.js

@@ -277 +277 @@
                 window.clearTimeout( timeout );
             }
+
+            $( document ).trigger( 'site-health-info-dirsizes-done' );
         } );
     }

trunk/src/wp-admin/includes/ajax-actions.php

@@ -4977 +4977 @@
 
     $sizes_data = WP_Debug_Data::get_sizes();
-    $all_sizes  = array();
+    $all_sizes  = array( 'raw' => 0 );
 
     foreach ( $sizes_data as $name => $value ) {
@@ -4999 +4999 @@
         }
 
+        if ( ! empty( $value['raw'] ) ) {
+            $data['raw'] = (int) $value['raw'];
+        }
+
         $all_sizes[ $name ] = $data;
     }

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

@@ -393 +393 @@
 
         $info['wp-paths-sizes']['fields'] = array(
-            'uploads_path'       => array(
-                'label' => __( 'Uploads Directory Location' ),
-                'value' => $upload_dir['basedir'],
-            ),
-            'uploads_size'       => array(
-                'label' => __( 'Uploads Directory Size' ),
+            'wordpress_path'     => array(
+                'label' => __( 'WordPress directory location' ),
+                'value' => untrailingslashit( ABSPATH ),
+            ),
+            'wordpress_size'     => array(
+                'label' => __( 'WordPress directory size' ),
                 'value' => $not_calculated,
                 'debug' => 'not calculated',
             ),
-            'themes_path'        => array(
-                'label' => __( 'Themes Directory Location' ),
-                'value' => trailingslashit( get_theme_root() ),
-            ),
-            'current_theme_path' => array(
-                'label' => __( 'Current Theme Directory' ),
-                'value' => get_template_directory(),
-            ),
-            'themes_size'        => array(
-                'label' => __( 'Themes Directory Size' ),
+            'uploads_path'       => array(
+                'label' => __( 'Uploads directory location' ),
+                'value' => $upload_dir['basedir'],
+            ),
+            'uploads_size'       => array(
+                'label' => __( 'Uploads directory size' ),
                 'value' => $not_calculated,
                 'debug' => 'not calculated',
             ),
-            'plugins_path'       => array(
-                'label' => __( 'Plugins Directory Location' ),
-                'value' => trailingslashit( WP_PLUGIN_DIR ),
-            ),
-            'plugins_size'       => array(
-                'label' => __( 'Plugins Directory Size' ),
+            'themes_path'        => array(
+                'label' => __( 'Themes directory location' ),
+                'value' => get_theme_root(),
+            ),
+            'themes_size'        => array(
+                'label' => __( 'Themes directory size' ),
                 'value' => $not_calculated,
                 'debug' => 'not calculated',
             ),
-            'wordpress_path'     => array(
-                'label' => __( 'WordPress Directory Location' ),
-                'value' => ABSPATH,
-            ),
-            'wordpress_size'     => array(
-                'label' => __( 'WordPress Directory Size' ),
+            'plugins_path'       => array(
+                'label' => __( 'Plugins directory location' ),
+                'value' => WP_PLUGIN_DIR,
+            ),
+            'plugins_size'       => array(
+                'label' => __( 'Plugins directory size' ),
                 'value' => $not_calculated,
                 'debug' => 'not calculated',
@@ -898 +894 @@
                 'label' => __( 'Theme features' ),
                 'value' => implode( ', ', $theme_features ),
+            ),
+            'theme_path'     => array(
+                'label' => __( 'Theme directory location' ),
+                'value' => get_template_directory(),
             ),
         );
@@ -1138 +1138 @@
 
         // Go through the various installation directories and calculate their sizes.
-        $all_sizes = array(
-            'wordpress_size' => array(
-                'path' => ABSPATH,
-                'size' => 0,
-            ),
-            'themes_size'    => array(
-                'path' => trailingslashit( get_theme_root() ),
-                'size' => 0,
-            ),
-            'plugins_size'   => array(
-                'path' => trailingslashit( WP_PLUGIN_DIR ),
-                'size' => 0,
-            ),
-            'uploads_size'   => array(
-                'path' => $upload_dir['basedir'],
-                'size' => 0,
-            ),
-        );
+        // No trailing slashes.
+        $paths = array(
+            'wordpress_size' => untrailingslashit( ABSPATH ),
+            'themes_size'    => get_theme_root(),
+            'plugins_size'   => WP_PLUGIN_DIR,
+            'uploads_size'   => $upload_dir['basedir'],
+        );
+
+        $exclude = $paths;
+        unset( $exclude['wordpress_size'] );
+        $exclude = array_values( $exclude );
 
         $size_total = 0;
+        $all_sizes  = array();
 
         // Loop over all the directories we want to gather the sizes for.
-        foreach ( $all_sizes as $name => $attributes ) {
+        foreach ( $paths as $name => $path ) {
             $dir_size = null; // Default to timeout.
+            $results  = array(
+                'path' => $path,
+                'raw'  => 0,
+            );
 
             if ( microtime( true ) - WP_START_TIMESTAMP < $max_execution_time ) {
-                $dir_size = recurse_dirsize( $attributes['path'], null, $max_execution_time );
+                if ( 'wordpress_size' === $name ) {
+                    $dir_size = recurse_dirsize( $path, $exclude, $max_execution_time );
+                } else {
+                    $dir_size = recurse_dirsize( $path, null, $max_execution_time );
+                }
             }
 
             if ( false === $dir_size ) {
                 // Error reading.
-                $all_sizes[ $name ]['size']  = __( 'The size cannot be calculated. The directory is not accessible. Usually caused by invalid permissions.' );
-                $all_sizes[ $name ]['debug'] = 'not accessible';
+                $results['size']  = __( 'The size cannot be calculated. The directory is not accessible. Usually caused by invalid permissions.' );
+                $results['debug'] = 'not accessible';
 
                 // Stop total size calculation.
@@ -1176 +1178 @@
             } elseif ( null === $dir_size ) {
                 // Timeout.
-                $all_sizes[ $name ]['size']  = __( 'The directory size calculation has timed out. Usually caused by a very large number of sub-directories and files.' );
-                $all_sizes[ $name ]['debug'] = 'timeout while calculating size';
+                $results['size']  = __( 'The directory size calculation has timed out. Usually caused by a very large number of sub-directories and files.' );
+                $results['debug'] = 'timeout while calculating size';
 
                 // Stop total size calculation.
                 $size_total = null;
             } else {
-                $is_subdir = ( strpos( $attributes['path'], ABSPATH ) === 0 );
-
-                // phpcs:ignore WordPress.WP.CapitalPDangit.Misspelled
-                if ( null !== $size_total && ( 'wordpress_size' === $name || ! $is_subdir ) ) {
+                if ( null !== $size_total ) {
                     $size_total += $dir_size;
                 }
 
-                $all_sizes[ $name ]['size']  = size_format( $dir_size, 2 );
-                $all_sizes[ $name ]['debug'] = $all_sizes[ $name ]['size'];
-            }
+                $results['raw']   = $dir_size;
+                $results['size']  = size_format( $dir_size, 2 );
+                $results['debug'] = $results['size'] . " ({$dir_size} bytes)";
+            }
+
+            $all_sizes[ $name ] = $results;
         }
 
@@ -1198 +1200 @@
 
             $all_sizes['database_size'] = array(
+                'raw'   => $size_db,
                 'size'  => $database_size,
-                'debug' => $database_size,
+                'debug' => $database_size . " ({$size_db} bytes)",
             );
         } else {
@@ -1209 +1212 @@
 
         if ( null !== $size_total && $size_db > 0 ) {
-            $total_size = size_format( $size_total + $size_db, 2 );
+            $total_size = $size_total + $size_db;
+            $total_size_mb = size_format( $total_size, 2 );
 
             $all_sizes['total_size'] = array(
-                'size'  => $total_size,
-                'debug' => $total_size,
+                'raw'   => $total_size,
+                'size'  => $total_size_mb,
+                'debug' => $total_size_mb . " ({$total_size} bytes)",
             );
         } else {

trunk/src/wp-includes/functions.php

@@ -7072 +7072 @@
  * @since 5.2.0 $max_execution_time parameter added.
  *
- * @param string $directory Full path of a directory.
- * @param string $exclude   Optional. Full path of a subdirectory to exclude from the total.
- * @param int    $max_execution_time Maximum time to run before giving up. In seconds.
- *                                   The timeout is global and is measured from the moment WordPress started to load.
- * @return int|false|null Size in MB if a valid directory. False if not. Null if timeout.
+ * @param string $directory       Full path of a directory.
+ * @param string|array $exclude   Optional. Full path of a subdirectory to exclude from the total, or array of paths.
+ *                                Expected without trailing slash(es).
+ * @param int $max_execution_time Maximum time to run before giving up. In seconds.
+ *                                The timeout is global and is measured from the moment WordPress started to load.
+ * @return int|false|null Size in bytes if a valid directory. False if not. Null if timeout.
  */
 function recurse_dirsize( $directory, $exclude = null, $max_execution_time = null ) {
@@ -7083 +7084 @@
     $directory = untrailingslashit( $directory );
 
-    if ( ! file_exists( $directory ) || ! is_dir( $directory ) || ! is_readable( $directory ) || $directory === $exclude ) {
+    if ( ! file_exists( $directory ) || ! is_dir( $directory ) || ! is_readable( $directory ) ) {
+        return false;
+    }
+
+    if (
+        ( is_string( $exclude ) && $directory === $exclude ) ||
+        ( is_array( $exclude ) && in_array( $directory, $exclude, true ) )
+    ) {
         return false;
     }