ApiQueryMessageTranslations.php

Go to the documentation of this file.

<?php
class ApiQueryMessageTranslations extends ApiQueryBase {

    public function __construct( $query, $moduleName ) {
        parent::__construct( $query, $moduleName, 'mt' );
    }

    public function getCacheMode( $params ) {
        return 'public';
    }

    public static function getTranslations( MessageHandle $handle ) {
        $namespace = $handle->getTitle()->getNamespace();
        $base = $handle->getKey();

        $dbr = wfGetDB( DB_SLAVE );

        $res = $dbr->select( 'page',
            array( 'page_namespace', 'page_title' ),
            array(
                'page_namespace' => $namespace,
                'page_title ' . $dbr->buildLike( "$base/", $dbr->anyString() ),
            ),
            __METHOD__,
            array(
                'ORDER BY' => 'page_title',
                'USE INDEX' => 'name_title',
            )
        );

        $titles = array();
        foreach ( $res as $row ) {
            $titles[] = $row->page_title;
        }

        if ( $titles === array() ) {
            return array();
        }

        $pageInfo = TranslateUtils::getContents( $titles, $namespace );

        return $pageInfo;
    }

    public function execute() {
        $params = $this->extractRequestParams();

        $title = Title::newFromText( $params['title'] );
        if ( !$title ) {
            $this->dieUsage( 'Invalid title', 'invalidtitle' );
        }

        $handle = new MessageHandle( $title );
        if ( !$handle->isValid() ) {
            $this->dieUsage(
                'Title does not correspond to a translatable message',
                'nomessagefortitle'
            );
        }

        $namespace = $title->getNamespace();
        $pageInfo = self::getTranslations( $handle );

        $result = $this->getResult();
        $count = 0;

        foreach ( $pageInfo as $key => $info ) {
            if ( ++$count <= $params['offset'] ) {
                continue;
            }

            $tTitle = Title::makeTitle( $namespace, $key );
            $tHandle = new MessageHandle( $tTitle );

            $data = array(
                'title' => $tTitle->getPrefixedText(),
                'language' => $tHandle->getCode(),
                'lasttranslator' => $info[1],
            );

            $fuzzy = MessageHandle::hasFuzzyString( $info[0] ) || $tHandle->isFuzzy();

            if ( $fuzzy ) {
                $data['fuzzy'] = 'fuzzy';
            }

            $translation = str_replace( TRANSLATE_FUZZY, '', $info[0] );
            $result->setContent( $data, $translation );

            $fit = $result->addValue( array( 'query', $this->getModuleName() ), null, $data );
            if ( !$fit ) {
                $this->setContinueEnumParameter( 'offset', $count );
                break;
            }
        }

        $result->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), 'message' );
    }

    public function getAllowedParams() {
        return array(
            'title' => array(
                ApiBase::PARAM_TYPE => 'string',
                ApiBase::PARAM_REQUIRED => true,
            ),
            'offset' => array(
                ApiBase::PARAM_DFLT => 0,
                ApiBase::PARAM_TYPE => 'integer',
            ),
        );
    }

    public function getParamDescription() {
        return array(
            'title' => 'Full title of a known message',
        );
    }

    public function getDescription() {
        return 'Query all translations for a single message';
    }

    public function getPossibleErrors() {
        return array_merge( parent::getPossibleErrors(), array(
            array( 'code' => 'invalidtitle', 'info' => 'The given title is invalid' ),
            array(
                'code' => 'nomessagefortitle',
                'info' => 'Title does not correspond to a translatable message'
            ),
        ) );
    }

    protected function getExamples() {
        return array(
            "api.php?action=query&meta=messagetranslations&mttitle=MediaWiki:January " .
                "List of translations in the wiki for MediaWiki:January",
        );
    }

    public function getVersion() {
        return __CLASS__ . ': ' . TRANSLATE_VERSION;
    }
}