MessageCollection.php

<?php
declare( strict_types = 1 );
 
namespace MediaWiki\Extension\Translate\MessageLoading;
 
use AppendIterator;
use ArrayAccess;
use Countable;
use EmptyIterator;
use InvalidArgumentException;
use Iterator;
use LogicException;
use MediaWiki\Content\TextContent;
use MediaWiki\Extension\Translate\MessageGroupProcessing\RevTagStore;
use MediaWiki\Extension\Translate\SystemUsers\FuzzyBot;
use MediaWiki\Extension\Translate\Utilities\Utilities;
use MediaWiki\MediaWikiServices;
use MediaWiki\Revision\SlotRecord;
use MediaWiki\Title\TitleValue;
use RuntimeException;
use stdClass;
use Traversable;
use Wikimedia\Rdbms\IDBAccessObject;
use Wikimedia\Rdbms\IReadableDatabase;
 
class MessageCollection implements ArrayAccess, Iterator, Countable {
    private const MAX_ITEMS_PER_QUERY = 2000;
    public const FILTER_FUZZY = 'fuzzy';
    public const FILTER_OPTIONAL = 'optional';
    public const FILTER_IGNORED = 'ignored';
    public const FILTER_HAS_TRANSLATION = 'hastranslation';
    public const FILTER_CHANGED = 'changed';
    public const FILTER_TRANSLATED = 'translated';
    public const FILTER_REVIEWER = 'reviewer';
    public const FILTER_LAST_TRANSLATOR = 'last-translator';
    private const AVAILABLE_FILTERS = [
        self::FILTER_FUZZY,
        self::FILTER_OPTIONAL,
        self::FILTER_IGNORED,
        self::FILTER_HAS_TRANSLATION,
        self::FILTER_CHANGED,
        self::FILTER_TRANSLATED,
        self::FILTER_REVIEWER,
        self::FILTER_LAST_TRANSLATOR,
    ];
    public const INCLUDE_MATCHING = false;
    public const EXCLUDE_MATCHING = true;
 
    public string $code;
    private MessageDefinitions $definitions;
    private array $infile = [];
    // Keys and messages.
 
    protected array $keys = [];
    protected ?array $messages = [];
    private ?array $reverseMap = null;
    // Database resources
 
    private Traversable $dbInfo;
    private Traversable $dbData;
    private Traversable $dbReviewData;
    protected array $tags = [];
    private array $authors = [];
 
    public function __construct( string $code ) {
        $this->code = $code;
    }
 
    public static function newFromDefinitions( MessageDefinitions $definitions, string $code ): self {
        $collection = new self( $code );
        $collection->definitions = $definitions;
        $collection->resetForNewLanguage( $code );
 
        return $collection;
    }
 
    public function getLanguage(): string {
        return $this->code;
    }
 
    // Data setters
 
    public function setInFile( array $messages ): void {
        $this->infile = $messages;
    }
 
    public function setTags( string $type, array $keys ): void {
        $this->tags[$type] = $keys;
    }
 
    public function keys(): array {
        return $this->keys;
    }
 
    private function getTitles(): array {
        return array_values( $this->keys );
    }
 
    public function getMessageKeys(): array {
        return array_keys( $this->keys );
    }
 
    public function getTags( string $type ): array {
        return $this->tags[$type] ?? [];
    }
 
    public function getAuthors(): array {
        $this->loadTranslations();
 
        $authors = array_flip( $this->authors );
 
        foreach ( $this->messages as $m ) {
            // Check if there are authors
            $author = $m->getProperty( 'last-translator-text' );
 
            if ( $author === null ) {
                continue;
            }
 
            if ( !isset( $authors[$author] ) ) {
                $authors[$author] = 1;
            } else {
                $authors[$author]++;
            }
        }
 
        # arsort( $authors, SORT_NUMERIC );
        ksort( $authors );
        $fuzzyBot = FuzzyBot::getName();
        $filteredAuthors = [];
        foreach ( $authors as $author => $edits ) {
            if ( $author !== $fuzzyBot ) {
                $filteredAuthors[] = (string)$author;
            }
        }
 
        return $filteredAuthors;
    }
 
