SemanticMediaWiki / SemanticCite

src/Specials/CitableMetadata/PageBuilder.php

<?php

namespace SCI\Specials\CitableMetadata;

use SMW\Services\ServicesFactory as ApplicationFactory;

The type SMW\Services\ServicesFactory was not found. Maybe you did not declare it correctly or list all dependencies?

use SCI\CitationResourceMatchFinder;
use SMW\MediaWiki\Renderer\HtmlFormRenderer;

The type SMW\MediaWiki\Renderer\HtmlFormRenderer was not found. Maybe you did not declare it correctly or list all dependencies?

use SMW\MediaWiki\Renderer\HtmlColumnListRenderer;

The type SMW\MediaWiki\Renderer\HtmlColumnListRenderer was not found. Maybe you did not declare it correctly or list all dependencies?

use SCI\FilteredMetadata\HttpResponseParserFactory;
use SCI\FilteredMetadata\BibliographicFilteredRecord;

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

	/**
	 * @var HtmlFormRenderer
	 */
	private $htmlFormRenderer;

	/**
	 * @var HtmlColumnListRenderer
	 */
	private $htmlColumnListRenderer;

	/**
	 * @var CitationResourceMatchFinder
	 */
	private $citationResourceMatchFinder;

	/**
	 * @var HttpResponseParserFactory
	 */
	private $httpResponseParserFactory;

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

	/**
	 * @since 1.0
	 *
	 * @param HtmlFormRenderer $htmlFormRenderer
	 * @param HtmlColumnListRenderer $htmlColumnListRenderer
	 * @param CitationResourceMatchFinder $citationResourceMatchFinder
	 * @param HttpResponseParserFactory $httpResponseParserFactory
	 */
	public function __construct( HtmlFormRenderer $htmlFormRenderer, HtmlColumnListRenderer $htmlColumnListRenderer, CitationResourceMatchFinder $citationResourceMatchFinder, HttpResponseParserFactory $httpResponseParserFactory ) {
		$this->htmlFormRenderer = $htmlFormRenderer;
		$this->htmlColumnListRenderer = $htmlColumnListRenderer;
		$this->citationResourceMatchFinder = $citationResourceMatchFinder;
		$this->httpResponseParserFactory = $httpResponseParserFactory;
	}

	/**
	 * @since 1.4
	 *
	 * @param boolean $isReadOnly
	 */
	public function isReadOnly( $isReadOnly ) {
		$this->isReadOnly = (bool)$isReadOnly;
	}

	/**
	 * @since 1.0
	 *
	 * @param string $type
	 * @param string $id
	 *
	 * @return string
	 */
	public function getRawResponseFor( $type, $id ) {

		$responseParser = $this->httpResponseParserFactory->newResponseParserForType(
			$type
		);

		$htmlResponseParserRenderer = new HtmlResponseParserRenderer(
			$responseParser
		);

		return $htmlResponseParserRenderer->getRawResponse( $id );
	}

	/**
	 * @since 1.0
	 *
	 * @param string $type
	 * @param string $id
	 *
	 * @return string
	 */
	public function getHtmlFor( $type, $id ) {

		$text = '';
		$success = true;
		$log = '';
		$matches = '';

		if ( $type !== '' && $id !== '' ) {

			$responseParser = $this->httpResponseParserFactory->newResponseParserForType(
				$type
			);

			$htmlResponseParserRenderer = new HtmlResponseParserRenderer(
				$responseParser
			);

			$htmlResponseParserRenderer->isReadOnly(
				$this->isReadOnly
			);

			$text = $htmlResponseParserRenderer->renderTextFor( $id );

			$matches = $this->tryToFindCitationResourceMatches(
				$responseParser->getFilteredRecord()
			);

			$success = $responseParser->getMessages() === [];

			$log = $this->prepareLog(
				$responseParser->getMessages(),
				$matches,
				$responseParser->usesCache()
			);
		}

		return $this->doRenderHtml( $type, $id, $success, $text, $log, $matches );
	}

	private function doRenderHtml( $type, $id, $success, $text, $log, $matches ) {

		$htmlFormRenderer = $this->htmlFormRenderer;
		$messageBuilder = $this->htmlFormRenderer->getMessageBuilder();

		$types = [
			'pubmed' => 'PMID',
			'pmc'  => 'PMCID',
			'doi'  => 'DOI',
			'oclc' => 'OCLC',
			'viaf' => 'VIAF',
			'ol'   => 'OLID',
		];


		if ( $matches !== '' ) {
			$htmlFormRenderer->addParagraph(
				'<div class="smw-callout smw-callout-info">' .
				$messageBuilder->getMessage( 'sci-metadata-search-has-match', $matches )->text() .
				'</div>'
			);
		}

		$html = $htmlFormRenderer->setName( 'sci-metadata-search-form' )
			->withFieldset()
			->setMethod( 'get' )
			->addParagraph( $messageBuilder->getMessage( 'sci-metadata-search-intro' )->parse() )
			->addParagraph( $this->getTypeIdIntroText( $messageBuilder ) )
			->addHorizontalRule()
			->addOptionSelectList(
				$messageBuilder->getMessage( 'sci-metadata-search-select-label' )->text(),
				'type',
				$type,
				$types )
			->addInputField(
				'',
				'id',
				$id,
				'id',
				40 )
			->addNonBreakingSpace()
			->addSubmitButton( $messageBuilder->getMessage( 'sci-metadata-search-form-submit' )->text() )
			->addNonBreakingSpace()
			->addCheckbox( 'Raw', 'format', 'raw' )
			->getForm();

		if ( $text !== '' && $success ) {
			$htmlFormRenderer
				->addHeader( 'h2', $messageBuilder->getMessage( 'sci-metadata-search-header-result' )->text() )
				->addParagraph( $text );
		}

		if ( $log !== '' ) {
			$htmlFormRenderer
				->setName( 'metadata-match' )
				->addHeader( 'h2', $messageBuilder->getMessage( 'sci-metadata-search-header-log' )->text() )
				->addParagraph( $log );
		}

		return $html . $htmlFormRenderer->getForm();
	}

	private function prepareLog( $messages, $matches, $usesCache ) {

The parameter $matches is not used and could be removed.

		$messageBuilder = $this->htmlFormRenderer->getMessageBuilder();

		$log = [];

		foreach ( $messages as $m ) {

			if ( call_user_func_array( 'wfMessage', $m )->exists() ) {
				$m = call_user_func_array( 'wfMessage', $m )->parse();
			} else {
				$m = current( $m );
			}

			$log[]  = $m;
		}

		if ( $usesCache ) {
			$log[] = $messageBuilder->getMessage( 'sci-metadata-search-cached' )->text();
		}

		if ( $this->isReadOnly ) {
			$log[] = $messageBuilder->getMessage( 'sci-metadata-search-read-only' )->text();
		}

		if ( $log === [] ) {
			return '';
		}

		$this->htmlColumnListRenderer->addContentsByNoIndex( $log );
		$this->htmlColumnListRenderer->setNumberOfColumns( 1 );

		return $this->htmlColumnListRenderer->getHtml();
	}

	private function getTypeIdIntroText( $messageBuilder ) {

		$explain = [];

		foreach ( [ 'doi', 'oclc', 'pubmed', 'ol', 'viaf' ] as $value ) {
			$explain[] = $messageBuilder->getMessage( 'sci-metadata-search-intro-'. $value )->parse();
		}

		$this->htmlColumnListRenderer->setColumnListClass( 'scite-metadata-search-types' );
		$this->htmlColumnListRenderer->addContentsByNoIndex( $explain );
		$this->htmlColumnListRenderer->setNumberOfColumns( 2 );

		return $this->htmlColumnListRenderer->getHtml();
	}

	private function tryToFindCitationResourceMatches( BibliographicFilteredRecord $bibliographicFilteredRecord ) {

		$html = [];

		foreach ( [ 'doi', 'oclc', 'viaf', 'olid', 'pubmed', 'pmc' ] as $type ) {
			$subjects = $this->citationResourceMatchFinder->findMatchForResourceIdentifierTypeToValue(
				$type,
				$bibliographicFilteredRecord->getSearchMatchSetValueFor( $type )
			);

			if ( $subjects !== [] ) {
				$html = array_merge(
					$html,
					$this->citationResourceMatchFinder->findCitationResourceLinks( $subjects, '', strtoupper( $type ) )
				);
			}
		}

		return $html !== [] ? '<strong>' . implode( ', ', $html ) . '</strong>' : '';
	}

}