<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[33184] trunk: Exclude individual site directories when calculating space used for the main site.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/33184">33184</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/33184","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>jeremyfelt</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2015-07-13 00:06:39 +0000 (Mon, 13 Jul 2015)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Exclude individual site directories when calculating space used for the main site.
* Add an `$exclude` parameter to `recurse_dirsize()`.
* Use this parameter in `get_dirsize()` to exclude `/sites` when on the main site.
* Add tests for main site and switched site.
Props @earnjam, @jeremyfelt.
Fixes <a href="https://core.trac.wordpress.org/ticket/30202">#30202</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesmsfunctionsphp">trunk/src/wp-includes/ms-functions.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunktestsphpunittestsmultisitegetSpaceUsedphp">trunk/tests/phpunit/tests/multisite/getSpaceUsed.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesmsfunctionsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/ms-functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/ms-functions.php 2015-07-12 22:06:56 UTC (rev 33183)
+++ trunk/src/wp-includes/ms-functions.php 2015-07-13 00:06:39 UTC (rev 33184)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1686,8 +1686,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since MU
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $directory
- * @return int
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $directory Full path of a directory.
+ * @return int Size of the directory in MB.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function get_dirsize( $directory ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $dirsize = get_transient( 'dirsize_cache' );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1697,7 +1697,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! is_array( $dirsize ) )
</span><span class="cx" style="display: block; padding: 0 10px"> $dirsize = array();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $dirsize[ $directory ][ 'size' ] = recurse_dirsize( $directory );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Exclude individual site directories from the total when checking the main site,
+ // as they are subdirectories and should not be counted.
+ if ( is_main_site() ) {
+ $dirsize[ $directory ][ 'size' ] = recurse_dirsize( $directory, $directory . '/sites' );
+ } else {
+ $dirsize[ $directory ][ 'size' ] = recurse_dirsize( $directory );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> set_transient( 'dirsize_cache', $dirsize, HOUR_IN_SECONDS );
</span><span class="cx" style="display: block; padding: 0 10px"> return $dirsize[ $directory ][ 'size' ];
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1710,17 +1716,20 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * other directories.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since MU
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.3.0 $exclude parameter added.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $directory
- * @return int|false
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $directory Full path of a directory.
+ * @param string $exclude Optional. Full path of a subdirectory to exclude from the total.
+ * @return int|false Size in MB if a valid directory. False if not.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function recurse_dirsize( $directory ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function recurse_dirsize( $directory, $exclude = null ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $size = 0;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $directory = untrailingslashit( $directory );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( !file_exists($directory) || !is_dir( $directory ) || !is_readable( $directory ) )
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! file_exists( $directory ) || ! is_dir( $directory ) || ! is_readable( $directory ) || $directory === $exclude ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> return false;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ($handle = opendir($directory)) {
</span><span class="cx" style="display: block; padding: 0 10px"> while(($file = readdir($handle)) !== false) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1729,7 +1738,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if (is_file($path)) {
</span><span class="cx" style="display: block; padding: 0 10px"> $size += filesize($path);
</span><span class="cx" style="display: block; padding: 0 10px"> } elseif (is_dir($path)) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $handlesize = recurse_dirsize($path);
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $handlesize = recurse_dirsize( $path, $exclude );
</ins><span class="cx" style="display: block; padding: 0 10px"> if ($handlesize > 0)
</span><span class="cx" style="display: block; padding: 0 10px"> $size += $handlesize;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunktestsphpunittestsmultisitegetSpaceUsedphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/tests/phpunit/tests/multisite/getSpaceUsed.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/multisite/getSpaceUsed.php (rev 0)
+++ trunk/tests/phpunit/tests/multisite/getSpaceUsed.php 2015-07-13 00:06:39 UTC (rev 33184)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,94 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+
+if ( is_multisite() ) :
+
+/**
+ * @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;
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of file
</span></span></pre>
</div>
</div>
</body>
</html>