    public function addCollectionAuthors( array $authors, string $mode = 'append' ): void {
        switch ( $mode ) {
            case 'append':
                $authors = array_merge( $this->authors, $authors );
                break;
            case 'set':
                break;
            default:
                throw new InvalidArgumentException( "Invalid mode $mode" );
        }
 
        $this->authors = array_unique( $authors );
    }
 
    // Data modifiers
 
    public function loadTranslations(): void {
        // Performance optimization: Instead of building conditions based on key in every
        // method, build them once and pass it on to each of them.
        $dbr = Utilities::getSafeReadDB();
        $titleConds = $this->getTitleConds( $dbr );
 
        $this->loadData( $this->keys, $titleConds );
        $this->loadInfo( $this->keys, $titleConds );
        $this->loadReviewInfo( $this->keys, $titleConds );
        $this->initMessages();
    }
 
    public function resetForNewLanguage( string $code ): void {
        $this->code = $code;
        $this->keys = $this->fixKeys();
        $this->dbInfo = new EmptyIterator();
        $this->dbData = new EmptyIterator();
        $this->dbReviewData = new EmptyIterator();
        $this->messages = null;
        $this->infile = [];
        $this->authors = [];
 
        unset( $this->tags['fuzzy'] );
        $this->reverseMap = null;
    }
 
    public function slice( $offset, $limit ) {
        $indexes = array_keys( $this->keys );
 
        if ( $offset === '' ) {
            $offset = 0;
        }
 
        // Handle string offsets
        if ( !ctype_digit( (string)$offset ) ) {
            $pos = array_search( $offset, array_keys( $this->keys ), true );
            // Now offset is always an integer, suitable for array_slice
            $offset = $pos !== false ? $pos : count( $this->keys );
        } else {
            $offset = (int)$offset;
        }
 
        // False means that cannot go back or forward
        $backwardsOffset = $forwardsOffset = false;
        // Backwards paging uses numerical indexes, see below
 
        // Can only skip this if no offset has been provided or the
        // offset is zero. (offset - limit ) > 1 does not work, because
        // users can end in offest=2, limit=5 and can't see the first
        // two messages. That's also why it is capped into zero with
        // max(). And finally make the offsets to be strings even if
        // they are numbers in this case.
        if ( $offset > 0 ) {
            $backwardsOffset = (string)( max( 0, $offset - $limit ) );
        }
 
        // Forwards paging uses keys. If user opens view Untranslated,
        // translates some messages and then clicks next, the first
        // message visible in the page is the first message not shown
        // in the previous page (unless someone else translated it at
        // the same time). If we used integer offsets, we would skip
        // same number of messages that were translated, because they
        // are no longer in the list. For backwards paging this is not
        // such a big issue, so it still uses integer offsets, because
        // we would need to also implement "direction" to have it work
        // correctly.
        if ( isset( $indexes[$offset + $limit] ) ) {
            $forwardsOffset = $indexes[$offset + $limit];
        }
 
        $this->keys = array_slice( $this->keys, $offset, $limit, true );
 
        return [ $backwardsOffset, $forwardsOffset, $offset ];
    }
 
