RepoGroup.php

Go to the documentation of this file.

<?php
class RepoGroup {
    var $localRepo;

    var $foreignRepos, $reposInitialised = false;
    var $localInfo, $foreignInfo;
    var $cache;

    protected static $instance;
    const MAX_CACHE_SIZE = 500;

    static function singleton() {
        if ( self::$instance ) {
            return self::$instance;
        }
        global $wgLocalFileRepo, $wgForeignFileRepos;
        self::$instance = new RepoGroup( $wgLocalFileRepo, $wgForeignFileRepos );
        return self::$instance;
    }

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

    static function setSingleton( $instance ) {
        self::$instance = $instance;
    }

    function __construct( $localInfo, $foreignInfo ) {
        $this->localInfo = $localInfo;
        $this->foreignInfo = $foreignInfo;
        $this->cache = array();
    }

    function findFile( $title, $options = array() ) {
        if ( !is_array( $options ) ) {
            // MW 1.15 compat
            $options = array( 'time' => $options );
        }
        if ( !$this->reposInitialised ) {
            $this->initialiseRepos();
        }
        $title = File::normalizeTitle( $title );
        if ( !$title ) {
            return false;
        }

        # Check the cache
        if ( empty( $options['ignoreRedirect'] )
            && empty( $options['private'] )
            && empty( $options['bypassCache'] ) )
        {
            $time = isset( $options['time'] ) ? $options['time'] : '';
            $dbkey = $title->getDBkey();
            if ( isset( $this->cache[$dbkey][$time] ) ) {
                wfDebug( __METHOD__ . ": got File:$dbkey from process cache\n" );
                # Move it to the end of the list so that we can delete the LRU entry later
                $this->pingCache( $dbkey );
                # Return the entry
                return $this->cache[$dbkey][$time];
            }
            $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 ? $image : false; // type sanity
        # Cache file existence or non-existence
        if ( $useCache && ( !$image || $image->isCacheable() ) ) {
            $this->trimCache();
            $this->cache[$dbkey][$time] = $image;
        }

        return $image;
    }

    function findFiles( $inputItems ) {
        if ( !$this->reposInitialised ) {
            $this->initialiseRepos();
        }

        $items = array();
        foreach ( $inputItems as $item ) {
            if ( !is_array( $item ) ) {
                $item = array( 'title' => $item );
            }
            $item['title'] = File::normalizeTitle( $item['title'] );
            if ( $item['title'] ) {
                $items[$item['title']->getDBkey()] = $item;
            }
        }

        $images = $this->localRepo->findFiles( $items );

        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 ) );
        }
        return $images;
    }

    function checkRedirect( Title $title ) {
        if ( !$this->reposInitialised ) {
            $this->initialiseRepos();
        }

        $redir = $this->localRepo->checkRedirect( $title );
        if ( $redir ) {
            return $redir;
        }
        foreach ( $this->foreignRepos as $repo ) {
            $redir = $repo->checkRedirect( $title );
            if ( $redir ) {
                return $redir;
            }
        }
        return false;
    }

    function findFileFromKey( $hash, $options = array() ) {
        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;
    }

    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::compare' );
        return $result;
    }

    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::compare' );
        }
        return $result;
    }

    function getRepo( $index ) {
        if ( !$this->reposInitialised ) {
            $this->initialiseRepos();
        }
        if ( $index === 'local' ) {
            return $this->localRepo;
        } elseif ( isset( $this->foreignRepos[$index] ) ) {
            return $this->foreignRepos[$index];
        } else {
            return false;
        }
    }

    function getRepoByName( $name ) {
        if ( !$this->reposInitialised ) {
            $this->initialiseRepos();
        }
        foreach ( $this->foreignRepos as $repo ) {
            if ( $repo->name == $name ) {
                return $repo;
            }
        }
        return false;
    }

    function getLocalRepo() {
        return $this->getRepo( 'local' );
    }

    function forEachForeignRepo( $callback, $params = array() ) {
        foreach ( $this->foreignRepos as $repo ) {
            $args = array_merge( array( $repo ), $params );
            if ( call_user_func_array( $callback, $args ) ) {
                return true;
            }
        }
        return false;
    }

    function hasForeignRepos() {
        return (bool)$this->foreignRepos;
    }

    function initialiseRepos() {
        if ( $this->reposInitialised ) {
            return;
        }
        $this->reposInitialised = true;

        $this->localRepo = $this->newRepo( $this->localInfo );
        $this->foreignRepos = array();
        foreach ( $this->foreignInfo as $key => $info ) {
            $this->foreignRepos[$key] = $this->newRepo( $info );
        }
    }

    protected function newRepo( $info ) {
        $class = $info['class'];
        return new $class( $info );
    }

    function splitVirtualUrl( $url ) {
        if ( substr( $url, 0, 9 ) != 'mwrepo://' ) {
            throw new MWException( __METHOD__ . ': unknown protocol' );
        }

        $bits = explode( '/', substr( $url, 9 ), 3 );
        if ( count( $bits ) != 3 ) {
            throw new MWException( __METHOD__ . ": invalid mwrepo URL: $url" );
        }
        return $bits;
    }

    function getFileProps( $fileName ) {
        if ( FileRepo::isVirtualUrl( $fileName ) ) {
            list( $repoName, /* $zone */, /* $rel */ ) = $this->splitVirtualUrl( $fileName );
            if ( $repoName === '' ) {
                $repoName = 'local';
            }
            $repo = $this->getRepo( $repoName );
            return $repo->getFileProps( $fileName );
        } else {
            return FSFile::getPropsFromPath( $fileName );
        }
    }

    protected function pingCache( $key ) {
        if ( isset( $this->cache[$key] ) ) {
            $tmp = $this->cache[$key];
            unset( $this->cache[$key] );
            $this->cache[$key] = $tmp;
        }
    }

    protected function trimCache() {
        while ( count( $this->cache ) >= self::MAX_CACHE_SIZE ) {
            reset( $this->cache );
            $key = key( $this->cache );
            wfDebug( __METHOD__ . ": evicting $key\n" );
            unset( $this->cache[$key] );
        }
    }

    public function clearCache( Title $title = null ) {
        if ( $title == null ) {
            $this->cache = array();
        } else {
            $dbKey = $title->getDBkey();
            if ( isset( $this->cache[$dbKey] ) ) {
                unset( $this->cache[$dbKey] );
            }
        }
    }
}