FileBackendGroup::singleton() - Code Metrics - wikimedia/mediawiki - Measure and Improve Code Quality continuously with Scrutinizer

FileBackendGroup::singleton() A
last analyzed 2016-11-13 17:42 UTC

↳ Parent: FileBackendGroup

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
eloc	5
nc	2
nop	0
dl	0
loc	8
rs	9.4285
c	0
b	0
f	0

<?php
/**
 * File backend registration handling.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 * http://www.gnu.org/copyleft/gpl.html
 *
 * @file
 * @ingroup FileBackend
 * @author Aaron Schulz
 */
use \MediaWiki\Logger\LoggerFactory;
use MediaWiki\MediaWikiServices;

/**
 * Class to handle file backend registration
 *
 * @ingroup FileBackend
 * @since 1.19
 */
class FileBackendGroup {
	/** @var FileBackendGroup */
	protected static $instance = null;

	/** @var array (name => ('class' => string, 'config' => array, 'instance' => object)) */
	protected $backends = [];

	protected function __construct() {
	}

	/**
	 * @return FileBackendGroup
	 */
	public static function singleton() {
		if ( self::$instance == null ) {
			self::$instance = new self();
			self::$instance->initFromGlobals();
		}

		return self::$instance;
	}

	/**
	 * Destroy the singleton instance
	 */
	public static function destroySingleton() {
		self::$instance = null;
	}

	/**
	 * Register file backends from the global variables
	 */
	protected function initFromGlobals() {
		global $wgLocalFileRepo, $wgForeignFileRepos, $wgFileBackends, $wgDirectoryMode;

		// Register explicitly defined backends
		$this->register( $wgFileBackends, wfConfiguredReadOnlyReason() );


		$autoBackends = [];
		// Automatically create b/c backends for file repos...
		$repos = array_merge( $wgForeignFileRepos, [ $wgLocalFileRepo ] );
		foreach ( $repos as $info ) {
			$backendName = $info['backend'];
			if ( is_object( $backendName ) || isset( $this->backends[$backendName] ) ) {
				continue; // already defined (or set to the object for some reason)
			}
			$repoName = $info['name'];
			// Local vars that used to be FSRepo members...
			$directory = $info['directory'];
			$deletedDir = isset( $info['deletedDir'] )
				? $info['deletedDir']
				: false; // deletion disabled
			$thumbDir = isset( $info['thumbDir'] )
				? $info['thumbDir']
				: "{$directory}/thumb";
			$transcodedDir = isset( $info['transcodedDir'] )
				? $info['transcodedDir']
				: "{$directory}/transcoded";
			// Get the FS backend configuration
			$autoBackends[] = [
				'name' => $backendName,
				'class' => 'FSFileBackend',
				'lockManager' => 'fsLockManager',
				'containerPaths' => [
					"{$repoName}-public" => "{$directory}",
					"{$repoName}-thumb" => $thumbDir,
					"{$repoName}-transcoded" => $transcodedDir,
					"{$repoName}-deleted" => $deletedDir,
					"{$repoName}-temp" => "{$directory}/temp"
				],
				'fileMode' => isset( $info['fileMode'] ) ? $info['fileMode'] : 0644,
				'directoryMode' => $wgDirectoryMode,
			];
		}

		// Register implicitly defined backends
		$this->register( $autoBackends, wfConfiguredReadOnlyReason() );

	}

	/**
	 * Register an array of file backend configurations
	 *
	 * @param array $configs
	 * @param string|null $readOnlyReason
	 * @throws InvalidArgumentException
	 */
	protected function register( array $configs, $readOnlyReason = null ) {
		foreach ( $configs as $config ) {
			if ( !isset( $config['name'] ) ) {
				throw new InvalidArgumentException( "Cannot register a backend with no name." );
			}
			$name = $config['name'];
			if ( isset( $this->backends[$name] ) ) {
				throw new LogicException( "Backend with name `{$name}` already registered." );
			} elseif ( !isset( $config['class'] ) ) {
				throw new InvalidArgumentException( "Backend with name `{$name}` has no class." );
			}
			$class = $config['class'];

			$config['readOnly'] = !empty( $config['readOnly'] )
				? $config['readOnly']
				: $readOnlyReason;

			unset( $config['class'] ); // backend won't need this
			$this->backends[$name] = [
				'class' => $class,
				'config' => $config,
				'instance' => null
			];
		}
	}