    public function filter( string $filter, bool $condition, ?int $value = null ): void {
        if ( !in_array( $filter, self::AVAILABLE_FILTERS, true ) ) {
            throw new InvalidFilterException( $filter );
        }
 
        $keys = $this->keys;
        if ( $filter === self::FILTER_FUZZY ) {
            $keys = $this->filterFuzzy( $keys, $condition );
        } elseif ( $filter === self::FILTER_HAS_TRANSLATION ) {
            $keys = $this->filterHastranslation( $keys, $condition );
        } elseif ( $filter === self::FILTER_TRANSLATED ) {
            $fuzzy = $this->filterFuzzy( $keys, self::INCLUDE_MATCHING );
            $hastranslation = $this->filterHastranslation( $keys, self::INCLUDE_MATCHING );
            // Fuzzy messages are not counted as translated messages
            $translated = $this->filterOnCondition( $hastranslation, $fuzzy );
            $keys = $this->filterOnCondition( $keys, $translated, $condition );
        } elseif ( $filter === self::FILTER_CHANGED ) {
            $keys = $this->filterChanged( $keys, $condition );
        } elseif ( $filter === self::FILTER_REVIEWER ) {
            $keys = $this->filterReviewer( $keys, $condition, $value );
        } elseif ( $filter === self::FILTER_LAST_TRANSLATOR ) {
            $keys = $this->filterLastTranslator( $keys, $condition, $value );
        } else {
            if ( !isset( $this->tags[$filter] ) ) {
                if ( $filter !== self::FILTER_OPTIONAL && $filter !== self::FILTER_IGNORED ) {
                    throw new RuntimeException( "No tagged messages for custom filter $filter" );
                }
                $keys = $this->filterOnCondition( $keys, [], $condition );
            } else {
                $taggedKeys = array_flip( $this->tags[$filter] );
                $keys = $this->filterOnCondition( $keys, $taggedKeys, $condition );
            }
        }
 
        $this->keys = $keys;
    }
 
    public function filterUntranslatedOptional(): void {
        $optionalKeys = array_flip( $this->tags['optional'] ?? [] );
        // Convert plain message keys to array<string,TitleValue>
        $optional = $this->filterOnCondition( $this->keys, $optionalKeys, self::INCLUDE_MATCHING );
        // Then get reduce that list to those which have no translation. Ensure we don't
        // accidentally populate the info cache with too few keys.
        $this->loadInfo( $this->keys );
        $untranslatedOptional = $this->filterHastranslation( $optional, self::EXCLUDE_MATCHING );
        // Now remove that list from the full list
        $this->keys = $this->filterOnCondition( $this->keys, $untranslatedOptional );
    }
 
    private function filterOnCondition( array $keys, array $condKeys, bool $condition = true ): array {
        if ( $condition === self::EXCLUDE_MATCHING ) {
            // Delete $condKeys from $keys
            foreach ( array_keys( $condKeys ) as $key ) {
                unset( $keys[$key] );
            }
        } else {
            // Keep the keys which are in $condKeys
            foreach ( array_keys( $keys ) as $key ) {
                if ( !isset( $condKeys[$key] ) ) {
                    unset( $keys[$key] );
                }
            }
        }
 
        return $keys;
    }
 
    private function filterFuzzy( array $keys, bool $condition ): array {
        $this->loadInfo( $keys );
 
        $origKeys = [];
        if ( $condition === self::INCLUDE_MATCHING ) {
            $origKeys = $keys;
        }
 
        foreach ( $this->dbInfo as $row ) {
            if ( $row->rt_type !== null ) {
                unset( $keys[$this->rowToKey( $row )] );
            }
        }
 
        if ( $condition === self::INCLUDE_MATCHING ) {
            $keys = array_diff( $origKeys, $keys );
        }
 
        return $keys;
    }
 
    private function filterHastranslation( array $keys, bool $condition ): array {
        $this->loadInfo( $keys );
 
        $origKeys = [];
        if ( $condition === self::INCLUDE_MATCHING ) {
            $origKeys = $keys;
        }
 
        foreach ( $this->dbInfo as $row ) {
            unset( $keys[$this->rowToKey( $row )] );
        }
 
        // Check also if there is something in the file that is not yet in the database
        foreach ( array_keys( $this->infile ) as $inf ) {
            unset( $keys[$inf] );
        }
 
        // Remove the messages which do not have a translation from the list
        if ( $condition === self::INCLUDE_MATCHING ) {
            $keys = array_diff( $origKeys, $keys );
        }
 
        return $keys;
    }
 
