Page MenuHomeWickedGov Phorge
Files F4121084

ApiTitleBlacklist.php
No OneTemporary
Actions

Size
3 KB
Referenced Files
None
Subscribers
None

ApiTitleBlacklist.php
View Options

<?php
/**
* TitleBlacklist extension API
*
* Copyright © 2011 Wikimedia Foundation and Ian Baker <ian@wikimedia.org>
* Based on code by Victor Vasiliev, Bryan Tong Minh, Roan Kattouw, and Alex Z.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*/
namespace MediaWiki\Extension\TitleBlacklist\Api;
use MediaWiki\Api\ApiBase;
use MediaWiki\Extension\TitleBlacklist\TitleBlacklist;
use MediaWiki\Extension\TitleBlacklist\TitleBlacklistEntry;
use MediaWiki\Title\Title;
use Wikimedia\ParamValidator\ParamValidator;
/**
* Module to check a title against the blacklist
*
* @ingroup API
* @ingroup Extensions
*/
class ApiTitleBlacklist extends ApiBase {
public function __construct( $mainModule, $moduleName ) {
parent::__construct( $mainModule, $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 ) {
$this->dieWithError(
[ 'apierror-invalidtitle', wfEscapeWikiText( $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' );
$messageObj = $this->msg( $message, $result )->page( $title );
if ( $this->getErrorFormatter()->getFormat() === 'html' ) {
$res->addValue( 'titleblacklist', 'reason', $messageObj->parse() );
} else {
$res->addValue( 'titleblacklist', 'reason', $messageObj->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' => [
ParamValidator::PARAM_REQUIRED => true,
],
'action' => [
ParamValidator::PARAM_DEFAULT => 'edit',
ParamValidator::PARAM_ISMULTI => false,
ParamValidator::PARAM_TYPE => [
// createtalk and createpage are useless as they're treated exactly like create
'create', 'edit', 'upload', 'createtalk', 'createpage', 'move', 'new-account'
],
],
'nooverride' => [
ParamValidator::PARAM_DEFAULT => false,
]
];
}
/**
* @see ApiBase::getExamplesMessages()
* @return string[]
*/
protected function getExamplesMessages() {
return [
'action=titleblacklist&tbtitle=Foo'
=> 'apihelp-titleblacklist-example-1',
'action=titleblacklist&tbtitle=Bar&tbaction=edit'
=> 'apihelp-titleblacklist-example-2',
];
}
}

File Metadata

Mime Type
text/x-php
Expires
Wed, Aug 19, 04:25 (2 d, 8 h ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
3c/cc/834ee72aa0d7274de0112dcccdcd
Default Alt Text
ApiTitleBlacklist.php (3 KB)

Event Timeline