wikimedia / mediawiki-extensions-Wikibase

repo/includes/FederatedProperties/SummaryParsingPrefetchHelper.php

<?php
declare( strict_types = 1 );

namespace Wikibase\Repo\FederatedProperties;

use LogicException;
use MediaWiki\Storage\RevisionRecord;
use Wikibase\DataAccess\PrefetchingTermLookup;
use Wikibase\DataModel\Entity\PropertyId;
use Wikimedia\Rdbms\IResultWrapper;

/**
 * A helper class for parsing and prefetching properties from summaries for federated properties
 *
 * @license GPL-2.0-or-later
 */
class SummaryParsingPrefetchHelper {

	/**
	 * @var PrefetchingTermLookup
	 */
	private $prefetchingLookup;

	public function __construct(
		PrefetchingTermLookup $prefetchingLookup

	) {
		$this->prefetchingLookup = $prefetchingLookup;
	}

	/**
	 * Matching links to properties in in edit summaries, such as "[[Property:P123]]" or "[[wdbeta:Special:EntityPage/P123]]"
	 */
	public const PROPERTY_SUMMARY_REGEXP = '/\[\[(\S+)(P[1-9]\d*)\]\]/';

	/**
	 * @param IResultWrapper|array $rows
	 * @param array $languageCodes
	 * @param array $termTypes
	 */
	public function prefetchFederatedProperties( $rows, array $languageCodes, array $termTypes ) : void {
		$resultProperties = $this->extractSummaryProperties( $rows );
		if ( empty( $resultProperties ) ) {
			return;
		}
		try {
			$this->prefetchingLookup->prefetchTerms(
				$resultProperties,
				$termTypes,
				$languageCodes
			);
		} catch ( FederatedPropertiesException $ex ) {
			wfLogWarning(
				__METHOD__ . ': Prefetching failed for federated properties: ' . implode( ',', $resultProperties )
			);
		}
	}

	/**
	 * @param IResultWrapper|array $result
	 * @return PropertyId[]
	 */
	public function extractSummaryProperties( $result ) : array {
		$propertyIds = [];
		foreach ( $result as $revisionRow ) {

			$comment = $this->getCommentText( $revisionRow );
			if ( $comment === null ) {
				continue;
			}

			$matches = [];
			preg_match( self::PROPERTY_SUMMARY_REGEXP, $comment, $matches );
			if ( count( $matches ) === 3 ) {
				$propertyId = $matches[2];
				$propertyIds[] = new PropertyId( $propertyId );
			}
		}
		return $propertyIds;
	}

	private function getCommentText( $revisionRow ) {
		if ( $revisionRow === null ) {
			return null;
		}

		if ( $revisionRow instanceof RevisionRecord ) {

The class MediaWiki\Storage\RevisionRecord does not exist. Did you forget a USE statement, or did you not list all dependencies?

			$comment = $revisionRow->getComment();
			return $comment === null ? null : $comment->text;
		}

		if ( property_exists( $revisionRow, 'rc_comment_text' ) ) {
			return $revisionRow->rc_comment_text;
		} elseif ( property_exists( $revisionRow, 'rev_comment_text' ) ) {
			return $revisionRow->rev_comment_text;
		}

		throw new LogicException( 'Rows should have either rc_comment_text or rev_comment_text field' );
	}
}