wikimedia/mediawiki-extensions-AbuseFilter
1
0
Fork 0
mirror of https://gerrit.wikimedia.org/r/mediawiki/extensions/AbuseFilter.git synced 2024-11-27 23:40:19 +00:00
Code Issues Packages Projects Releases Wiki Activity
mediawiki-extensions-AbuseF.../AbuseFilter.hooks.php
Bartosz Dziewoński 1826d39620 Use custom error code for all edit and upload API responses 
The error code 'abusefilter-disallowed' or 'abusefilter-warning' is
used, depending on whether the filter only warns (and will allow the
action when retried) or prevents the user from performing the action.
The API response has been extended with some additional properties.

* For simple filters with no custom messages where the only action is
  'disallow' or 'warn', the error code is the same as before.
* For filters with different actions, different error codes would
  previously be returned; 'abusefilter-disallowed' will be returned
  for them all, with the actions taken listed in the
  .abusefilter.actions property of the API response.
* For filters with custom messages, the message key would previously
  be used as the error code; now 'abusefilter-disallowed' or
  'abusefilter-warning' is used, with the message available in the
  .message property of the API response.

Also cleaned up some dead "forwards-compatibility" code and made a
recently introduced public method private.

The new functionality depends on Ifac8995a4d16d11840cee814177fc2808bc2072c
in MediaWiki core, older MediaWiki versions behave mostly as before.

