3 * File backend registration handling.
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.
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.
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
21 * @ingroup FileBackend
23 use \MediaWiki\Logger\LoggerFactory
;
24 use MediaWiki\MediaWikiServices
;
27 * Class to handle file backend registration
29 * @ingroup FileBackend
32 class FileBackendGroup
{
33 /** @var FileBackendGroup */
34 protected static $instance = null;
36 /** @var array (name => ('class' => string, 'config' => array, 'instance' => object)) */
37 protected $backends = [];
39 protected function __construct() {
43 * @return FileBackendGroup
45 public static function singleton() {
46 if ( self
::$instance == null ) {
47 self
::$instance = new self();
48 self
::$instance->initFromGlobals();
51 return self
::$instance;
55 * Destroy the singleton instance
57 public static function destroySingleton() {
58 self
::$instance = null;
62 * Register file backends from the global variables
64 protected function initFromGlobals() {
65 global $wgLocalFileRepo, $wgForeignFileRepos, $wgFileBackends, $wgDirectoryMode;
67 // Register explicitly defined backends
68 $this->register( $wgFileBackends, wfConfiguredReadOnlyReason() );
71 // Automatically create b/c backends for file repos...
72 $repos = array_merge( $wgForeignFileRepos, [ $wgLocalFileRepo ] );
73 foreach ( $repos as $info ) {
74 $backendName = $info['backend'];
75 if ( is_object( $backendName ) ||
isset( $this->backends
[$backendName] ) ) {
76 continue; // already defined (or set to the object for some reason)
78 $repoName = $info['name'];
79 // Local vars that used to be FSRepo members...
80 $directory = $info['directory'];
81 $deletedDir = isset( $info['deletedDir'] )
83 : false; // deletion disabled
84 $thumbDir = isset( $info['thumbDir'] )
86 : "{$directory}/thumb";
87 $transcodedDir = isset( $info['transcodedDir'] )
88 ?
$info['transcodedDir']
89 : "{$directory}/transcoded";
90 // Get the FS backend configuration
92 'name' => $backendName,
93 'class' => 'FSFileBackend',
94 'lockManager' => 'fsLockManager',
96 "{$repoName}-public" => "{$directory}",
97 "{$repoName}-thumb" => $thumbDir,
98 "{$repoName}-transcoded" => $transcodedDir,
99 "{$repoName}-deleted" => $deletedDir,
100 "{$repoName}-temp" => "{$directory}/temp"
102 'fileMode' => isset( $info['fileMode'] ) ?
$info['fileMode'] : 0644,
103 'directoryMode' => $wgDirectoryMode,
107 // Register implicitly defined backends
108 $this->register( $autoBackends, wfConfiguredReadOnlyReason() );
112 * Register an array of file backend configurations
114 * @param array $configs
115 * @param string|null $readOnlyReason
116 * @throws InvalidArgumentException
118 protected function register( array $configs, $readOnlyReason = null ) {
119 foreach ( $configs as $config ) {
120 if ( !isset( $config['name'] ) ) {
121 throw new InvalidArgumentException( "Cannot register a backend with no name." );
123 $name = $config['name'];
124 if ( isset( $this->backends
[$name] ) ) {
125 throw new LogicException( "Backend with name `{$name}` already registered." );
126 } elseif ( !isset( $config['class'] ) ) {
127 throw new InvalidArgumentException( "Backend with name `{$name}` has no class." );
129 $class = $config['class'];
131 $config['readOnly'] = !empty( $config['readOnly'] )
132 ?
$config['readOnly']
135 unset( $config['class'] ); // backend won't need this
136 $this->backends
[$name] = [
145 * Get the backend object with a given name
147 * @param string $name
148 * @return FileBackend
149 * @throws InvalidArgumentException
151 public function get( $name ) {
152 // Lazy-load the actual backend instance
153 if ( !isset( $this->backends
[$name]['instance'] ) ) {
154 $config = $this->config( $name );
156 $class = $config['class'];
157 if ( $class === 'FileBackendMultiWrite' ) {
158 foreach ( $config['backends'] as $index => $beConfig ) {
159 if ( isset( $beConfig['template'] ) ) {
160 // Config is just a modified version of a registered backend's.
161 // This should only be used when that config is used only by this backend.
162 $config['backends'][$index] +
= $this->config( $beConfig['template'] );
167 $this->backends
[$name]['instance'] = new $class( $config );
170 return $this->backends
[$name]['instance'];
174 * Get the config array for a backend object with a given name
176 * @param string $name
177 * @return array Parameters to FileBackend::__construct()
178 * @throws InvalidArgumentException
180 public function config( $name ) {
181 if ( !isset( $this->backends
[$name] ) ) {
182 throw new InvalidArgumentException( "No backend defined with the name `$name`." );
184 $class = $this->backends
[$name]['class'];
186 $config = $this->backends
[$name]['config'];
187 $config['class'] = $class;
188 $config +
= [ // set defaults
189 'wikiId' => wfWikiID(), // e.g. "my_wiki-en_"
190 'mimeCallback' => [ $this, 'guessMimeInternal' ],
191 'obResetFunc' => 'wfResetOutputBuffers',
192 'streamMimeFunc' => [ 'StreamFile', 'contentTypeFromPath' ],
193 'tmpDirectory' => wfTempDir(),
194 'statusWrapper' => [ 'Status', 'wrap' ],
195 'wanCache' => MediaWikiServices
::getInstance()->getMainWANObjectCache(),
196 'srvCache' => ObjectCache
::getLocalServerInstance( 'hash' ),
197 'logger' => LoggerFactory
::getInstance( 'FileOperation' ),
198 'profiler' => Profiler
::instance()
200 $config['lockManager'] =
201 LockManagerGroup
::singleton( $config['wikiId'] )->get( $config['lockManager'] );
202 $config['fileJournal'] = isset( $config['fileJournal'] )
203 ? FileJournal
::factory( $config['fileJournal'], $name )
204 : FileJournal
::factory( [ 'class' => 'NullFileJournal' ], $name );
210 * Get an appropriate backend object from a storage path
212 * @param string $storagePath
213 * @return FileBackend|null Backend or null on failure
215 public function backendFromPath( $storagePath ) {
216 list( $backend, , ) = FileBackend
::splitStoragePath( $storagePath );
217 if ( $backend !== null && isset( $this->backends
[$backend] ) ) {
218 return $this->get( $backend );
225 * @param string $storagePath
226 * @param string|null $content
227 * @param string|null $fsPath
231 public function guessMimeInternal( $storagePath, $content, $fsPath ) {
232 $magic = MimeMagic
::singleton();
233 // Trust the extension of the storage path (caller must validate)
234 $ext = FileBackend
::extensionFromPath( $storagePath );
235 $type = $magic->guessTypesForExtension( $ext );
236 // For files without a valid extension (or one at all), inspect the contents
237 if ( !$type && $fsPath ) {
238 $type = $magic->guessMimeType( $fsPath, false );
239 } elseif ( !$type && strlen( $content ) ) {
240 $tmpFile = TempFSFile
::factory( 'mime_', '', wfTempDir() );
241 file_put_contents( $tmpFile->getPath(), $content );
242 $type = $magic->guessMimeType( $tmpFile->getPath(), false );
244 return $type ?
: 'unknown/unknown';