LogPager.php

Go to the documentation of this file.

<?php
use MediaWiki\Cache\LinkBatchFactory;
use MediaWiki\MainConfigNames;
use MediaWiki\MediaWikiServices;
use MediaWiki\Page\PageReference;
use MediaWiki\User\ActorNormalization;
use Wikimedia\Rdbms\ILoadBalancer;
 
class LogPager extends ReverseChronologicalPager {
    private $types = [];
 
    private $performer = '';
 
    private $page = '';
 
    private $pattern = false;
 
    private $typeCGI = '';
 
    private $action = '';
 
    private $performerRestrictionsEnforced = false;
 
    private $actionRestrictionsEnforced = false;
 
    private $mConds;
 
    private $mTagFilter;
 
    public $mLogEventsList;
 
    private $linkBatchFactory;
 
    private $actorNormalization;
 
    public function __construct( $list, $types = [], $performer = '', $page = '',
        $pattern = false, $conds = [], $year = false, $month = false, $day = false,
        $tagFilter = '', $action = '', $logId = 0,
        LinkBatchFactory $linkBatchFactory = null,
        ILoadBalancer $loadBalancer = null,
        ActorNormalization $actorNormalization = null
    ) {
        $services = MediaWikiServices::getInstance();
        // Set database before parent constructor to avoid setting it there with wfGetDB
        $this->mDb = ( $loadBalancer ?? $services->getDBLoadBalancer() )
            ->getConnectionRef( ILoadBalancer::DB_REPLICA, 'logpager' );
        parent::__construct( $list->getContext() );
        $this->mConds = $conds;
 
        $this->mLogEventsList = $list;
 
        // Class is used directly in extensions - T266480
        $this->linkBatchFactory = $linkBatchFactory ?? $services->getLinkBatchFactory();
        $this->actorNormalization = $actorNormalization ?? $services->getActorNormalization();
 
        $this->limitLogId( $logId ); // set before types per T269761
        $this->limitType( $types ); // also excludes hidden types
        $this->limitFilterTypes();
        $this->limitPerformer( $performer );
        $this->limitTitle( $page, $pattern );
        $this->limitAction( $action );
        $this->getDateCond( $year, $month, $day );
        $this->mTagFilter = (string)$tagFilter;
    }
 
    public function getDefaultQuery() {
        $query = parent::getDefaultQuery();
        $query['type'] = $this->typeCGI; // arrays won't work here
        $query['user'] = $this->performer;
        $query['day'] = $this->mDay;
        $query['month'] = $this->mMonth;
        $query['year'] = $this->mYear;
 
        return $query;
    }
 
    private function limitFilterTypes() {
        if ( $this->hasEqualsClause( 'log_id' ) ) { // T220834
            return;
        }
        $filterTypes = $this->getFilterParams();
        foreach ( $filterTypes as $type => $hide ) {
            if ( $hide ) {
                $this->mConds[] = 'log_type != ' . $this->mDb->addQuotes( $type );
            }
        }
    }
 
    public function getFilterParams() {
        $filters = [];
        if ( count( $this->types ) ) {
            return $filters;
        }
 
        $wpfilters = $this->getRequest()->getArray( "wpfilters" );
        $filterLogTypes = $this->getConfig()->get( MainConfigNames::FilterLogTypes );
 
        foreach ( $filterLogTypes as $type => $default ) {
            // Back-compat: Check old URL params if the new param wasn't passed
            if ( $wpfilters === null ) {
                $hide = $this->getRequest()->getBool( "hide_{$type}_log", $default );
            } else {
                $hide = !in_array( $type, $wpfilters );
            }
 
            $filters[$type] = $hide;
        }
 
        return $filters;
    }
 
    private function limitType( $types ) {
        $user = $this->getUser();
        $restrictions = $this->getConfig()->get( MainConfigNames::LogRestrictions );
        // If $types is not an array, make it an array
        $types = ( $types === '' ) ? [] : (array)$types;
        // Don't even show header for private logs; don't recognize it...
        $needReindex = false;
        foreach ( $types as $type ) {
            if ( isset( $restrictions[$type] )
                && !$this->getAuthority()->isAllowed( $restrictions[$type] )
            ) {
                $needReindex = true;
                $types = array_diff( $types, [ $type ] );
            }
        }
        if ( $needReindex ) {
            // Lots of this code makes assumptions that
            // the first entry in the array is $types[0].
            $types = array_values( $types );
        }
        $this->types = $types;
        // Don't show private logs to unprivileged users.
        // Also, only show them upon specific request to avoid surprises.
        // Exception: if we are showing only a single log entry based on the log id,
        // we don't require that "specific request" so that the links-in-logs feature
        // works. See T269761
        $audience = ( $types || $this->hasEqualsClause( 'log_id' ) ) ? 'user' : 'public';
        $hideLogs = LogEventsList::getExcludeClause( $this->mDb, $audience, $user );
        if ( $hideLogs !== false ) {
            $this->mConds[] = $hideLogs;
        }
        if ( count( $types ) ) {
            $this->mConds['log_type'] = $types;
            // Set typeCGI; used in url param for paging
            if ( count( $types ) == 1 ) {
                $this->typeCGI = $types[0];
            }
        }
    }
 
