Changeset 45104 for trunk/src/wp-includes/functions.php

Timestamp:

04/02/2019 11:32:31 PM (6 years ago)

Author:

azaozz

Message:

Site health:

• Prevent fatal errors from timeouts on the Tools => Site Health => Info tab.
• Use the get_dirsize() and recurse_dirsize() functions to calculate directory sizes. The results are cached.
• Introduce "timeout protection" in recurse_dirsize().

Props pento, Clorith, xkon, afercia, jeremyfelt, azaozz.
Fixes #46645.

File:

• trunk/src/wp-includes/functions.php (modified) (1 diff)

trunk/src/wp-includes/functions.php

@@ -7007 +7007 @@
     echo '</p>';
 }
+
+/**
+ * Get the size of a directory.
+ *
+ * A helper function that is used primarily to check whether
+ * a blog has exceeded its allowed upload space.
+ *
+ * @since MU (3.0.0)
+ *
+ * @param string $directory Full path of a directory.
+ * @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.
+ */
+function get_dirsize( $directory, $max_execution_time = null ) {
+    $dirsize = get_transient( 'dirsize_cache' );
+
+    if ( is_array( $dirsize ) && isset( $dirsize[ $directory ]['size'] ) ) {
+        return $dirsize[ $directory ]['size'];
+    }
+
+    if ( ! is_array( $dirsize ) ) {
+        $dirsize = array();
+    }
+
+    // Exclude individual site directories from the total when checking the main site of a network
+    // as they are subdirectories and should not be counted.
+    if ( is_multisite() && is_main_site() ) {
+        $dirsize[ $directory ]['size'] = recurse_dirsize( $directory, $directory . '/sites', $max_execution_time );
+    } else {
+        $dirsize[ $directory ]['size'] = recurse_dirsize( $directory, null, $max_execution_time );
+    }
+
+    set_transient( 'dirsize_cache', $dirsize, HOUR_IN_SECONDS );
+    return $dirsize[ $directory ]['size'];
+}
+
+/**
+ * Get the size of a directory recursively.
+ *
+ * Used by get_dirsize() to get a directory's size when it contains
+ * other directories.
+ *
+ * @since MU (3.0.0)
+ * @since 4.3.0 $exclude 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.
+ */
+function recurse_dirsize( $directory, $exclude = null, $max_execution_time = null ) {
+    $size = 0;
+
+    $directory = untrailingslashit( $directory );
+
+    if ( ! file_exists( $directory ) || ! is_dir( $directory ) || ! is_readable( $directory ) || $directory === $exclude ) {
+        return false;
+    }
+
+    if ( ! $max_execution_time ) {
+        // Keep the previous behavior but attempt to prevent fatal errors from timeout.
+        if ( function_exists( 'ini_get' ) ) {
+            $max_execution_time = ini_get( 'max_execution_time' );
+        } else {
+            // Use PHP default.
+            $max_execution_time = 30;
+        }
+
+        // Leave 1 second "buffer" for other operations if $max_execution_time has reasonable value.
+        if ( $max_execution_time > 10 ) {
+            $max_execution_time -= 1;
+        }
+    }
+
+    if ( $handle = opendir( $directory ) ) {
+        while ( ( $file = readdir( $handle ) ) !== false ) {
+            $path = $directory . '/' . $file;
+            if ( $file != '.' && $file != '..' ) {
+                if ( is_file( $path ) ) {
+                    $size += filesize( $path );
+                } elseif ( is_dir( $path ) ) {
+                    $handlesize = recurse_dirsize( $path, $exclude, $max_execution_time );
+                    if ( $handlesize > 0 ) {
+                        $size += $handlesize;
+                    }
+                }
+
+                if ( microtime( true ) - WP_START_TIMESTAMP > $max_execution_time ) {
+                    // Time exceeded. Give up instead of risking a fatal timeout.
+                    $size = null;
+                    break;
+                }
+            }
+        }
+        closedir( $handle );
+    }
+    return $size;
+}