    private function filterChanged( array $keys, bool $condition ): array {
        $this->loadData( $keys );
 
        $origKeys = [];
        if ( $condition === self::INCLUDE_MATCHING ) {
            $origKeys = $keys;
        }
 
        $revStore = MediaWikiServices::getInstance()->getRevisionStore();
        $infileRows = [];
        foreach ( $this->dbData as $row ) {
            $mkey = $this->rowToKey( $row );
            if ( isset( $this->infile[$mkey] ) ) {
                $infileRows[] = $row;
            }
        }
 
        $revisions = $revStore->newRevisionsFromBatch( $infileRows, [
            'slots' => [ SlotRecord::MAIN ],
            'content' => true
        ] )->getValue();
        foreach ( $infileRows as $row ) {
            $content = $revisions[$row->rev_id]?->getContent( SlotRecord::MAIN );
            if ( $content instanceof TextContent ) {
                $mkey = $this->rowToKey( $row );
                if ( $this->infile[$mkey] === $content->getText() ) {
                    // Remove unchanged messages from the list
                    unset( $keys[$mkey] );
                }
            }
        }
 
        // Remove the messages which have changed from the original list
        if ( $condition === self::INCLUDE_MATCHING ) {
            $keys = $this->filterOnCondition( $origKeys, $keys );
        }
 
        return $keys;
    }
 
    private function filterReviewer( array $keys, bool $condition, ?int $userId ): array {
        $this->loadReviewInfo( $keys );
        $origKeys = $keys;
 
        /* This removes messages from the list which have certain
         * reviewer (among others) */
        foreach ( $this->dbReviewData as $row ) {
            if ( $userId === null || (int)$row->trr_user === $userId ) {
                unset( $keys[$this->rowToKey( $row )] );
            }
        }
 
        if ( $condition === self::INCLUDE_MATCHING ) {
            $keys = array_diff( $origKeys, $keys );
        }
 
        return $keys;
    }
 
    private function filterLastTranslator( array $keys, bool $condition, ?int $userId ): array {
        $this->loadData( $keys );
        $origKeys = $keys;
 
        $userId ??= 0;
        foreach ( $this->dbData as $row ) {
            if ( (int)$row->rev_user === $userId ) {
                unset( $keys[$this->rowToKey( $row )] );
            }
        }
 
        if ( $condition === self::INCLUDE_MATCHING ) {
            $keys = array_diff( $origKeys, $keys );
        }
 
        return $keys;
    }
 
    private function fixKeys(): array {
        $newkeys = [];
 
        $pages = $this->definitions->getPages();
        foreach ( $pages as $key => $baseTitle ) {
            $newkeys[$key] = new TitleValue(
                $baseTitle->getNamespace(),
                $baseTitle->getDBkey() . '/' . $this->code
            );
        }
 
        return $newkeys;
    }
 
    private function loadInfo( array $keys, ?array $titleConds = null ): void {
        if ( !$this->dbInfo instanceof EmptyIterator ) {
            return;
        }
 
        if ( !count( $keys ) ) {
            $this->dbInfo = new EmptyIterator();
            return;
        }
 
        $dbr = Utilities::getSafeReadDB();
 
        $titleConds ??= $this->getTitleConds( $dbr );
        $iterator = new AppendIterator();
        foreach ( $titleConds as $conds ) {
            $queryResults = $dbr->newSelectQueryBuilder()
                ->select( [ 'page_namespace', 'page_title', 'rt_type' ] )
                ->from( 'page' )
                ->leftJoin( 'revtag', null, [
                    'page_id=rt_page',
                    'page_latest=rt_revision',
                    'rt_type' => RevTagStore::FUZZY_TAG,
                ] )
                ->where( $conds )
                ->caller( __METHOD__ )
                ->fetchResultSet();
            $iterator->append( $queryResults );
        }
 
        $this->dbInfo = $iterator;
 
        // Populate and cache reverse map now, since if call to initMesages is delayed (e.g. a
        // filter that calls loadData() is used, or ::slice is used) the reverse map will not
        // contain all the entries that are present in our $iterator and will throw notices.
        $this->getReverseMap();
    }
 