	/**
	 * Get the backend object with a given name
	 *
	 * @param string $name
	 * @return FileBackend
	 * @throws InvalidArgumentException
	 */
	public function get( $name ) {
		// Lazy-load the actual backend instance
		if ( !isset( $this->backends[$name]['instance'] ) ) {
			$config = $this->config( $name );

			$class = $config['class'];
			if ( $class === 'FileBackendMultiWrite' ) {
				foreach ( $config['backends'] as $index => $beConfig ) {
					if ( isset( $beConfig['template'] ) ) {
						// Config is just a modified version of a registered backend's.
						// This should only be used when that config is used only by this backend.
						$config['backends'][$index] += $this->config( $beConfig['template'] );
					}
				}
			}

			$this->backends[$name]['instance'] = new $class( $config );
		}

		return $this->backends[$name]['instance'];
	}

	/**
	 * Get the config array for a backend object with a given name
	 *
	 * @param string $name
	 * @return array Parameters to FileBackend::__construct()
	 * @throws InvalidArgumentException
	 */
	public function config( $name ) {
		if ( !isset( $this->backends[$name] ) ) {
			throw new InvalidArgumentException( "No backend defined with the name `$name`." );
		}
		$class = $this->backends[$name]['class'];

		$config = $this->backends[$name]['config'];
		$config['class'] = $class;
		$config += [ // set defaults
			'wikiId' => wfWikiID(), // e.g. "my_wiki-en_"
			'mimeCallback' => [ $this, 'guessMimeInternal' ],
			'obResetFunc' => 'wfResetOutputBuffers',
			'streamMimeFunc' => [ 'StreamFile', 'contentTypeFromPath' ],
			'tmpDirectory' => wfTempDir(),
			'statusWrapper' => [ 'Status', 'wrap' ],
			'wanCache' => MediaWikiServices::getInstance()->getMainWANObjectCache(),
			'srvCache' => ObjectCache::getLocalServerInstance( 'hash' ),
			'logger' => LoggerFactory::getInstance( 'FileOperation' ),
			'profiler' => Profiler::instance()
		];
		$config['lockManager'] =
			LockManagerGroup::singleton( $config['wikiId'] )->get( $config['lockManager'] );
		$config['fileJournal'] = isset( $config['fileJournal'] )
			? FileJournal::factory( $config['fileJournal'], $name )
			: FileJournal::factory( [ 'class' => 'NullFileJournal' ], $name );

		return $config;
	}

	/**
	 * Get an appropriate backend object from a storage path
	 *
	 * @param string $storagePath
	 * @return FileBackend|null Backend or null on failure
	 */
	public function backendFromPath( $storagePath ) {
		list( $backend, , ) = FileBackend::splitStoragePath( $storagePath );
		if ( $backend !== null && isset( $this->backends[$backend] ) ) {
			return $this->get( $backend );
		}

		return null;
	}

	/**
	 * @param string $storagePath
	 * @param string|null $content
	 * @param string|null $fsPath
	 * @return string
	 * @since 1.27
	 */
	public function guessMimeInternal( $storagePath, $content, $fsPath ) {
		$magic = MimeMagic::singleton();
		// Trust the extension of the storage path (caller must validate)
		$ext = FileBackend::extensionFromPath( $storagePath );
		$type = $magic->guessTypesForExtension( $ext );
		// For files without a valid extension (or one at all), inspect the contents
		if ( !$type && $fsPath ) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
			$type = $magic->guessMimeType( $fsPath, false );
		} elseif ( !$type && strlen( $content ) ) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
			$tmpFile = TempFSFile::factory( 'mime_', '', wfTempDir() );
			file_put_contents( $tmpFile->getPath(), $content );
			$type = $magic->guessMimeType( $tmpFile->getPath(), false );
		}
		return $type ?: 'unknown/unknown';
	}
}


