TranslatablePageStore.php
No OneTemporary
Actions

Size

7 KB

Referenced Files

None

Subscribers

None

TranslatablePageStore.php
View Options

	<?php
	declare( strict_types = 1 );

	namespace MediaWiki\Extension\Translate\MessageGroupProcessing;

	use AggregateMessageGroup;
	use IDBAccessObject;
	use InvalidArgumentException;
	use JobQueueGroup;
	use MediaWiki\Deferred\DeferredUpdates;
	use MediaWiki\Extension\Translate\MessageLoading\MessageIndex;
	use MediaWiki\Extension\Translate\MessageLoading\RebuildMessageIndexJob;
	use MediaWiki\Extension\Translate\MessageProcessing\MessageGroupMetadata;
	use MediaWiki\Extension\Translate\PageTranslation\TranslatablePage;
	use MediaWiki\Extension\Translate\PageTranslation\TranslatablePageParser;
	use MediaWiki\Extension\Translate\PageTranslation\UpdateTranslatablePageJob;
	use MediaWiki\Page\PageIdentity;
	use MediaWiki\Revision\RevisionRecord;
	use MediaWiki\Revision\SlotRecord;
	use MediaWiki\Title\Title;
	use RuntimeException;
	use TextContent;
	use Wikimedia\Rdbms\IConnectionProvider;

	/**
	* @author Abijeet Patro
	* @author Niklas Laxström
	* @since 2022.03
	* @license GPL-2.0-or-later
	*/
	class TranslatablePageStore implements TranslatableBundleStore {
	private MessageIndex $messageIndex;
	private JobQueueGroup $jobQueue;
	private RevTagStore $revTagStore;
	private IConnectionProvider $dbProvider;
	private TranslatableBundleStatusStore $translatableBundleStatusStore;
	private TranslatablePageParser $translatablePageParser;
	private MessageGroupMetadata $messageGroupMetadata;

	public function __construct(
	MessageIndex $messageIndex,
	JobQueueGroup $jobQueue,
	RevTagStore $revTagStore,
	IConnectionProvider $dbProvider,
	TranslatableBundleStatusStore $translatableBundleStatusStore,
	TranslatablePageParser $translatablePageParser,
	MessageGroupMetadata $messageGroupMetadata
	) {
	$this->messageIndex = $messageIndex;
	$this->jobQueue = $jobQueue;
	$this->revTagStore = $revTagStore;
	$this->dbProvider = $dbProvider;
	$this->translatableBundleStatusStore = $translatableBundleStatusStore;
	$this->translatablePageParser = $translatablePageParser;
	$this->messageGroupMetadata = $messageGroupMetadata;
	}

	public function move( Title $oldName, Title $newName ): void {
	$oldTranslatablePage = TranslatablePage::newFromTitle( $oldName );
	$newTranslatablePage = TranslatablePage::newFromTitle( $newName );
	$oldGroupId = $oldTranslatablePage->getMessageGroupId();
	$newGroupId = $newTranslatablePage->getMessageGroupId();

	$this->messageGroupMetadata->moveMetadata( $oldGroupId, $newGroupId, TranslatablePage::METADATA_KEYS );

	$this->moveMetadata( $oldGroupId, $newGroupId );

	TranslatablePage::clearSourcePageCache();

	// Re-render the pages to get everything in sync
	MessageGroups::singleton()->recache();
	// Update message index now so that, when after this job the MoveTranslationUnits hook
	// runs in deferred updates, it will not run RebuildMessageIndexJob (T175834).
	$this->messageIndex->rebuild();

	$job = UpdateTranslatablePageJob::newFromPage( TranslatablePage::newFromTitle( $newName ) );
	$this->jobQueue->push( $job );
	}

	public function handleNullRevisionInsert( TranslatableBundle $bundle, RevisionRecord $revision ): void {
	if ( !$bundle instanceof TranslatablePage ) {
	throw new InvalidArgumentException(
	'Expected $bundle to be of type TranslatablePage, got ' . get_class( $bundle )
	);
	}

	$pageContent = $revision->getContent( SlotRecord::MAIN );
	if ( !$pageContent instanceof TextContent ) {
	throw new RuntimeException( "Translatable page {$bundle->getTitle()} has non-textual content." );
	}

	// Check if the revision still has the <translate> tag
	$pageText = $pageContent->getText();
	if ( $this->translatablePageParser->containsMarkup( $pageText ) ) {
	$this->revTagStore->replaceTag( $bundle->getTitle(), RevTagStore::TP_READY_TAG, $revision->getId() );
	TranslatablePage::clearSourcePageCache();
	}
	}

	/** Delete a translatable page */
	public function delete( Title $title ): void {
	$dbw = $this->dbProvider->getPrimaryDatabase();
	$dbw->newDeleteQueryBuilder()
	->deleteFrom( 'translate_sections' )
	->where( [ 'trs_page' => $title->getArticleID() ] )
	->caller( __METHOD__ )
	->execute();

	$this->unmark( $title );
	}

	/** Unmark a translatable page */
	public function unmark( PageIdentity $title ): void {
	$translatablePage = TranslatablePage::newFromTitle( $title );
	$translatablePage->getTranslationPercentages();
	foreach ( $translatablePage->getTranslationPages() as $page ) {
	$page->invalidateCache();
	}

	$groupId = $translatablePage->getMessageGroupId();
	$this->messageGroupMetadata->clearMetadata( $groupId, TranslatablePage::METADATA_KEYS );
	$this->removeFromAggregateGroups( $groupId );

	// Remove tags after all group related work is done in order to avoid breaking calls to
	// TranslatablePage::getMessageGroup incase the group cache is not populated
	$this->revTagStore->removeTags( $title, RevTagStore::TP_MARK_TAG, RevTagStore::TP_READY_TAG );
	$this->translatableBundleStatusStore->removeStatus( $title->getId() );

	MessageGroups::singleton()->recache();
	$this->jobQueue->push( RebuildMessageIndexJob::newJob( __METHOD__ ) );

	TranslatablePage::clearSourcePageCache();
	$translatablePage->getTitle()->invalidateCache();
	}

	/** Queues an update for the status of the translatable page. Update is not done immediately. */
	public function performStatusUpdate( Title $title ): void {
	DeferredUpdates::addCallableUpdate(
	function () use ( $title ) {
	$this->updateStatus( $title );
	}
	);
	}

	/** @internal public only for testing. Use ::performStatusUpdate instead */
	public function updateStatus( Title $title ): ?TranslatableBundleStatus {
	$revTags = $this->revTagStore->getLatestRevisionsForTags(
	$title,
	RevTagStore::TP_MARK_TAG,
	RevTagStore::TP_READY_TAG
	);

	$status = TranslatablePage::determineStatus(
	$revTags[RevTagStore::TP_READY_TAG] ?? null,
	$revTags[RevTagStore::TP_MARK_TAG] ?? null,
	$title->getLatestRevID( IDBAccessObject::READ_LATEST )
	);

	if ( $status ) {
	$this->translatableBundleStatusStore->setStatus(
	$title, $status, TranslatablePage::class
	);
	}

	return $status;
	}

	private function moveMetadata( string $oldGroupId, string $newGroupId ): void {
	// Make the changes in aggregate groups metadata, if present in any of them.
	$aggregateGroups = MessageGroups::getGroupsByType( AggregateMessageGroup::class );
	$this->messageGroupMetadata->preloadGroups( array_keys( $aggregateGroups ), __METHOD__ );

	foreach ( $aggregateGroups as $id => $group ) {
	$subgroups = $this->messageGroupMetadata->get( $id, 'subgroups' );
	if ( $subgroups === false ) {
	continue;
	}

	$subgroups = explode( ',', $subgroups );
	$subgroups = array_flip( $subgroups );
	if ( isset( $subgroups[$oldGroupId] ) ) {
	$subgroups[$newGroupId] = $subgroups[$oldGroupId];
	unset( $subgroups[$oldGroupId] );
	$subgroups = array_flip( $subgroups );
	$this->messageGroupMetadata->set(
	$group->getId(),
	'subgroups',
	implode( ',', $subgroups )
	);
	}
	}

	// Move discouraged status
	$priority = MessageGroups::getPriority( $oldGroupId );
	if ( $priority !== '' ) {
	MessageGroups::setPriority( $newGroupId, $priority );
	MessageGroups::setPriority( $oldGroupId, '' );
	}
	}

	private function removeFromAggregateGroups( string $groupId ): void {
	// remove the page from aggregate groups, if present in any of them.
	$aggregateGroups = MessageGroups::getGroupsByType( AggregateMessageGroup::class );
	$this->messageGroupMetadata->preloadGroups( array_keys( $aggregateGroups ), __METHOD__ );
	foreach ( $aggregateGroups as $group ) {
	$subgroups = $this->messageGroupMetadata->get( $group->getId(), 'subgroups' );
	if ( $subgroups !== false ) {
	$subgroups = explode( ',', $subgroups );
	$subgroups = array_flip( $subgroups );
	if ( isset( $subgroups[$groupId] ) ) {
	unset( $subgroups[$groupId] );
	$subgroups = array_flip( $subgroups );
	$this->messageGroupMetadata->set(
	$group->getId(),
	'subgroups',
	implode( ',', $subgroups )
	);
	}
	}
	}
	}
	}

File Metadata

Mime Type: text/x-php
Expires: Wed, Aug 19, 10:26 (2 w, 6 d ago)
Storage Engine: local-disk
Storage Format: Raw Data
Storage Handle: bc/c2/c377bb496ff6b469778327226ac4
Default Alt Text: TranslatablePageStore.php (7 KB)

TranslatablePageStore.phpNo OneTemporaryActions

TranslatablePageStore.phpView Options

File Metadata

Event Timeline

TranslatablePageStore.php
No OneTemporary
Actions

TranslatablePageStore.php
View Options