    private function loadReviewInfo( array $keys, ?array $titleConds = null ): void {
        if ( !$this->dbReviewData instanceof EmptyIterator ) {
            return;
        }
 
        if ( !count( $keys ) ) {
            $this->dbReviewData = new EmptyIterator();
            return;
        }
 
        $dbr = Utilities::getSafeReadDB();
 
        $titleConds ??= $this->getTitleConds( $dbr );
        $iterator = new AppendIterator();
        foreach ( $titleConds as $conds ) {
            $queryResults = $dbr->newSelectQueryBuilder()
                ->select( [ 'page_namespace', 'page_title', 'trr_user' ] )
                ->from( 'page' )
                ->join( 'translate_reviews', null, [ 'page_id=trr_page', 'page_latest=trr_revision' ] )
                ->where( $conds )
                ->caller( __METHOD__ )
                ->fetchResultSet();
            $iterator->append( $queryResults );
        }
 
        $this->dbReviewData = $iterator;
 
        // Populate and cache reverse map now, since if call to initMesages is delayed (e.g. a
        // filter that calls loadData() is used, or ::slice is used) the reverse map will not
        // contain all the entries that are present in our $iterator and will throw notices.
        $this->getReverseMap();
    }
 
    private function loadData( array $keys, ?array $titleConds = null ): void {
        if ( !$this->dbData instanceof EmptyIterator ) {
            return;
        }
 
        if ( !count( $keys ) ) {
            $this->dbData = new EmptyIterator();
            return;
        }
 
        $dbr = Utilities::getSafeReadDB();
        $revisionStore = MediaWikiServices::getInstance()->getRevisionStore();
 
        $titleConds ??= $this->getTitleConds( $dbr );
        $iterator = new AppendIterator();
        foreach ( $titleConds as $conds ) {
            $queryResults = $revisionStore->newSelectQueryBuilder( $dbr )
                ->joinPage()
                ->joinComment()
                ->where( $conds )
                ->andWhere( [ 'page_latest = rev_id' ] )
                ->caller( __METHOD__ )
                ->fetchResultSet();
            $iterator->append( $queryResults );
        }
 
        $this->dbData = $iterator;
 
        // Populate and cache reverse map now, since if call to initMesages is delayed (e.g. a
        // filter that calls loadData() is used, or ::slice is used) the reverse map will not
        // contain all the entries that are present in our $iterator and will throw notices.
        $this->getReverseMap();
    }
 
    private function getTitleConds( IReadableDatabase $db ): array {
        $titles = $this->getTitles();
        $chunks = array_chunk( $titles, self::MAX_ITEMS_PER_QUERY );
        $results = [];
 
        foreach ( $chunks as $titles ) {
            // Array of array( namespace, pagename )
            $byNamespace = [];
            foreach ( $titles as $title ) {
                $namespace = $title->getNamespace();
                $pagename = $title->getDBkey();
                $byNamespace[$namespace][] = $pagename;
            }
 
            $conds = [];
            foreach ( $byNamespace as $namespaces => $pagenames ) {
                $cond = [
                    'page_namespace' => $namespaces,
                    'page_title' => $pagenames,
                ];
 
                $conds[] = $db->makeList( $cond, LIST_AND );
            }
 
            $results[] = $db->makeList( $conds, LIST_OR );
        }
 
        return $results;
    }
 
    private function rowToKey( stdClass $row ): ?string {
        $map = $this->getReverseMap();
        if ( isset( $map[$row->page_namespace][$row->page_title] ) ) {
            return $map[$row->page_namespace][$row->page_title];
        } else {
            wfWarn( "Got unknown title from the database: {$row->page_namespace}:{$row->page_title}" );
 
            return null;
        }
    }
 
    private function getReverseMap(): array {
        if ( $this->reverseMap !== null ) {
            return $this->reverseMap;
        }
 
        $map = [];
        foreach ( $this->keys as $mkey => $title ) {
            $map[$title->getNamespace()][$title->getDBkey()] = $mkey;
        }
 
        $this->reverseMap = $map;
        return $this->reverseMap;
    }
 
