SpamBlacklistHooks.php

Go to the documentation of this file.

<?php
 
class SpamBlacklistHooks {
 
    static function filterMergedContent(
        IContextSource $context,
        Content $content,
        Status $status,
        $summary,
        User $user,
        $minoredit
    ) {
        $title = $context->getTitle();
 
        // get the link from the not-yet-saved page content.
        $editInfo = $context->getWikiPage()->prepareContentForEdit( $content );
        $pout = $editInfo->output;
        $links = array_keys( $pout->getExternalLinks() );
 
        // HACK: treat the edit summary as a link if it contains anything
        // that looks like it could be a URL or e-mail address.
        if ( preg_match( '/\S(\.[^\s\d]{2,}|[\/@]\S)/', $summary ) ) {
            $links[] = $summary;
        }
 
        $spamObj = BaseBlacklist::getSpamBlacklist();
        $matches = $spamObj->filter( $links, $title );
 
        if ( $matches !== false ) {
            $status->fatal( 'spamprotectiontext' );
 
            foreach ( $matches as $match ) {
                $status->fatal( 'spamprotectionmatch', $match );
            }
 
            $status->apiHookResult = [
                'spamblacklist' => implode( '|', $matches ),
            ];
        }
 
        // Always return true, EditPage will look at $status->isOk().
        return true;
    }
 
    public static function onParserOutputStashForEdit(
        WikiPage $page,
        Content $content,
        ParserOutput $output
    ) {
        $links = array_keys( $output->getExternalLinks() );
        $spamObj = BaseBlacklist::getSpamBlacklist();
        $spamObj->warmCachesForFilter( $page->getTitle(), $links );
    }
 
    public static function userCanSendEmail( &$user, &$hookErr ) {
        $blacklist = BaseBlacklist::getEmailBlacklist();
        if ( $blacklist->checkUser( $user ) ) {
            return true;
        }
 
        $hookErr = [ 'spam-blacklisted-email', 'spam-blacklisted-email-text', null ];
 
        return false;
    }
 
    static function validate( EditPage $editPage, $text, $section, &$hookError ) {
        $title = $editPage->getTitle();
        $thisPageName = $title->getPrefixedDBkey();
 
        if ( !BaseBlacklist::isLocalSource( $title ) ) {
            wfDebugLog( 'SpamBlacklist',
                "Spam blacklist validator: [[$thisPageName]] not a local blacklist\n"
            );
            return true;
        }
 
        $type = BaseBlacklist::getTypeFromTitle( $title );
        if ( $type === false ) {
            return true;
        }
 
        $lines = explode( "\n", $text );
 
        $badLines = SpamRegexBatch::getBadLines( $lines, BaseBlacklist::getInstance( $type ) );
        if ( $badLines ) {
            wfDebugLog( 'SpamBlacklist',
                "Spam blacklist validator: [[$thisPageName]] given invalid input lines: " .
                    implode( ', ', $badLines ) . "\n"
            );
 
            $badList = "*<code>" .
                implode( "</code>\n*<code>",
                    array_map( 'wfEscapeWikiText', $badLines ) ) .
                "</code>\n";
            $hookError =
                "<div class='errorbox'>" .
                    wfMessage( 'spam-invalid-lines' )->numParams( $badLines )->text() . "<br />" .
                    $badList .
                    "</div>\n" .
                    "<br clear='all' />\n";
        } else {
            wfDebugLog( 'SpamBlacklist',
                "Spam blacklist validator: [[$thisPageName]] ok or empty blacklist\n"
            );
        }
 
        return true;
    }
 
    static function pageSaveContent(
        WikiPage $wikiPage,
        User $user,
        Content $content,
        $summary,
        $isMinor,
        $isWatch,
        $section,
        $flags,
        $revision,
        Status $status,
        $baseRevId
    ) {
        if ( $revision ) {
            BaseBlacklist::getSpamBlacklist()
                ->doLogging( $user, $wikiPage->getTitle(), $revision->getId() );
        }
 
        if ( !BaseBlacklist::isLocalSource( $wikiPage->getTitle() ) ) {
            return true;
        }
 
        // This sucks because every Blacklist needs to be cleared
        foreach ( BaseBlacklist::getBlacklistTypes() as $type => $class ) {
            $blacklist = BaseBlacklist::getInstance( $type );
            $blacklist->clearCache();
        }
 
        return true;
    }
 
    public static function onUploadVerifyUpload(
        UploadBase $upload,
        User $user,
        array $props,
        $comment,
        $pageText,
        &$error
    ) {
        $title = $upload->getTitle();
 
        // get the link from the not-yet-saved page content.
        $content = ContentHandler::makeContent( $pageText, $title );
        $parserOptions = ParserOptions::newCanonical( 'canonical' );
        $output = $content->getParserOutput( $title, null, $parserOptions );
        $links = array_keys( $output->getExternalLinks() );
 
        // HACK: treat comment as a link if it contains anything
        // that looks like it could be a URL or e-mail address.
        if ( preg_match( '/\S(\.[^\s\d]{2,}|[\/@]\S)/', $comment ) ) {
            $links[] = $comment;
        }
        if ( !$links ) {
            return true;
        }
 
        $spamObj = BaseBlacklist::getSpamBlacklist();
        $matches = $spamObj->filter( $links, $title );
 
        if ( $matches !== false ) {
            $error = new ApiMessage(
                wfMessage( 'spamprotectiontext' ),
                'spamblacklist',
                [
                    'spamblacklist' => [ 'matches' => $matches ],
                    'message' => [
                        'key' => 'spamprotectionmatch',
                        'params' => $matches[0],
                    ],
                ]
            );
        }
 
        return true;
    }
 
    public static function onArticleDelete( WikiPage &$article, User &$user, &$reason, &$error ) {
        $spam = BaseBlacklist::getSpamBlacklist();
        if ( !$spam->isLoggingEnabled() ) {
            return;
        }
 
        // Log the changes, but we only commit them once the deletion has happened.
        // We do that since the external links table could get cleared before the
        // ArticleDeleteComplete hook runs
        $spam->logUrlChanges( $spam->getCurrentLinks( $article->getTitle() ), [], [] );
    }
 
    public static function onArticleDeleteComplete(
        &$page,
        User &$user,
        $reason,
        $id,
        Content $content = null,
        LogEntry $logEntry
    ) {
        $spam = BaseBlacklist::getSpamBlacklist();
        $spam->doLogging( $user, $page->getTitle(), $page->getLatest() );
    }
}