SeenCondition.php

Go to the documentation of this file.

<?php
 
namespace MediaWiki\RecentChanges\ChangesListQuery;
 
use MediaWiki\Page\PageReferenceValue;
use MediaWiki\User\UserIdentity;
use MediaWiki\Watchlist\WatchedItemStoreInterface;
use stdClass;
use Wikimedia\Rdbms\IReadableDatabase;
use Wikimedia\Rdbms\RawSQLExpression;
use Wikimedia\Timestamp\ConvertibleTimestamp;
use Wikimedia\Timestamp\TimestampFormat as TS;
 
class SeenCondition extends ChangesListConditionBase {
    private ?UserIdentity $user = null;
 
    public function __construct(
        private WatchedItemStoreInterface $watchedItemStore
    ) {
    }
 
    public function setUser( UserIdentity $user ) {
        if ( $user->getId() ) {
            $this->user = $user;
        } else {
            $this->user = null;
        }
    }
 
    public function evaluate( stdClass $row, $value ): bool {
        if ( !$this->user ) {
            $seen = false;
        } else {
            $firstUnseen = $this->getLatestNotificationTimestamp( $row, $this->user );
            $seen = $firstUnseen === null
                || $firstUnseen > ConvertibleTimestamp::convert( TS::MW, $row->rc_timestamp );
        }
        return $seen === $value;
    }
 
    private function getLatestNotificationTimestamp( stdClass $row, UserIdentity $user ) {
        if ( $row->rc_title === '' ) {
            return null;
        }
        return $this->watchedItemStore->getLatestNotificationTimestamp(
            $row->wl_notificationtimestamp,
            $user,
            new PageReferenceValue( (int)$row->rc_namespace, $row->rc_title, PageReferenceValue::LOCAL )
        );
    }
 
    public function validateValue( $value ) {
        if ( !is_bool( $value ) ) {
            throw new \InvalidArgumentException(
                'filter "seen" requires a boolean value' );
        }
        return $value;
    }
 
    protected function prepareCapture( IReadableDatabase $dbr, QueryBackend $query ) {
        if ( $this->user ) {
            $query->joinForFields( 'watchlist' )->weakLeft();
            $query->fields( [ 'rc_timestamp', 'rc_namespace', 'rc_title', 'wl_notificationtimestamp' ] );
        }
    }
 
    protected function prepareConds( IReadableDatabase $dbr, QueryBackend $query ) {
        $values = $this->getEnumValues( [ true, false ] );
        if ( $values === [] ) {
            $query->forceEmptySet();
        } elseif ( $values === [ true ] ) {
            // Require seen
            if ( $this->user ) {
                $query->joinForConds( 'watchlist' )->weakLeft();
                $query->where( $dbr->expr( 'wl_notificationtimestamp', '=', null )
                    ->orExpr( new RawSQLExpression( 'rc_timestamp < wl_notificationtimestamp' ) ) );
            } else {
                $query->forceEmptySet();
            }
        } elseif ( $values === [ false ] ) {
            // Require unseen
            if ( $this->user ) {
                $query->joinForConds( 'watchlist' )->weakLeft();
                $query->where( $dbr->expr( 'wl_notificationtimestamp', '!=', null )
                    ->andExpr( new RawSQLExpression( 'rc_timestamp >= wl_notificationtimestamp' ) ) );
            }
        }
    }
}