Merge "Revert "filebackend: cleaned up the FileBackend constructor""
authorjenkins-bot <jenkins-bot@gerrit.wikimedia.org>
Tue, 3 Dec 2013 20:46:05 +0000 (20:46 +0000)
committerGerrit Code Review <gerrit@wikimedia.org>
Tue, 3 Dec 2013 20:46:05 +0000 (20:46 +0000)
16 files changed:
includes/filebackend/FileBackend.php
includes/filebackend/FileBackendGroup.php
includes/filebackend/FileBackendMultiWrite.php
tests/parser/parserTest.inc
tests/phpunit/includes/LocalFileTest.php
tests/phpunit/includes/filebackend/FileBackendTest.php
tests/phpunit/includes/filerepo/FileRepoTest.php
tests/phpunit/includes/filerepo/StoreBatchTest.php
tests/phpunit/includes/media/ExifRotationTest.php
tests/phpunit/includes/media/FormatMetadataTest.php
tests/phpunit/includes/media/GIFTest.php
tests/phpunit/includes/media/JpegTest.php
tests/phpunit/includes/media/PNGTest.php
tests/phpunit/includes/media/SVGTest.php
tests/phpunit/includes/parser/NewParserTest.php
tests/phpunit/suites/UploadFromUrlTestSuite.php

