Ticket #30202: 30202.3.diff

src/wp-includes/ms-functions.php

@@ -1686 +1686 @@
  *
  * @since MU
  *
- * @param string $directory
- * @return int
- */
-function get_dirsize( $directory ) {
-        $dirsize = get_transient( 'dirsize_cache' );
+ * @param string $directory The full path of a directory to check size of.
+ * @param string $exclude   Optional. Full path of a subdirectory to exclude from the total.
+ * @return int Size of the directory in MB
+ */
+function get_dirsize( $directory, $exclude = null  ) {
+        // Retrieve dirsize from transient if no exclude parameter was passed or if this is
+        // the main site and a specific exclude parameter used by core is passed.
+        if ( is_null( $exclude ) || ( is_main_site() && $directory . '/sites' === $exclude ) ) {
+                $dirsize = get_transient( 'dirsize_cache' );
+        } else {
+                $dirsize = false;
+        }
+
+        // If a cached value is available matching this directory, return it immediately.
         if ( is_array( $dirsize ) && isset( $dirsize[ $directory ][ 'size' ] ) )
                 return $dirsize[ $directory ][ 'size' ];
 
         if ( ! is_array( $dirsize ) )
                 $dirsize = array();
 
-        $dirsize[ $directory ][ 'size' ] = recurse_dirsize( $directory );
+        // No cached value is available, calculate the size recursively.
+        $dirsize[ $directory ][ 'size' ] = recurse_dirsize( $directory, $exclude );
+
+        // Cache the dirsize if no exclude parameter was passed or if this is the main site
+        // and a specific exclude parameter used by core is passed.
+        if ( is_null( $exclude ) || ( is_main_site() && $directory . '/sites' === $exclude ) ) {
+                set_transient( 'dirsize_cache', $dirsize, HOUR_IN_SECONDS );
+        }
 
-        set_transient( 'dirsize_cache', $dirsize, HOUR_IN_SECONDS );
         return $dirsize[ $directory ][ 'size' ];
 }
 
@@ -1711 +1726 @@
  *
  * @since MU
  *
- * @param string $directory
- * @return int|false
+ * @param string $directory The full path of a directory to check the size of.
+ * @param string $exclude   Optional. The full path of a subdirectory to exclude from the total.
+ * @return int|false Size in MB if a valid directory. False if not.
  */
-function recurse_dirsize( $directory ) {
+function recurse_dirsize( $directory, $exclude = null ) {
         $size = 0;
 
         $directory = untrailingslashit( $directory );
 
-        if ( !file_exists($directory) || !is_dir( $directory ) || !is_readable( $directory ) )
+        if ( ! file_exists( $directory ) || ! is_dir( $directory ) || ! is_readable( $directory ) || $directory === $exclude ) {
                 return false;
+        }
 
         if ($handle = opendir($directory)) {
                 while(($file = readdir($handle)) !== false) {
@@ -1729 +1746 @@
                                 if (is_file($path)) {
                                         $size += filesize($path);
                                 } elseif (is_dir($path)) {
-                                        $handlesize = recurse_dirsize($path);
+                                        $handlesize = recurse_dirsize( $path, $exclude );
                                         if ($handlesize > 0)
                                                 $size += $handlesize;
                                 }
@@ -2301 +2318 @@
         $space_used = apply_filters( 'pre_get_space_used', false );
         if ( false === $space_used ) {
                 $upload_dir = wp_upload_dir();
-                $space_used = get_dirsize( $upload_dir['basedir'] ) / 1024 / 1024;
+                $exclude = ( is_main_site() ) ? $upload_dir['basedir'] . '/sites' : null;
+                $space_used = get_dirsize( $upload_dir['basedir'], $exclude ) / 1024 / 1024; 
         }
 
         return $space_used;

tests/phpunit/tests/multisite/getSpaceUsed.php

@@ +1 @@
+<?php
+
+if ( is_multisite() ) :
+
+/**
+ * @group space-used
+ * @group multisite
+ * @covers ::get_space_used
+ */
+class Tests_Multisite_Get_Space_Used extends WP_UnitTestCase {
+        protected $suppress = false;
+
+        function setUp() {
+                global $wpdb;
+                parent::setUp();
+                $this->suppress = $wpdb->suppress_errors();
+
+                $_SERVER['REMOTE_ADDR'] = '';
+        }
+
+        function tearDown() {
+                global $wpdb;
+                $wpdb->suppress_errors( $this->suppress );
+                parent::tearDown();
+        }
+
+        function test_get_space_used_switched_site() {
+                $blog_id = $this->factory->blog->create();
+                switch_to_blog( $blog_id );
+
+                // Our comparison of space relies on an initial value of 0. If a previous test has failed or if the
+                // src directory already contains a content directory with site content, then the initial expectation
+                // will be polluted. We create sites until an empty one is available.
+                while ( 0 != get_space_used() ) {
+                        restore_current_blog();
+                        $blog_id = $this->factory->blog->create();
+                        switch_to_blog( $blog_id );
+                }
+
+                // Upload a file to the new site.
+                $filename = rand_str().'.jpg';
+                $contents = rand_str();
+                $file = wp_upload_bits( $filename, null, $contents );
+
+                // get_space_used() is measures in MB, get the size of the new file in MB.
+                $size = filesize( $file['file'] ) / 1024 / 1024;
+
+                delete_transient( 'dirsize_cache' );
+
+                $this->assertEquals( $size, get_space_used() );
+                $upload_dir = wp_upload_dir();
+                $this->remove_added_uploads();
+                $this->delete_folders( $upload_dir['basedir'] );
+                restore_current_blog();
+        }
+
+        /**
+         * Directories of sub sites on a network should not count against the same spaced used total for
+         * the main site.
+         */
+        function test_get_space_used_main_site() {
+                $space_used = get_space_used();
+
+                $blog_id = $this->factory->blog->create();
+                switch_to_blog( $blog_id );
+
+                // We don't rely on an initial value of 0 for space used, but should have a clean space available
+                // so that we can remove any uploaded files and directories without concern of a conflict with
+                // existing content directories in src.
+                while ( 0 != get_space_used() ) {
+                        restore_current_blog();
+                        $blog_id = $this->factory->blog->create();
+                        switch_to_blog( $blog_id );
+                }
+
+                // Upload a file to the new site.
+                $filename = rand_str().'.jpg';
+                $contents = rand_str();
+                wp_upload_bits( $filename, null, $contents );
+
+                restore_current_blog();
+
+                delete_transient( 'dirsize_cache' );
+
+                $this->assertEquals( $space_used, get_space_used() );
+
+                // Switch back to the new site to remove the uploaded file.
+                switch_to_blog( $blog_id );
+                $upload_dir = wp_upload_dir();
+                $this->remove_added_uploads();
+                $this->delete_folders( $upload_dir['basedir'] );
+                restore_current_blog();
+        }
+}
+endif;
+ No newline at end of file