SpecialImportTranslations.php

Go to the documentation of this file.

<?php
class SpecialImportTranslations extends SpecialPage {
    public function __construct() {
        parent::__construct( 'ImportTranslations', 'translate-import' );
    }

    public function execute( $parameters ) {
        $this->setHeaders();

        // Security and validity checks
        if ( !$this->userCanExecute( $this->getUser() ) ) {
            $this->displayRestrictionError();

            return;
        }

        if ( !$this->getRequest()->wasPosted() ) {
            $this->outputForm();

            return;
        }

        if ( !$this->getUser()->matchEditToken( $this->getRequest()->getVal( 'token' ) ) ) {
            $this->getOutput()->addWikiMsg( 'session_fail_preview' );
            $this->outputForm();

            return;
        }

        if ( $this->getRequest()->getCheck( 'process' ) ) {
            $data = $this->getCachedData();
            if ( !$data ) {
                $this->getOutput()->addWikiMsg( 'session_fail_preview' );
                $this->outputForm();

                return;
            }
        } else {
            $file = null;
            $msg = $this->loadFile( $file );
            if ( $this->checkError( $msg ) ) {
                return;
            }

            $msg = $this->parseFile( $file );
            if ( $this->checkError( $msg ) ) {
                return;
            }

            $data = $msg[1];
            $this->setCachedData( $data );
        }

        $messages = $data['MESSAGES'];
        $group = $data['METADATA']['group'];
        $code = $data['METADATA']['code'];

        if ( !MessageGroups::exists( $group ) ) {
            $errorWrap = "<div class='error'>\n$1\n</div>";
            $this->getOutput()->wrapWikiMsg( $errorWrap, 'translate-import-err-stale-group' );

            return;
        }

        $importer = new MessageWebImporter( $this->getTitle(), $group, $code );
        $alldone = $importer->execute( $messages );

        if ( $alldone ) {
            $this->deleteCachedData();
        }
    }

    protected function checkError( $msg ) {
        // Give grep a chance to find the usages:
        // translate-import-err-dl-failed, translate-import-err-ul-failed,
        // translate-import-err-invalid-title, translate-import-err-no-such-file,
        // translate-import-err-stale-group, translate-import-err-no-headers,
        // translate-import-err-warnings
        if ( $msg[0] !== 'ok' ) {
            $errorWrap = "<div class='error'>\n$1\n</div>";
            $msg[0] = 'translate-import-err-' . $msg[0];
            $this->getOutput()->wrapWikiMsg( $errorWrap, $msg );
            $this->outputForm();

            return true;
        }

        return false;
    }

    protected function outputForm() {
        $this->getOutput()->addModules( 'ext.translate.special.importtranslations' );
        TranslateUtils::addSpecialHelpLink(
            $this->getOutput(),
            'Help:Extension:Translate/Off-line_translation'
        );
        $this->getOutput()->addHTML(
            Xml::openElement( 'form', array(
                'action' => $this->getTitle()->getLocalUrl(),
                'method' => 'post',
                'enctype' => 'multipart/form-data',
                'id' => 'mw-translate-import',
            ) ) .
                Html::hidden( 'token', $this->getUser()->getEditToken() ) .
                Html::hidden( 'title', $this->getTitle()->getPrefixedText() ) .
                Xml::inputLabel(
                    $this->msg( 'translate-import-from-local' )->text(),
                    'upload-local', // name
                    'mw-translate-up-local-input', // id
                    50, // size
                    $this->getRequest()->getText( 'upload-local' ),
                    array( 'type' => 'file' )
                ) .
                Xml::submitButton( $this->msg( 'translate-import-load' )->text() ) .
                Xml::closeElement( 'form' )
        );
    }

    protected function loadFile( &$filedata ) {
        $filename = $this->getRequest()->getFileTempname( 'upload-local' );

        if ( !is_uploaded_file( $filename ) ) {
            return array( 'ul-failed' );
        }

        $filedata = file_get_contents( $filename );

        return array( 'ok' );
    }

    protected function parseFile( $data ) {
        $group = MessageGroupBase::factory( array(
            'FILES' => array(
                'class' => 'GettextFFS',
                'CtxtAsKey' => true,
            ),
            'BASIC' => array(
                'class' => 'FileBasedMessageGroup',
                'namespace' => -1,
            )
        ) );

        $ffs = new GettextFFS( $group );
        $data = $ffs->readFromVariable( $data );

        $metadata = $data['METADATA'];

        if ( !isset( $metadata['code'] ) || !isset( $metadata['group'] ) ) {
            return array( 'no-headers' );
        }

        if ( isset( $metadata['warnings'] ) ) {
            return array( 'warnings', $this->getLanguage()->commaList( $metadata['warnings'] ) );
        }

        return array( 'ok', $data );
    }

    protected function setCachedData( $data ) {
        $key = wfMemcKey( 'translate', 'webimport', $this->getUser()->getId() );
        wfGetCache( CACHE_DB )->set( $key, $data, 60 * 30 );
    }

    protected function getCachedData() {
        $key = wfMemcKey( 'translate', 'webimport', $this->getUser()->getId() );

        return wfGetCache( CACHE_DB )->get( $key );
    }

    protected function deleteCachedData() {
        $key = wfMemcKey( 'translate', 'webimport', $this->getUser()->getId() );

        return wfGetCache( CACHE_DB )->delete( $key );
    }
}