RepoGroup.php

Go to the documentation of this file.

<?php
use MediaWiki\Linker\LinkTarget;
use MediaWiki\Page\PageIdentity;
use MediaWiki\Title\Title;
use Wikimedia\Mime\MimeAnalyzer;
use Wikimedia\ObjectCache\WANObjectCache;
 
class RepoGroup {
    protected $localRepo;
 
    protected $foreignRepos;
 
    protected $wanCache;
 
    protected $reposInitialised = false;
 
    protected $localInfo;
 
    protected $foreignInfo;
 
    protected $cache;
 
    private const MAX_CACHE_SIZE = 500;
 
    private $mimeAnalyzer;
 
    public function __construct(
        $localInfo,
        $foreignInfo,
        WANObjectCache $wanCache,
        MimeAnalyzer $mimeAnalyzer
    ) {
        $this->localInfo = $localInfo;
        $this->foreignInfo = $foreignInfo;
        $this->cache = new MapCacheLRU( self::MAX_CACHE_SIZE );
        $this->wanCache = $wanCache;
        $this->mimeAnalyzer = $mimeAnalyzer;
    }
 
    public function findFile( $title, $options = [] ) {
        if ( !is_array( $options ) ) {
            // MW 1.15 compat
            $options = [ 'time' => $options ];
        }
        if ( isset( $options['bypassCache'] ) ) {
            $options['latest'] = $options['bypassCache']; // b/c
        }
        if ( isset( $options['time'] ) && $options['time'] !== false ) {
            $options['time'] = wfTimestamp( TS_MW, $options['time'] );
        } else {
            $options['time'] = false;
        }
 
        if ( !$this->reposInitialised ) {
            $this->initialiseRepos();
        }
 
        $title = File::normalizeTitle( $title );
        if ( !$title ) {
            return false;
        }
 
        # Check the cache
        $dbkey = $title->getDBkey();
        $timeKey = is_string( $options['time'] ) ? $options['time'] : '';
        if ( empty( $options['ignoreRedirect'] )
            && empty( $options['private'] )
            && empty( $options['latest'] )
        ) {
            if ( $this->cache->hasField( $dbkey, $timeKey, 60 ) ) {
                return $this->cache->getField( $dbkey, $timeKey );
            }
            $useCache = true;
        } else {
            $useCache = false;
        }
 
        # Check the local repo
        $image = $this->localRepo->findFile( $title, $options );
 
        # Check the foreign repos
        if ( !$image ) {
            foreach ( $this->foreignRepos as $repo ) {
                $image = $repo->findFile( $title, $options );
                if ( $image ) {
                    break;
                }
            }
        }
 
        $image = $image instanceof File ? $image : false; // type check
        # Cache file existence or non-existence
        if ( $useCache && ( !$image || $image->isCacheable() ) ) {
            $this->cache->setField( $dbkey, $timeKey, $image );
        }
 
        return $image;
    }
 
    public function findFiles( array $inputItems, $flags = 0 ) {
        if ( !$this->reposInitialised ) {
            $this->initialiseRepos();
        }
 
        $items = [];
        foreach ( $inputItems as $item ) {
            if ( !is_array( $item ) ) {
                $item = [ 'title' => $item ];
            }
            $item['title'] = File::normalizeTitle( $item['title'] );
            if ( $item['title'] ) {
                $items[$item['title']->getDBkey()] = $item;
            }
        }
 
        $images = $this->localRepo->findFiles( $items, $flags );
 
        foreach ( $this->foreignRepos as $repo ) {
            // Remove found files from $items
            foreach ( $images as $name => $image ) {
                unset( $items[$name] );
            }
 
            $images = array_merge( $images, $repo->findFiles( $items, $flags ) );
        }
 
        return $images;
    }
 
    public function checkRedirect( $title ) {
        if ( !$this->reposInitialised ) {
            $this->initialiseRepos();
        }
 
        $title = File::normalizeTitle( $title );
 
        $redir = $this->localRepo->checkRedirect( $title );
        if ( $redir ) {
            return $redir;
        }
 
        foreach ( $this->foreignRepos as $repo ) {
            $redir = $repo->checkRedirect( $title );
            if ( $redir ) {
                return $redir;
            }
        }
 
        return false;
    }
 
    public function findFileFromKey( $hash, $options = [] ) {
        if ( !$this->reposInitialised ) {
            $this->initialiseRepos();
        }
 
        $file = $this->localRepo->findFileFromKey( $hash, $options );
        if ( !$file ) {
            foreach ( $this->foreignRepos as $repo ) {
                $file = $repo->findFileFromKey( $hash, $options );
                if ( $file ) {
                    break;
                }
            }
        }
 
        return $file;
    }
 
