ApiHardMessages.php

Go to the documentation of this file.

<?php
class ApiHardMessages extends ApiBase {
    protected static $right = 'translate';

    public function execute() {
        if ( !$this->getUser()->isAllowed( self::$right ) ) {
            $this->dieUsage( 'Permission denied', 'permissiondenied' );
        }

        $params = $this->extractRequestParams();
        $title = Title::newFromText( $params['title'] );

        if ( !$title ) {
            $this->dieUsage( 'Invalid title', 'invalidtitle' );
        }

        $handle = new MessageHandle( $title );
        if ( !$handle->isValid() ) {
            $this->dieUsage( 'Invalid title', 'invalidtitle' );
        }

        $baseTitle = Title::makeTitle( $title->getNamespace(),
            $handle->getKey() . '/' . $handle->getGroup()->getSourceLanguage() );
        $revision = Revision::newFromTitle( $baseTitle );

        if ( !$revision ) {
            // This can fail. See https://bugzilla.wikimedia.org/show_bug.cgi?id=43286
            $this->dieUsage( 'Invalid revision', 'invalidrevision' );
        }

        $count = self::getHardCount( $revision ) + 1;
        self::doMarkHard( $revision, $count );

        $output = array(
            'title' => $baseTitle->getPrefixedText(),
            'pageid' => $revision->getPage(),
            'revision' => $revision->getId(),
            'count' => $count
        );

        $this->getResult()->addValue( null, $this->getModuleName(), $output );
    }

    public static function doMarkHard( Revision $revision, $count ) {
        $dbw = wfGetDB( DB_MASTER );
        $table = 'revtag';

        if ( $count === 1 ) {
            $row = array(
                'rt_type' => 'hard',
                'rt_page' => $revision->getPage(),
                'rt_revision' => $revision->getId(),
                'rt_value' => $count
            );
            $options = array( 'IGNORE' );
            $dbw->insert( $table, $row, __METHOD__, $options );
        } else {
            $dbw->update( $table,
                array(
                    'rt_value' => $count
                ),
                array(
                    'rt_type' => 'hard',
                    'rt_page' => $revision->getPage(),
                ),
                __METHOD__
            );
        }
    }

    public static function getHardCount( Revision $revision ) {
        $dbr = wfGetDB( DB_SLAVE );
        $res = $dbr->selectField(
            'revtag',
            'rt_value',
            array( 'rt_type = "hard"',
                'rt_page = ' . $revision->getPage(),
            ),
            __METHOD__
        );

        $count = intval( $res );

        return $count;
    }

    public function isWriteMode() {
        return true;
    }

    public function needsToken() {
        return true;
    }

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

    public function getParamDescription() {
        $action = TranslateUtils::getTokenAction( 'hardmessages' );

        return array(
            'title' => 'The title of the message to mark hard',
            'token' => "A token previously acquired with $action",
        );
    }

    public function getDescription() {
        return 'Mark translations hard';
    }

    public function getPossibleErrors() {
        $right = self::$right;

        return array_merge( parent::getPossibleErrors(), array(
            array( 'code' => 'permissiondenied', 'info' => "You must have $right right" ),
            array( 'code' => 'invalidtitle', 'info' => 'Title $1 is invalid' ),
            array( 'code' => 'invalidrevision', 'info' => 'Revision $1 is invalid' ),
        ) );
    }

    public function getExamples() {
        return array(
            'api.php?action=hardmessages&title=SampleTitle&token=foo',
        );
    }

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

    public static function getToken() {
        $user = RequestContext::getMain()->getUser();
        if ( !$user->isAllowed( self::$right ) ) {
            return false;
        }

        return $user->getEditToken();
    }

    public static function injectTokenFunction( &$list ) {
        $list['hardmessage'] = array( __CLASS__, 'getToken' );

        return true;
    }

    public static function getRight() {
        return self::$right;
    }
}