index ea953e0..a6eda18 100644 (file)
@@ -114,13 +114,13 @@ abstract class FileBackend {
         *                   This name should not be changed after use (e.g. with journaling).
         *                   Note that the name is *not* used in actual container names.
         *   - wikiId      : Prefix to container names that is unique to this backend.
+        *                   If not provided, this defaults to the current wiki ID.
         *                   It should only consist of alphanumberic, '-', and '_' characters.
         *                   This ID is what avoids collisions if multiple logical backends
         *                   use the same storage system, so this should be set carefully.
-        *   - lockManager : LockManager object to use for any file locking.
-        *                   If not provided, then no file locking will be enforced.
-        *   - fileJournal : FileJournal object to use for logging changes to files.
-        *                   If not provided, then change journaling will be disabled.
+        *   - lockManager : Registered name of a file lock manager to use.
+        *   - fileJournal : File journal configuration; see FileJournal::factory().
+        *                   Journals simply log changes to files stored in the backend.
         *   - readOnly    : Write operations are disallowed if this is a non-empty string.
         *                   It should be an explanation for the backend being read-only.
         *   - parallelize : When to do file operations in parallel (when possible).
@@ -133,12 +133,16 @@ abstract class FileBackend {
                if ( !preg_match( '!^[a-zA-Z0-9-_]{1,255}$!', $this->name ) ) {
                        throw new MWException( "Backend name `{$this->name}` is invalid." );
                }
-               $this->wikiId = $config['wikiId']; // e.g. "my_wiki-en_"
-               $this->lockManager = isset( $config['lockManager'] )
+               $this->wikiId = isset( $config['wikiId'] )
+                       ? $config['wikiId']
+                       : wfWikiID(); // e.g. "my_wiki-en_"
+               $this->lockManager = ( $config['lockManager'] instanceof LockManager )
                        ? $config['lockManager']
-                       : new NullLockManager( array() );
+                       : LockManagerGroup::singleton( $this->wikiId )->get( $config['lockManager'] );
                $this->fileJournal = isset( $config['fileJournal'] )
-                       ? $config['fileJournal']
+                       ? ( ( $config['fileJournal'] instanceof FileJournal )
+                               ? $config['fileJournal']
+                               : FileJournal::factory( $config['fileJournal'], $this->name ) )
                        : FileJournal::factory( array( 'class' => 'NullFileJournal' ), $this->name );
                $this->readOnly = isset( $config['readOnly'] )
                        ? (string)$config['readOnly']
index e451e3c..491424b 100644 (file)
@@ -152,14 +152,6 @@ class FileBackendGroup {
                if ( !isset( $this->backends[$name]['instance'] ) ) {
                        $class = $this->backends[$name]['class'];
                        $config = $this->backends[$name]['config'];
-                       $config['wikiId'] = isset( $config['wikiId'] )
-                               ? $config['wikiId']
-                               : wfWikiID(); // e.g. "my_wiki-en_"
-                       $config['lockManager'] =
-                               LockManagerGroup::singleton( $config['wikiId'] )->get( $config['lockManager'] );
-                       $config['fileJournal'] = isset( $config['fileJournal'] )
-                               ? FileJournal::factory( $config['fileJournal'], $name )
-                               : FileJournal::factory( array( 'class' => 'NullFileJournal' ), $name );
                        $this->backends[$name]['instance'] = new $class( $config );
                }
 
index cb7a58e..b3c46c6 100644 (file)
@@ -125,8 +125,8 @@ class FileBackendMultiWrite extends FileBackend {
                        // Alter certain sub-backend settings for sanity
                        unset( $config['readOnly'] ); // use proxy backend setting
                        unset( $config['fileJournal'] ); // use proxy backend journal
-                       unset( $config['lockManager'] ); // lock under proxy backend
                        $config['wikiId'] = $this->wikiId; // use the proxy backend wiki ID
+                       $config['lockManager'] = 'nullLockManager'; // lock under proxy backend
                        if ( !empty( $config['isMultiMaster'] ) ) {
                                if ( $this->masterIndex >= 0 ) {
                                        throw new MWException( 'More than one master backend defined.' );
index 39fa09e..58ea1ed 100644 (file)
@@ -170,7 +170,7 @@ class ParserTest {
                        'transformVia404' => false,
                        'backend' => new FSFileBackend( array(
                                'name' => 'local-backend',
-                               'wikiId' => wfWikiId(),
+                               'lockManager' => 'fsLockManager',
                                'containerPaths' => array(
                                        'local-public' => wfTempDir() . '/test-repo/public',
                                        'local-thumb' => wfTempDir() . '/test-repo/thumb',
@@ -738,7 +738,7 @@ class ParserTest {
                                'transformVia404' => false,
                                'backend' => new FSFileBackend( array(
                                        'name' => 'local-backend',
-                                       'wikiId' => wfWikiId(),
+                                       'lockManager' => 'fsLockManager',
                                        'containerPaths' => array(
                                                'local-public' => $this->uploadDir,
                                                'local-thumb' => $this->uploadDir . '/thumb',
index d210ce5..694f4ae 100644 (file)
@@ -21,7 +21,7 @@ class LocalFileTest extends MediaWikiTestCase {
                        'transformVia404' => false,
                        'backend' => new FSFileBackend( array(
                                'name' => 'local-backend',
-                               'wikiId' => wfWikiId(),
+                               'lockManager' => 'fsLockManager',
                                'containerPaths' => array(
                                        'cont1' => "/testdir/local-backend/tempimages/cont1",
                                        'cont2' => "/testdir/local-backend/tempimages/cont2"
index 072cb7c..fcfa724 100644 (file)
@@ -37,8 +37,6 @@ class FileBackendTest extends MediaWikiTestCase {
                                $useConfig['shardViaHashLevels'] = array( // test sharding
                                        'unittest-cont1' => array( 'levels' => 1, 'base' => 16, 'repeat' => 1 )
                                );
-                               $useConfig['fileJournal'] = FileJournal::factory( $config['fileJournal'], $name );
-                               $useConfig['lockManager'] = LockManagerGroup::singleton()->get( $useConfig['lockManager'] );
                                $class = $useConfig['class'];
                                self::$backendToUse = new $class( $useConfig );
                                $this->singleBackend = self::$backendToUse;
@@ -46,8 +44,9 @@ class FileBackendTest extends MediaWikiTestCase {
                } else {
                        $this->singleBackend = new FSFileBackend( array(
                                'name' => 'localtesting',
-                               'lockManager' => LockManagerGroup::singleton()->get( 'fsLockManager' ),
-                               'wikiId' => wfWikiID(),
+                               'lockManager' => 'fsLockManager',
+                               #'parallelize' => 'implicit',
+                               'wikiId' => wfWikiID() . $uniqueId,
                                'containerPaths' => array(
                                        'unittest-cont1' => "{$tmpPrefix}-localtesting-cont1",
                                        'unittest-cont2' => "{$tmpPrefix}-localtesting-cont2" )
@@ -55,13 +54,14 @@ class FileBackendTest extends MediaWikiTestCase {
                }
                $this->multiBackend = new FileBackendMultiWrite( array(
                        'name' => 'localtesting',
-                       'lockManager' => LockManagerGroup::singleton()->get( 'fsLockManager' ),
+                       'lockManager' => 'fsLockManager',
                        'parallelize' => 'implicit',
                        'wikiId' => wfWikiId() . $uniqueId,
                        'backends' => array(
                                array(
                                        'name' => 'localmultitesting1',
                                        'class' => 'FSFileBackend',
+                                       'lockManager' => 'nullLockManager',
                                        'containerPaths' => array(
                                                'unittest-cont1' => "{$tmpPrefix}-localtestingmulti1-cont1",
                                                'unittest-cont2' => "{$tmpPrefix}-localtestingmulti1-cont2" ),
@@ -70,6 +70,7 @@ class FileBackendTest extends MediaWikiTestCase {
                                array(
                                        'name' => 'localmultitesting2',
                                        'class' => 'FSFileBackend',
+                                       'lockManager' => 'nullLockManager',
                                        'containerPaths' => array(
                                                'unittest-cont1' => "{$tmpPrefix}-localtestingmulti2-cont1",
                                                'unittest-cont2' => "{$tmpPrefix}-localtestingmulti2-cont2" ),
index a196dca..e3a7556 100644 (file)
@@ -46,7 +46,7 @@ class FileRepoTest extends MediaWikiTestCase {
                        'name' => 'FileRepoTestRepository',
                        'backend' => new FSFileBackend( array(
                                'name' => 'local-testing',
-                               'wikiId' => 'test_wiki',
+                               'lockManager' => 'nullLockManager',
                                'containerPaths' => array()
                        ) )
                ) );
index 8fb85b6..b33c1bb 100644 (file)
@@ -25,15 +25,13 @@ class StoreBatchTest extends MediaWikiTestCase {
                                        $useConfig = $conf;
                                }
                        }
-                       $useConfig['lockManager'] = LockManagerGroup::singleton()->get( $useConfig['lockManager'] );
-                       unset( $useConfig['fileJournal'] );
                        $useConfig['name'] = 'local-testing'; // swap name
                        $class = $useConfig['class'];
                        $backend = new $class( $useConfig );
                } else {
                        $backend = new FSFileBackend( array(
                                'name' => 'local-testing',
-                               'wikiId' => wfWikiID(),
+                               'lockManager' => 'nullLockManager',
                                'containerPaths' => array(
                                        'unittests-public' => "{$tmpPrefix}-public",
                                        'unittests-thumb' => "{$tmpPrefix}-thumb",
index 118dc85..f4f4154 100644 (file)
@@ -24,7 +24,7 @@ class ExifRotationTest extends MediaWikiTestCase {
                        'url' => 'http://localhost/thumbtest',
                        'backend' => new FSFileBackend( array(
                                'name' => 'localtesting',
-                               'wikiId' => wfWikiId(),
+                               'lockManager' => 'nullLockManager',
                                'containerPaths' => array( 'temp-thumb' => $tmpDir, 'data' => $filePath )
                        ) )
                ) );
index 44d8f00..a4f71db 100644 (file)
@@ -16,7 +16,7 @@ class FormatMetadataTest extends MediaWikiTestCase {
                $filePath = __DIR__ . '/../../data/media';
                $this->backend = new FSFileBackend( array(
                        'name' => 'localtesting',
-                       'wikiId' => wfWikiId(),
+                       'lockManager' => 'nullLockManager',
                        'containerPaths' => array( 'data' => $filePath )
                ) );
                $this->repo = new FSRepo( array(
index 7bd04b7..4350cbb 100644 (file)
@@ -16,7 +16,7 @@ class GIFHandlerTest extends MediaWikiTestCase {
                $this->filePath = __DIR__ . '/../../data/media';
                $this->backend = new FSFileBackend( array(
                        'name' => 'localtesting',
-                       'wikiId' => wfWikiId(),
+                       'lockManager' => 'nullLockManager',
                        'containerPaths' => array( 'data' => $this->filePath )
                ) );
                $this->repo = new FSRepo( array(
index a5bf1dc..bff64bb 100644 (file)
@@ -18,7 +18,7 @@ class JpegTest extends MediaWikiTestCase {
 
                $this->backend = new FSFileBackend( array(
                        'name' => 'localtesting',
-                       'wikiId' => wfWikiId(),
+                       'lockManager' => 'nullLockManager',
                        'containerPaths' => array( 'data' => $this->filePath )
                ) );
                $this->repo = new FSRepo( array(
index a47dc4a..2cb7426 100644 (file)
@@ -16,7 +16,7 @@ class PNGHandlerTest extends MediaWikiTestCase {
                $this->filePath = __DIR__ . '/../../data/media';
                $this->backend = new FSFileBackend( array(
                        'name' => 'localtesting',
-                       'wikiId' => wfWikiId(),
+                       'lockManager' => 'nullLockManager',
                        'containerPaths' => array( 'data' => $this->filePath )
                ) );
                $this->repo = new FSRepo( array(
index dafcae7..e0fae71 100644 (file)
@@ -11,7 +11,7 @@ class SvgTest extends MediaWikiTestCase {
 
                $this->backend = new FSFileBackend( array(
                        'name' => 'localtesting',
-                       'wikiId' => wfWikiId(),
+                       'lockManager' => 'nullLockManager',
                        'containerPaths' => array( 'data' => $this->filePath )
                ) );
                $this->repo = new FSRepo( array(
index 124b477..eac4de5 100644 (file)
@@ -306,8 +306,6 @@ class NewParserTest extends MediaWikiTestCase {
                                        }
                                }
                                $useConfig['name'] = 'local-backend'; // swap name
-                               unset( $useConfig['lockManager'] );
-                               unset( $useConfig['fileJournal'] );
                                $class = $conf['class'];
                                self::$backendToUse = new $class( $useConfig );
                                $backend = self::$backendToUse;
@@ -318,7 +316,7 @@ class NewParserTest extends MediaWikiTestCase {
                        # informations.
                        $backend = new MockFileBackend( array(
                                'name' => 'local-backend',
-                               'wikiId' => wfWikiId(),
+                               'lockManager' => 'nullLockManager',
                                'containerPaths' => array(
                                        'local-public' => "$uploadDir",
                                        'local-thumb' => "$uploadDir/thumb",
index fb7780d..7eb599e 100644 (file)
@@ -36,7 +36,7 @@ class UploadFromUrlTestSuite extends PHPUnit_Framework_TestSuite {
                        'transformVia404' => false,
                        'backend' => new FSFileBackend( array(
                                'name' => 'local-backend',
-                               'wikiId' => wfWikiId(),
+                               'lockManager' => 'fsLockManager',
                                'containerPaths' => array(
                                        'local-public' => wfTempDir() . '/test-repo/public',
                                        'local-thumb' => wfTempDir() . '/test-repo/thumb',