The new .message property contains both the key and the parameters
duplicated from .abusefilter, so that the client doesn't have to know
what AbuseFilter is - it'll be able to just display the given
message with the given parameters. My specific use case is the upload
dialog in core (core shouldn't have to know about any extensions).

See also TitleBlacklist change I97c1f5c6bbbdfc0b8ea9914bb075d5299c14df8f.

Bug: T137961
Change-Id: I5780eae96930211191ecd874aacf53fdacb58f89
2016-07-11 19:20:19 +00:00

913 lines
28 KiB
PHP
Raw Blame History

<?php
use MediaWiki\Auth\AuthManager;
class AbuseFilterHooks {
public static $successful_action_vars = false;
/** @var WikiPage|Article|bool */
public static $last_edit_page = false; // make sure edit filter & edit save hooks match
// So far, all of the error message out-params for these hooks accept HTML.
// Hooray!
/**
* Called right after configuration has been loaded.
*/
public static function onRegistration() {
global $wgAbuseFilterAvailableActions, $wgAbuseFilterRestrictedActions,
$wgDisableAuthManager, $wgAuthManagerAutoConfig;
if ( isset( $wgAbuseFilterAvailableActions ) || isset( $wgAbuseFilterRestrictedActions ) ) {
wfWarn( '$wgAbuseFilterAvailableActions and $wgAbuseFilterRestrictedActions have been'
. 'removed. Please use $wgAbuseFilterActions and $wgAbuseFilterRestrictions'
. 'instead. The format is the same except the action names are the keys of the'
. 'array and the values are booleans.' );
}
if ( class_exists( AuthManager::class ) && !$wgDisableAuthManager ) {
$wgAuthManagerAutoConfig['preauth'][AbuseFilterPreAuthenticationProvider::class] = [
'class' => AbuseFilterPreAuthenticationProvider::class,
'sort' => 5, // run after normal preauth providers to keep the log cleaner
];
} else {
Hooks::register( 'AbortNewAccount', 'AbuseFilterHooks::onAbortNewAccount' );
Hooks::register( 'AbortAutoAccount', 'AbuseFilterHooks::onAbortAutoAccount' );
}
}
/**
* Entry point for the EditFilterMergedContent hook.
*
* @param IContextSource $context the context of the edit
* @param Content $content the new Content generated by the edit
* @param Status $status Error message to return
* @param string $summary Edit summary for page
* @param User $user the user performing the edit
* @param bool $minoredit whether this is a minor edit according to the user.
* @return bool Always true
*/
public static function onEditFilterMergedContent( IContextSource $context, Content $content,
Status $status, $summary, User $user, $minoredit ) {
$text = AbuseFilter::contentToString( $content );
$filterStatus = self::filterEdit( $context, $content, $text, $status, $summary, $minoredit );
if ( !$filterStatus->isOK() ) {
// Produce a useful error message for API edits
$status->apiHookResult = self::getApiResult( $filterStatus );
}
return true;
}
/**
* Implementation for EditFilterMergedContent hook.
*
* @param IContextSource $context the context of the edit
* @param Content|null $content the new Content generated by the edit
* @param string $text new page content (subject of filtering)
* @param Status $status Error message to return
* @param string $summary Edit summary for page
* @param bool $minoredit whether this is a minor edit according to the user.
* @return Status
*/
public static function filterEdit( IContextSource $context, $content, $text,
Status $status, $summary, $minoredit ) {
$title = $context->getTitle();
self::$successful_action_vars = false;
self::$last_edit_page = false;
$user = $context->getUser();
$oldtext = '';
if ( ( $title instanceof Title ) && $title->canExist() && $title->exists() ) {
// Make sure we load the latest text saved in database (bug 31656)
$page = $context->getWikiPage();
$revision = $page->getRevision();
if ( !$revision ) {
return Status::newGood();
}
$oldcontent = $revision->getContent( Revision::RAW );
$oldtext = AbuseFilter::contentToString( $oldcontent );
// Cache article object so we can share a parse operation
$articleCacheKey = $title->getNamespace() . ':' . $title->getText();
AFComputedVariable::$articleCache[$articleCacheKey] = $page;
// Don't trigger for null edits.
if ( $content && isset( $oldcontent ) && $content->equals( $oldcontent ) ) {
// Compare Content objects if available
return Status::newGood();
} elseif ( strcmp( $oldtext, $text ) == 0 ) {
// Otherwise, compare strings
return Status::newGood();
}
} else {
$page = null;
}
// Load vars for filters to check
$vars = self::newVariableHolderForEdit(
$user, $title, $page, $summary, $oldtext, $text
);
$filter_result = AbuseFilter::filterAction( $vars, $title );
if ( !$filter_result->isOK() ) {
$status->merge( $filter_result );
return $filter_result;
}
self::$successful_action_vars = $vars;
self::$last_edit_page = $page;
return Status::newGood();
}
/**
* @param User $user
* @param Title $title
* @param WikiPage|null $page
* @param string $summary
* @param string $oldtext
* @param string $text
* @return AbuseFilterVariableHolder
* @throws MWException
*/
private static function newVariableHolderForEdit(
User $user, Title $title, $page, $summary, $oldtext, $text
) {
$vars = new AbuseFilterVariableHolder();
$vars->addHolders(
AbuseFilter::generateUserVars( $user ),
AbuseFilter::generateTitleVars( $title, 'ARTICLE' )
);
$vars->setVar( 'action', 'edit' );
$vars->setVar( 'summary', $summary );
$vars->setVar( 'old_wikitext', $oldtext );
$vars->setVar( 'new_wikitext', $text );
// TODO: set old_content and new_content vars, use them
$vars->addHolders( AbuseFilter::getEditVars( $title, $page ) );
return $vars;
}
/**
* @param Status $status Error message details
* @return array API result
*/
private static function getApiResult( Status $status ) {
global $wgFullyInitialised;
$params = $status->getErrorsArray()[0];
$key = array_shift( $params );
$warning = wfMessage( $key )->params( $params );
if ( !$wgFullyInitialised ) {
// This could happen for account autocreation checks
$warning = $warning->inContentLanguage();
}
$filterDescription = $params[0];
$filter = $params[1];
// The value is a nested structure keyed by filter id, which doesn't make sense when we only
// return the result from one filter. Flatten it to a plain array of actions.
$actionsTaken = array_values( array_unique(
call_user_func_array( 'array_merge', array_values( $status->getValue() ) )
) );
$code = ( $actionsTaken === [ 'warn' ] ) ? 'abusefilter-warning' : 'abusefilter-disallowed';
ApiResult::setIndexedTagName( $params, 'param' );
return array(
'code' => $code,
'message' => array(
'key' => $key,
'params' => $params,
),
'abusefilter' => array(
'id' => $filter,
'description' => $filterDescription,
'actions' => $actionsTaken,
),
// For backwards-compatibility
'info' => 'Hit AbuseFilter: ' . $filterDescription,
'warning' => $warning->parse(),
);
}
/**
* @param Article|WikiPage $article
* @param User $user
* @param string $text
* @param string $summary
* @param bool $minoredit
* @param bool $watchthis
* @param string $sectionanchor
* @param integer $flags
* @param Revision $revision
* @return bool
*/
public static function onArticleSaveComplete(
&$article, &$user, $text, $summary, $minoredit, $watchthis, $sectionanchor,
&$flags, $revision
) {
if ( !self::$successful_action_vars || !$revision ) {
self::$successful_action_vars = false;
return true;
}
/** @var AbuseFilterVariableHolder $vars */
$vars = self::$successful_action_vars;
if ( $vars->getVar( 'article_prefixedtext' )->toString() !==
$article->getTitle()->getPrefixedText()
) {
return true;
}
if ( !self::identicalPageObjects( $article, self::$last_edit_page ) ) {
return true; // this isn't the edit $successful_action_vars was set for
}
self::$last_edit_page = false;
if ( $vars->getVar( 'local_log_ids' ) ) {
// Now actually do our storage
$log_ids = $vars->getVar( 'local_log_ids' )->toNative();
$dbw = wfGetDB( DB_MASTER );
if ( count( $log_ids ) ) {
$dbw->update( 'abuse_filter_log',
array( 'afl_rev_id' => $revision->getId() ),
array( 'afl_id' => $log_ids ),
__METHOD__
);
}
}
if ( $vars->getVar( 'global_log_ids' ) ) {
$log_ids = $vars->getVar( 'global_log_ids' )->toNative();
if ( count( $log_ids ) ) {
global $wgAbuseFilterCentralDB;
$fdb = wfGetDB( DB_MASTER, array(), $wgAbuseFilterCentralDB );
$fdb->update( 'abuse_filter_log',
array( 'afl_rev_id' => $revision->getId() ),
array( 'afl_id' => $log_ids, 'afl_wiki' => wfWikiId() ),
__METHOD__
);
}
}
return true;
}
/**
* Check if two article objects are identical or have an identical WikiPage
* @param $page1 Article|WikiPage
* @param $page2 Article|WikiPage
* @return bool
*/
protected static function identicalPageObjects( $page1, $page2 ) {
if ( method_exists( 'Article', 'getPage' ) ) {
$wpage1 = ( $page1 instanceof Article ) ? $page1->getPage() : $page1;
$wpage2 = ( $page2 instanceof Article ) ? $page2->getPage() : $page2;
return ( $wpage1 === $wpage2 );
} else { // b/c for before WikiPage
return ( $page1 === $page2 ); // should be two Article objects
}
}
/**
* @param $user
* @param $promote
* @return bool
*/
public static function onGetAutoPromoteGroups( $user, &$promote ) {
if ( $promote ) {
$key = AbuseFilter::autoPromoteBlockKey( $user );
$blocked = (bool)ObjectCache::getInstance( 'hash' )->getWithSetCallback(
$key,
30,
function () use ( $key ) {
return (int)ObjectCache::getMainStashInstance()->get( $key );
}
);
if ( $blocked ) {
$promote = array();
}
}
return true;
}
public static function onMovePageCheckPermissions( Title $oldTitle, Title $newTitle,
User $user, $reason, Status $status
) {
$vars = new AbuseFilterVariableHolder;
$vars->addHolders(
AbuseFilter::generateUserVars( $user ),
AbuseFilter::generateTitleVars( $oldTitle, 'MOVED_FROM' ),
AbuseFilter::generateTitleVars( $newTitle, 'MOVED_TO' )
);
$vars->setVar( 'SUMMARY', $reason );
$vars->setVar( 'ACTION', 'move' );
$result = AbuseFilter::filterAction( $vars, $oldTitle );
$status->merge( $result );
return $result->isOK();
}
/**
* @param $oldTitle Title
* @param $newTitle Title
* @param $user User
* @param $error
* @param $reason
* @return bool
*/
public static function onAbortMove( $oldTitle, $newTitle, $user, &$error, $reason ) {
global $wgUser;
// HACK: This is a secret userright so system actions
// can bypass AbuseFilter. Should not be assigned to
// normal users. This should be turned into a proper
// userright in bug 67936.
if ( $wgUser->isAllowed( 'abusefilter-bypass' ) ) {
return true;
}
$status = new Status();
self::onMovePageCheckPermissions( $oldTitle, $newTitle, $wgUser, $reason, $status );
if ( !$status->isOK() ) {
$error = $status->getHTML();
}
return $status->isOK();
}
/**
* @param $article Article
* @param $user User
* @param $reason string
* @param $error
* @param Status $status
* @return bool
*/
public static function onArticleDelete( &$article, &$user, &$reason, &$error, &$status ) {
$vars = new AbuseFilterVariableHolder;
global $wgUser;
$vars->addHolders(
AbuseFilter::generateUserVars( $wgUser ),
AbuseFilter::generateTitleVars( $article->getTitle(), 'ARTICLE' )
);
$vars->setVar( 'SUMMARY', $reason );
$vars->setVar( 'ACTION', 'delete' );
$filter_result = AbuseFilter::filterAction( $vars, $article->getTitle() );
$status->merge( $filter_result );
$error = $filter_result->isOK() ? '' : $filter_result->getHTML();
return $filter_result->isOK();
}
/**
* @param $user User
* @param $message
* @param $autocreate bool Indicates whether the account is created automatically.
* @return bool
* @deprecated AbuseFilterPreAuthenticationProvider will take over this functionality
*/
private static function checkNewAccount( $user, &$message, $autocreate ) {
if ( $user->getName() == wfMessage( 'abusefilter-blocker' )->inContentLanguage()->text() ) {
$message = wfMessage( 'abusefilter-accountreserved' )->text();
return false;
}
$vars = new AbuseFilterVariableHolder;
// Add variables only for a registered user, so IP addresses of
// new users won't be exposed
global $wgUser;
if ( !$autocreate && $wgUser->getId() ) {
$vars->addHolders( AbuseFilter::generateUserVars( $wgUser ) );
}
$vars->setVar( 'ACTION', $autocreate ? 'autocreateaccount' : 'createaccount' );
$vars->setVar( 'ACCOUNTNAME', $user->getName() );
$filter_result = AbuseFilter::filterAction(
$vars, SpecialPage::getTitleFor( 'Userlogin' ) );
$message = $filter_result->isOK() ? '' : $filter_result->getWikiText();
return $filter_result->isOK();
}
/**
* @param $user User
* @param $message
* @return bool
* @deprecated AbuseFilterPreAuthenticationProvider will take over this functionality
*/
public static function onAbortNewAccount( $user, &$message ) {
return self::checkNewAccount( $user, $message, false );
}
/**
* @param $user User
* @param $message
* @return bool
* @deprecated AbuseFilterPreAuthenticationProvider will take over this functionality
*/
public static function onAbortAutoAccount( $user, &$message ) {
// FIXME: ERROR MESSAGE IS SHOWN IN A WEIRD WAY, BEACUSE $message
// HERE MEANS NAME OF THE MESSAGE, NOT THE TEXT OF THE MESSAGE AS
// IN AbortNewAccount HOOK WHICH WE CANNOT PROVIDE!
return self::checkNewAccount( $user, $message, true );
}
/**
* @param $recentChange RecentChange
* @return bool
*/
public static function onRecentChangeSave( $recentChange ) {
$title = Title::makeTitle(
$recentChange->getAttribute( 'rc_namespace' ),
$recentChange->getAttribute( 'rc_title' )
);
$action = $recentChange->mAttribs['rc_log_type'] ?
$recentChange->mAttribs['rc_log_type'] : 'edit';
$actionID = implode( '-', array(
$title->getPrefixedText(), $recentChange->mAttribs['rc_user_text'], $action
) );
if ( !empty( AbuseFilter::$tagsToSet[$actionID] )
&& count( $tags = AbuseFilter::$tagsToSet[$actionID] )
) {
ChangeTags::addTags(
$tags,
$recentChange->mAttribs['rc_id'],
$recentChange->mAttribs['rc_this_oldid'],
$recentChange->mAttribs['rc_logid']
);
}
return true;
}
/**
* @param array $tags
* @param bool $enabled
* @return bool
*/
private static function fetchAllTags( array &$tags, $enabled ) {
global $wgAbuseFilterCentralDB, $wgAbuseFilterIsCentral;
# This is a pretty awful hack.
$dbr = wfGetDB( DB_SLAVE );
$where = array( 'afa_consequence' => 'tag', 'af_deleted' => false );
if ( $enabled ) {
$where['af_enabled'] = true;
}
$res = $dbr->select(
array( 'abuse_filter_action', 'abuse_filter' ),
'afa_parameters',
$where,
__METHOD__,
array(),
array( 'abuse_filter' => array( 'INNER JOIN', 'afa_filter=af_id' ) )
);
foreach ( $res as $row ) {
$tags = array_filter(
array_merge( explode( "\n", $row->afa_parameters ), $tags )
);
}
if ( $wgAbuseFilterCentralDB && !$wgAbuseFilterIsCentral ) {
$dbr = wfGetDB( DB_SLAVE, array(), $wgAbuseFilterCentralDB );
$where['af_global'] = 1;
$res = $dbr->select(
array( 'abuse_filter_action', 'abuse_filter' ),
'afa_parameters',
$where,
__METHOD__,
array(),
array( 'abuse_filter' => array( 'INNER JOIN', 'afa_filter=af_id' ) )
);
foreach ( $res as $row ) {
$tags = array_filter(
array_merge( explode( "\n", $row->afa_parameters ), $tags )
);
}
}
return true;
}
/**
* @param array $tags
* @return bool
*/
public static function onListDefinedTags( array &$tags ) {
return self::fetchAllTags( $tags, false );
}
/**
* @param array $tags
* @return bool
*/
public static function onChangeTagsListActive( array &$tags ) {
return self::fetchAllTags( $tags, true );
}
/**
* @param $updater DatabaseUpdater
* @throws MWException
* @return bool
*/
public static function onLoadExtensionSchemaUpdates( $updater = null ) {
$dir = dirname( __FILE__ );
if ( $updater->getDB()->getType() == 'mysql' || $updater->getDB()->getType() == 'sqlite' ) {
if ( $updater->getDB()->getType() == 'mysql' ) {
$updater->addExtensionUpdate( array( 'addTable', 'abuse_filter',
"$dir/abusefilter.tables.sql", true ) );
$updater->addExtensionUpdate( array( 'addTable', 'abuse_filter_history',
"$dir/db_patches/patch-abuse_filter_history.sql", true ) );
} else {
$updater->addExtensionUpdate( array( 'addTable', 'abuse_filter',
"$dir/abusefilter.tables.sqlite.sql", true ) );
$updater->addExtensionUpdate( array( 'addTable', 'abuse_filter_history',
"$dir/db_patches/patch-abuse_filter_history.sqlite.sql", true ) );
}
$updater->addExtensionUpdate( array(
'addField', 'abuse_filter_history', 'afh_changed_fields',
"$dir/db_patches/patch-afh_changed_fields.sql", true
) );
$updater->addExtensionUpdate( array( 'addField', 'abuse_filter', 'af_deleted',
"$dir/db_patches/patch-af_deleted.sql", true ) );
$updater->addExtensionUpdate( array( 'addField', 'abuse_filter', 'af_actions',
"$dir/db_patches/patch-af_actions.sql", true ) );
$updater->addExtensionUpdate( array( 'addField', 'abuse_filter', 'af_global',
"$dir/db_patches/patch-global_filters.sql", true ) );
$updater->addExtensionUpdate( array( 'addField', 'abuse_filter_log', 'afl_rev_id',
"$dir/db_patches/patch-afl_action_id.sql", true ) );
if ( $updater->getDB()->getType() == 'mysql' ) {
$updater->addExtensionUpdate( array( 'addIndex', 'abuse_filter_log',
'filter_timestamp', "$dir/db_patches/patch-fix-indexes.sql", true ) );
} else {
$updater->addExtensionUpdate( array(
'addIndex', 'abuse_filter_log', 'afl_filter_timestamp',
"$dir/db_patches/patch-fix-indexes.sqlite.sql", true
) );
}
$updater->addExtensionUpdate( array( 'addField', 'abuse_filter',
'af_group', "$dir/db_patches/patch-af_group.sql", true ) );
if ( $updater->getDB()->getType() == 'mysql' ) {
$updater->addExtensionUpdate( array(
'addIndex', 'abuse_filter_log', 'wiki_timestamp',
"$dir/db_patches/patch-global_logging_wiki-index.sql", true
) );
} else {
$updater->addExtensionUpdate( array(
'addIndex', 'abuse_filter_log', 'afl_wiki_timestamp',
"$dir/db_patches/patch-global_logging_wiki-index.sqlite.sql", true
) );
}
if ( $updater->getDB()->getType() == 'mysql' ) {
$updater->addExtensionUpdate( array(
'modifyField', 'abuse_filter_log', 'afl_namespace',
"$dir/db_patches/patch-afl-namespace_int.sql", true
) );
} else {
/*
$updater->addExtensionUpdate( array(
'modifyField',
'abuse_filter_log',
'afl_namespace',
"$dir/db_patches/patch-afl-namespace_int.sqlite.sql",
true
) );
*/
/* @todo Modify a column in sqlite, which do not support such
* things create backup, drop, create with new schema, copy,
* drop backup or simply see
* https://www.mediawiki.org/wiki/Manual:SQLite#About_SQLite :
* Several extensions are known to have database update or
* installation issues with SQLite: AbuseFilter, ...
*/
}
} elseif ( $updater->getDB()->getType() == 'postgres' ) {
$updater->addExtensionUpdate( array(
'addTable', 'abuse_filter', "$dir/abusefilter.tables.pg.sql", true ) );
$updater->addExtensionUpdate( array(
'addTable', 'abuse_filter_history',
"$dir/db_patches/patch-abuse_filter_history.pg.sql", true
) );
$updater->addExtensionUpdate( array(
'addPgField', 'abuse_filter', 'af_actions', "TEXT NOT NULL DEFAULT ''" ) );
$updater->addExtensionUpdate( array(
'addPgField', 'abuse_filter', 'af_deleted', 'SMALLINT NOT NULL DEFAULT 0' ) );
$updater->addExtensionUpdate( array(
'addPgField', 'abuse_filter', 'af_global', 'SMALLINT NOT NULL DEFAULT 0' ) );
$updater->addExtensionUpdate( array(
'addPgField', 'abuse_filter_log', 'afl_wiki', 'TEXT' ) );
$updater->addExtensionUpdate( array(
'addPgField', 'abuse_filter_log', 'afl_deleted', 'SMALLINT' ) );
$updater->addExtensionUpdate( array(
'changeField', 'abuse_filter_log', 'afl_filter', 'TEXT', '' ) );
$updater->addExtensionUpdate( array(
'addPgExtIndex', 'abuse_filter_log', 'abuse_filter_log_ip', "(afl_ip)" ) );
$updater->addExtensionUpdate( array(
'addPgExtIndex', 'abuse_filter_log', 'abuse_filter_log_wiki', "(afl_wiki)" ) );
$updater->addExtensionUpdate( array(
'changeField', 'abuse_filter_log', 'afl_namespace', "INTEGER" ) );
}
$updater->addExtensionUpdate( array( array( __CLASS__, 'createAbuseFilterUser' ) ) );
return true;
}
/**
* Updater callback to create the AbuseFilter user after the user tables have been updated.
* @param $updater DatabaseUpdater
*/
public static function createAbuseFilterUser( $updater ) {
$username = wfMessage( 'abusefilter-blocker' )->inContentLanguage()->text();
$user = User::newFromName( $username );
if ( $user && !$updater->updateRowExists( 'create abusefilter-blocker-user' ) ) {
if ( method_exists( 'User', 'newSystemUser' ) ) {
$user = User::newSystemUser( $username, array( 'steal' => true ) );
} else {
if ( !$user->getId() ) {
$user->addToDatabase();
$user->saveSettings();
# Increment site_stats.ss_users
$ssu = new SiteStatsUpdate( 0, 0, 0, 0, 1 );
$ssu->doUpdate();
} else {
// Sorry dude, we need this account.
$user->setPassword( null );
$user->setEmail( null );
$user->saveSettings();
}
}
$updater->insertUpdateRow( 'create abusefilter-blocker-user' );
# Promote user so it doesn't look too crazy.
$user->addGroup( 'sysop' );
}
}
/**
* @param $id
* @param $nt Title
* @param $tools
* @return bool
*/
public static function onContributionsToolLinks( $id, $nt, &$tools ) {
global $wgUser;
if ( $wgUser->isAllowed( 'abusefilter-log' ) ) {
$tools[] = Linker::link(
SpecialPage::getTitleFor( 'AbuseLog' ),
wfMessage( 'abusefilter-log-linkoncontribs' )->text(),
array( 'title' => wfMessage( 'abusefilter-log-linkoncontribs-text' )->parse() ),
array( 'wpSearchUser' => $nt->getText() )
);
}
return true;
}
/**
* @param UploadBase $upload
* @param User $user
* @param array $props
* @param string $comment
* @param string $pageText
* @param array|ApiMessage &$error
* @return bool
*/
public static function onUploadVerifyUpload( UploadBase $upload, User $user,
array $props, $comment, $pageText, &$error
) {
return self::filterUpload( 'upload', $upload, $user, $props, $comment, $pageText, $error );
}
/**
* @param UploadBase $upload
* @param string $mime
* @param array|ApiMessage &$error
* @return bool
*/
public static function onUploadVerifyFile( $upload, $mime, &$error ) {
global $wgUser, $wgVersion;
// On MW 1.27 and older, this is the only hook we can use, even though it's deficient.
// On MW 1.28 and newer, we use UploadVerifyUpload to check file uploads, and this one only
// to check file uploads to stash. If a filter doesn't need to check the page contents or
// upload comment, it can use `action='stashupload'` to provide better experience to e.g.
// UploadWizard (rejecting files immediately, rather than after the user adds the details).
$action = version_compare( $wgVersion, '1.28', '<' ) ? 'upload' : 'stashupload';
// UploadBase makes it absolutely impossible to get these out of it, even though it knows them.
$props = FSFile::getPropsFromPath( $upload->getTempPath() );
return self::filterUpload( $action, $upload, $wgUser, $props, null, null, $error );
}
/**
* Implementation for UploadVerifyFile and UploadVerifyUpload hooks.
*
* @param string $action 'upload' or 'stashupload'
* @param UploadBase $upload
* @param User $user User performing the action
* @param array $props File properties, as returned by FSFile::getPropsFromPath()
* @param string|null $summary Upload log comment (also used as edit summary)
* @param string|null $text File description page text (only used for new uploads)
* @param array|ApiMessage &$error
* @return bool
*/
public static function filterUpload( $action, UploadBase $upload, User $user,
array $props, $summary, $text, &$error
) {
$title = $upload->getTitle();
$vars = new AbuseFilterVariableHolder;
$vars->addHolders(
AbuseFilter::generateUserVars( $user ),
AbuseFilter::generateTitleVars( $title, 'ARTICLE' )
);
$vars->setVar( 'ACTION', $action );
// We use the hexadecimal version of the file sha1.
// Use UploadBase::getTempFileSha1Base36 so that we don't have to calculate the sha1 sum again
$sha1 = Wikimedia\base_convert( $upload->getTempFileSha1Base36(), 36, 16, 40 );
$vars->setVar( 'file_sha1', $sha1 );
$vars->setVar( 'file_size', $upload->getFileSize() );
$vars->setVar( 'file_mime', $props['mime'] );
$vars->setVar( 'file_mediatype', MimeMagic::singleton()->getMediaType( null, $props['mime'] ) );
$vars->setVar( 'file_width', $props['width'] );
$vars->setVar( 'file_height', $props['height'] );
$vars->setVar( 'file_bits_per_channel', $props['bits'] );
// We only have the upload comment and page text when using the UploadVerifyUpload hook
if ( $summary !== null && $text !== null ) {
// This block is adapted from self::filterEdit()
if ( $title->exists() ) {
$page = WikiPage::factory( $title );
$revision = $page->getRevision();
if ( !$revision ) {
return true;
}
$oldcontent = $revision->getContent( Revision::RAW );
$oldtext = AbuseFilter::contentToString( $oldcontent );
// Cache article object so we can share a parse operation
$articleCacheKey = $title->getNamespace() . ':' . $title->getText();
AFComputedVariable::$articleCache[$articleCacheKey] = $page;
// Page text is ignored for uploads when the page already exists
$text = $oldtext;
} else {
$page = null;
$oldtext = '';
}
// Load vars for filters to check
$vars->setVar( 'summary', $summary );
$vars->setVar( 'minor_edit', false );
$vars->setVar( 'old_wikitext', $oldtext );
$vars->setVar( 'new_wikitext', $text );
// TODO: set old_content and new_content vars, use them
$vars->addHolders( AbuseFilter::getEditVars( $title, $page ) );
}
$filter_result = AbuseFilter::filterAction( $vars, $title );
if ( !$filter_result->isOK() ) {
$messageAndParams = $filter_result->getErrorsArray()[0];
$apiResult = self::getApiResult( $filter_result );
$error = ApiMessage::create(
$messageAndParams,
$apiResult['code'],
$apiResult
);
}
return $filter_result->isOK();
}
/**
* Adds global variables to the Javascript as needed
*
* @param array $vars
* @return bool
*/
public static function onMakeGlobalVariablesScript( array &$vars ) {
if ( isset( AbuseFilter::$editboxName ) && AbuseFilter::$editboxName !== null ) {
$vars['abuseFilterBoxName'] = AbuseFilter::$editboxName;
}
if ( AbuseFilterViewExamine::$examineType !== null ) {
$vars['abuseFilterExamine'] = array(
'type' => AbuseFilterViewExamine::$examineType,
'id' => AbuseFilterViewExamine::$examineId,
);
}
return true;
}
/**
* Tables that Extension:UserMerge needs to update
*
* @param array $updateFields
* @return bool
*/
public static function onUserMergeAccountFields( array &$updateFields ) {
$updateFields[] = array( 'abuse_filter', 'af_user', 'af_user_text' );
$updateFields[] = array( 'abuse_filter_log', 'afl_user', 'afl_user_text' );
$updateFields[] = array( 'abuse_filter_history', 'afh_user', 'afh_user_text' );
return true;
}
/**
* Warms the cache for getLastPageAuthors() - T116557
*
* @param WikiPage $page
* @param Content $content
* @param ParserOutput $output
* @param string $summary
* @param User $user
*/
public static function onParserOutputStashForEdit(
WikiPage $page, Content $content, ParserOutput $output, $summary = '', $user = null
) {
$revision = $page->getRevision();
if ( !$revision ) {
return;
}
$text = AbuseFilter::contentToString( $content );
$oldcontent = $revision->getContent( Revision::RAW );
$oldtext = AbuseFilter::contentToString( $oldcontent );
$user = $user ?: RequestContext::getMain()->getUser();
// Cache any resulting filter matches.
// Do this outside the synchronous stash lock to avoid any chance of slowdown.
DeferredUpdates::addCallableUpdate(
function () use ( $user, $page, $summary, $oldtext, $text ) {
$vars = self::newVariableHolderForEdit(
$user, $page->getTitle(), $page, $summary, $oldtext, $text
);
AbuseFilter::filterAction( $vars, $page->getTitle(), 'default', $user, 'stash' );
},
DeferredUpdates::PRESEND
);
}
/**
* Hook to add PHPUnit test cases.
* @see https://www.mediawiki.org/wiki/Manual:Hooks/UnitTestsList
*
* @param array $files
*
* @return bool
*/
public static function onUnitTestsList( array &$files ) {
$testDir = __DIR__ . '/tests/phpunit';
$files = array_merge(
$files,
glob( $testDir . '/*Test.php' )
);
return true;
}
}
Reference in a new issue View git blame Copy permalink