mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/TitleBlacklist
synced 2024-11-15 02:03:58 +00:00
17d3a9e313
Bug: T110469 Change-Id: I9690d2fe6b172fcc85e1a8f7f91af21c6422d870 Depends-On: I8b52ec8ddf494f23941807638f149f15b5e46b0c
366 lines
11 KiB
PHP
366 lines
11 KiB
PHP
<?php
|
|
/**
|
|
* Hooks for Title Blacklist
|
|
* @author Victor Vasiliev
|
|
* @copyright © 2007-2010 Victor Vasiliev et al
|
|
* @license GNU General Public License 2.0 or later
|
|
*/
|
|
|
|
use MediaWiki\Auth\AuthManager;
|
|
|
|
/**
|
|
* Hooks for the TitleBlacklist class
|
|
*
|
|
* @ingroup Extensions
|
|
*/
|
|
class TitleBlacklistHooks {
|
|
|
|
/**
|
|
* Called right after configuration variables have been set.
|
|
*/
|
|
public static function onRegistration() {
|
|
global $wgDisableAuthManager, $wgAuthManagerAutoConfig;
|
|
|
|
if ( class_exists( AuthManager::class ) && !$wgDisableAuthManager ) {
|
|
$wgAuthManagerAutoConfig['preauth'][TitleBlacklistPreAuthenticationProvider::class] =
|
|
[ 'class' => TitleBlacklistPreAuthenticationProvider::class ];
|
|
} else {
|
|
Hooks::register( 'AbortNewAccount', 'TitleBlacklistHooks::abortNewAccount' );
|
|
Hooks::register( 'AbortAutoAccount', 'TitleBlacklistHooks::abortAutoAccount' );
|
|
Hooks::register( 'UserCreateForm', 'TitleBlacklistHooks::addOverrideCheckbox' );
|
|
Hooks::register( 'APIGetAllowedParams', 'TitleBlacklistHooks::onAPIGetAllowedParams' );
|
|
Hooks::register( 'AddNewAccountApiForm', 'TitleBlacklistHooks::onAddNewAccountApiForm' );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* getUserPermissionsErrorsExpensive hook
|
|
*
|
|
* @param $title Title
|
|
* @param $user User
|
|
* @param $action
|
|
* @param $result
|
|
* @return bool
|
|
*/
|
|
public static function userCan( $title, $user, $action, &$result ) {
|
|
# Some places check createpage, while others check create.
|
|
# As it stands, upload does createpage, but normalize both
|
|
# to the same action, to stop future similar bugs.
|
|
if ( $action === 'createpage' || $action === 'createtalk' ) {
|
|
$action = 'create';
|
|
}
|
|
if ( $action == 'create' || $action == 'edit' || $action == 'upload' ) {
|
|
$blacklisted = TitleBlacklist::singleton()->userCannot( $title, $user, $action );
|
|
if ( $blacklisted instanceof TitleBlacklistEntry ) {
|
|
$errmsg = $blacklisted->getErrorMessage( 'edit' );
|
|
$result = ApiMessage::create(
|
|
wfMessage(
|
|
$errmsg,
|
|
htmlspecialchars( $blacklisted->getRaw() ),
|
|
$title->getFullText()
|
|
),
|
|
'titleblacklist-forbidden',
|
|
array(
|
|
'message' => $errmsg,
|
|
'line' => $blacklisted->getRaw(),
|
|
// As $errmsg usually represents a non-default message here, and ApiBase uses
|
|
// ->inLanguage( 'en' )->useDatabase( false ) for all messages, it will never result in
|
|
// useful 'info' text in the API. Try this, extra data seems to override the default.
|
|
'info' => 'TitleBlacklist prevents this title from being created',
|
|
)
|
|
);
|
|
return false;
|
|
}
|
|
}
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Display a notice if a user is only able to create or edit a page
|
|
* because they have tboverride.
|
|
*
|
|
* @param Title $title
|
|
* @param integer $oldid
|
|
* @param array &$notices
|
|
*/
|
|
public static function displayBlacklistOverrideNotice( Title $title, $oldid, array &$notices ) {
|
|
if ( !RequestContext::getMain()->getUser()->isAllowed( 'tboverride' ) ) {
|
|
return true;
|
|
}
|
|
|
|
$blacklisted = TitleBlacklist::singleton()->isBlacklisted(
|
|
$title,
|
|
$title->exists() ? 'edit' : 'create'
|
|
);
|
|
if ( !$blacklisted ) {
|
|
return true;
|
|
}
|
|
|
|
$params = $blacklisted->getParams();
|
|
$msg = wfMessage( 'titleblacklist-warning' );
|
|
$notices['titleblacklist'] = $msg->rawParams(
|
|
htmlspecialchars( $blacklisted->getRaw() ) )->parseAsBlock();
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* MovePageCheckPermissions hook (1.25+)
|
|
*
|
|
* @param Title $oldTitle
|
|
* @param Title $newTitle
|
|
* @param User $user
|
|
* @param $reason
|
|
* @param Status $status
|
|
* @return bool
|
|
*/
|
|
public static function onMovePageCheckPermissions( Title $oldTitle, Title $newTitle, User $user, $reason, Status $status ) {
|
|
$titleBlacklist = TitleBlacklist::singleton();
|
|
$blacklisted = $titleBlacklist->userCannot( $newTitle, $user, 'move' );
|
|
if ( !$blacklisted ) {
|
|
$blacklisted = $titleBlacklist->userCannot( $oldTitle, $user, 'edit' );
|
|
}
|
|
if ( $blacklisted instanceof TitleBlacklistEntry ) {
|
|
$errmsg = $blacklisted->getErrorMessage( 'move' );
|
|
ApiBase::$messageMap[$errmsg] = array(
|
|
'code' => $errmsg,
|
|
'info' => 'TitleBlacklist prevents this new title from being created or old title from being edited'
|
|
);
|
|
$status->fatal( $errmsg,
|
|
$blacklisted->getRaw(),
|
|
$oldTitle->getFullText(),
|
|
$newTitle->getFullText() );
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Check whether a user name is acceptable,
|
|
* and set a message if unacceptable.
|
|
*
|
|
* Used by abortNewAccount and centralAuthAutoCreate.
|
|
* May also be called externally to vet alternate account names.
|
|
*
|
|
* @return bool Acceptable
|
|
*/
|
|
public static function acceptNewUserName( $userName, $permissionsUser, &$err, $override = true, $log = false ) {
|
|
$sv = self::testUserName( $userName, $permissionsUser, $override, $log );
|
|
if ( !$sv->isGood() ) {
|
|
$err = Status::wrap( $sv )->getMessage()->parse();
|
|
}
|
|
return $sv->isGood();
|
|
}
|
|
|
|
/**
|
|
* Check whether a user name is acceptable for account creation or autocreation, and explain
|
|
* why not if that's the case.
|
|
*
|
|
* @param string $userName
|
|
* @param User $creatingUser
|
|
* @param bool $override Should the test be skipped, if the user has sufficient privileges?
|
|
* @param bool $log Log blacklist hits to Special:Log
|
|
* @return StatusValue
|
|
*/
|
|
public static function testUserName( $userName, User $creatingUser, $override = true, $log = false ) {
|
|
$title = Title::makeTitleSafe( NS_USER, $userName );
|
|
$blacklisted = TitleBlacklist::singleton()->userCannot( $title, $creatingUser,
|
|
'new-account', $override );
|
|
if ( $blacklisted instanceof TitleBlacklistEntry ) {
|
|
if ( $log ) {
|
|
self::logFilterHitUsername( $creatingUser, $title, $blacklisted->getRaw() );
|
|
}
|
|
$message = $blacklisted->getErrorMessage( 'new-account' );
|
|
return StatusValue::newFatal( ApiMessage::create(
|
|
[ $message, $blacklisted->getRaw(), $userName ],
|
|
'titleblacklist-forbidden',
|
|
[
|
|
'message' => $message,
|
|
'line' => $blacklisted->getRaw(),
|
|
// The text of the message probably isn't useful API info, so do this instead
|
|
'info' => 'TitleBlacklist prevents this username from being created',
|
|
]
|
|
) );
|
|
}
|
|
return StatusValue::newGood();
|
|
}
|
|
|
|
/**
|
|
* AbortNewAccount hook
|
|
*
|
|
* @param User $user
|
|
* @param string &$message
|
|
* @param Status $status
|
|
* @return bool
|
|
*/
|
|
public static function abortNewAccount( $user, &$message, &$status ) {
|
|
global $wgUser, $wgRequest;
|
|
$override = $wgRequest->getCheck( 'wpIgnoreTitleBlacklist' );
|
|
$sv = self::testUserName( $user->getName(), $wgUser, $override, true );
|
|
if ( !$sv->isGood() ) {
|
|
$status = Status::wrap( $sv );
|
|
$message = $status->getMessage()->parse();
|
|
}
|
|
return $sv->isGood();
|
|
}
|
|
|
|
/**
|
|
* AbortAutoAccount hook
|
|
*
|
|
* @param User $user
|
|
* @param string &$message
|
|
* @return bool
|
|
*/
|
|
public static function abortAutoAccount( $user, &$message ) {
|
|
global $wgTitleBlacklistBlockAutoAccountCreation;
|
|
if ( $wgTitleBlacklistBlockAutoAccountCreation ) {
|
|
return self::abortNewAccount( $user, $message );
|
|
}
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* EditFilter hook
|
|
*
|
|
* @param $editor EditPage
|
|
*/
|
|
public static function validateBlacklist( $editor, $text, $section, &$error ) {
|
|
global $wgUser;
|
|
$title = $editor->mTitle;
|
|
|
|
if ( $title->getNamespace() == NS_MEDIAWIKI && $title->getDBkey() == 'Titleblacklist' ) {
|
|
|
|
$blackList = TitleBlacklist::singleton();
|
|
$bl = $blackList->parseBlacklist( $text, 'page' );
|
|
$ok = $blackList->validate( $bl );
|
|
if ( count( $ok ) == 0 ) {
|
|
return true;
|
|
}
|
|
|
|
$errmsg = wfMessage( 'titleblacklist-invalid' )->numParams( count( $ok ) )->text();
|
|
$errlines = '* <code>' . implode( "</code>\n* <code>", array_map( 'wfEscapeWikiText', $ok ) ) . '</code>';
|
|
$error = Html::openElement( 'div', array( 'class' => 'errorbox' ) ) .
|
|
$errmsg .
|
|
"\n" .
|
|
$errlines .
|
|
Html::closeElement( 'div' ) . "\n" .
|
|
Html::element( 'br', array( 'clear' => 'all' ) ) . "\n";
|
|
|
|
// $error will be displayed by the edit class
|
|
}
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* ArticleSaveComplete hook
|
|
*
|
|
* @param Article $article
|
|
*/
|
|
public static function clearBlacklist( &$article, &$user,
|
|
$text, $summary, $isminor, $iswatch, $section )
|
|
{
|
|
$title = $article->getTitle();
|
|
if ( $title->getNamespace() == NS_MEDIAWIKI && $title->getDBkey() == 'Titleblacklist' ) {
|
|
TitleBlacklist::singleton()->invalidate();
|
|
}
|
|
return true;
|
|
}
|
|
|
|
/** UserCreateForm hook based on the one from AntiSpoof extension */
|
|
public static function addOverrideCheckbox( &$template ) {
|
|
global $wgRequest, $wgUser;
|
|
|
|
if ( TitleBlacklist::userCanOverride( $wgUser, 'new-account' ) ) {
|
|
$template->addInputItem( 'wpIgnoreTitleBlacklist',
|
|
$wgRequest->getCheck( 'wpIgnoreTitleBlacklist' ),
|
|
'checkbox', 'titleblacklist-override' );
|
|
}
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* @param ApiBase $module
|
|
* @param array $params
|
|
* @return bool
|
|
*/
|
|
public static function onAPIGetAllowedParams( ApiBase &$module, array &$params ) {
|
|
if ( $module instanceof ApiCreateAccount ) {
|
|
$params['ignoretitleblacklist'] = array(
|
|
ApiBase::PARAM_TYPE => 'boolean',
|
|
ApiBase::PARAM_DFLT => false
|
|
);
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Pass API parameter on to the login form when using
|
|
* API account creation.
|
|
*
|
|
* @param ApiBase $apiModule
|
|
* @param LoginForm $loginForm
|
|
* @return bool Always true
|
|
*/
|
|
public static function onAddNewAccountApiForm( ApiBase $apiModule, LoginForm $loginForm ) {
|
|
global $wgRequest;
|
|
$main = $apiModule->getMain();
|
|
|
|
if ( $main->getVal( 'ignoretitleblacklist' ) !== null ) {
|
|
$wgRequest->setVal( 'wpIgnoreTitleBlacklist', '1' );
|
|
|
|
// Suppress "unrecognized parameter" warning:
|
|
$main->getVal( 'wpIgnoreTitleBlacklist' );
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Logs the filter username hit to Special:Log if
|
|
* $wgTitleBlacklistLogHits is enabled.
|
|
*
|
|
* @param User $user
|
|
* @param Title $title
|
|
* @param string $entry
|
|
*/
|
|
public static function logFilterHitUsername( $user, $title, $entry ) {
|
|
global $wgTitleBlacklistLogHits;
|
|
if ( $wgTitleBlacklistLogHits ) {
|
|
$logEntry = new ManualLogEntry( 'titleblacklist', 'hit-username' );
|
|
$logEntry->setPerformer( $user );
|
|
$logEntry->setTarget( $title );
|
|
$logEntry->setParameters( array(
|
|
'4::entry' => $entry,
|
|
) );
|
|
$logid = $logEntry->insert();
|
|
$logEntry->publish( $logid );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Add phpunit tests
|
|
*
|
|
* @param array &$files List of test cases and directories to search
|
|
* @return bool
|
|
*/
|
|
public static function unitTestsList( &$files ) {
|
|
$files = array_merge( $files, glob( __DIR__ . '/tests/*Test.php' ) );
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* External Lua library for Scribunto
|
|
*
|
|
* @param string $engine
|
|
* @param array $extraLibraries
|
|
* @return bool
|
|
*/
|
|
public static function scribuntoExternalLibraries( $engine, array &$extraLibraries ) {
|
|
if( $engine == 'lua' ) {
|
|
$extraLibraries['mw.ext.TitleBlacklist'] = 'Scribunto_LuaTitleBlacklistLibrary';
|
|
}
|
|
return true;
|
|
}
|
|
}
|