SCI\Specials\SpecialFindCitableMetadata

Complexity

Total Complexity

15

Size/Duplication

Total Lines	133
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Test Coverage

Coverage

81.54%

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	3	1
A	getGroupName()	0	3	1
A	addExternalHelpLinkFor()	0	8	2
A	execute()	0	29	3
A	callPageBuilderFor()	0	23	2
A	getRequestParameters()	0	16	5
A	newPageBuilder()	0	29	1

<?php

namespace SCI\Specials;

use SpecialPage;
use SMW\ApplicationFactory;
use Onoi\HttpRequest\HttpRequestFactory;
use SCI\FilteredMetadata\HttpResponseParserFactory;
use SCI\CitationResourceMatchFinder;
use SCI\Specials\CitableMetadata\PageBuilder;

/**
 * @license GNU GPL v2+
 * @since   1.0
 *
 * @author mwjames
 */
class SpecialFindCitableMetadata extends SpecialPage {

	/**
	 * @codeCoverageIgnore
	 */
	public function __construct() {
		parent::__construct( 'FindCitableMetadata', 'sci-metadatasearch' );
	}

	/**
	 * @see SpecialPage::getGroupName
	 */
	protected function getGroupName() {
		return 'wiki';
	}

	/**
	 * @see SpecialPage::execute
	 */
	public function execute( $query ) {

		if ( !$this->userCanExecute( $this->getUser() ) ) {
			$this->displayRestrictionError();
			return;
		}

		$output = $this->getOutput();
		$output->setPageTitle( $this->msg( 'findmetadatabyid' )->text() );
		$this->setHeaders();

		$output->addModuleStyles( 'ext.scite.styles' );

		$output->addModules(
			[
				'ext.scite.metadata'
			]
		);

		list( $type, $id, $format ) = $this->getRequestParameters(
			$query
		);

		if ( $type === 'pmid' ) {
			$type = 'pubmed';
		}

		$this->callPageBuilderFor( $type, $id, $format );
	}

	private function callPageBuilderFor( $type, $id, $format ) {

		$pageBuilder = $this->newPageBuilder();

		if ( $format === 'raw' ) {
			$this->getOutput()->disable();
			header( "Content-type: text/plain; charset=utf-8" );
			header( 'Cache-Control: private, no-cache, must-revalidate' );

			$html = $pageBuilder->getRawResponseFor(
				$type, $id
			);

			return print $html;
		}

		$html = $pageBuilder->getHtmlFor(
			$type, $id
		);

		$this->getOutput()->addHTML( $html );
		$this->addExternalHelpLinkFor( 'sci-specials-citablemetadata-helplink' );
	}

	private function getRequestParameters( $query ) {

		$request = $this->getRequest()->getValues();

		if ( strpos( $query, '/' ) !== false ) {
			list( $type, $id ) = explode( '/', $query, 2 );
			$request['type'] = $type;
			$request['id'] = $id;
		}

		$id = isset( $request['id'] ) ? trim( $request['id'] ) : '';
		$type = isset( $request['type'] ) ? strtolower( $request['type'] ) : '';
		$format = isset( $request['format'] ) ? strtolower( $request['format'] ) : '';

		return [ $type, $id, $format ];
	}

	private function newPageBuilder() {

		$applicationFactory = ApplicationFactory::getInstance();
		$mwCollaboratorFactory = $applicationFactory->newMwCollaboratorFactory();

		$htmlFormRenderer = $mwCollaboratorFactory->newHtmlFormRenderer(
			$this->getContext()->getTitle(),
			$this->getLanguage()
		);

		$httpRequestFactory = new HttpRequestFactory(
			$applicationFactory->newCacheFactory()->newMediaWikiCompositeCache( $GLOBALS['scigMetadataResponseCacheType'] )
		);

		$httpRequest = $httpRequestFactory->newCachedCurlRequest();
		$httpRequest->setOption( ONOI_HTTP_REQUEST_RESPONSECACHE_TTL, $GLOBALS['scigMetadataResponseCacheLifetime'] );
		$httpRequest->setOption( ONOI_HTTP_REQUEST_RESPONSECACHE_PREFIX, $GLOBALS['scigCachePrefix'] . ':sci:meta:' );

		$pageBuilder = new PageBuilder(
			$htmlFormRenderer,
			$mwCollaboratorFactory->newHtmlColumnListRenderer(),
			new CitationResourceMatchFinder( $applicationFactory->getStore() ),
			new HttpResponseParserFactory( $httpRequest )
		);

		$pageBuilder->isReadOnly( wfReadOnly() );

		return $pageBuilder;
	}

	/**
	 * FIXME MW 1.25
	 */
	private function addExternalHelpLinkFor( $key ) {

		if ( !method_exists( $this, 'addHelpLink' ) ) {
			return null;
		}

		$this->getOutput()->addHelpLink( wfMessage( $key )->escaped(), true );
	}

}