TranslationAidDataProvider.php

<?php
declare( strict_types = 1 );
 
namespace MediaWiki\Extension\Translate\TranslatorInterface\Aid;
 
use Content;
use ContentHandler;
use MediaWiki\Extension\Translate\MessageGroupProcessing\RevTagStore;
use MediaWiki\Extension\Translate\TranslatorInterface\TranslationHelperException;
use MediaWiki\MediaWikiServices;
use MediaWiki\Revision\RevisionRecord;
use MediaWiki\Revision\SlotRecord;
use MessageGroup;
use MessageHandle;
use TextContent;
use Wikimedia\Rdbms\IDatabase;
 
class TranslationAidDataProvider {
    private $handle;
    private $group;
    private $definition;
    private $translations;
 
    public function __construct( MessageHandle $handle ) {
        $this->handle = $handle;
        $this->group = $handle->getGroup();
    }
 
    public function getDefinition(): string {
        if ( $this->definition !== null ) {
            return $this->definition;
        }
 
        // Optional performance optimization
        if ( is_callable( [ $this->group, 'getMessageContent' ] ) ) {
            // @phan-suppress-next-line PhanUndeclaredMethod
            $this->definition = $this->group->getMessageContent( $this->handle );
        } else {
            $this->definition = $this->group->getMessage(
                $this->handle->getKey(),
                $this->group->getSourceLanguage()
            );
        }
 
        if ( $this->definition === null ) {
            throw new TranslationHelperException(
                'Did not find message definition for ' . $this->handle->getTitle()->getPrefixedText() .
                ' in group ' . $this->group->getId()
            );
        }
        return $this->definition;
    }
 
    public function hasDefinition(): bool {
        try {
            $this->getDefinition();
            return true;
        } catch ( TranslationHelperException $e ) {
            return false;
        }
    }
 
    public function getDefinitionContent(): Content {
        return ContentHandler::makeContent( $this->getDefinition(), $this->handle->getTitle() );
    }
 
    public function getGoodTranslations(): array {
        if ( $this->translations !== null ) {
            return $this->translations;
        }
 
        $data = self::loadTranslationData( wfGetDB( DB_REPLICA ), $this->handle );
        $translations = [];
        $prefixLength = strlen( $this->handle->getTitleForBase()->getDBKey() . '/' );
        $languageNameUtils = MediaWikiServices::getInstance()->getLanguageNameUtils();
 
        foreach ( $data as $page => $translation ) {
            // Could use MessageHandle here, but that queries the message index.
            // Instead we can get away with simple string manipulation.
            $code = substr( $page, $prefixLength );
            if ( !$languageNameUtils->isKnownLanguageTag( $code ) ) {
                continue;
            }
 
            $translations[ $code ] = $translation;
        }
 
        $this->translations = $translations;
 
        return $translations;
    }
 
    private static function loadTranslationData( IDatabase $db, MessageHandle $handle ): array {
        $revisionStore = MediaWikiServices::getInstance()->getRevisionStore();
        $queryInfo = $revisionStore->getQueryInfo( [ 'page' ] );
        $tables = $queryInfo[ 'tables' ];
        $fields = $queryInfo[ 'fields' ];
        $conds = [];
        $options = [];
        $joins = $queryInfo[ 'joins' ];
 
        // The list of pages we want to select, and their latest versions
        $conds['page_namespace'] = $handle->getTitle()->getNamespace();
        $base = $handle->getKey();
        $conds[] = 'page_title ' . $db->buildLike( "$base/", $db->anyString() );
        $conds[] = 'rev_id=page_latest';
 
        // For fuzzy tags we also need:
        $tables[] = 'revtag';
        $conds[ 'rt_type' ] = null;
        $joins[ 'revtag' ] = [
            'LEFT JOIN',
            [ 'page_id=rt_page', 'page_latest=rt_revision', 'rt_type' => RevTagStore::FUZZY_TAG ]
        ];
 
        $rows = $db->select( $tables, $fields, $conds, __METHOD__, $options, $joins );
 
        $pages = [];
        $revisions = $revisionStore->newRevisionsFromBatch( $rows, [ 'slots' => [ SlotRecord::MAIN ] ] )
            ->getValue();
        foreach ( $rows as $row ) {
            $rev = $revisions[$row->rev_id];
            if ( $rev && $rev->getContent( SlotRecord::MAIN ) instanceof TextContent ) {
                $pages[$row->page_title] = $rev->getContent( SlotRecord::MAIN )->getText();
            }
        }
 
        return $pages;
    }
}