    public function findBySha1( $hash ) {
        if ( !$this->reposInitialised ) {
            $this->initialiseRepos();
        }
 
        $result = $this->localRepo->findBySha1( $hash );
        foreach ( $this->foreignRepos as $repo ) {
            $result = array_merge( $result, $repo->findBySha1( $hash ) );
        }
        usort( $result, [ File::class, 'compare' ] );
 
        return $result;
    }
 
    public function findBySha1s( array $hashes ) {
        if ( !$this->reposInitialised ) {
            $this->initialiseRepos();
        }
 
        $result = $this->localRepo->findBySha1s( $hashes );
        foreach ( $this->foreignRepos as $repo ) {
            $result = array_merge_recursive( $result, $repo->findBySha1s( $hashes ) );
        }
        // sort the merged (and presorted) sublist of each hash
        foreach ( $result as $hash => $files ) {
            usort( $result[$hash], [ File::class, 'compare' ] );
        }
 
        return $result;
    }
 
    public function getRepo( $index ) {
        if ( !$this->reposInitialised ) {
            $this->initialiseRepos();
        }
        if ( $index === 'local' ) {
            return $this->localRepo;
        }
        return $this->foreignRepos[$index] ?? false;
    }
 
    public function getRepoByName( $name ) {
        if ( !$this->reposInitialised ) {
            $this->initialiseRepos();
        }
        foreach ( $this->foreignRepos as $repo ) {
            if ( $repo->name == $name ) {
                return $repo;
            }
        }
 
        return false;
    }
 
    public function getLocalRepo() {
        // @phan-suppress-next-line PhanTypeMismatchReturnSuperType
        return $this->getRepo( 'local' );
    }
 
    public function forEachForeignRepo( $callback, $params = [] ) {
        if ( !$this->reposInitialised ) {
            $this->initialiseRepos();
        }
        foreach ( $this->foreignRepos as $repo ) {
            if ( $callback( $repo, ...$params ) ) {
                return true;
            }
        }
 
        return false;
    }
 
    public function hasForeignRepos() {
        if ( !$this->reposInitialised ) {
            $this->initialiseRepos();
        }
        return (bool)$this->foreignRepos;
    }
 
    public function initialiseRepos() {
        if ( $this->reposInitialised ) {
            return;
        }
        $this->reposInitialised = true;
 
        $this->localRepo = $this->newRepo( $this->localInfo );
        $this->foreignRepos = [];
        foreach ( $this->foreignInfo as $key => $info ) {
            $this->foreignRepos[$key] = $this->newRepo( $info );
        }
    }
 
    public function newCustomLocalRepo( $info = [] ) {
        // @phan-suppress-next-line PhanTypeMismatchReturnSuperType
        return $this->newRepo( $info + $this->localInfo );
    }
 
    protected function newRepo( $info ) {
        $class = $info['class'];
 
        $info['wanCache'] = $this->wanCache;
 
        return new $class( $info );
    }
 
    private function splitVirtualUrl( $url ) {
        if ( !str_starts_with( $url, 'mwrepo://' ) ) {
            throw new InvalidArgumentException( __METHOD__ . ': unknown protocol' );
        }
 
        $bits = explode( '/', substr( $url, 9 ), 3 );
        if ( count( $bits ) != 3 ) {
            throw new InvalidArgumentException( __METHOD__ . ": invalid mwrepo URL: $url" );
        }
 
        return $bits;
    }
 
    public function getFileProps( $fileName ) {
        if ( FileRepo::isVirtualUrl( $fileName ) ) {
            [ $repoName, /* $zone */, /* $rel */ ] = $this->splitVirtualUrl( $fileName );
            if ( $repoName === '' ) {
                $repoName = 'local';
            }
            $repo = $this->getRepo( $repoName );
 
            return $repo->getFileProps( $fileName );
        } else {
            $mwProps = new MWFileProps( $this->mimeAnalyzer );
 
            return $mwProps->getPropsFromPath( $fileName, true );
        }
    }
 
    public function clearCache( $title = null ) {
        if ( $title == null ) {
            $this->cache->clear();
        } elseif ( is_string( $title ) ) {
            $this->cache->clear( $title );
        } else {
            $this->cache->clear( $title->getDBkey() );
        }
    }
}