1			<?php
2			/**
3			* File backend registration handling.
4			*
5			* This program is free software; you can redistribute it and/or modify
6			* it under the terms of the GNU General Public License as published by
7			* the Free Software Foundation; either version 2 of the License, or
8			* (at your option) any later version.
9			*
10			* This program is distributed in the hope that it will be useful,
11			* but WITHOUT ANY WARRANTY; without even the implied warranty of
12			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13			* GNU General Public License for more details.
14			*
15			* You should have received a copy of the GNU General Public License along
16			* with this program; if not, write to the Free Software Foundation, Inc.,
17			* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18			* http://www.gnu.org/copyleft/gpl.html
19			*
20			* @file
21			* @ingroup FileBackend
22			* @author Aaron Schulz
23			*/
24			use \MediaWiki\Logger\LoggerFactory;
25			use MediaWiki\MediaWikiServices;
26
27			/**
28			* Class to handle file backend registration
29			*
30			* @ingroup FileBackend
31			* @since 1.19
32			*/
33			class FileBackendGroup {
34			/** @var FileBackendGroup */
35			protected static $instance = null;
36
37			/** @var array (name => ('class' => string, 'config' => array, 'instance' => object)) */
38			protected $backends = [];
39
40			protected function __construct() {
41			}
42
43			/**
44			* @return FileBackendGroup
45			*/
46			public static function singleton() {
47			if ( self::$instance == null ) {
48			self::$instance = new self();
49			self::$instance->initFromGlobals();
50			}
51
52			return self::$instance;
53			}
54
55			/**
56			* Destroy the singleton instance
57			*/
58			public static function destroySingleton() {
59			self::$instance = null;
60			}
61
62			/**
63			* Register file backends from the global variables
64			*/
65			protected function initFromGlobals() {
66			global $wgLocalFileRepo, $wgForeignFileRepos, $wgFileBackends, $wgDirectoryMode;
67
68			// Register explicitly defined backends
69			$this->register( $wgFileBackends, wfConfiguredReadOnlyReason() );
			0 ignored issues – show Security Bug introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report It seems like `wfConfiguredReadOnlyReason()` can also be of type `false`; however, `FileBackendGroup::register()` does only seem to accept `string\|null`, did you maybe forget to handle an error condition? Loading history...
70
71			$autoBackends = [];
72			// Automatically create b/c backends for file repos...
73			$repos = array_merge( $wgForeignFileRepos, [ $wgLocalFileRepo ] );
74			foreach ( $repos as $info ) {
75			$backendName = $info['backend'];
76			if ( is_object( $backendName ) \|\| isset( $this->backends[$backendName] ) ) {
77			continue; // already defined (or set to the object for some reason)
78			}
79			$repoName = $info['name'];
80			// Local vars that used to be FSRepo members...
81			$directory = $info['directory'];
82			$deletedDir = isset( $info['deletedDir'] )
83			? $info['deletedDir']
84			: false; // deletion disabled
85			$thumbDir = isset( $info['thumbDir'] )
86			? $info['thumbDir']
87			: "{$directory}/thumb";
88			$transcodedDir = isset( $info['transcodedDir'] )
89			? $info['transcodedDir']
90			: "{$directory}/transcoded";
91			// Get the FS backend configuration
92			$autoBackends[] = [
93			'name' => $backendName,
94			'class' => 'FSFileBackend',
95			'lockManager' => 'fsLockManager',
96			'containerPaths' => [
97			"{$repoName}-public" => "{$directory}",
98			"{$repoName}-thumb" => $thumbDir,
99			"{$repoName}-transcoded" => $transcodedDir,
100			"{$repoName}-deleted" => $deletedDir,
101			"{$repoName}-temp" => "{$directory}/temp"
102			],
103			'fileMode' => isset( $info['fileMode'] ) ? $info['fileMode'] : 0644,
104			'directoryMode' => $wgDirectoryMode,
105			];
106			}
107
108			// Register implicitly defined backends
109			$this->register( $autoBackends, wfConfiguredReadOnlyReason() );
			0 ignored issues – show Security Bug introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report It seems like `wfConfiguredReadOnlyReason()` can also be of type `false`; however, `FileBackendGroup::register()` does only seem to accept `string\|null`, did you maybe forget to handle an error condition? Loading history...
110			}
111
112			/**
113			* Register an array of file backend configurations
114			*
115			* @param array $configs
116			* @param string\|null $readOnlyReason
117			* @throws InvalidArgumentException
118			*/
119			protected function register( array $configs, $readOnlyReason = null ) {
120			foreach ( $configs as $config ) {
121			if ( !isset( $config['name'] ) ) {
122			throw new InvalidArgumentException( "Cannot register a backend with no name." );
123			}
124			$name = $config['name'];
125			if ( isset( $this->backends[$name] ) ) {
126			throw new LogicException( "Backend with name `{$name}` already registered." );
127			} elseif ( !isset( $config['class'] ) ) {
128			throw new InvalidArgumentException( "Backend with name `{$name}` has no class." );
129			}
130			$class = $config['class'];
131
132			$config['readOnly'] = !empty( $config['readOnly'] )
133			? $config['readOnly']
134			: $readOnlyReason;
135
136			unset( $config['class'] ); // backend won't need this
137			$this->backends[$name] = [
138			'class' => $class,
139			'config' => $config,
140			'instance' => null
141			];
142			}
143			}
144
145			/**
146			* Get the backend object with a given name
147			*
148			* @param string $name
149			* @return FileBackend
150			* @throws InvalidArgumentException
151			*/
152			public function get( $name ) {
153			// Lazy-load the actual backend instance
154			if ( !isset( $this->backends[$name]['instance'] ) ) {
155			$config = $this->config( $name );
156
157			$class = $config['class'];
158			if ( $class === 'FileBackendMultiWrite' ) {
159			foreach ( $config['backends'] as $index => $beConfig ) {
160			if ( isset( $beConfig['template'] ) ) {
161			// Config is just a modified version of a registered backend's.
162			// This should only be used when that config is used only by this backend.
163			$config['backends'][$index] += $this->config( $beConfig['template'] );
164			}
165			}
166			}
167
168			$this->backends[$name]['instance'] = new $class( $config );
169			}
170
171			return $this->backends[$name]['instance'];
172			}
173
174			/**
175			* Get the config array for a backend object with a given name
176			*
177			* @param string $name
178			* @return array Parameters to FileBackend::__construct()
179			* @throws InvalidArgumentException
180			*/
181			public function config( $name ) {
182			if ( !isset( $this->backends[$name] ) ) {
183			throw new InvalidArgumentException( "No backend defined with the name `$name`." );
184			}
185			$class = $this->backends[$name]['class'];
186
187			$config = $this->backends[$name]['config'];
188			$config['class'] = $class;
189			$config += [ // set defaults
190			'wikiId' => wfWikiID(), // e.g. "my_wiki-en_"
191			'mimeCallback' => [ $this, 'guessMimeInternal' ],
192			'obResetFunc' => 'wfResetOutputBuffers',
193			'streamMimeFunc' => [ 'StreamFile', 'contentTypeFromPath' ],
194			'tmpDirectory' => wfTempDir(),
195			'statusWrapper' => [ 'Status', 'wrap' ],
196			'wanCache' => MediaWikiServices::getInstance()->getMainWANObjectCache(),
197			'srvCache' => ObjectCache::getLocalServerInstance( 'hash' ),
198			'logger' => LoggerFactory::getInstance( 'FileOperation' ),
199			'profiler' => Profiler::instance()
200			];
201			$config['lockManager'] =
202			LockManagerGroup::singleton( $config['wikiId'] )->get( $config['lockManager'] );
203			$config['fileJournal'] = isset( $config['fileJournal'] )
204			? FileJournal::factory( $config['fileJournal'], $name )
205			: FileJournal::factory( [ 'class' => 'NullFileJournal' ], $name );
206
207			return $config;
208			}
209
210			/**
211			* Get an appropriate backend object from a storage path
212			*
213			* @param string $storagePath
214			* @return FileBackend\|null Backend or null on failure
215			*/
216			public function backendFromPath( $storagePath ) {
217			list( $backend, , ) = FileBackend::splitStoragePath( $storagePath );
218			if ( $backend !== null && isset( $this->backends[$backend] ) ) {
219			return $this->get( $backend );
220			}
221
222			return null;
223			}
224
225			/**
226			* @param string $storagePath
227			* @param string\|null $content
228			* @param string\|null $fsPath
229			* @return string
230			* @since 1.27
231			*/
232			public function guessMimeInternal( $storagePath, $content, $fsPath ) {
233			$magic = MimeMagic::singleton();
234			// Trust the extension of the storage path (caller must validate)
235			$ext = FileBackend::extensionFromPath( $storagePath );
236			$type = $magic->guessTypesForExtension( $ext );
237			// For files without a valid extension (or one at all), inspect the contents
238			if ( !$type && $fsPath ) {
			0 ignored issues – show Bug Best Practice introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report The expression `$type` of type `null\|string` is loosely compared to `false`; this is ambiguous if the string can be empty. You might want to explicitly use `=== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history... Bug Best Practice introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report The expression `$fsPath` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
239			$type = $magic->guessMimeType( $fsPath, false );
240			} elseif ( !$type && strlen( $content ) ) {
			0 ignored issues – show Bug Best Practice introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report The expression `$type` of type `null\|string` is loosely compared to `false`; this is ambiguous if the string can be empty. You might want to explicitly use `=== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
241			$tmpFile = TempFSFile::factory( 'mime_', '', wfTempDir() );
242			file_put_contents( $tmpFile->getPath(), $content );
243			$type = $magic->guessMimeType( $tmpFile->getPath(), false );
244			}
245			return $type ?: 'unknown/unknown';
246			}
247			}
248

wikimedia / mediawiki

FileBackendGroup::singleton() A last analyzed 2016-11-13 17:42 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

FileBackendGroup::singleton() A
last analyzed 2016-11-13 17:42 UTC