TranslationEditPage.php

Go to the documentation of this file.

<?php
class TranslationEditPage {
    // Instance of an Title object
    protected $title;
    protected $suggestions = 'sync';

    public function __construct( Title $title ) {
        $this->setTitle( $title );
    }

    public static function newFromRequest( WebRequest $request ) {
        $title = Title::newFromText( $request->getText( 'page' ) );

        if ( !$title ) {
            return null;
        }

        $obj = new self( $title );
        $obj->suggestions = $request->getText( 'suggestions' );

        return $obj;
    }

    public function setTitle( Title $title ) {
        $this->title = $title;
    }

    public function getTitle() {
        return $this->title;
    }

    public function execute() {
        global $wgServer, $wgScriptPath;

        $context = RequestContext::getMain();

        $context->getOutput()->disable();

        $data = $this->getEditInfo();
        $groupId = $context->getRequest()->getText( 'loadgroup', '' );
        $helpers = new TranslationHelpers( $this->getTitle(), $groupId );

        $id = "tm-target-{$helpers->dialogID()}";
        $helpers->setTextareaId( $id );

        if ( $this->suggestions === 'only' ) {
            echo $helpers->getBoxes( $this->suggestions );

            return;
        }

        if ( $this->suggestions === 'checks' ) {
            echo $helpers->getBoxes( $this->suggestions );

            return;
        }

        $handle = new MessageHandle( $this->getTitle() );
        $groupId = MessageIndex::getPrimaryGroupId( $handle );

        $translation = '';
        if ( $groupId ) {
            $translation = $helpers->getTranslation();
        }

        $targetLang = Language::factory( $helpers->getTargetLanguage() );
        $textareaParams = array(
            'name' => 'text',
            'class' => 'mw-translate-edit-area',
            'id' => $id,
            /* Target language might differ from interface language. Set
             * a suitable default direction */
            'lang' => $targetLang->getCode(),
            'dir' => $targetLang->getDir(),
        );

        if ( !$groupId || !$context->getUser()->isAllowed( 'translate' ) ) {
            $textareaParams['readonly'] = 'readonly';
        }

        $extraInputs = '';
        wfRunHooks( 'TranslateGetExtraInputs', array( &$translation, &$extraInputs ) );

        $textarea = Html::element( 'textarea', $textareaParams, $translation );

        $hidden = array();
        $hidden[] = Html::hidden( 'title', $this->getTitle()->getPrefixedDbKey() );

        if ( isset( $data['revisions'][0]['timestamp'] ) ) {
            $hidden[] = Html::hidden( 'basetimestamp', $data['revisions'][0]['timestamp'] );
        }

        $hidden[] = Html::hidden( 'starttimestamp', $data['starttimestamp'] );
        if ( isset( $data['edittoken'] ) ) {
            $hidden[] = Html::hidden( 'token', $data['edittoken'] );
        }
        $hidden[] = Html::hidden( 'format', 'json' );
        $hidden[] = Html::hidden( 'action', 'edit' );

        $summary = Xml::inputLabel(
            $context->msg( 'translate-js-summary' )->text(),
            'summary',
            'summary',
            40
        );
        $save = Xml::submitButton(
            $context->msg( 'translate-js-save' )->text(),
            array( 'class' => 'mw-translate-save' )
        );
        $saveAndNext = Xml::submitButton(
            $context->msg( 'translate-js-next' )->text(),
            array( 'class' => 'mw-translate-next' )
        );
        $skip = Html::element( 'input', array(
            'class' => 'mw-translate-skip',
            'type' => 'button',
            'value' => $context->msg( 'translate-js-skip' )->text()
        ) );

        if ( $this->getTitle()->exists() ) {
            $history = Html::element(
                'input',
                array(
                    'class' => 'mw-translate-history',
                    'type' => 'button',
                    'value' => $context->msg( 'translate-js-history' )->text()
                )
            );
        } else {
            $history = '';
        }

        $support = $this->getSupportButton( $this->getTitle() );

        if ( $context->getUser()->isAllowed( 'translate' ) ) {
            $bottom = "$summary$save$saveAndNext$skip$history$support";
        } else {
            $text = $context->msg( 'translate-edit-nopermission' )->escaped();
            $button = $this->getPermissionPageButton();
            $bottom = "$text $button$skip$history$support";
        }

        // Use the api to submit edits
        $formParams = array(
            'action' => "{$wgServer}{$wgScriptPath}/api.php",
            'method' => 'post',
        );

        $form = Html::rawElement( 'form', $formParams,
            implode( "\n", $hidden ) . "\n" .
                $helpers->getBoxes( $this->suggestions ) . "\n" .
                Html::rawElement(
                    'div',
                    array( 'class' => 'mw-translate-inputs' ),
                    "$textarea\n$extraInputs"
                ) . "\n" .
                Html::rawElement( 'div', array( 'class' => 'mw-translate-bottom' ), $bottom )
        );

        echo Html::rawElement( 'div', array( 'class' => 'mw-ajax-dialog' ), $form );
    }

