TitleBlacklistEntry.php

Go to the documentation of this file.

<?php
class TitleBlacklistEntry {
    private $mRaw;
 
    private $mRegex;
 
    private $mParams;
 
    private $mFormatVersion;
 
    private $mSource;
 
    private function __construct( $regex, $params, $raw, $source ) {
        $this->mRaw = $raw;
        $this->mRegex = $regex;
        $this->mParams = $params;
        $this->mFormatVersion = TitleBlacklist::VERSION;
        $this->mSource = $source;
    }
 
    private function filtersNewAccounts() {
        global $wgTitleBlacklistUsernameSources;
 
        if ( $wgTitleBlacklistUsernameSources === '*' ) {
            return true;
        }
 
        if ( !$wgTitleBlacklistUsernameSources ) {
            return false;
        }
 
        if ( !is_array( $wgTitleBlacklistUsernameSources ) ) {
            throw new Exception(
                '$wgTitleBlacklistUsernameSources must be "*", false or an array' );
        }
 
        return in_array( $this->mSource, $wgTitleBlacklistUsernameSources, true );
    }
 
    public function matches( $title, $action ) {
        if ( $title == '' ) {
            return false;
        }
 
        if ( $action === 'new-account' && !$this->filtersNewAccounts() ) {
            return false;
        }
 
        if ( isset( $this->mParams['antispoof'] )
            && is_callable( 'AntiSpoof::checkUnicodeString' )
        ) {
            if ( $action === 'edit' ) {
                // Use process cache for frequently edited pages
                $cache = ObjectCache::getMainWANInstance();
                list( $ok, $norm ) = $cache->getWithSetCallback(
                    $cache->makeKey( 'titleblacklist', 'normalized-unicode', md5( $title ) ),
                    $cache::TTL_MONTH,
                    function () use ( $title ) {
                        return AntiSpoof::checkUnicodeString( $title );
                    },
                    [ 'pcTTL' => $cache::TTL_PROC_LONG ]
                );
            } else {
                list( $ok, $norm ) = AntiSpoof::checkUnicodeString( $title );
            }
 
            if ( $ok === "OK" ) {
                list( $ver, $title ) = explode( ':', $norm, 2 );
            } else {
                wfDebugLog( 'TitleBlacklist', 'AntiSpoof could not normalize "' . $title . '".' );
            }
        }
 
        Wikimedia\suppressWarnings();
        $match = preg_match(
            "/^(?:{$this->mRegex})$/us" . ( isset( $this->mParams['casesensitive'] ) ? '' : 'i' ),
            $title
        );
        Wikimedia\restoreWarnings();
 
        if ( $match ) {
            if ( isset( $this->mParams['moveonly'] ) && $action != 'move' ) {
                return false;
            }
            if ( isset( $this->mParams['newaccountonly'] ) && $action != 'new-account' ) {
                return false;
            }
            if ( !isset( $this->mParams['noedit'] ) && $action == 'edit' ) {
                return false;
            }
            if ( isset( $this->mParams['reupload'] ) && $action == 'upload' ) {
                // Special:Upload also checks 'create' permissions when not reuploading
                return false;
            }
            return true;
        }
 
        return false;
    }
 
    public static function newFromString( $line, $source ) {
        $raw = $line; // Keep line for raw data
        $options = [];
        // Strip comments
        $line = preg_replace( "/^\\s*([^#]*)\\s*((.*)?)$/", "\\1", $line );
        $line = trim( $line );
        // A blank string causes problems later on
        if ( $line === '' ) {
            return null;
        }
        // Parse the rest of message
        $pockets = [];
        if ( !preg_match( '/^(.*?)(\s*<([^<>]*)>)?$/', $line, $pockets ) ) {
            return null;
        }
        $regex = trim( $pockets[1] );
        $regex = str_replace( '_', ' ', $regex ); // We'll be matching against text form
        $opts_str = isset( $pockets[3] ) ? trim( $pockets[3] ) : '';
        // Parse opts
        $opts = preg_split( '/\s*\|\s*/', $opts_str );
        foreach ( $opts as $opt ) {
            $opt2 = strtolower( $opt );
            if ( $opt2 == 'autoconfirmed' ) {
                $options['autoconfirmed'] = true;
            }
            if ( $opt2 == 'moveonly' ) {
                $options['moveonly'] = true;
            }
            if ( $opt2 == 'newaccountonly' ) {
                $options['newaccountonly'] = true;
            }
            if ( $opt2 == 'noedit' ) {
                $options['noedit'] = true;
            }
            if ( $opt2 == 'casesensitive' ) {
                $options['casesensitive'] = true;
            }
            if ( $opt2 == 'reupload' ) {
                $options['reupload'] = true;
            }
            if ( preg_match( '/errmsg\s*=\s*(.+)/i', $opt, $matches ) ) {
                $options['errmsg'] = $matches[1];
            }
            if ( $opt2 == 'antispoof' ) {
                $options['antispoof'] = true;
            }
        }
        // Process magic words
        preg_match_all( '/{{\s*([a-z]+)\s*:\s*(.+?)\s*}}/', $regex, $magicwords, PREG_SET_ORDER );
        foreach ( $magicwords as $mword ) {
            global $wgParser;   // Functions we're calling don't need, nevertheless let's use it
            switch ( strtolower( $mword[1] ) ) {
                case 'ns':
                    $cpf_result = CoreParserFunctions::ns( $wgParser, $mword[2] );
                    if ( is_string( $cpf_result ) ) {
                        // All result will have the same value, so we can just use str_seplace()
                        $regex = str_replace( $mword[0], $cpf_result, $regex );
                    }
                    break;
                case 'int':
                    $cpf_result = wfMessage( $mword[2] )->inContentLanguage()->text();
                    if ( is_string( $cpf_result ) ) {
                        $regex = str_replace( $mword[0], $cpf_result, $regex );
                    }
            }
        }
        // Return result
        if ( $regex ) {
            return new TitleBlacklistEntry( $regex, $options, $raw, $source );
        } else {
            return null;
        }
    }
 
    public function getRegex() {
        return $this->mRegex;
    }
 
    public function getRaw() {
        return $this->mRaw;
    }
 
    public function getParams() {
        return $this->mParams;
    }
 
    public function getCustomMessage() {
        return $this->mParams['errmsg'] ?? null;
    }
 
    public function getFormatVersion() {
        return $this->mFormatVersion;
    }
 
    public function setFormatVersion( $v ) {
        $this->mFormatVersion = $v;
    }
 
    public function getErrorMessage( $operation ) {
        $message = $this->getCustomMessage();
        // For grep:
        // titleblacklist-forbidden-edit, titleblacklist-forbidden-move,
        // titleblacklist-forbidden-upload, titleblacklist-forbidden-new-account
        return $message ?: "titleblacklist-forbidden-{$operation}";
    }
}