FileBackendGroup.php

Go to the documentation of this file.

<?php
use \MediaWiki\Logger\LoggerFactory;
use MediaWiki\MediaWikiServices;

class FileBackendGroup {
    protected static $instance = null;

    protected $backends = [];

    protected function __construct() {
    }

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

        return self::$instance;
    }

    public static function destroySingleton() {
        self::$instance = null;
    }

    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() );
    }

    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
            ];
        }
    }

    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'];
    }

    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;
    }

    public function backendFromPath( $storagePath ) {
        list( $backend, , ) = FileBackend::splitStoragePath( $storagePath );
        if ( $backend !== null && isset( $this->backends[$backend] ) ) {
            return $this->get( $backend );
        }

        return null;
    }

    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 ) {
            $type = $magic->guessMimeType( $fsPath, false );
        } elseif ( !$type && strlen( $content ) ) {
            $tmpFile = TempFSFile::factory( 'mime_', '', wfTempDir() );
            file_put_contents( $tmpFile->getPath(), $content );
            $type = $magic->guessMimeType( $tmpFile->getPath(), false );
        }
        return $type ?: 'unknown/unknown';
    }
}