    private function limitPerformer( $name ) {
        if ( $name == '' ) {
            return;
        }
 
        $actorId = $this->actorNormalization->findActorIdByName( $name, $this->mDb );
 
        if ( !$actorId ) {
            // Unknown user, match nothing.
            $this->mConds[] = '1 = 0';
            return;
        }
 
        $this->mConds[ 'log_actor' ] = $actorId;
 
        $this->enforcePerformerRestrictions();
 
        $this->performer = $name;
    }
 
    private function limitTitle( $page, $pattern ) {
        if ( !$page instanceof PageReference ) {
            // NOTE: For some types of logs, the title may be something strange, like "User:#12345"!
            $page = Title::newFromText( $page );
            if ( !$page ) {
                return;
            }
        }
 
        $titleFormatter = MediaWikiServices::getInstance()->getTitleFormatter();
        $this->page = $titleFormatter->getPrefixedDBkey( $page );
        $ns = $page->getNamespace();
        $db = $this->mDb;
 
        $interwikiDelimiter = $this->getConfig()->get( MainConfigNames::UserrightsInterwikiDelimiter );
 
        $doUserRightsLogLike = false;
        if ( $this->types == [ 'rights' ] ) {
            $parts = explode( $interwikiDelimiter, $page->getDBkey() );
            if ( count( $parts ) == 2 ) {
                list( $name, $database ) = array_map( 'trim', $parts );
                if ( strstr( $database, '*' ) ) { // Search for wildcard in database name
                    $doUserRightsLogLike = true;
                }
            }
        }
 
        $this->mConds['log_namespace'] = $ns;
        if ( $doUserRightsLogLike ) {
            // @phan-suppress-next-line PhanPossiblyUndeclaredVariable $name is set when reached here
            $params = [ $name . $interwikiDelimiter ];
            // @phan-suppress-next-next-line PhanPossiblyUndeclaredVariable $database is set when reached here
            // @phan-suppress-next-line PhanTypeMismatchArgumentNullableInternal $database is set when reached here
            foreach ( explode( '*', $database ) as $databasepart ) {
                $params[] = $databasepart;
                $params[] = $db->anyString();
            }
            array_pop( $params ); // Get rid of the last % we added.
            $this->mConds[] = 'log_title' . $db->buildLike( ...$params );
        } elseif ( $pattern && !$this->getConfig()->get( MainConfigNames::MiserMode ) ) {
            $this->mConds[] = 'log_title' . $db->buildLike( $page->getDBkey(), $db->anyString() );
            $this->pattern = $pattern;
        } else {
            $this->mConds['log_title'] = $page->getDBkey();
        }
        $this->enforceActionRestrictions();
    }
 
    private function limitAction( $action ) {
        // Allow to filter the log by actions
        $type = $this->typeCGI;
        if ( $type === '' ) {
            // nothing to do
            return;
        }
        $actions = $this->getConfig()->get( MainConfigNames::ActionFilteredLogs );
        if ( isset( $actions[$type] ) ) {
            // log type can be filtered by actions
            $this->mLogEventsList->setAllowedActions( array_keys( $actions[$type] ) );
            if ( $action !== '' && isset( $actions[$type][$action] ) ) {
                // add condition to query
                $this->mConds['log_action'] = $actions[$type][$action];
                $this->action = $action;
            }
        }
    }
 
    protected function limitLogId( $logId ) {
        if ( !$logId ) {
            return;
        }
        $this->mConds['log_id'] = $logId;
    }
 
