SIL\SiteLanguageLinksParserOutputAppender

Complexity

Total Complexity

19

Size/Duplication

Total Lines	165
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

92.98%

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	getRedirectTargetFor()	0	3	1
A	sanitizeLanguageTargetLinks()	0	7	1
A	tryAddLanguageTargetLinksToOutput()	0	37	3
A	compareTargetToCurrentLanguage()	0	20	5
A	addLanguageLinksToOutput()	0	24	5
A	doPurgeParserCache()	0	10	3

<?php

namespace SIL;

use Title;
use ParserOutput;

/**
 * @license GNU GPL v2+
 * @since 1.0
 *
 * @author mwjames
 */
class SiteLanguageLinksParserOutputAppender {

	/**
	 * @var ParserOutput
	 */
	private $parserOutput;

	/**
	 * @var InterlanguageLinksLookup
	 */
	private $interlanguageLinksLookup;

	/**
	 * This is made static by choice to monitor multiple parser calls and filter
	 * out links with the same target.
	 *
	 * @var array
	 */
	private static $languageTargetLinksMap = [];

	/**
	 * @since 1.0
	 *
	 * @param ParserOutput $parserOutput
	 * @param InterlanguageLinksLookup $interlanguageLinksLookup
	 */
	public function __construct( ParserOutput $parserOutput, InterlanguageLinksLookup $interlanguageLinksLookup ) {
		$this->parserOutput = $parserOutput;
		$this->interlanguageLinksLookup = $interlanguageLinksLookup;
	}

	/**
	 * @since 1.0
	 *
	 * @param Title $target
	 *
	 * @return Title
	 */
	public function getRedirectTargetFor( Title $title ) {
		return $this->interlanguageLinksLookup->getRedirectTargetFor( $title );
	}

	/**
	 * @since 1.0
	 *
	 * @param InterlanguageLink $interlanguageLink
	 * @param Title|null $target
	 *
	 * @return string
	 */
	public function tryAddLanguageTargetLinksToOutput( InterlanguageLink $interlanguageLink, Title $target = null ) {

		$knownTargetLink = '';
		$selectedTargetLinkForCurrentLanguage = false;

		$languageTargetLinks = $this->interlanguageLinksLookup->queryLanguageTargetLinks(
			$interlanguageLink,
			$target
		);

		// Always update the cache entry with an annotation directly made to avoid
		// extra lookup during the view action
		$this->interlanguageLinksLookup->pushPageLanguageToLookupCache(
			$target,
			$interlanguageLink->getLanguageCode()
		);

		if ( isset( $languageTargetLinks[ $interlanguageLink->getLanguageCode() ] ) ) {
			$selectedTargetLinkForCurrentLanguage = $languageTargetLinks[ $interlanguageLink->getLanguageCode() ];
		}

		$knownTargetLink = $this->compareTargetToCurrentLanguage(
			$target,
			$selectedTargetLinkForCurrentLanguage
		);

		if ( !$knownTargetLink ) {
			$this->addLanguageLinksToOutput(
				$interlanguageLink,
				$languageTargetLinks
			);
		}

		$this->doPurgeParserCache( $languageTargetLinks );

		return $knownTargetLink;
	}

	/**
	 * Identify whether a double assignment did occur by comparing the target
	 * for the requested language and the current article as target that invoked
	 * INTERLANGUAGELINK parser.
	 *
	 * @return boolean|string
	 */
	private function compareTargetToCurrentLanguage( Title $target = null, $selectedTargetLinkForCurrentLanguage ) {

		if ( $selectedTargetLinkForCurrentLanguage instanceof Title ) {
			 $selectedTargetLinkForCurrentLanguage = $selectedTargetLinkForCurrentLanguage->getPrefixedText();
		}

		if ( $target !== null && $selectedTargetLinkForCurrentLanguage !== $target->getPrefixedText() ) {

			$title = Title::newFromText( $selectedTargetLinkForCurrentLanguage );

			if ( $title->isRedirect() ) {
			//	 $this->interlanguageLinksLookup->resetLookupCacheBy( $target );
				 return false;
			}

			return $selectedTargetLinkForCurrentLanguage;
		}

		return false;
	}

	/**
	 * `sil:` is used as internal code to distinguish any language link that
	 * was not added by SIL
	 */
	private function addLanguageLinksToOutput( InterlanguageLink $interlanguageLink, array $languageTargetLinks ) {

		$languageTargetLinks = $this->sanitizeLanguageTargetLinks(
			$interlanguageLink,
			$languageTargetLinks
		);

		foreach ( $languageTargetLinks as $languageCode => $target ) {

			if ( $target instanceof Title ) {
				$target = $target->getPrefixedText();
			}

			// Multiple parser calls can create maps that contain the same targets,
			// safeguard against mutliple entries with the same target
			if ( isset( self::$languageTargetLinksMap[$languageCode] ) && self::$languageTargetLinksMap[$languageCode] === $target ) {
				continue;
			}

			self::$languageTargetLinksMap[$languageCode] = $target;

			$this->parserOutput->addLanguageLink( 'sil:' . $languageCode . ':' . $target );
		}
	}

	private function sanitizeLanguageTargetLinks( InterlanguageLink $interlanguageLink, array $languageTargetLinks ) {

		unset( $languageTargetLinks[ $interlanguageLink->getLanguageCode() ] );
		ksort( $languageTargetLinks );

		return $languageTargetLinks;
	}

	private function doPurgeParserCache( $languageTargetLinks ) {
		foreach ( $languageTargetLinks as $languageTargetLink ) {

			if ( !$languageTargetLink instanceof Title ) {
				continue;
			}

			$languageTargetLink->invalidateCache();
		}
	}

}