SIL\PageContentLanguageDbModifier

Complexity

Total Complexity

12

Size/Duplication

Total Lines	115
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

94.44%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	markAsPageLanguageByDB()	0	3	1
A	updatePageLanguage()	0	14	4
A	getDbPageLanguageCode()	0	15	4
A	doUpdate()	0	26	2

<?php

namespace SIL;

use LinkCache;
use Title;
use DatabaseBase;

/**
 * Handling Title::getDbPageLanguageCode and Special:PageLanguage to avoid possible
 * contradictory results when $wgPageLanguageUseDB is enabled.
 *
 * If wgPageLanguageUseDB is enabled then the PageContentLanguage hook is not
 * going to be called in case Special:PageLanguage assigned a pagelanguage which
 * could create a possible deviation between SIL annotation and the stored DB
 * `page_lang`.
 *
 * @license GNU GPL v2+
 * @since 1.3
 *
 * @author mwjames
 */
class PageContentLanguageDbModifier {

	/**
	 * @var Title
	 */
	private $title;

	/**
	 * @var DatabaseBase
	 */
	private $connection;

	/**
	 * @var LinkCache
	 */
	private $linkCache;

	/**
	 * @var boolean
	 */
	private $isDbPageLanguage = false;

	/**
	 * @var string|false
	 */
	private $dbPageLanguage = false;

	/**
	 * @since 1.3
	 *
	 * @param Title $title
	 * @param DatabaseBase|null $connection
	 * @param LinkCache|null $linkCache
	 */
	public function __construct( Title $title, DatabaseBase $connection = null, LinkCache $linkCache = null ) {
		$this->title = $title;
		$this->connection = $connection;
		$this->linkCache = $linkCache;
	}

	/**
	 * @since 1.3
	 *
	 * @param boolean $isDbPageLanguage
	 */
	public function markAsPageLanguageByDB( $isDbPageLanguage ) {
		$this->isDbPageLanguage = $isDbPageLanguage;
	}

	/**
	 * @since 1.3
	 *
	 * @param string $expectedLanguageCode
	 */
	public function updatePageLanguage( $expectedLanguageCode ) {

		if ( !$this->isDbPageLanguage ) {
			return null;
		}

		$expectedLanguageCode = strtolower( $expectedLanguageCode );

		// If the pagelanguage added via Special:PageLanguage is different from
		// what SIL is expecting then push for a DB update
		if ( $this->getDbPageLanguageCode() && $this->dbPageLanguage !== $expectedLanguageCode ) {
			$this->doUpdate( $expectedLanguageCode, $this->dbPageLanguage );
		}
	}

	// @see Title::getDbPageLanguageCode
	private function getDbPageLanguageCode() {

		if ( $this->linkCache === null ) {
			$this->linkCache = LinkCache::singleton();
		}

		// check, if the page language could be saved in the database, and if so and
		// the value is not requested already, lookup the page language using LinkCache
		if ( $this->isDbPageLanguage && $this->dbPageLanguage === false ) {
			$this->linkCache->addLinkObj( $this->title );
			$this->dbPageLanguage = $this->linkCache->getGoodLinkFieldObj( $this->title, 'lang' );
		}

		return $this->dbPageLanguage;
	}

	// @see Special:PageLanguage::onSubmit
	private function doUpdate( $expectedLanguageCode, $dbPageLanguage ) {

		$connection = $this->connection;
		$title = $this->title;

		if ( $connection === null ) {
			 $connection = wfGetDB( DB_MASTER );
		}

		$connection->onTransactionIdle( function() use ( $connection, $expectedLanguageCode, $dbPageLanguage, $title ) {

			$pageId = $title->getArticleID();

			$connection->update(
				'page',
				[
					'page_lang' => $expectedLanguageCode
				],
				[
					'page_id'   => $pageId,
					'page_lang' => $dbPageLanguage
				],
				__METHOD__
			);
		} );
	}

}