MessageBundle.php

<?php
declare( strict_types = 1 );
 
namespace MediaWiki\Extension\Translate\MessageBundleTranslation;
 
use MediaWiki\Extension\Translate\MessageGroupProcessing\RevTagStore;
use MediaWiki\Extension\Translate\MessageGroupProcessing\TranslatableBundle;
use MediaWiki\MediaWikiServices;
use MediaWiki\Page\PageIdentity;
use MediaWiki\Title\Title;
 
class MessageBundle extends TranslatableBundle {
 
    public function __construct(
        private readonly PageIdentity $page,
    ) {
    }
 
    public function getTitle(): Title {
        return Title::newFromPageIdentity( $this->page );
    }
 
    public function getMessageGroupId(): string {
        return MessageBundleMessageGroup::getGroupId( $this->getTitle()->getPrefixedText() );
    }
 
    public function getTranslationPages(): array {
        // MessageBundle do not have translation pages
        return [];
    }
 
    public function getTranslationUnitPages( ?string $code = null ): array {
        return $this->getTranslationUnitPagesByTitle( $this->page, $code );
    }
 
    public function isMoveable(): bool {
        return true;
    }
 
    public function isDeletable(): bool {
        return true;
    }
 
    public static function isSourcePage( PageIdentity $page ): bool {
        if ( !$page->exists() ) {
            return false;
        }
 
        $mwServices = MediaWikiServices::getInstance();
        $cache = $mwServices->getMainWANObjectCache();
        $cacheKey = $cache->makeKey( 'messagebundle', 'source' );
 
        $messageBundleIds = $cache->getWithSetCallback(
            $cacheKey,
            $cache::TTL_HOUR * 2,
            static function () {
                $ids = RevTagStore::getTranslatableBundleIds( [ RevTagStore::MB_VALID_TAG ] );
                // Adding a comma at the end and beginning so that we can check for page Id
                // existence with the "," delimiters
                return ',' . implode( ',', $ids ) . ',';
            },
            [
                'checkKeys' => [ $cacheKey ],
                'pcTTL' => $cache::TTL_PROC_SHORT,
                'pcGroup' => __CLASS__ . ':1',
                'version' => 3,
            ]
        );
 
        return str_contains( $messageBundleIds, ( ',' . $page->getId() . ',' ) );
    }
 
    public static function clearSourcePageCache(): void {
        $cache = MediaWikiServices::getInstance()->getMainWANObjectCache();
        $cache->touchCheckKey( $cache->makeKey( 'messagebundle', 'source' ) );
    }
}