    protected function getEditInfo() {
        $params = new FauxRequest( array(
            'action' => 'query',
            'prop' => 'info|revisions',
            'intoken' => 'edit',
            'titles' => $this->getTitle(),
            'rvprop' => 'timestamp',
        ) );

        $api = new ApiMain( $params );
        $api->execute();
        $data = $api->getResultData();

        if ( !isset( $data['query']['pages'] ) ) {
            throw new MWException( 'Api query failed' );
        }
        $data = $data['query']['pages'];
        $data = array_shift( $data );

        return $data;
    }

    public static function jsEdit( Title $title, $group = "", $type = 'default' ) {
        $context = RequestContext::getMain();

        if ( !$context->getUser()->getOption( 'translate-jsedit' ) ) {
            return array();
        }

        if ( $type === 'default' ) {
            $text = 'tqe-anchor-' . substr( sha1( $title->getPrefixedText() ), 0, 12 );
            $onclick = "jQuery( '#$text' ).dblclick(); return false;";
        } else {
            $onclick = Xml::encodeJsCall(
                'return mw.translate.openDialog', array( $title->getPrefixedDbKey(), $group )
            );
        }

        return array(
            'onclick' => $onclick,
            'title' => $context->msg( 'translate-edit-title', $title->getPrefixedText() )->text()
        );
    }

    protected function getSupportButton( $title ) {
        global $wgTranslateSupportUrl;
        if ( !$wgTranslateSupportUrl ) {
            return '';
        }

        $supportTitle = Title::newFromText( $wgTranslateSupportUrl['page'] );
        if ( !$supportTitle ) {
            return '';
        }

        $supportParams = $wgTranslateSupportUrl['params'];
        foreach ( $supportParams as &$value ) {
            $value = str_replace( '%MESSAGE%', $title->getPrefixedText(), $value );
        }

        $support = Html::element(
            'input',
            array(
                'class' => 'mw-translate-support',
                'type' => 'button',
                'value' => wfMessage( 'translate-js-support' )->text(),
                'title' => wfMessage( 'translate-js-support-title' )->text(),
                'data-load-url' => $supportTitle->getLocalUrl( $supportParams ),
            )
        );

        return $support;
    }

    protected function getPermissionPageButton() {
        global $wgTranslatePermissionUrl;
        if ( !$wgTranslatePermissionUrl ) {
            return '';
        }

        $title = Title::newFromText( $wgTranslatePermissionUrl );
        if ( !$title ) {
            return '';
        }

        $button = Html::element(
            'input',
            array(
                'class' => 'mw-translate-askpermission',
                'type' => 'button',
                'value' => wfMessage( 'translate-edit-askpermission' )->text(),
                'data-load-url' => $title->getLocalUrl(),
            )
        );

        return $button;
    }
}