SpecialListTransclusions.php

<?php

use MediaWiki\MediaWikiServices;

/**
 * ListTransclusions extension, Special page
 *
 * @author Patrick Westerhoff [poke]
 */
class SpecialListTransclusions extends SpecialPage {
	protected $dbr;
	protected $target;
	protected $opts;

	/**
	 * constructor
	 */
	public function __construct() {
		parent::__construct( 'ListTransclusions' );
	}

	/**
	 * Entry point for the special page.
	 *
	 * @param String $par Subpage of called special page
	 */
	public function execute( $par ) {
		global $wgRequest, $wgOut, $wgUser;

		$this->setHeaders();
		$this->dbr = wfGetDB( DB_REPLICA );
		$this->opts = new FormOptions();
		$this->opts->add( 'target', '' );
		$this->opts->fetchValuesFromRequest( $wgRequest );

		if ( isset( $par ) ) {
			$this->opts->setValue( 'target', $par );
		}

		$this->target = Title::newFromURL( $this->opts->getValue( 'target' ) );

		// output :: showForm
		$wgOut->addHTML( $this->generateForm() );

		if ( !$this->target ) {
			if ( trim( $this->opts->getValue( 'target' ) ) != '' ) {
				$wgOut->addWikiMsg( 'listtransclusions-invalid' );
			}

			return;
		}

		// output :: titles
		$targetText = $this->target->getPrefixedText();
		$wgOut->setPageTitle( wfMessage( 'listtransclusions-title', $targetText )->text() );
		$wgOut->setSubtitle( wfMessage( 'listtransclusions-backlink',
				Linker::link( $this->target, htmlspecialchars( $targetText ), array(),
				array( 'redirect' => 'no' ) ) )->text() );

		// check target's existance
		if ( !$this->target->exists() ) {
			$wgOut->addWikiMsg( 'listtransclusions-notexist', $targetText );
			return;
		}

		// receive transcluded pages
		$targetId   = $this->target->getArticleId();
		$loadedTpls = $this->loadTemplates( $targetId );
		$loadedImgs = $this->loadImages( $targetId );

		// output
		$wgOut->addWikiMsg( 'listtransclusions-header', $targetText );
		$wgOut->addHTML( $this->generatePagesList( $loadedTpls, 'listtransclusions-tpls' ) );
		$wgOut->addHTML( $this->generatePagesList( $loadedImgs, 'listtransclusions-imgs' ) );
		$wgOut->addWikiMsg( 'listtransclusions-footer', $targetText );
	}

	/**
	 * Loads the used templates on the target page
	 *
	 * @param String $targetId Target page
	 * @return Array Loaded templates
	 */
	private function loadTemplates( $targetId ) {

		$linksMigration = MediaWikiServices::getInstance()->getLinksMigration();
		$queryInfo = $linksMigration->getQueryInfo( 'templatelinks' );
		list( $nsField, $titleField ) = $linksMigration->getTitleFields( 'templatelinks' );

		$pages = array();
		$dbRes = $this->dbr->select(
				$queryInfo['tables'],
				$queryInfo['fields'],
				array( 'tl_from' => $targetId ),
				__METHOD__,
				array(),
				$queryInfo['joins']);

		if ( $dbRes !== false ) {
			foreach ( $dbRes as $row ) {
				$pages[] = Title::makeTitle( $row->$nsField, $row->$titleField );
			}
		}

		$dbRes->free();
		return $pages;
	}

	/**
	 * Load the used images on the target page
	 *
	 * @param String $targetId Target page
	 * @return Array Loaded images
	 */
	private function loadImages( $targetId ) {
		$pages = array();
		$dbRes = $this->dbr->select(
				array( 'imagelinks' ),
				array( 'il_to' ),
				array( 'il_from' => $targetId ),
				__METHOD__ );

		if ( $dbRes !== false ) {
			foreach ( $dbRes as $row ) {
				$pages[] = Title::makeTitle( NS_FILE, $row->il_to );
			}
		}

		$dbRes->free();
		return $pages;
	}

	/**
	 * Generates a list of the pages using the message.
	 * The function uses the message and the message with an appended '-no'.
	 *
	 * @param Array $pages Array of the loaded pages
	 * @param String $msg Message name to use
	 * @return String Generated HTML code
	 */
	private function generatePagesList( $pages, $msg ) {
		if ( count( $pages ) <= 0 ) {
			return wfMessage( $msg . '-no', $this->target->getPrefixedText() )->parseAsBlock();
		}

		usort( $pages, array( 'Title', 'compare' ) );
		$t = wfMessage( $msg, $this->target->getPrefixedText() )->parseAsBlock();
		$t .= "<ul>\n";

		foreach ( $pages as $titleObj ) {
			$t .= '<li>' . Linker::link( $titleObj ) . ' (';
			$t .= Linker::link( $titleObj, wfMessage( 'hist' )->text(), array(), array( 'action' => 'history' ) );
			$t .= ")</li>\n";
		}

		$t .= "</ul>\n";
		return $t;
	}

	/**
	 * Generates the form used for this special page
	 *
	 * @return String Generated HTML code
	 */
	private function generateForm() {
		global $wgScript, $wgTitle;

		$this->opts->consumeValue( 'target' );
		$target = $this->target ? $this->target->getPrefixedText() : '';

		$f  = Xml::openElement( 'form', array( 'action' => $wgScript ) );
		$f .= Xml::fieldset( wfMessage( 'listtransclusions' )->text() );

		// hidden values
		$f .= Html::hidden( 'title', $wgTitle->getPrefixedText() );
		foreach ( $this->opts->getUnconsumedValues() as $name => $value ) {
			$f .= Html::hidden( $name, $value );
		}

		// form elements
		$f .= Xml::inputLabel( wfMessage( 'listtransclusions-page' )->text(), 'target',
			'mw-listtransclusions-target', 40, $target );
		$f .= ' ';
		$f .= Xml::submitButton( wfMessage( 'allpagessubmit' )->text() );

		$f .= Xml::closeElement( 'fieldset' ) . Xml::closeElement( 'form' );

		return $f . "\n";
	}

	/**
	 * Set special page group name.
	 */
	protected function getGroupName() {
		return 'pagetools';
	}
}