https://www.mediawiki.org/wiki/Special:Code/MediaWiki/108377
Revision: 108377
Author: aaron
Date: 2012-01-09 00:20:28 +0000 (Mon, 09 Jan 2012)
Log Message:
-----------
* r107986: Added readOnly checks to prepare(), secure(), and clean() in
FileBackendBase.
* Added some prepare()/clean() tests.
Modified Paths:
--------------
trunk/phase3/includes/filerepo/backend/FSFileBackend.php
trunk/phase3/includes/filerepo/backend/FileBackend.php
trunk/phase3/includes/filerepo/backend/FileBackendMultiWrite.php
trunk/phase3/tests/phpunit/includes/filerepo/FileBackendTest.php
Modified: trunk/phase3/includes/filerepo/backend/FSFileBackend.php
===================================================================
--- trunk/phase3/includes/filerepo/backend/FSFileBackend.php 2012-01-09
00:15:38 UTC (rev 108376)
+++ trunk/phase3/includes/filerepo/backend/FSFileBackend.php 2012-01-09
00:20:28 UTC (rev 108377)
@@ -274,9 +274,9 @@
}
/**
- * @see FileBackend::doPrepare()
+ * @see FileBackend::doPrepareInternal()
*/
- protected function doPrepare( $container, $dir, array $params ) {
+ protected function doPrepareInternal( $container, $dir, array $params )
{
$status = Status::newGood();
if ( !wfMkdirParents( $dir ) ) {
$status->fatal( 'directorycreateerror', $params['dir']
);
@@ -289,9 +289,9 @@
}
/**
- * @see FileBackend::doSecure()
+ * @see FileBackend::doSecureInternal()
*/
- protected function doSecure( $container, $dir, array $params ) {
+ protected function doSecureInternal( $container, $dir, array $params ) {
$status = Status::newGood();
if ( !wfMkdirParents( $dir ) ) {
$status->fatal( 'directorycreateerror', $params['dir']
);
@@ -308,25 +308,27 @@
}
}
// Add a .htaccess file to the root of the container...
- list( $b, $container, $r ) = FileBackend::splitStoragePath(
$params['dir'] );
- $dirRoot = $this->containerPaths[$container]; // real path
- if ( !empty( $params['noAccess'] ) && !file_exists(
"{$dirRoot}/.htaccess" ) ) {
- wfSuppressWarnings();
- $ok = file_put_contents( "{$dirRoot}/.htaccess", "Deny
from all\n" );
- wfRestoreWarnings();
- if ( !$ok ) {
- $storeDir =
"mwstore://{$this->name}/{$container}";
- $status->fatal( 'backend-fail-create',
"$storeDir/.htaccess" );
- return $status;
+ if ( !empty( $params['noAccess'] ) ) {
+ list( $b, $container, $r ) =
FileBackend::splitStoragePath( $params['dir'] );
+ $dirRoot = $this->containerPaths[$container]; // real
path
+ if ( !file_exists( "{$dirRoot}/.htaccess" ) ) {
+ wfSuppressWarnings();
+ $ok = file_put_contents(
"{$dirRoot}/.htaccess", "Deny from all\n" );
+ wfRestoreWarnings();
+ if ( !$ok ) {
+ $storeDir =
"mwstore://{$this->name}/{$container}";
+ $status->fatal( 'backend-fail-create',
"$storeDir/.htaccess" );
+ return $status;
+ }
}
}
return $status;
}
/**
- * @see FileBackend::doClean()
+ * @see FileBackend::doCleanInternal()
*/
- protected function doClean( $container, $dir, array $params ) {
+ protected function doCleanInternal( $container, $dir, array $params ) {
$status = Status::newGood();
wfSuppressWarnings();
if ( is_dir( $dir ) ) {
Modified: trunk/phase3/includes/filerepo/backend/FileBackend.php
===================================================================
--- trunk/phase3/includes/filerepo/backend/FileBackend.php 2012-01-09
00:15:38 UTC (rev 108376)
+++ trunk/phase3/includes/filerepo/backend/FileBackend.php 2012-01-09
00:20:28 UTC (rev 108377)
@@ -292,9 +292,19 @@
* @param $params Array
* @return Status
*/
- abstract public function prepare( array $params );
+ final public function prepare( array $params ) {
+ if ( $this->readOnly != '' ) {
+ return Status::newFatal( 'backend-fail-readonly',
$this->name, $this->readOnly );
+ }
+ return $this->doPrepare( $params );
+ }
/**
+ * @see FileBackendBase::prepare()
+ */
+ abstract protected function doPrepare( array $params );
+
+ /**
* Take measures to block web access to a directory and
* the container it belongs to. FS backends might add .htaccess
* files wheras backends like Swift this might restrict container
@@ -309,9 +319,19 @@
* @param $params Array
* @return Status
*/
- abstract public function secure( array $params );
+ final public function secure( array $params ) {
+ if ( $this->readOnly != '' ) {
+ return Status::newFatal( 'backend-fail-readonly',
$this->name, $this->readOnly );
+ }
+ return $this->doSecure( $params );
+ }
/**
+ * @see FileBackendBase::secure()
+ */
+ abstract protected function doSecure( array $params );
+
+ /**
* Clean up an empty storage directory.
* On FS backends, the directory will be deleted. Others may do nothing.
*
@@ -321,9 +341,19 @@
* @param $params Array
* @return Status
*/
- abstract public function clean( array $params );
+ final public function clean( array $params ) {
+ if ( $this->readOnly != '' ) {
+ return Status::newFatal( 'backend-fail-readonly',
$this->name, $this->readOnly );
+ }
+ return $this->doClean( $params );
+ }
/**
+ * @see FileBackendBase::clean()
+ */
+ abstract protected function doClean( array $params );
+
+ /**
* Check if a file exists at a storage path in the backend.
* This returns false if only a directory exists at the path.
*
@@ -747,9 +777,9 @@
}
/**
- * @see FileBackendBase::prepare()
+ * @see FileBackendBase::doPrepare()
*/
- final public function prepare( array $params ) {
+ final protected function doPrepare( array $params ) {
$status = Status::newGood();
list( $fullCont, $dir, $shard ) = $this->resolveStoragePath(
$params['dir'] );
if ( $dir === null ) {
@@ -757,28 +787,28 @@
return $status; // invalid storage path
}
if ( $shard !== null ) { // confined to a single container/shard
- $status->merge( $this->doPrepare( $fullCont, $dir,
$params ) );
+ $status->merge( $this->doPrepareInternal( $fullCont,
$dir, $params ) );
} else { // directory is on several shards
wfDebug( __METHOD__ . ": iterating over all container
shards.\n" );
list( $b, $shortCont, $r ) = self::splitStoragePath(
$params['dir'] );
foreach ( $this->getContainerSuffixes( $shortCont ) as
$suffix ) {
- $status->merge( $this->doPrepare(
"{$fullCont}{$suffix}", $dir, $params ) );
+ $status->merge( $this->doPrepareInternal(
"{$fullCont}{$suffix}", $dir, $params ) );
}
}
return $status;
}
/**
- * @see FileBackend::prepare()
+ * @see FileBackend::doPrepare()
*/
- protected function doPrepare( $container, $dir, array $params ) {
+ protected function doPrepareInternal( $container, $dir, array $params )
{
return Status::newGood();
}
/**
- * @see FileBackendBase::secure()
+ * @see FileBackendBase::doSecure()
*/
- final public function secure( array $params ) {
+ final protected function doSecure( array $params ) {
$status = Status::newGood();
list( $fullCont, $dir, $shard ) = $this->resolveStoragePath(
$params['dir'] );
if ( $dir === null ) {
@@ -786,28 +816,28 @@
return $status; // invalid storage path
}
if ( $shard !== null ) { // confined to a single container/shard
- $status->merge( $this->doSecure( $fullCont, $dir,
$params ) );
+ $status->merge( $this->doSecureInternal( $fullCont,
$dir, $params ) );
} else { // directory is on several shards
wfDebug( __METHOD__ . ": iterating over all container
shards.\n" );
list( $b, $shortCont, $r ) = self::splitStoragePath(
$params['dir'] );
foreach ( $this->getContainerSuffixes( $shortCont ) as
$suffix ) {
- $status->merge( $this->doSecure(
"{$fullCont}{$suffix}", $dir, $params ) );
+ $status->merge( $this->doSecureInternal(
"{$fullCont}{$suffix}", $dir, $params ) );
}
}
return $status;
}
/**
- * @see FileBackend::secure()
+ * @see FileBackend::doSecure()
*/
- protected function doSecure( $container, $dir, array $params ) {
+ protected function doSecureInternal( $container, $dir, array $params ) {
return Status::newGood();
}
/**
- * @see FileBackendBase::clean()
+ * @see FileBackendBase::doClean()
*/
- final public function clean( array $params ) {
+ final protected function doClean( array $params ) {
$status = Status::newGood();
list( $fullCont, $dir, $shard ) = $this->resolveStoragePath(
$params['dir'] );
if ( $dir === null ) {
@@ -815,21 +845,21 @@
return $status; // invalid storage path
}
if ( $shard !== null ) { // confined to a single container/shard
- $status->merge( $this->doClean( $fullCont, $dir,
$params ) );
+ $status->merge( $this->doCleanInternal( $fullCont,
$dir, $params ) );
} else { // directory is on several shards
wfDebug( __METHOD__ . ": iterating over all container
shards.\n" );
list( $b, $shortCont, $r ) = self::splitStoragePath(
$params['dir'] );
foreach ( $this->getContainerSuffixes( $shortCont ) as
$suffix ) {
- $status->merge( $this->doClean(
"{$fullCont}{$suffix}", $dir, $params ) );
+ $status->merge( $this->doCleanInternal(
"{$fullCont}{$suffix}", $dir, $params ) );
}
}
return $status;
}
/**
- * @see FileBackend::clean()
+ * @see FileBackend::doClean()
*/
- protected function doClean( $container, $dir, array $params ) {
+ protected function doCleanInternal( $container, $dir, array $params ) {
return Status::newGood();
}
Modified: trunk/phase3/includes/filerepo/backend/FileBackendMultiWrite.php
===================================================================
--- trunk/phase3/includes/filerepo/backend/FileBackendMultiWrite.php
2012-01-09 00:15:38 UTC (rev 108376)
+++ trunk/phase3/includes/filerepo/backend/FileBackendMultiWrite.php
2012-01-09 00:20:28 UTC (rev 108377)
@@ -251,37 +251,37 @@
}
/**
- * @see FileBackendBase::prepare()
+ * @see FileBackendBase::doPrepare()
*/
- public function prepare( array $params ) {
+ public function doPrepare( array $params ) {
$status = Status::newGood();
foreach ( $this->backends as $backend ) {
$realParams = $this->substOpPaths( $params, $backend );
- $status->merge( $backend->prepare( $realParams ) );
+ $status->merge( $backend->doPrepare( $realParams ) );
}
return $status;
}
/**
- * @see FileBackendBase::secure()
+ * @see FileBackendBase::doSecure()
*/
- public function secure( array $params ) {
+ public function doSecure( array $params ) {
$status = Status::newGood();
foreach ( $this->backends as $backend ) {
$realParams = $this->substOpPaths( $params, $backend );
- $status->merge( $backend->secure( $realParams ) );
+ $status->merge( $backend->doSecure( $realParams ) );
}
return $status;
}
/**
- * @see FileBackendBase::clean()
+ * @see FileBackendBase::doClean()
*/
- public function clean( array $params ) {
+ public function doClean( array $params ) {
$status = Status::newGood();
foreach ( $this->backends as $backend ) {
$realParams = $this->substOpPaths( $params, $backend );
- $status->merge( $backend->clean( $realParams ) );
+ $status->merge( $backend->doClean( $realParams ) );
}
return $status;
}
Modified: trunk/phase3/tests/phpunit/includes/filerepo/FileBackendTest.php
===================================================================
--- trunk/phase3/tests/phpunit/includes/filerepo/FileBackendTest.php
2012-01-09 00:15:38 UTC (rev 108376)
+++ trunk/phase3/tests/phpunit/includes/filerepo/FileBackendTest.php
2012-01-09 00:20:28 UTC (rev 108377)
@@ -690,12 +690,54 @@
return $cases;
}
- // @TODO: testPrepare
+ /**
+ * @dataProvider provider_testPrepareAndClean
+ */
+ public function testPrepareAndClean( $path, $isOK ) {
+ $this->backend = $this->singleBackend;
+ $this->doTestPrepareAndClean( $path, $isOK );
+ $this->backend = $this->multiBackend;
+ $this->doTestPrepareAndClean( $path, $isOK );
+ }
+
+ function provider_testPrepareAndClean() {
+ $base = $this->baseStorePath();
+ return array(
+ array( "$base/cont1/a/z/some_file1.txt", true ),
+ array( "$base/cont2/a/z/some_file2.txt", true ),
+ array( "$base/cont3/a/z/some_file3.txt", false ),
+ );
+ }
+
+ function doTestPrepareAndClean( $path, $isOK ) {
+ $backendName = $this->backendClass();
+
+ $status = $this->backend->prepare( array( 'dir' => $path ) );
+ if ( $isOK ) {
+ $this->assertEquals( array(), $status->errors,
+ "Preparing dir $path succeeded without warnings
($backendName)." );
+ $this->assertEquals( true, $status->isOK(),
+ "Preparing dir $path succeeded ($backendName)."
);
+ } else {
+ $this->assertEquals( false, $status->isOK(),
+ "Preparing dir $path failed ($backendName)." );
+ }
+
+ $status = $this->backend->clean( array( 'dir' => $path ) );
+ if ( $isOK ) {
+ $this->assertEquals( array(), $status->errors,
+ "Cleaning dir $path succeeded without warnings
($backendName)." );
+ $this->assertEquals( true, $status->isOK(),
+ "Cleaning dir $path succeeded ($backendName)."
);
+ } else {
+ $this->assertEquals( false, $status->isOK(),
+ "Cleaning dir $path failed ($backendName)." );
+ }
+ }
+
// @TODO: testSecure
- // @TODO: testClean
-
// @TODO: testDoOperations
public function testGetFileList() {
_______________________________________________
MediaWiki-CVS mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-cvs