    public function initMessages(): void {
        if ( $this->messages !== null ) {
            return;
        }
 
        $messages = [];
        $definitions = $this->definitions->getDefinitions();
        $revStore = MediaWikiServices::getInstance()->getRevisionStore();
        $queryFlags = Utilities::shouldReadFromPrimary() ? IDBAccessObject::READ_LATEST : 0;
        foreach ( array_keys( $this->keys ) as $mkey ) {
            $messages[$mkey] = new ThinMessage( $mkey, $definitions[$mkey] );
        }
 
        if ( !$this->dbData instanceof EmptyIterator ) {
            $slotRows = $revStore->getContentBlobsForBatch(
                $this->dbData,
                [ SlotRecord::MAIN ],
                $queryFlags
            )->getValue();
 
            foreach ( $this->dbData as $row ) {
                $mkey = $this->rowToKey( $row );
                if ( !isset( $messages[$mkey] ) ) {
                    continue;
                }
                $messages[$mkey]->setRow( $row );
                $messages[$mkey]->setProperty( 'revision', $row->page_latest );
 
                if ( isset( $slotRows[$row->rev_id][SlotRecord::MAIN] ) ) {
                    $slot = $slotRows[$row->rev_id][SlotRecord::MAIN];
                    $messages[$mkey]->setTranslation( $slot->blob_data );
                }
            }
        }
 
        $fuzzy = [];
        foreach ( $this->dbInfo as $row ) {
            if ( $row->rt_type !== null ) {
                $fuzzy[] = $this->rowToKey( $row );
            }
        }
 
        $this->setTags( 'fuzzy', $fuzzy );
 
        // Copy tags if any.
        foreach ( $this->tags as $type => $keys ) {
            foreach ( $keys as $mkey ) {
                if ( isset( $messages[$mkey] ) ) {
                    $messages[$mkey]->addTag( $type );
                }
            }
        }
 
        // Copy infile if any.
        foreach ( $this->infile as $mkey => $value ) {
            if ( isset( $messages[$mkey] ) ) {
                $messages[$mkey]->setInfile( $value );
            }
        }
 
        foreach ( $this->dbReviewData as $row ) {
            $mkey = $this->rowToKey( $row );
            if ( !isset( $messages[$mkey] ) ) {
                continue;
            }
            $messages[$mkey]->appendProperty( 'reviewers', $row->trr_user );
        }
 
        // Set the status property
        foreach ( $messages as $obj ) {
            if ( $obj->hasTag( 'fuzzy' ) ) {
                $obj->setProperty( 'status', 'fuzzy' );
            } elseif ( is_array( $obj->getProperty( 'reviewers' ) ) ) {
                $obj->setProperty( 'status', 'proofread' );
            } elseif ( $obj->translation() !== null ) {
                $obj->setProperty( 'status', 'translated' );
            } else {
                $obj->setProperty( 'status', 'untranslated' );
            }
        }
 
        $this->messages = $messages;
    }
 
    public function offsetExists( $offset ): bool {
        return isset( $this->keys[$offset] );
    }
 
    public function offsetGet( $offset ): ?Message {
        return $this->messages[$offset] ?? null;
    }
 
    public function offsetSet( $offset, $value ): void {
        $this->messages[$offset] = $value;
    }
 
    public function offsetUnset( $offset ): void {
        unset( $this->keys[$offset] );
    }
 
    public function __get( string $name ): void {
        throw new LogicException( __METHOD__ . ": Trying to access unknown property $name" );
    }
 
    public function __set( string $name, $value ): void {
        throw new LogicException( __METHOD__ . ": Trying to modify unknown property $name" );
    }
 
    public function rewind(): void {
        reset( $this->keys );
    }
 
    #[\ReturnTypeWillChange]
    public function current() {
        if ( !count( $this->keys ) ) {
            return false;
        }
 
        // @phan-suppress-next-line PhanTypeArraySuspiciousNullable
        return $this->messages[key( $this->keys )];
    }
 
    public function key(): string {
        return key( $this->keys );
    }
 
    public function next(): void {
        next( $this->keys );
    }
 
    public function valid(): bool {
        return isset( $this->messages[key( $this->keys )] );
    }
 
    public function count(): int {
        return count( $this->keys() );
    }
 
}