    public function getQueryInfo() {
        $basic = DatabaseLogEntry::getSelectQueryData();
 
        $tables = $basic['tables'];
        $fields = $basic['fields'];
        $conds = $basic['conds'];
        $options = $basic['options'];
        $joins = $basic['join_conds'];
 
        # Add log_search table if there are conditions on it.
        # This filters the results to only include log rows that have
        # log_search records with the specified ls_field and ls_value values.
        if ( array_key_exists( 'ls_field', $this->mConds ) ) {
            $tables[] = 'log_search';
            $options['IGNORE INDEX'] = [ 'log_search' => 'ls_log_id' ];
            $options['USE INDEX'] = [ 'logging' => 'PRIMARY' ];
            if ( !$this->hasEqualsClause( 'ls_field' )
                || !$this->hasEqualsClause( 'ls_value' )
            ) {
                # Since (ls_field,ls_value,ls_logid) is unique, if the condition is
                # to match a specific (ls_field,ls_value) tuple, then there will be
                # no duplicate log rows. Otherwise, we need to remove the duplicates.
                $options[] = 'DISTINCT';
            }
        } elseif ( array_key_exists( 'log_actor', $this->mConds ) ) {
            // Optimizer doesn't pick the right index when a user has lots of log actions (T303089)
            $index = 'log_actor_time';
            foreach ( $this->getFilterParams() as $type => $hide ) {
                if ( !$hide ) {
                    $index = 'log_actor_type_time';
                    break;
                }
            }
            $options['USE INDEX'] = [ 'logging' => $index ];
        }
        # Don't show duplicate rows when using log_search
        $joins['log_search'] = [ 'JOIN', 'ls_log_id=log_id' ];
 
        // T221458: MySQL/MariaDB (10.1.37) can sometimes irrationally decide that querying `actor` before
        // `logging` and filesorting is somehow better than querying $limit+1 rows from `logging`.
        // Tell it not to reorder the query. But not when tag filtering or log_search was used, as it
        // seems as likely to be harmed as helped in that case.
        if ( $this->mTagFilter === '' && !array_key_exists( 'ls_field', $this->mConds ) ) {
            $options[] = 'STRAIGHT_JOIN';
        }
 
        $options['MAX_EXECUTION_TIME'] = $this->getConfig()
            ->get( MainConfigNames::MaxExecutionTimeForExpensiveQueries );
 
        $info = [
            'tables' => $tables,
            'fields' => $fields,
            'conds' => array_merge( $conds, $this->mConds ),
            'options' => $options,
            'join_conds' => $joins,
        ];
        # Add ChangeTags filter query
        ChangeTags::modifyDisplayQuery( $info['tables'], $info['fields'], $info['conds'],
            $info['join_conds'], $info['options'], $this->mTagFilter );
 
        return $info;
    }
 
    protected function hasEqualsClause( $field ) {
        return (
            array_key_exists( $field, $this->mConds ) &&
            ( !is_array( $this->mConds[$field] ) || count( $this->mConds[$field] ) == 1 )
        );
    }
 
    public function getIndexField() {
        return 'log_timestamp';
    }
 
    protected function getStartBody() {
        # Do a link batch query
        if ( $this->getNumRows() > 0 ) {
            $lb = $this->linkBatchFactory->newLinkBatch();
            foreach ( $this->mResult as $row ) {
                $lb->add( $row->log_namespace, $row->log_title );
                $lb->add( NS_USER, $row->log_user_text );
                $lb->add( NS_USER_TALK, $row->log_user_text );
                $formatter = LogFormatter::newFromRow( $row );
                foreach ( $formatter->getPreloadTitles() as $title ) {
                    $lb->addObj( $title );
                }
            }
            $lb->execute();
            $this->mResult->seek( 0 );
        }
 
        return '';
    }
 
    public function formatRow( $row ) {
        return $this->mLogEventsList->logLine( $row );
    }
 
    public function getType() {
        return $this->types;
    }
 
    public function getPerformer() {
        return $this->performer;
    }
 
    public function getPage() {
        return $this->page;
    }
 
    public function getPattern() {
        return $this->pattern;
    }
 
    public function getYear() {
        return $this->mYear;
    }
 
    public function getMonth() {
        return $this->mMonth;
    }
 
    public function getDay() {
        return $this->mDay;
    }
 
    public function getTagFilter() {
        return $this->mTagFilter;
    }
 
    public function getAction() {
        return $this->action;
    }
 
    public function doQuery() {
        // Workaround MySQL optimizer bug
        $this->mDb->setBigSelects();
        parent::doQuery();
        $this->mDb->setBigSelects( 'default' );
    }
 
    private function enforceActionRestrictions() {
        if ( $this->actionRestrictionsEnforced ) {
            return;
        }
        $this->actionRestrictionsEnforced = true;
        if ( !$this->getAuthority()->isAllowed( 'deletedhistory' ) ) {
            $this->mConds[] = $this->mDb->bitAnd( 'log_deleted', LogPage::DELETED_ACTION ) . ' = 0';
        } elseif ( !$this->getAuthority()->isAllowedAny( 'suppressrevision', 'viewsuppressed' ) ) {
            $this->mConds[] = $this->mDb->bitAnd( 'log_deleted', LogPage::SUPPRESSED_ACTION ) .
                ' != ' . LogPage::SUPPRESSED_USER;
        }
    }
 
    private function enforcePerformerRestrictions() {
        // Same as enforceActionRestrictions(), except for _USER instead of _ACTION bits.
        if ( $this->performerRestrictionsEnforced ) {
            return;
        }
        $this->performerRestrictionsEnforced = true;
        if ( !$this->getAuthority()->isAllowed( 'deletedhistory' ) ) {
            $this->mConds[] = $this->mDb->bitAnd( 'log_deleted', LogPage::DELETED_USER ) . ' = 0';
        } elseif ( !$this->getAuthority()->isAllowedAny( 'suppressrevision', 'viewsuppressed' ) ) {
            $this->mConds[] = $this->mDb->bitAnd( 'log_deleted', LogPage::SUPPRESSED_USER ) .
                ' != ' . LogPage::SUPPRESSED_ACTION;
        }
    }
}