ForeignDBFile.php

Go to the documentation of this file.

<?php
namespace MediaWiki\FileRepo\File;
 
use MediaWiki\FileRepo\ForeignDBRepo;
use MediaWiki\Language\Language;
use MediaWiki\MediaWikiServices;
use MediaWiki\Title\Title;
use MediaWiki\User\UserIdentity;
use Wikimedia\ObjectCache\WANObjectCache;
use Wikimedia\Rdbms\DBUnexpectedError;
 
class ForeignDBFile extends LocalFile {
 
    public function getRepo() {
        return $this->repo;
    }
 
    public function publish( $srcPath, $flags = 0, array $options = [] ): never {
        $this->readOnlyError();
    }
 
    public function restore( $versions = [], $unsuppress = false ): never {
        $this->readOnlyError();
    }
 
    public function deleteFile( $reason, UserIdentity $user, $suppress = false ): never {
        $this->readOnlyError();
    }
 
    public function move( $target ): never {
        $this->readOnlyError();
    }
 
    public function getDescriptionUrl() {
        // Restore remote behavior
        return File::getDescriptionUrl();
    }
 
    public function getDescriptionText( ?Language $lang = null ) {
        global $wgLang;
 
        if ( !$this->repo->fetchDescription ) {
            return false;
        }
 
        $lang ??= $wgLang;
        $renderUrl = $this->repo->getDescriptionRenderUrl( $this->getName(), $lang->getCode() );
        if ( !$renderUrl ) {
            return false;
        }
 
        $touched = $this->repo->getReplicaDB()->newSelectQueryBuilder()
            ->select( 'page_touched' )
            ->from( 'page' )
            ->where( [ 'page_namespace' => NS_FILE, 'page_title' => $this->title->getDBkey() ] )
            ->caller( __METHOD__ )->fetchField();
        if ( $touched === false ) {
            return false; // no description page
        }
 
        $cache = MediaWikiServices::getInstance()->getMainWANObjectCache();
        $fname = __METHOD__;
 
        return $cache->getWithSetCallback(
            $this->repo->getLocalCacheKey(
                'file-foreign-description',
                $lang->getCode(),
                md5( $this->getName() ),
                $touched
            ),
            $this->repo->descriptionCacheExpiry ?: $cache::TTL_UNCACHEABLE,
            static function ( $oldValue, &$ttl, array &$setOpts ) use ( $renderUrl, $fname ) {
                wfDebug( "Fetching shared description from $renderUrl" );
                $res = MediaWikiServices::getInstance()->getHttpRequestFactory()->
                    get( $renderUrl, [], $fname );
                if ( !$res ) {
                    $ttl = WANObjectCache::TTL_UNCACHEABLE;
                }
 
                return $res;
            }
        );
    }
 
    public function getDescriptionShortUrl() {
        $dbr = $this->repo->getReplicaDB();
        $pageId = $dbr->newSelectQueryBuilder()
            ->select( 'page_id' )
            ->from( 'page' )
            ->where( [ 'page_namespace' => NS_FILE, 'page_title' => $this->title->getDBkey() ] )
            ->caller( __METHOD__ )->fetchField();
 
        if ( $pageId !== false ) {
            $url = $this->repo->makeUrl( [ 'curid' => $pageId ] );
            if ( $url !== false ) {
                return $url;
            }
        }
        return null;
    }
 
}
 
class_alias( ForeignDBFile::class, 'ForeignDBFile' );