ApiQueryTitleBlacklist.php

Go to the documentation of this file.

<?php
class ApiQueryTitleBlacklist extends ApiBase {
 
    public function __construct( $query, $moduleName ) {
        parent::__construct( $query, $moduleName, 'tb' );
    }
 
    public function execute() {
        $params = $this->extractRequestParams();
        $action = $params['action'];
        $override = !$params['nooverride'];
 
        // createtalk and createpage are useless as they're treated exactly like create
        if ( $action === 'createpage' || $action === 'createtalk' ) {
            $action = 'create';
        }
 
        $title = Title::newFromText( $params['title'] );
        if ( !$title ) {
            if ( is_callable( [ $this, 'dieWithError' ] ) ) {
                $this->dieWithError(
                    [ 'apierror-invalidtitle', wfEscapeWikiText( $params['title'] ) ]
                );
            } else {
                $this->dieUsageMsg( [ 'invalidtitle', $params['title'] ] );
            }
        }
 
        $blacklisted = TitleBlacklist::singleton()->userCannot(
            $title, $this->getUser(), $action, $override
        );
        if ( $blacklisted instanceof TitleBlacklistEntry ) {
            // this title is blacklisted.
            $result = [
                htmlspecialchars( $blacklisted->getRaw() ),
                htmlspecialchars( $params['title'] ),
            ];
 
            $res = $this->getResult();
            $res->addValue( 'titleblacklist', 'result', 'blacklisted' );
            // there aren't any messages for create(talk|page), using edit for those instead
            $message = $blacklisted->getErrorMessage( $action !== 'create' ? $action : 'edit' );
            $res->addValue( 'titleblacklist', 'reason', wfMessage( $message, $result )->text() );
            $res->addValue( 'titleblacklist', 'message', $message );
            $res->addValue( 'titleblacklist', 'line', htmlspecialchars( $blacklisted->getRaw() ) );
        } else {
            // not blacklisted
            $this->getResult()->addValue( 'titleblacklist', 'result', 'ok' );
        }
    }
 
    public function getAllowedParams() {
        return [
            'title' => [
                ApiBase::PARAM_REQUIRED => true,
            ],
            'action' => [
                ApiBase::PARAM_DFLT => 'edit',
                ApiBase::PARAM_ISMULTI => false,
                ApiBase::PARAM_TYPE => [
                    // createtalk and createpage are useless as they're treated exactly like create
                    'create', 'edit', 'upload', 'createtalk', 'createpage', 'move', 'new-account'
                ],
            ],
            'nooverride' => [
                ApiBase::PARAM_DFLT => false,
            ]
        ];
    }
 
    protected function getExamplesMessages() {
        return [
            'action=titleblacklist&tbtitle=Foo'
                => 'apihelp-titleblacklist-example-1',
            'action=titleblacklist&tbtitle=Bar&tbaction=edit'
                => 'apihelp-titleblacklist-example-2',
        ];
    }
}